RTI Connext Traditional C++ API  Version 6.1.2
DDSStatusCondition Class Referenceabstract

<<interface>> A specific DDSCondition that is associated with each DDSEntity. More...

Inheritance diagram for DDSStatusCondition:
DDSCondition

Public Member Functions

virtual DDS_StatusMask get_enabled_statuses ()=0
 Get the list of statuses enabled on an DDSEntity. More...
 
virtual DDS_ReturnCode_t set_enabled_statuses (DDS_StatusMask mask)=0
 This operation defines the list of communication statuses that determine the trigger_value of the DDSStatusCondition. More...
 
virtual DDSEntityget_entity ()=0
 Get the DDSEntity associated with the DDSStatusCondition. More...
 
- Public Member Functions inherited from DDSCondition
virtual DDS_Boolean get_trigger_value ()=0
 Retrieve the trigger_value. More...
 
virtual DDS_ReturnCode_t set_handler (DDSConditionHandler *handler)
 <<extension>> Registers a DDSConditionHandler in this DDSCondition. More...
 
virtual DDSConditionHandlerget_handler ()
 <<extension>> Returns the registered DDSConditionHandler. More...
 
virtual void dispatch ()
 <<extension>> Calls DDSConditionHandler::on_condition_triggered of the registered DDSConditionHandler. More...
 

Detailed Description

<<interface>> A specific DDSCondition that is associated with each DDSEntity.

The trigger_value of the DDSStatusCondition depends on the communication status of that entity (e.g., arrival of data, loss of information, etc.), 'filtered' by the set of enabled_statuses on the DDSStatusCondition.

See also
Status Kinds
DDSWaitSet, DDSCondition
DDSListener

Member Function Documentation

◆ get_enabled_statuses()

virtual DDS_StatusMask DDSStatusCondition::get_enabled_statuses ( )
pure virtual

Get the list of statuses enabled on an DDSEntity.

Returns
list of enabled statuses.

◆ set_enabled_statuses()

virtual DDS_ReturnCode_t DDSStatusCondition::set_enabled_statuses ( DDS_StatusMask  mask)
pure virtual

This operation defines the list of communication statuses that determine the trigger_value of the DDSStatusCondition.

This operation may change the trigger_value of the DDSStatusCondition.

DDSWaitSet objects' behavior depends on the changes of the trigger_value of their attached conditions. Therefore, any DDSWaitSet to which the DDSStatusCondition is attached is potentially affected by this operation.

If this function is not invoked, the default list of enabled statuses includes all the statuses.

Parameters
mask<<in>> the list of enables statuses (see Status Kinds)
Returns
One of the Standard Return Codes

◆ get_entity()

virtual DDSEntity* DDSStatusCondition::get_entity ( )
pure virtual

Get the DDSEntity associated with the DDSStatusCondition.

There is exactly one DDSEntity assocated with each DDSStatusCondition.

Returns
DDSEntity associated with the DDSStatusCondition.