Rti.Dds.Core.Policy.AllocationSettings Class Reference

Configures the allocation policy of a resource. More...

Inherits IEquatable< AllocationSettings >.

Public Member Functions
	AllocationSettings (int initial=Automatic, int max=Automatic, int incremental=Automatic)
	Creates a new AllocationSettings More...
AllocationSettings	With (Action< AllocationSettingsBuilder > build)
	Creates a new AllocationSettings with a set of changes specified in an Action More...
override bool	Equals (object other)
	Compares for equality. More...
override int	GetHashCode ()
	Gets the hash code. More...
bool	Equals (AllocationSettings other)
	Compares for equality. More...

Static Public Attributes
const int	Unlimited = LengthUnlimited.Value
	Special value for MaxCount indicating no upper limit. More...
const int	Automatic = -2
	Special value for InitialCount, MaxCount, or IncrementalCount indicating that the actual value will be automatically determined. More...

Properties
int	InitialCount [get]
	The initial count of resources. More...
int	MaxCount [get]
	The maximum count of resources. More...
int	IncrementalCount [get]
	The incremental count of resources. More...
static AllocationSettings	Default = new AllocationSettings() [get]
	Singleton containing the default value of a AllocationSettings More...

Detailed Description

Configures the allocation policy of a resource.

Constructor & Destructor Documentation

AllocationSettings()

Rti.Dds.Core.Policy.AllocationSettings.AllocationSettings ( int  initial = Automatic, int  max = Automatic, int  incremental = Automatic  )

inline

Creates a new AllocationSettings

Parameters

initial	The value for InitialCount
max	The value for MaxCount
incremental	The value for IncrementalCount

Member Function Documentation

With()

AllocationSettings Rti.Dds.Core.Policy.AllocationSettings.With ( Action< AllocationSettingsBuilder >  build )

inline

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

Parameters

build

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

Returns

A new AllocationSettings with the changes applied by the Action

Equals() [1/2]

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

(

object

other

)

Compares for equality.

GetHashCode()

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

inline

Gets the hash code.

Equals() [2/2]

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

inline

Compares for equality.

Field Documentation

Unlimited

const int Rti.Dds.Core.Policy.AllocationSettings.Unlimited = LengthUnlimited.Value

static

Special value for MaxCount indicating no upper limit.

Automatic

const int Rti.Dds.Core.Policy.AllocationSettings.Automatic = -2

static

Special value for InitialCount, MaxCount, or IncrementalCount indicating that the actual value will be automatically determined.

Property Documentation

InitialCount

int Rti.Dds.Core.Policy.AllocationSettings.InitialCount

get

The initial count of resources.

The full documentation is available in the C API: DDS_AllocationSettings_t_initial_count

MaxCount

int Rti.Dds.Core.Policy.AllocationSettings.MaxCount

get

The maximum count of resources.

The full documentation is available in the C API: DDS_AllocationSettings_t_max_count

IncrementalCount

int Rti.Dds.Core.Policy.AllocationSettings.IncrementalCount

get

The incremental count of resources.

The full documentation is available in the C API: DDS_AllocationSettings_t_incremental_count

Default

AllocationSettings Rti.Dds.Core.Policy.AllocationSettings.Default = new AllocationSettings()

staticget

Singleton containing the default value of a AllocationSettings