RTI Connext Modern C++ API  Version 5.3.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::core::cond::WaitSetProperty Class Reference

<<extension>> <<value-type>> Specifies the dds::core::cond::WaitSet behavior for multiple trigger events More...

#include <WaitSetImpl.hpp>

Inherits rti::core::NativeValueType< T, NATIVE_T, ADAPTER >.

Public Member Functions

 WaitSetProperty ()
 Creates the default WaitSetProperty.
 
 WaitSetProperty (int32_t the_max_event_count, const dds::core::Duration &the_max_event_delay)
 Creates a WaitSetProperty with the given parameters.
 
int32_t max_event_count () const
 Gets the max_event_count.
 
WaitSetPropertymax_event_count (int32_t value)
 Sets the maximum number of trigger events to cause a WaitSet to wake up.
 
dds::core::Duration max_event_delay () const
 Gets the max_event_delay.
 
WaitSetPropertymax_event_delay (const dds::core::Duration &value)
 Sets the maximum delay from occurrence of first trigger event to cause a WaitSet to wake up.
 

Detailed Description

<<extension>> <<value-type>> Specifies the dds::core::cond::WaitSet behavior for multiple trigger events

In simple use, a dds::core::cond::WaitSet returns when a single trigger event occurs on one of its attached dds::core::cond::Condition (s), or when the timeout maximum wait duration specified in the dds::core::cond::WaitSet::wait call expires.

The rti::core::cond::WaitSetProperty allows configuration of the waiting behavior of a dds::core::cond::WaitSet. If no conditions are true at the time of the call to wait, then the max_event_count parameter may be used to configure the WaitSet to wait for max_event_count trigger events to occur before returning, or to wait for up to max_event_delay time from the occurrence of the first trigger event before returning.

The timeout maximum wait duration specified in the dds::core::cond::WaitSet::wait call continues to apply.

Entity:
dds::core::cond::WaitSet
Properties:
RxO = N/A

Changeable = YES

Constructor & Destructor Documentation

rti::core::cond::WaitSetProperty::WaitSetProperty ( )

Creates the default WaitSetProperty.

rti::core::cond::WaitSetProperty::WaitSetProperty ( int32_t  the_max_event_count,
const dds::core::Duration the_max_event_delay 
)

Creates a WaitSetProperty with the given parameters.

Member Function Documentation

int32_t rti::core::cond::WaitSetProperty::max_event_count ( ) const

Gets the max_event_count.

See Also
max_event_count(int32_t)
WaitSetProperty& rti::core::cond::WaitSetProperty::max_event_count ( int32_t  value)

Sets the maximum number of trigger events to cause a WaitSet to wake up.

The dds::core::cond::WaitSet will wait until up to max_event_count trigger events have occurred before returning. The dds::core::cond::WaitSet may return earlier if either the timeout duration has expired, or max_event_delay has elapsed since the occurrence of the first trigger event. max_event_count may be used to "collect" multiple trigger events for processing at the same time.

[default] 1

[range] >= 1

dds::core::Duration rti::core::cond::WaitSetProperty::max_event_delay ( ) const

Gets the max_event_delay.

See Also
max_event_delay(const dds::core::Duration&)
WaitSetProperty& rti::core::cond::WaitSetProperty::max_event_delay ( const dds::core::Duration value)

Sets the maximum delay from occurrence of first trigger event to cause a WaitSet to wake up.

The dds::core::cond::WaitSet will return no later than max_event_delay after the first trigger event. max_event_delay may be used to establish a maximum latency for events reported by the dds::core::cond::WaitSet.

Note that dds::core::TimeoutError is not returned if max_event_delay is exceeded. dds::core::TimeoutError is returned only if the timeout duration expires before any trigger events occur.

[default] dds::core::Duration::infinite()


RTI Connext Modern C++ API Version 5.3.0 Copyright © Sun Jun 25 2017 Real-Time Innovations, Inc