Rti.Dds.Core.Policy.ReceiverPool Class Reference

Configures threads used by the middleware to receive and process data from transport (for example, UDP sockets). More...

Inherits IEquatable< ReceiverPool >.

Public Member Functions
ReceiverPool	With (Action< ReceiverPoolBuilder > build)
	Creates a new ReceiverPool 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 (ReceiverPool other)
	Compares for equality More...

Static Public Attributes
const int	LengthAuto = -2
	A special value indicating that the actual value of BufferSize will be automatically resolved. More...

Properties
ThreadSettings	Thread [get]
	Receiver pool thread(s). More...
int	BufferSize [get]
	The receive buffer size. More...
int	BufferAlignment [get]
	The receive buffer alignment. More...
static ReceiverPool	Default [get]
	Singleton containing the default value of a ReceiverPool More...

Detailed Description

Configures threads used by the middleware to receive and process data from transport (for example, UDP sockets).

Member Function Documentation

With()

ReceiverPool Rti.Dds.Core.Policy.ReceiverPool.With ( Action< ReceiverPoolBuilder >  build )

inline

Creates a new ReceiverPool 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 ReceiverPool.

Returns

A new ReceiverPool with the changes applied by the Action

GetHashCode()

override int Rti.Dds.Core.Policy.ReceiverPool.GetHashCode ( )

inline

Gets the hash code

Equals() [1/2]

override bool Rti.Dds.Core.Policy.ReceiverPool.Equals

(

object

other

)

Compares for equality

Equals() [2/2]

bool Rti.Dds.Core.Policy.ReceiverPool.Equals ( ReceiverPool  other )

inline

Compares for equality

Field Documentation

LengthAuto

const int Rti.Dds.Core.Policy.ReceiverPool.LengthAuto = -2

static

A special value indicating that the actual value of BufferSize will be automatically resolved.

The full documentation is available in the C API: DDSReceiverPoolQosPolicyLENGTH_AUTO

Property Documentation

Thread

ThreadSettings Rti.Dds.Core.Policy.ReceiverPool.Thread

get

Receiver pool thread(s).

The full documentation is available in the C API: DDS_ReceiverPoolQosPolicy_thread

BufferSize

int Rti.Dds.Core.Policy.ReceiverPool.BufferSize

get

The receive buffer size.

The full documentation is available in the C API: DDS_ReceiverPoolQosPolicy_buffer_size

BufferAlignment

int Rti.Dds.Core.Policy.ReceiverPool.BufferAlignment

get

The receive buffer alignment.

The full documentation is available in the C API: DDS_ReceiverPoolQosPolicy_buffer_alignment

Default

ReceiverPool Rti.Dds.Core.Policy.ReceiverPool.Default

staticget

Singleton containing the default value of a ReceiverPool