Function rcl_subscription_options_set_acceptable_buffer_backends

Function Documentation

rcl_ret_t rcl_subscription_options_set_acceptable_buffer_backends(const char *acceptable_buffer_backends, rcl_subscription_options_t *options)

Set the acceptable buffer backends for the given subscription options.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

No

Lock-Free

No

Parameters:
  • acceptable_buffer_backends[in] Comma-separated list of acceptable buffer backend names. NULL or empty string means CPU-only (default). “any” means all installed backends.

  • options[out] The subscription options to be set.

Returns:

RCL_RET_OK if set options successfully, or

Returns:

RCL_RET_INVALID_ARGUMENT if options is NULL, or

Returns:

RCL_RET_BAD_ALLOC if allocating memory fails.