Function rcl_service_get_options

• Defined in File service.h

Function Documentation

const rcl_service_options_t *rcl_service_get_options(const rcl_service_t *service)

Return the rcl service options.

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

• service is NULL

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

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

service – [in] pointer to the service

Returns:

options struct if successful, otherwise NULL