Function rcl_subscription_get_content_filter

• Defined in File subscription.h

Function Documentation

rcl_ret_t rcl_subscription_get_content_filter(const rcl_subscription_t *subscription, rcl_subscription_content_filter_options_t *options)

Retrieve the filter expression of the subscription.

This function will return an filter expression by the given subscription.

Attribute	Adherence
Allocates Memory	Yes
Thread-Safe	No
Uses Atomics	Maybe [1]
Lock-Free	Maybe [1]

Parameters:

• subscription – [in] The subscription object to inspect.

• options – [out] The rcl content filter options. It is up to the caller to finalize this options later on, using rcl_subscription_content_filter_options_fini().

Returns:

RCL_RET_OK if the query was successful, or

Returns:

RCL_RET_INVALID_ARGUMENT if subscription is NULL, or

Returns:

RCL_RET_INVALID_ARGUMENT if options is NULL, or

Returns:

RCL_RET_BAD_ALLOC if memory allocation fails, or

Returns:

RCL_RET_UNSUPPORTED if the implementation does not support content filter topic, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.