Function rclc_executor_prepare

Function Documentation

rcl_ret_t rclc_executor_prepare(rclc_executor_t *executor)

The executor prepare function prepare the waitset of the executor if it is invalid. Does nothing if a valid waitset is already prepared.

Memory is dynamically allocated within rcl-layer, when DDS queue is accessed with rcl_wait_set_init()

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:

executor[inout] pointer to initialized executor

Returns:

RCL_RET_OK if executor prepare operation was successful

Returns:

RCL_RET_INVALID_ARGUMENT if any parameter is a null pointer

Returns:

RCL_RET_ERROR if any other error occured