Function rclc_executor_remove_timer

• Defined in File executor.h

Function Documentation

rcl_ret_t rclc_executor_remove_timer(rclc_executor_t *executor, const rcl_timer_t *timer)

Removes a timer from an executor.

• An error is returned if rclc_executor_t.handles array is empty.

• An error is returned if timer is not found in rclc_executor_t.handles.

• The total number_of_timers field of rclc_executor_t.info is incremented by one.

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

Parameters:

• executor – [inout] pointer to initialized executor

• timer – [in] pointer to an allocated and initialized timer previously added to executor

Returns:

RCL_RET_OK if add-operation was successful

Returns:

RCL_RET_INVALID_ARGUMENT if any parameter is a null pointer

Returns:

RCL_RET_ERROR if any other error occured