GuardCondition Class Reference

<<interface>> A specific com.rti.dds.infrastructure.Condition whose trigger_value is completely under the control of the application. More...

Inherits AbstractNativeObject, AutoCloseable, and NativeCondition.

Public Member Functions
	GuardCondition ()
	No argument constructor. More...
void	set_trigger_value (boolean value)
	Set the guard condition trigger value. More...
boolean	get_trigger_value ()
	Retrieve the trigger_value. More...
void	delete ()
	Destructor. More...
void	close ()
	See delete(). More...

Detailed Description

<<interface>> A specific com.rti.dds.infrastructure.Condition whose trigger_value is completely under the control of the application.

The com.rti.dds.infrastructure.GuardCondition provides a way for an application to manually wake up a com.rti.dds.infrastructure.WaitSet. This is accomplished by attaching the com.rti.dds.infrastructure.GuardCondition to the com.rti.dds.infrastructure.WaitSet and then setting the trigger_value by means of the com.rti.dds.infrastructure.GuardCondition.set_trigger_value operation.

Important: GuardCondition allocates native resources. When a GuardCondition is no longer being used, close() must be called.

See also

com.rti.dds.infrastructure.WaitSet

Constructor & Destructor Documentation

GuardCondition()

GuardCondition

(

)

No argument constructor.

Construct a new guard condition with trigger value com.rti.dds.infrastructure.false.

MT Safety:

UNSAFE. In VxWorks, it is unsafe to call this method while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipantFactory.get_instance, com.rti.dds.domain.DomainParticipantFactory.finalize_instance, com.rti.dds.typecode.TypeCodeFactory.get_instance, com.rti.dds.infrastructure.GuardCondition.GuardCondition.GuardCondition(), com.rti.dds.infrastructure.WaitSet.WaitSet.WaitSet(), com.rti.dds.infrastructure.WaitSet.WaitSet.WaitSet(WaitSetProperty_t), com.rti.ndds.config.Logger.get_instance, com.rti.ndds.config.Logger.get_output_device, com.rti.ndds.config.Logger.set_output_device, com.rti.ndds.utility.NetworkCapture.enable, or com.rti.ndds.utility.NetworkCapture.disable.

Exceptions

com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES

if a new com.rti.dds.infrastructure.GuardCondition could not be allocated.

Important: The com.rti.dds.infrastructure.GuardCondition allocates native resources. When com.rti.dds.infrastructure.GuardCondition is no longer being used, user should call com.rti.dds.infrastructure.GuardCondition.delete explicitly to properly cleanup all native resources.

Member Function Documentation

set_trigger_value()

void set_trigger_value

(

boolean

value

)

Set the guard condition trigger value.

Parameters

value

<<in>> the new trigger value.

get_trigger_value()

boolean get_trigger_value

(

)

Retrieve the trigger_value.

Returns

the trigger value.

Implements Condition.

delete()

void delete

(

)

Destructor.

Releases the resources associated with this object.

MT Safety:

UNSAFE. In VxWorks, it is unsafe to call this method while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipantFactory.get_instance, com.rti.dds.domain.DomainParticipantFactory.finalize_instance, com.rti.dds.typecode.TypeCodeFactory.get_instance, com.rti.dds.infrastructure.GuardCondition.GuardCondition.GuardCondition(), com.rti.dds.infrastructure.WaitSet.WaitSet.WaitSet(), com.rti.dds.infrastructure.WaitSet.WaitSet.WaitSet(WaitSetProperty_t), com.rti.dds.infrastructure.GuardCondition.delete, com.rti.dds.infrastructure.WaitSet.WaitSet.delete, com.rti.ndds.config.Logger.get_instance, com.rti.ndds.config.Logger.get_output_device, com.rti.ndds.config.Logger.set_output_device, com.rti.ndds.utility.NetworkCapture.enable, or com.rti.ndds.utility.NetworkCapture.disable.

Calling this method multiple times on the same object is safe; subsequent deletions will have no effect.

Referenced by GuardCondition.close().

close()

void close

(

)

See delete().

References GuardCondition.delete().