DDS::BatchQosPolicy Struct Reference

Used to configure batching of multiple samples into a single network packet in order to increase throughput for small samples. More...

#include <managed_infrastructure.h>

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

Public Attributes
System::Int32	max_data_bytes
	The maximum cumulative length of all serialized samples in a batch. More...
System::Int32	max_samples
	The maximum number of samples in a batch. More...
Duration_t	max_flush_delay
	The maximum flush delay. More...
Duration_t	source_timestamp_resolution
	Batch source timestamp resolution. More...

Properties
System::Boolean	enable [get, set]
	Specifies whether or not batching is enabled. More...
System::Boolean	thread_safe_write [get, set]
	Determines whether or not the write operation is thread safe. More...

Detailed Description

Used to configure batching of multiple samples into a single network packet in order to increase throughput for small samples.

This QoS policy configures the ability of the middleware to collect multiple user data samples to be sent in a single network packet, to take advantage of the efficiency of sending larger packets and thus increase effective throughput.

This QoS policy can be used to dramatically increase effective throughput for small data samples. Usually, throughput for small samples (size < 2048 bytes) is limited by CPU capacity and not by network bandwidth. Batching many smaller samples to be sent in a single large packet will increase network utilization, and thus throughput, in terms of samples per second.

Entity:

DDS::DataWriter

Properties:

RxO = NO
Changeable = UNTIL ENABLE

Member Data Documentation

max_data_bytes

System::Int32 DDS::BatchQosPolicy::max_data_bytes

The maximum cumulative length of all serialized samples in a batch.

A batch is flushed automatically when this maximum is reached.

max_data_bytes does not include the meta data associated with the batch samples. Each sample has at least 8 bytes of meta data containing information such as the timestamp and sequence number. The meta data can be as large as 52 bytes for keyed topics and 20 bytes for unkeyed topics.

Note: Batches must contain whole samples. If a new batch is started and its initial sample causes the serialized size to exceed max_data_bytes, RTI Connext will send the sample in a single batch.

[default] 1024

[range] [1,DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED]

Consistency

The setting of DDS::BatchQosPolicy::max_data_bytes must be consistent with DDS::BatchQosPolicy::max_samples. For these two values to be consistent, they cannot be both DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED.

max_samples

System::Int32 DDS::BatchQosPolicy::max_samples

The maximum number of samples in a batch.

A batch is flushed automatically when this maximum is reached.

[default] DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED

[range] [1,DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED]

Consistency

The setting of DDS::BatchQosPolicy::max_samples must be consistent with DDS::BatchQosPolicy::max_data_bytes. For these two values to be consistent, they cannot be both DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED.

max_flush_delay

Duration_t DDS::BatchQosPolicy::max_flush_delay

The maximum flush delay.

A batch is flushed automatically after the delay specified by this parameter.

The delay is measured from the time the first sample in the batch is written by the application.

[default] DDS::Duration_t::DURATION_INFINITE

[range] [0,DDS::Duration_t::DURATION_INFINITE]

Consistency

The setting of DDS::BatchQosPolicy::max_flush_delay must be consistent with DDS::AsynchronousPublisherQosPolicy::disable_asynchronous_batch and DDS::BatchQosPolicy::thread_safe_write. If the delay is different than DDS::Duration_t::DURATION_INFINITE, DDS::AsynchronousPublisherQosPolicy::disable_asynchronous_batch must be set to false and DDS::BatchQosPolicy::thread_safe_write must be set to true.

source_timestamp_resolution

Duration_t DDS::BatchQosPolicy::source_timestamp_resolution

Batch source timestamp resolution.

The value of this field determines how the source timestamp is associated with the samples in a batch.

A sample written with timestamp 't' inherits the source timestamp 't2' associated with the previous sample unless ('t' - 't2') > source_timestamp_resolution.

If source_timestamp_resolution is set to DDS::Duration_t::DURATION_INFINITE, every sample in the batch will share the source timestamp associated with the first sample.

If source_timestamp_resolution is set to zero, every sample in the batch will contain its own source timestamp corresponding to the moment when the sample was written.

The performance of the batching process is better when source_timestamp_resolution is set to DDS::Duration_t::DURATION_INFINITE.

[default] DDS::Duration_t::DURATION_INFINITE

[range] [0,DDS::Duration_t::DURATION_INFINITE]

Consistency

The setting of DDS::BatchQosPolicy::source_timestamp_resolution must be consistent with DDS::BatchQosPolicy::thread_safe_write. If DDS::BatchQosPolicy::thread_safe_write is set to false, DDS::BatchQosPolicy::source_timestamp_resolution must be set to DDS::Duration_t::DURATION_INFINITE.

Property Documentation

enable

System:: Boolean DDS::BatchQosPolicy::enable

getset

Specifies whether or not batching is enabled.

[default] false

thread_safe_write

System:: Boolean DDS::BatchQosPolicy::thread_safe_write

getset

Determines whether or not the write operation is thread safe.

If this parameter is set to true, multiple threads can call write on the DDS::DataWriter concurrently.

[default] true

Consistency

The setting of DDS::BatchQosPolicy::thread_safe_write must be consistent with DDS::BatchQosPolicy::source_timestamp_resolution. If DDS::BatchQosPolicy::thread_safe_write is set to false, DDS::BatchQosPolicy::source_timestamp_resolution must be set to DDS::Duration_t::DURATION_INFINITE.