rti::core::policy::Event Class Reference

<<extension>> Configures the thread in a DomainParticipant that handles timed events. More...

#include <rti/core/policy/CorePolicy.hpp>

Public Member Functions
	Event ()
	Creates the default policy.
	Event (const rti::core::ThreadSettings &the_thread, int32_t the_initial_count, int32_t the_max_count)
	Creates an instance with all the parameters set.
Event &	thread (const rti::core::ThreadSettings &the_thread)
	Event thread QoS.
const rti::core::ThreadSettings &	thread () const
	Getter (see setter with the same name)
rti::core::ThreadSettings &	thread ()
	Getter (see setter with the same name)
Event &	initial_count (int32_t the_initial_count)
	The initial number of events.
int32_t	initial_count () const
	Getter (see setter with the same name)
Event &	max_count (int32_t the_max_count)
	The maximum number of events.
int32_t	max_count () const
	Getter (see setter with the same name)

Detailed Description

<<extension>> Configures the thread in a DomainParticipant that handles timed events.

In a dds::domain::DomainParticipant, a thread is dedicated to handle all timed events, including checking for timeouts and deadlines and executing internal and user-defined timeout or exception handling routines/callbacks.

This QoS policy allows you to configure thread properties such as priority level and stack size. You can also configure the maximum number of events that can be posted to the event thread. By default, a dds::domain::DomainParticipant will dynamically allocate memory as needed for events posted to the event thread. However, by setting a maximum value or setting the initial and maximum value to be the same, you can either bound the amount of memory allocated for the event thread or prevent a dds::domain::DomainParticipant from dynamically allocating memory for the event thread after initialization.

This QoS policy is an extension to the DDS standard.

Entity:

dds::domain::DomainParticipant

Properties:

RxO = N/A
Changeable = NO

Constructor & Destructor Documentation

rti::core::policy::Event::Event ( )

inline

Creates the default policy.

rti::core::policy::Event::Event	(	const rti::core::ThreadSettings &	the_thread,
		int32_t	the_initial_count,
		int32_t	the_max_count
	)

Creates an instance with all the parameters set.

Member Function Documentation

Event& rti::core::policy::Event::thread

(

const rti::core::ThreadSettings &

the_thread

)

Event thread QoS.

There is only one event thread.

Priority:
[default] The actual value depends on your architecture:
For Windows: -2
For Linux: OS default priority
For a complete list of platform specific values, please refer to Platform Notes.

Stack Size:
[default] The actual value depends on your architecture:
For Windows: OS default stack size
For Linux: OS default stack size
For a complete list of platform specific values, please refer to Platform Notes.

Mask:
[default] mask = rti::core::ThreadSettingsKindMask::floating_point() | rti::core::ThreadSettingsKindMask::stdio()

const rti::core::ThreadSettings& rti::core::policy::Event::thread

(

)

const

Getter (see setter with the same name)

rti::core::ThreadSettings& rti::core::policy::Event::thread

(

)

Getter (see setter with the same name)

Event& rti::core::policy::Event::initial_count

(

int32_t

the_initial_count

)

The initial number of events.

[default] 256

[range] [1, 1 million], <= max_count

int32_t rti::core::policy::Event::initial_count

(

)

const

Getter (see setter with the same name)

Event& rti::core::policy::Event::max_count

(

int32_t

the_max_count

)

The maximum number of events.

The maximum number of events. If the limit is reached, no new event can be added.

[default] dds::core::LENGTH_UNLIMITED

[range] [1, 1 million] or dds::core::LENGTH_UNLIMITED, >= initial_count

int32_t rti::core::policy::Event::max_count

(

)

const

Getter (see setter with the same name)