Function rcl_client_get_options

• Defined in File client.h

Function Documentation

const rcl_client_options_t *rcl_client_get_options(const rcl_client_t *client)

Return the rcl client options.

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

• client is NULL

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

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

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

Parameters:

client – [in] pointer to the client

Returns:

options struct if successful, otherwise NULL