Function rcl_subscription_get_options

• Defined in File subscription.h

Function Documentation

const rcl_subscription_options_t *rcl_subscription_get_options(const rcl_subscription_t *subscription)

Return the rcl subscription options.

This function returns the subscription’s internal options struct. This function can fail, and therefore return NULL, if the:

• subscription is NULL

• subscription is invalid (never called init, called fini, or invalid)

The returned struct is only valid as long as the subscription is valid. The values in the struct may change if the subscription’s options change, and therefore copying the struct is recommended if this is a concern.

Attribute	Adherence
Allocates Memory	No
Thread-Safe	No
Uses Atomics	No
Lock-Free	Yes

Parameters:

subscription – [in] pointer to the subscription

Returns:

options struct if successful, otherwise NULL