Function rmw_publisher_event_init

Function Documentation

rmw_ret_t rmw_publisher_event_init(rmw_event_t *rmw_event, const rmw_publisher_t *publisher, rmw_event_type_t event_type)

Initialize a rmw publisher event.

Parameters:
  • rmw_event[inout] to initialize

  • publisher[in] to initialize with

  • event_type[inout] for the event to initialize

Returns:

RMW_RET_OK if successful, or

Returns:

RMW_RET_INVALID_ARGUMENT if invalid argument, or

Returns:

RMW_RET_UNSUPPORTED if event_type is not supported, or

Returns:

RMW_RET_ERROR if an unexpected error occurs.