Function dds_get_listener

Function Documentation

dds_return_t dds_get_listener(dds_entity_t entity, dds_listener_t *listener)

Get entity listeners.

This operation allows access to the existing listeners attached to the entity.

Parameters
  • entity[in] Entity on which to get the listeners.

  • listener[out] Pointer to the listener structure that returns the set of listener callbacks.

Return values
  • DDS_RETCODE_OK – The listeners of to the entity have been successfully been copied into the specified listener parameter.

  • DDS_RETCODE_ERROR – An internal error has occurred.

  • DDS_RETCODE_BAD_PARAMETER – The listener parameter is NULL.

  • DDS_RETCODE_ILLEGAL_OPERATION – The operation is invoked on an inappropriate object.

  • DDS_RETCODE_ALREADY_DELETED – The entity has already been deleted.

Returns

A dds_return_t indicating success or failure.