Class GuardCondition

Defined in File GuardCondition.hpp

Inheritance Relationships

Base Type

public eprosima::fastdds::dds::Condition (Class Condition)

Class Documentation

class GuardCondition : public eprosima::fastdds::dds::Condition 

The GuardCondition class is a specific Condition whose trigger_value is completely under the control of the application.

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

Public Functions

RTPS_DllAPI GuardCondition()

RTPS_DllAPI ~GuardCondition()

virtual RTPS_DllAPI bool get_trigger_value () const override

Retrieves the trigger_value of the Condition.

Returns: true if trigger_value is set to ‘true’, ‘false’ otherwise

RTPS_DllAPI ReturnCode_t set_trigger_value (bool value)

Set the trigger_value.

Parameters: value – new value for trigger
Returns: RETURN_OK