DDS::AsynchronousPublisherQosPolicy Class Reference

Configures the mechanism that sends user data in an external middleware thread. More...

#include <managed_infrastructure.h>

Static Public Member Functions
static System::String ^	get_asynchronouspublisher_qos_policy_name ()
	Stringified human-readable name for DDS::AsynchronousPublisherQosPolicy. More...

Public Attributes
ThreadSettings_t ^	thread
	Settings of the publishing thread. More...
ThreadSettings_t ^	asynchronous_batch_thread
	Settings of the batch flushing thread. More...
ThreadSettings_t ^	topic_query_publication_thread
	Settings of the DDS::TopicQuery publication thread. More...

Properties
System::Boolean	disable_asynchronous_write [get, set]
	Disable asynchronous publishing. More...
System::Boolean	disable_asynchronous_batch [get, set]
	Disable asynchronous batch flushing. More...
System::Boolean	disable_topic_query_publication [get, set]
	Disable topic query publication. More...

Detailed Description

Configures the mechanism that sends user data in an external middleware thread.

Specifies the asynchronous publishing and asynchronous batch flushing settings of the DDS::Publisher instances.

The QoS policy specifies whether asynchronous publishing and asynchronous batch flushing are enabled for the DDS::DataWriter entities belonging to this DDS::Publisher. If so, the publisher will spawn up to two threads, one for asynchronous publishing and one for asynchronous batch flushing.

This policy also configures the settings of the DDS::TopicQuery publication thread. The publisher will spawn this thread only if one or more DataWriters enable TopicQueries.

See also

DDS::BatchQosPolicy.

DDS::PublishModeQosPolicy.

Entity:

DDS::Publisher

Properties:

RxO = N/A

Changeable = NO

Usage

You can use this QoS policy to reduce the amount of time your application thread spends sending data.

You can also use it, along with DDS::PublishModeQosPolicy and a DDS::FlowController, to send large data reliably. "Large" in this context means that the data that cannot be sent as a single packet by a network transport. For example, to send data larger than 63K reliably using UDP/IP, you must configure RTI Connext to fragment the data and send it asynchronously.

The asynchronous publisher thread is shared by all DDS::PublishModeQosPolicyKind::ASYNCHRONOUS_PUBLISH_MODE_QOS DDS::DataWriter instances that belong to this publisher and handles their data transmission chores.

The asynchronous batch flushing thread is shared by all DDS::DataWriter instances with batching enabled that belong to this publisher.

This QoS policy also allows you to adjust the settings of the asynchronous publishing and the asynchronous batch flushing threads. To use different threads for two different DDS::DataWriter entities, the instances must belong to different DDS::Publisher instances.

A DDS::Publisher must have asynchronous publishing enabled for its DDS::DataWriter instances to write asynchronously.

A DDS::Publisher must have asynchronous batch flushing enabled in order to flush the batches of its DDS::DataWriter instances asynchronously. However, no asynchronous batch flushing thread will be started until the first DDS::DataWriter instance with batching enabled is created from this DDS::Publisher.

Member Data Documentation

thread

ThreadSettings_t ^ DDS::AsynchronousPublisherQosPolicy::thread

Settings of the publishing thread.

There is only one asynchronous publishing thread per DDS::Publisher.

[default] priority below normal.
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.

[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.

[default] mask = DDS::ThreadSettingsKind::THREAD_SETTINGS_KIND_MASK_DEFAULT

asynchronous_batch_thread

ThreadSettings_t ^ DDS::AsynchronousPublisherQosPolicy::asynchronous_batch_thread

Settings of the batch flushing thread.

There is only one asynchronous batch flushing thread per DDS::Publisher.

[default] priority below normal.
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. [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.

[default] mask = DDS::ThreadSettingsKind::THREAD_SETTINGS_KIND_MASK_DEFAULT

topic_query_publication_thread

ThreadSettings_t ^ DDS::AsynchronousPublisherQosPolicy::topic_query_publication_thread

Settings of the DDS::TopicQuery publication thread.

There is only one TopicQuery publication thread per DDS::Publisher. This thread will exist as long as one or more DDS::DataWriter enables TopicQueries (via DDS::DataWriterQos::topic_query_dispatch).

[default] priority below normal.
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. [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.

[default] mask = DDS::ThreadSettingsKind::THREAD_SETTINGS_KIND_MASK_DEFAULT

Property Documentation

disable_asynchronous_write

System:: Boolean DDS::AsynchronousPublisherQosPolicy::disable_asynchronous_write

getset

Disable asynchronous publishing.

If set to true, any DDS::DataWriter created with DDS::PublishModeQosPolicyKind::ASYNCHRONOUS_PUBLISH_MODE_QOS will fail with DDS::Retcode_InconsistentPolicy.

[default] false

disable_asynchronous_batch

System:: Boolean DDS::AsynchronousPublisherQosPolicy::disable_asynchronous_batch

getset

Disable asynchronous batch flushing.

If set to true, any DDS::DataWriter created with batching enabled will fail with DDS::Retcode_InconsistentPolicy.

If DDS::BatchQosPolicy::max_flush_delay is different than DDS::Duration_t::DURATION_INFINITE, DDS::AsynchronousPublisherQosPolicy::disable_asynchronous_batch must be set false.

[default] false

disable_topic_query_publication

System:: Boolean DDS::AsynchronousPublisherQosPolicy::disable_topic_query_publication

getset

Disable topic query publication.

If set to true, any DDS::DataWriter created with DDS::TopicQueryDispatchQosPolicy::enable set to true will fail with DDS::Retcode_InconsistentPolicy.

[default] false