Skip to main content

dds_get_datareader

cyclonedds_rust_sys

Function dds_get_datareader 

Source 
pub unsafe extern "C" fn dds_get_datareader(
    entity: dds_entity_t,
) -> dds_entity_t
Expand description

@brief Get entity datareader. @ingroup entity @component entity_relations

This operation returns the datareader to which the given entity belongs. For instance, it will return the DataReader that was used when creating a ReadCondition (when that ReadCondition was provided here).

@param[in] entity Entity from which to get its datareader.

@returns A valid reader handle or an error code.

@retval >0 A valid reader handle. @retval DDS_RETCODE_ERROR An internal error has occurred. @retval DDS_RETCODE_ILLEGAL_OPERATION The operation is invoked on an inappropriate object. @retval DDS_RETCODE_ALREADY_DELETED The entity has already been deleted. DOC_TODO: Link to generic dds entity relations documentation.