DDS::GuardCondition Class Reference

A GuardCondition is a condition where the trigger_value is under application control. More...

Inheritance diagram for DDS::GuardCondition:

Public Member Functions
bool	get_trigger_value ()
	This routine returns the current value of the trigger_value in gc. More...
ReturnCode_t	set_trigger_value (bool v)
	This routine set the current value of the trigger_value in gc. More...

Detailed Description

A GuardCondition is a condition where the trigger_value is under application control.

Member Function Documentation

get_trigger_value()

bool DDS::GuardCondition::get_trigger_value ( )

virtual

This routine returns the current value of the trigger_value in gc.

A non-zero return value indicates that the trigger_value is TRUE.

A zero return value indicates that the trigger_value is FALSE.

Reimplemented from DDS::Condition.

set_trigger_value()

ReturnCode_t DDS::GuardCondition::set_trigger_value

(

bool

v

)

This routine set the current value of the trigger_value in gc.

A non-zero v argument indicates that the trigger_value is TRUE.

A zero v argument indicates that the trigger_value is FALSE. Setting the trigger value to a non-zero state will cause any threads that are waiting on a WaitSet with this GuardCondition attached to unblock. [In other words, the WaitSet_wait() routine will return if the WaitSet has this GuardCondition attached to it.]