Batch Class Reference

Configures mechanism for collecting multiple data samples to be sent in a single network packet. More...

Inherits IEquatable< Batch >.

Public Member Functions
Batch	With (Action< BatchBuilder > build)
	Creates a new Batch with a set of changes specified in an Action More...
override int	GetHashCode ()
	Gets the hash code More...
override bool	Equals (object other)
	Compares for equality More...
bool	Equals (Batch other)
	Compares for equality More...

Properties
bool	Enable [get]
	Specifies whether or not batching is enabled. More...
int	MaxDataBytes [get]
	The maximum cumulative length of all serialized samples in a batch. More...
int	MaxSamples [get]
	The maximum number of samples in a batch. More...
Duration	MaxFlushDelay [get]
	The maximum flush delay. More...
Duration	SourceTimestampResolution [get]
	Batch source timestamp resolution. More...
bool	ThreadSafeWrite [get]
	Determines whether or not the write operation is thread safe. More...
static Batch	Default [get]
	Singleton containing the default value of a Batch More...

Detailed Description

Configures mechanism for collecting multiple data samples to be sent in a single network packet.

The full documentation is available in the C API: DDS_BatchQosPolicy

Member Function Documentation

Equals() [1/2]

bool Equals

(

Batch

other

)

Compares for equality

Equals() [2/2]

override bool Equals

(

object

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

With()

Batch With

(

Action< BatchBuilder >

build

)

Creates a new Batch with a set of changes specified in an Action

Parameters

build

An Action (typically a lambda function) that receives a modifiable object with the current values of this Batch.

Returns

A new Batch with the changes applied by the Action

Property Documentation

Default

Batch Default

staticget

Singleton containing the default value of a Batch

Enable

bool Enable

get

Specifies whether or not batching is enabled.

The full documentation is available in the C API: DDS_BatchQosPolicy::enable

MaxDataBytes

int MaxDataBytes

get

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

The full documentation is available in the C API: DDS_BatchQosPolicy::max_data_bytes

MaxFlushDelay

Duration MaxFlushDelay

get

The maximum flush delay.

The full documentation is available in the C API: DDS_BatchQosPolicy::max_flush_delay

MaxSamples

int MaxSamples

get

The maximum number of samples in a batch.

The full documentation is available in the C API: DDS_BatchQosPolicy::max_samples

SourceTimestampResolution

Duration SourceTimestampResolution

get

Batch source timestamp resolution.

The full documentation is available in the C API: DDS_BatchQosPolicy::source_timestamp_resolution

ThreadSafeWrite

bool ThreadSafeWrite

get

Determines whether or not the write operation is thread safe.

The full documentation is available in the C API: DDS_BatchQosPolicy::thread_safe_write