A GuardCondition object is a specific Condition whose trigger_value is completely under the control of the application. More...

#include "GuardCondition.hpp"

Inheritance diagram for dds::core::cond::GuardCondition:

Public Member Functions
	GuardCondition ()

template<typename FUN >
	GuardCondition (FUN &functor)

template<typename FUN >
	GuardCondition (const FUN &functor)

void	dispatch ()

template<typename Functor >
void	handler (Functor &func)

template<typename Functor >
void	handler (const Functor &func)

bool	is_nil () const

template<typename R >
bool	operator!= (const R &ref) const

bool	operator!= (const null_type nil) const

DELEGATE *	operator-> ()

const DELEGATE *	operator-> () const

template<typename R >
bool	operator== (const R &ref) const

bool	operator== (const null_type) const

void	reset_handler ()

bool	trigger_value () const

void	trigger_value (bool value)

bool	trigger_value ()

Detailed Description

A GuardCondition object is a specific Condition whose trigger_value is completely under the control of the application.

When a GuardCondition is initially created, the trigger_value is FALSE.

The purpose of the GuardCondition is to provide the means for the application to manually triggering a WaitSet to stop waiting. This is accomplished by attaching the GuardCondition to the WaitSet and then setting the trigger_value by means of the set trigger_value operation.

dds::core::cond::GuardCondition guard;
dds::core::cond::WaitSet waitset;
waitset.attach_condition(guard);
waitset.wait();
...
// To wakeup waitset, do in another thread:
guard.trigger_value(true);

See the WaitSet examples for more examples.
Although the WaitSet examples use the StatusCondition, the basic usage of this Condition with a WaitSet is the same.

See also: dds::core::cond::Condition; WaitSet concept; WaitSet examples

Definition at line 67 of file GuardCondition.hpp.

Constructor & Destructor Documentation

◆ GuardCondition() [1/3]

dds::core::cond::GuardCondition::GuardCondition ( )

Create a dds::core::cond::GuardCondition.

The GuardCondition can then be added to a dds::core::cond::WaitSet so that the application can manually wake up a thread that is blocked on that WaitSet.

Exceptions

dds::core::Exception

Definition at line 44 of file GuardConditionImpl.hpp.

◆ GuardCondition() [2/3]

template<typename FUN >

dds::core::cond::GuardCondition::GuardCondition ( FUN & functor )

Create a dds::core::cond::GuardCondition.

The GuardCondition can then be added to a dds::core::cond::WaitSet so that the application can manually wake up a thread that is blocked on that WaitSet.

The supplied functor will be called when this GuardCondition is triggered and either the inherited dds::core::cond::Condition::dispatch() is called or the dds::core::cond::WaitSet::dispatch() on the WaitSet to which this GuardCondition is attached to.

Template Parameters

functor The functor to be called when the GuardCondition triggers.

Exceptions

dds::core::Exception

◆ GuardCondition() [3/3]

template<typename FUN >

dds::core::cond::GuardCondition::GuardCondition ( const FUN & functor )

Create a dds::core::cond::GuardCondition.

The GuardCondition can then be added to a dds::core::cond::WaitSet so that the application can manually wake up a thread that is blocked on that WaitSet.

The supplied functor will be called when this GuardCondition is triggered and either the inherited dds::core::cond::Condition::dispatch() is called or the dds::core::cond::WaitSet::dispatch() on the WaitSet to which this GuardCondition is attached to.

Template Parameters

functor The functor to be called when the GuardCondition triggers.

Exceptions

dds::core::Exception

Member Function Documentation

◆ dispatch()

void dds::core::cond::Condition::dispatch ( )

inherited

Dispatches the functor that have been registered with the Condition.

The Condition has to have been triggered for the functor will be called by this function.

Returns: void

Exceptions

dds::core::Exception

Definition at line 76 of file ConditionImpl.hpp.

◆ handler() [1/2]

template<typename Functor >

void dds::core::cond::Condition::handler ( Functor & func )

inherited

Registers a functor as custom handler with this Condition.

The supplied functor will be called when this Condition is triggered and either the dds::core::cond::Condition::dispatch() is called or the dds::core::cond::WaitSet::dispatch() on the WaitSet to which this Condition is attached to.

Template Parameters

Functor The functor to be called when the StatusCondition triggers.

Returns: void

Exceptions

dds::core::Exception

◆ handler() [2/2]

template<typename Functor >

void dds::core::cond::Condition::handler ( const Functor & func )

inherited

Registers a functor as custom handler with this Condition.

The supplied functor will be called when this Condition is triggered and either the dds::core::cond::Condition::dispatch() is called or the dds::core::cond::WaitSet::dispatch() on the WaitSet to which this Condition is attached to.

Template Parameters

Functor The functor to be called when the StatusCondition triggers.

Returns: void

Exceptions

dds::core::Exception

◆ is_nil()

template<typename DELEGATE >

bool dds::core::Reference< DELEGATE >::is_nil ( ) const

inherited

Check if the referenced object is nil.

In other words, check if the reference is pointing to a null object.

Returns: true if the referenced object is null.

Definition at line 143 of file ReferenceImpl.hpp.

◆ operator!=() [1/2]

template<typename DELEGATE >

template<typename R >

bool dds::core::Reference< DELEGATE >::operator!= ( const R & ref ) const

inherited

Compares two Reference objects and returns true if they are not equal.

Inequality is based on the referential inequality of the object being pointed to.

Parameters

ref	the other Reference object

Returns: true when not equal

Definition at line 100 of file ReferenceImpl.hpp.

◆ operator!=() [2/2]

template<typename DELEGATE >

bool dds::core::Reference< DELEGATE >::operator!= ( const null_type nil ) const

inherited

Special operator!= used to check if this reference object does not equal the dds::core::null reference.

The non-null-check can be done like this:

if (r != dds::core::null) {
   // Use the dds reference object r
}

Returns: true if this reference is not null.

Definition at line 157 of file ReferenceImpl.hpp.

◆ operator->() [1/2]

template<typename DELEGATE >

DELEGATE * dds::core::Reference< DELEGATE >::operator-> ( )

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Reference and on all its subclasses as follows:

my_dds_entity.standard_function();

my_dds_entity->vendor_specific_extension();

Returns: a reference to delegate.

Definition at line 180 of file ReferenceImpl.hpp.

◆ operator->() [2/2]

template<typename DELEGATE >

const DELEGATE * dds::core::Reference< DELEGATE >::operator-> ( ) const

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Reference and on all its subclasses as follows:

my_dds_entity.standard_function();

my_dds_entity->vendor_specific_extension();

Returns: a reference to delegate.

Definition at line 188 of file ReferenceImpl.hpp.

◆ operator==() [1/2]

template<typename DELEGATE >

template<typename R >

bool dds::core::Reference< DELEGATE >::operator== ( const R & ref ) const

inherited

Compares two Reference objects and returns true if they are equal.

Equality is based on the referential equality of the object being pointed.

Parameters

ref	the other Reference object

Returns: true when equal

Definition at line 83 of file ReferenceImpl.hpp.

◆ operator==() [2/2]

template<typename DELEGATE >

bool dds::core::Reference< DELEGATE >::operator== ( const null_type ) const

inherited

Special operator== used to check if this reference object equals the dds::core::null reference.

The null-check can be done like this:

if (r == dds::core::null) {
   // Do not use the dds reference object r in its current state
}

Returns: true if this reference is null.

Definition at line 150 of file ReferenceImpl.hpp.

◆ reset_handler()

void dds::core::cond::Condition::reset_handler ( )

inherited

Resets the handler for this Condition.

After the invocation of this function no handler will be registered with this Condition.

Returns: void

Exceptions

dds::core::Exception

Definition at line 69 of file ConditionImpl.hpp.

◆ trigger_value() [1/3]

bool dds::core::cond::Condition::trigger_value ( ) const

inherited

This operation retrieves the trigger_value of the Condition.

A Condition has a trigger_value that can be TRUE or FALSE and is set by the Data Distribution Service (except a GuardCondition). This operation returns the trigger_value of the Condition.

Returns: bool The boolean value to which the Condition is set.

Exceptions

dds::core::Exception

Definition at line 83 of file ConditionImpl.hpp.

◆ trigger_value() [2/3]

void dds::core::cond::GuardCondition::trigger_value ( bool value )

This operation sets the trigger_value of the GuardCondition.

A GuardCondition object is a specific Condition which trigger_value is completely under the control of the application. This operation must be used by the application to manually wake-up a WaitSet. This operation sets the trigger_value of the GuardCondition to the parameter value. The GuardCondition is directly created using the GuardCondition constructor. When a GuardCondition is initially created, the trigger_value is FALSE.

Parameters

value The boolean value to which the GuardCondition is set.

Exceptions

dds::core::Exception

Definition at line 81 of file GuardConditionImpl.hpp.

◆ trigger_value() [3/3]

bool dds::core::cond::GuardCondition::trigger_value ( )

This operation retrieves the trigger_value of the Condition.

A Condition has a trigger_value that can be TRUE or FALSE and is set by the Data Distribution Service (except a GuardCondition). This operation returns the trigger_value of the Condition.

Returns: bool The boolean value to which the Condition is set.

Exceptions

dds::core::Exception

Definition at line 88 of file GuardConditionImpl.hpp.

The documentation for this class was generated from the following files:

include/dcps/C++/isocpp2/dds/core/cond/GuardCondition.hpp
include/dcps/C++/isocpp2/dds/core/cond/detail/GuardConditionImpl.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GuardCondition() [1/3]

◆ GuardCondition() [2/3]

◆ GuardCondition() [3/3]

Member Function Documentation

◆ dispatch()

◆ handler() [1/2]

◆ handler() [2/2]

◆ is_nil()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ reset_handler()

◆ trigger_value() [1/3]

◆ trigger_value() [2/3]

◆ trigger_value() [3/3]