Function rmw_take_event

Function Documentation

rmw_ret_t rmw_take_event(const rmw_event_t *event_handle, void *event_info, bool *taken)

Take an event from the event handle.

Parameters:
  • event_handle[in] event object to take from

  • event_info[inout] event info object to write taken data into

  • taken[out] boolean flag indicating if an event was taken or not

Returns:

RMW_RET_OK if successful, or

Returns:

RMW_RET_BAD_ALLOC if memory allocation failed, or

Returns:

RMW_RET_ERROR if an unexpected error occurs.