Index

Package: DDS.GuardCondition

Description

package DDS.GuardCondition is

Summary: <<interface>> A specific DDS.Condition whose trigger_value is completely under the control of the application.

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

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


See also: DDS.WaitSet

Classes

Ref 

type Ref is limited new Ada.Finalization.Limited_Controlled and DDS.Condition.Ref with private;

Ancestors:

Limited_Controlled

Primitive operations:

Get_Impl_ConditionI
Get_Trigger_Value (Inherited)
Get_Trigger_Value
Get_Trigger_Value (Inherited)
Set_Trigger_Value

Summary: No argument constructor.

Construct a new guard condition with trigger value DDS.BOOLEAN_FALSE.

MT Safety:
UNSAFE. In VxWorks, it is unsafe to call this procedure while another thread may be simultaneously calling DDS.DomainParticipantFactory.get_instance, DDS.DomainParticipantFactory.finalize_instance, DDS_TypeCodeFactory.get_instance, DDSGuardCondition::DDSGuardCondition, DDSWaitSet::DDSWaitSet(), DDSWaitSet::DDSWaitSet(const DDS_WaitSetProperty_t&), NDDSConfigLogger.get_instance, NDDSConfigLogger.get_output_device, NDDSConfigLogger.set_output_device, NDDSUtilityNetworkCapture.enable, or NDDSUtilityNetworkCapture.disable.

Raises: DDS.RETCODE_OUT_OF_RESOURCES if a new DDS.GuardCondition could not be allocated.

Important: The DDS.GuardCondition allocates native resources. When DDS.GuardCondition is no longer being used, user should call DDSGuardCondition::~DDSGuardCondition explicitly to properly cleanup all native resources.

Types

Ref_Access 

type Ref_Access is access all Ref'Class;

Subprograms & Entries

Initialize 

procedure Initialize 
(Self: in out Ref);

Adjust 

procedure Adjust 
(Self: in out Ref);

Finalize 

procedure Finalize 
(Self: in out Ref);

Set_Trigger_Value 

procedure Set_Trigger_Value 
(Self: access Ref;
Value: DDS.Boolean);

Summary: Set the guard condition trigger value.

self: <<in>> Cannot be NULL

value: <<in>> the new trigger value.

Get_Trigger_Value 

function Get_Trigger_Value 
(Self: access Ref) return DDS.Boolean;

Get_Impl_ConditionI 

function Get_Impl_ConditionI 
(Self: access Ref) return DDS.GuardCondition_Impl.Ref_Access;

Free 

procedure Free 
(This: in out Ref_Access);

Summary: Destructor

Releases the resources associated with this object.

MT Safety:
UNSAFE. In VxWorks, it is unsafe to call this procedure while another thread may be simultaneously calling DDS.DomainParticipantFactory.get_instance, DDS.DomainParticipantFactory.finalize_instance, DDS_TypeCodeFactory.get_instance, DDSGuardCondition::DDSGuardCondition, DDSWaitSet::DDSWaitSet(), DDSWaitSet::DDSWaitSet(const DDS_WaitSetProperty_t&), DDSGuardCondition::~DDSGuardCondition, DDSWaitSet::~DDSWaitSet(), NDDSConfigLogger.get_instance, NDDSConfigLogger.get_output_device, NDDSConfigLogger.set_output_device, Deleting a ull_value condition is safe and has no effect.

self: <<in>> Cannot be NULL

= 

function "=" 
(L: GuardCondition.Ref_Access;
R: Condition.Ref_Access) return Boolean;

= 

function "=" 
(L: Condition.Ref_Access;
R: GuardCondition.Ref_Access) return Boolean;