RTI Connext C# API  6.1.2
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
 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

◆ Equals() [1/2]

override bool Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Equals ( ReceiverPool  other)

Compares for equality

◆ GetHashCode()

override int GetHashCode ( )

Gets the hash code

◆ With()

ReceiverPool With ( Action< ReceiverPoolBuilder build)

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

Parameters
buildAn 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

Member Data Documentation

◆ LengthAuto

const int LengthAuto
static

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

The full documentation is available in the C API: DDS_LENGTH_AUTO

Property Documentation

◆ BufferAlignment

int BufferAlignment
get

The receive buffer alignment.

The full documentation is available in the C API: DDS_ReceiverPoolQosPolicy::buffer_alignment

◆ BufferSize

int BufferSize
get

The receive buffer size.

The full documentation is available in the C API: DDS_ReceiverPoolQosPolicy::buffer_size

◆ Default

ReceiverPool Default
staticget

Singleton containing the default value of a ReceiverPool

◆ Thread

ThreadSettings Thread
get

Receiver pool thread(s).

The full documentation is available in the C API: DDS_ReceiverPoolQosPolicy::thread