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
	Special value for MaxCount indicating no upper limit. More...

const int	Automatic
	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 `[get]`
	Singleton containing the default value of a AllocationSettings More...

Detailed Description

Configures the allocation policy of a resource.

Constructor & Destructor Documentation

◆ AllocationSettings()

AllocationSettings	(	int	initial = `Automatic`,
		int	max = `Automatic`,
		int	incremental = `Automatic`
	)

Creates a new AllocationSettings

Parameters

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

Member Function Documentation

◆ Equals() [1/2]

bool Equals ( AllocationSettings other )

Compares for equality.

◆ Equals() [2/2]

override bool Equals ( object other )

Compares for equality.

◆ GetHashCode()

override int GetHashCode ( )

Gets the hash code.

◆ With()

AllocationSettings With ( Action< AllocationSettingsBuilder > build )

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

Member Data Documentation

◆ Automatic

const int Automatic

static

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

◆ Unlimited

const int Unlimited

static

Special value for MaxCount indicating no upper limit.

Property Documentation

◆ Default

AllocationSettings Default

staticget

Singleton containing the default value of a AllocationSettings

◆ IncrementalCount

int IncrementalCount

get

The incremental count of resources.

The full documentation is available in the C API: DDS_AllocationSettings_t::incremental_count

◆ InitialCount

int InitialCount

get

The initial count of resources.

The full documentation is available in the C API: DDS_AllocationSettings_t::initial_count

◆ MaxCount

int MaxCount

get

The maximum count of resources.

The full documentation is available in the C API: DDS_AllocationSettings_t::max_count

Public Member Functions

Static Public Attributes

Properties