Function rcl_take_event

Defined in File event.h

Function Documentation

rcl_ret_t rcl_take_event(const rcl_event_t *event, void *event_info)

Take an event from the event handle.

Parameters:

event – [in] event object to take from
event_info – [inout] event info object to write taken data into

Returns:

RCL_RET_OK if successful, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_BAD_ALLOC if memory allocation failed, or

Returns:

RCL_RET_EVENT_TAKE_FAILED if the take event failed, or

Returns:

RCL_RET_ERROR if an unexpected error occurs.