Function rmw_subscription_get_content_filter

• Defined in File rmw.h

Function Documentation

rmw_ret_t rmw_subscription_get_content_filter(const rmw_subscription_t *subscription, rcutils_allocator_t *allocator, rmw_subscription_content_filter_options_t *options)

Retrieve the content filter options of the subscription.

This function will return a content filter options by the given subscription.

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

[1] implementation defined, check the implementation documentation

Parameters:

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

• allocator – [in] Allocator to be used when populating the content filter options.

• options – [out] The content filter options.

Returns:

RMW_RET_OK if successful, or

Returns:

RMW_RET_INVALID_ARGUMENT if an argument is null, or

Returns:

RMW_RET_INCORRECT_RMW_IMPLEMENTATION if the subscription implementation identifier does not match this implementation, or

Returns:

RMW_RET_BAD_ALLOC if memory allocation fails, or

Returns:

RMW_RET_UNSUPPORTED if the implementation does not support content filtered topic, or

Returns:

RMW_RET_ERROR if an unspecified error occurs.