WaitSetProperty_t Class Reference

<<eXtension>> Specifies the com.rti.dds.infrastructure.WaitSet behavior for multiple trigger events. More...

Inherits Struct.

Public Attributes
int	max_event_count
	Maximum number of trigger events to cause a com.rti.dds.infrastructure.WaitSet to awaken.
final Duration_t	max_event_delay
	Maximum delay from occurrence of first trigger event to cause a com.rti.dds.infrastructure.WaitSet to awaken.

Additional Inherited Members
Public Member Functions inherited from Struct
abstract boolean	equals (Object obj)
abstract int	hashCode ()
String	toString ()
Protected Member Functions inherited from Struct
	Struct ()
abstract void	pull_from_nativeI (long native_status)
abstract void	push_to_nativeI (long native_status)

Detailed Description

<<eXtension>> Specifies the com.rti.dds.infrastructure.WaitSet behavior for multiple trigger events.

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

The com.rti.dds.infrastructure.WaitSetProperty_t allows configuration of the waiting behavior of a com.rti.dds.infrastructure.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 com.rti.dds.infrastructure.WaitSet.WaitSet.wait call continues to apply.

Entity:

com.rti.dds.infrastructure.WaitSet

Properties:

RxO = N/A

Changeable = YES

Member Data Documentation

int max_event_count

Maximum number of trigger events to cause a com.rti.dds.infrastructure.WaitSet to awaken.

The com.rti.dds.infrastructure.WaitSet will wait until up to max_event_count trigger events have occurred before returning. The com.rti.dds.infrastructure.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

final Duration_t max_event_delay

Maximum delay from occurrence of first trigger event to cause a com.rti.dds.infrastructure.WaitSet to awaken.

The com.rti.dds.infrastructure.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 com.rti.dds.infrastructure.WaitSet.

Note that com.rti.dds.infrastructure.RETCODE_TIMEOUT is not returned if max_event_delay is exceeded. com.rti.dds.infrastructure.RETCODE_TIMEOUT is returned only if the timeout duration expires before any trigger events occur.

[default] com.rti.dds.infrastructure.Duration_t.INFINITE