RTI Connext Java API  Version 5.2.0
 All Classes Namespaces Functions Variables Groups Pages
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, and NativeCondition.

Public Member Functions

 GuardCondition ()
 No argument constructor.
 
void set_trigger_value (boolean value)
 Set the guard condition trigger value.
 
void delete ()
 Destructor.
 
- Public Member Functions inherited from AbstractNativeObject
final void check_aliveI ()
 
- Public Member Functions inherited from NativeObject
long get_native_pointer ()
 
void clear_native_pointer ()
 
boolean is_alive ()
 

Additional Inherited Members

- Static Public Member Functions inherited from AbstractNativeObject
static void check_for_zeroI (long native_pointer)
 
static final void check_aliveI (NativeObject obj)
 
static final boolean is_aliveI (NativeObject obj)
 
- Protected Member Functions inherited from AbstractNativeObject
void set_native_pointer (long native_pointer)
 
 AbstractNativeObject (long native_pointer)
 
final void check_for_null_argumentI (Object arg)
 

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: 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.

See Also
com.rti.dds.infrastructure.WaitSet

Constructor & Destructor Documentation

No argument constructor.

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

Exceptions
com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCESif 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

void set_trigger_value ( boolean  value)

Set the guard condition trigger value.

Parameters
value<<in>> the new trigger value.
void delete ( )

Destructor.

Releases the resources associated with this object.

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


RTI Connext Java API Version 5.2.0 Copyright © Sun Jun 21 2015 Real-Time Innovations, Inc