DDSStatusCondition Class Reference

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

Inheritance diagram for DDSStatusCondition:

List of all members.

Public Member Functions
DDS_StatusMask	get_enabled_statuses ()
	<<cert>> Get the list of statuses enabled on an DDSEntity.
DDS_ReturnCode_t	set_enabled_statuses (DDS_StatusMask mask)
	<<cert>> This operation defines the list of communication statuses that determine the trigger_value of the DDSStatusCondition.

Friends
class	DDSEntity

---

Detailed Description

<<interface>> <<cert>> 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

DDS_StatusMask DDSStatusCondition::get_enabled_statuses

(

)

<<cert>> Get the list of statuses enabled on an DDSEntity.

Returns:

list of enabled statuses.

MT Safety:

This operation is thread safe. However, note that the arguments are not protected from being modified by other threads and must not be modified until the call returns.

DDS_ReturnCode_t DDSStatusCondition::set_enabled_statuses

(

DDS_StatusMask

mask

)

<<cert>> 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

MT Safety:

This operation is thread safe. However, note that the arguments are not protected from being modified by other threads and must not be modified until the call returns.