Function rcl_event_get_rmw_handle

Function Documentation

rmw_event_t *rcl_event_get_rmw_handle(const rcl_event_t *event)

Return the rmw event handle.

The handle returned is a pointer to the internally held rmw handle. This function can fail, and therefore return NULL, if the:

  • event is NULL

  • event is invalid (never called init, called fini, or invalid node)

The returned handle is made invalid if the event is finalized or if rcl_shutdown() is called. The returned handle is not guaranteed to be valid for the life time of the event as it may be finalized and recreated itself. Therefore it is recommended to get the handle from the event using this function each time it is needed and avoid use of the handle concurrently with functions that might change it.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:

event – [in] pointer to the rcl event

Returns:

rmw event handle if successful, otherwise NULL