Function rclc_executor_add_guard_condition
Defined in File executor.h
Function Documentation
-
rcl_ret_t rclc_executor_add_guard_condition(rclc_executor_t *executor, rcl_guard_condition_t *gc, rclc_gc_callback_t callback)
Adds a guard_condition to an executor.
An error is returned if
rclc_executor_t.handles
array is full.The total number_of_guard_conditions 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
gc – [in] pointer to an allocated and initialized guard_condition
callback – [in] function pointer to a callback function
- 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