Function rcl_publisher_get_options

• Defined in File publisher.h

Function Documentation

const rcl_publisher_options_t *rcl_publisher_get_options(const rcl_publisher_t *publisher)

Return the rcl publisher options.

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

• publisher is NULL

• publisher is invalid (never called init, called fini, or invalid node)

The returned struct is only valid as long as the rcl_publisher_t is valid. The values in the struct may change if the options of the publisher 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:

publisher – [in] pointer to the publisher

Returns:

options struct if successful, otherwise NULL