Function rcl_wait_set_get_allocator

Function Documentation

rcl_ret_t rcl_wait_set_get_allocator(const rcl_wait_set_t *wait_set, rcl_allocator_t *allocator)

Retrieve the wait set’s allocator.

The allocator must be an allocated rcl_allocator_t struct, as the result is copied into this variable.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:

  • wait_set – [in] the handle to the wait set

  • allocator – [out] the rcl_allocator_t struct to which the result is copied

Returns:

RCL_RET_OK if the allocator was successfully retrieved, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_WAIT_SET_INVALID if the wait set is invalid, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.