Function rclc_executor_handle_init

• Defined in File executor_handle.h

Function Documentation

rcl_ret_t rclc_executor_handle_init(rclc_executor_handle_t *handle, size_t max_handles)

Initializes a handle with default values. The rclc_executor_handle_t.index is initialized with max_handles, which is a non-valid index. Note that, valid indicies are [0,max-handles-1]. The rclc_executor_handle_t.invocation is set to ON_NEW_DATA, so that a potential callback is invoced only whenever new data is received. All other member fields are set appropriate default values, like none, NULL or false.

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

Parameters:

• handle – [inout] preallocated rclc_executor_handle_t

• max_handles – [in] maximum number of handles

Returns:

RCL_RET_OK if the handle was initialized successfully

Returns:

RCL_RET_INVALID_ARGUMENT if h is a null pointer