RTI Connext Traditional C++ API  Version 6.1.1

Specifies the DDSAsyncWaitSet behavior. More...

Public Attributes

struct DDS_WaitSetProperty_t waitset_property
 Specifies the behavior of the asynchronous wait behavior, which is equivalent to the wait mechanism of a DDSWaitSet. More...
 
DDS_UnsignedLong thread_pool_size
 Number of threads that conform the thread pool of the DDSAsyncWaitSet. More...
 
struct DDS_ThreadSettings_t thread_settings
 DDS_ThreadSettings_t for each thread conforming the thread pool of the DDSAsyncWaitSet. More...
 
char * thread_name_prefix
 Prefix used to composed the name of each thread that conforms the thread pool the DDSAsyncWaitSet. More...
 
struct DDS_Duration_t wait_timeout
 Asynchronous wait timeout. More...
 
DDS_Long level
 Specifies the level of an DDSAsyncWaitSet. More...
 

Detailed Description

Specifies the DDSAsyncWaitSet behavior.

This property allows configuring the behavior of the asynchronous wait and the DDSCondition dispatch, as well as the parameters of the thread pool.

See also
DDS_WaitSetProperty_t
DDS_ThreadSettings_t

Member Data Documentation

◆ waitset_property

struct DDS_WaitSetProperty_t DDS_AsyncWaitSetProperty_t::waitset_property

Specifies the behavior of the asynchronous wait behavior, which is equivalent to the wait mechanism of a DDSWaitSet.

See also
DDS_WaitSetProperty_t

◆ thread_pool_size

DDS_UnsignedLong DDS_AsyncWaitSetProperty_t::thread_pool_size

Number of threads that conform the thread pool of the DDSAsyncWaitSet.

Size must be equal or greater than one.

[default] 1

◆ thread_settings

struct DDS_ThreadSettings_t DDS_AsyncWaitSetProperty_t::thread_settings

DDS_ThreadSettings_t for each thread conforming the thread pool of the DDSAsyncWaitSet.

Each thread within the pool is created with the same settings.

[default] Default thread settings values.

See also
DDS_ThreadSettings_t

◆ thread_name_prefix

char* DDS_AsyncWaitSetProperty_t::thread_name_prefix

Prefix used to composed the name of each thread that conforms the thread pool the DDSAsyncWaitSet.

The composed name has the form:

thread_name_prefix##[index]AWs where [index] is an integer that identifies the thread relative to the DDSAsyncWaitSet.

If NULL, the default prefix will be used.

[default] NULL (use default prefix)

◆ wait_timeout

struct DDS_Duration_t DDS_AsyncWaitSetProperty_t::wait_timeout

Asynchronous wait timeout.

Specifies the maximum amount of time the leader thread of the DDSAsyncWaitSet waits for an attached DDSCondition to trigger before it wakes up.

Duration must be a value greater than zero.

See also
DDSWaitSet::wait

[default] DDS_DURATION_INFINITE

◆ level

DDS_Long DDS_AsyncWaitSetProperty_t::level

Specifies the level of an DDSAsyncWaitSet.

The level prevents an application to deadlock when it uses multiple DDSAsyncWaitSet instances that call operations on each other from the context of one of their thread pool's thread.

Inside the context of one of these threads, the application can synchronize only with other DDSAsyncWaitSet of bigger level.

[default] 1