RTI Connext DDS Micro C++ API  Version 2.4.14.1
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
DDSGuardCondition Class Reference

<<interface>> <<cert>> A specific DDSCondition whose trigger_value is completely under the control of the application. More...

Inheritance diagram for DDSGuardCondition:
DDSCondition

List of all members.

Public Member Functions

DDS_ReturnCode_t set_trigger_value (bool value)
 <<cert>> Set the guard condition trigger value.

Detailed Description

<<interface>> <<cert>> A specific DDSCondition whose trigger_value is completely under the control of the application.

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

See also:
DDSWaitSet

Member Function Documentation

DDS_ReturnCode_t DDSGuardCondition::set_trigger_value ( bool  value)

<<cert>> Set the guard condition trigger value.

Parameters:
value<<in>> the new trigger value.
MT Safety:
This operation is thread safe. However, note that the arguments are not protected from being modified by other threads and must not be modified until the call returns.

RTI Connext DDS Micro C++ API Version 2.4.14.1 Copyright © Thu Nov 2 2023 Real-Time Innovations, Inc