RTI Connext C# API Version 7.3.0
Rti.Dds.Core.Policy.ResourceLimits Class Reference

Controls the amount of physical memory allocated for DDS entities, if dynamic allocations are allowed, and how they occur. Also controls memory usage among different instance values for keyed topics. More...

Inherits IEquatable< ResourceLimits >.

Public Member Functions

ResourceLimits With (Action< ResourceLimitsBuilder > build)
 Creates a new ResourceLimits 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 (ResourceLimits other)
 Compares for equality More...
 

Static Public Attributes

const int LengthUnlimited = -1
 Value that represents an unlimited length. More...
 

Properties

int MaxSamples [get]
 Represents the maximum samples the middleware can store for any one Publication.DataWriter<T> (or Subscription.DataReader<T>). More...
 
int MaxInstances [get]
 Represents the maximum number of instances a Publication.DataWriter<T> (or Subscription.DataReader<T>) can manage. More...
 
int MaxSamplesPerInstance [get]
 Represents the maximum number of samples of any one instance a Publication.DataWriter<T> (or Subscription.DataReader<T>) can manage. More...
 
int InitialSamples [get]
 Represents the initial samples the middleware will store for any one Publication.DataWriter<T> (or Subscription.DataReader<T>). More...
 
int InitialInstances [get]
 Represents the initial number of instances a Publication.DataWriter<T> (or Subscription.DataReader<T>) will manage. More...
 
int InstanceHashBuckets [get]
 Number of hash buckets for instances. More...
 
static ResourceLimits Default [get]
 Singleton containing the default value of a ResourceLimits More...
 

Detailed Description

Controls the amount of physical memory allocated for DDS entities, if dynamic allocations are allowed, and how they occur. Also controls memory usage among different instance values for keyed topics.

The full documentation is available in the C API: DDS_ResourceLimitsQosPolicy

Member Function Documentation

◆ With()

ResourceLimits Rti.Dds.Core.Policy.ResourceLimits.With ( Action< ResourceLimitsBuilder build)
inline

Creates a new ResourceLimits 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 ResourceLimits.
Returns
A new ResourceLimits with the changes applied by the Action

◆ GetHashCode()

override int Rti.Dds.Core.Policy.ResourceLimits.GetHashCode ( )
inline

Gets the hash code

◆ Equals() [1/2]

override bool Rti.Dds.Core.Policy.ResourceLimits.Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Rti.Dds.Core.Policy.ResourceLimits.Equals ( ResourceLimits  other)
inline

Compares for equality

Field Documentation

◆ LengthUnlimited

const int Rti.Dds.Core.Policy.ResourceLimits.LengthUnlimited = -1
static

Value that represents an unlimited length.

Property Documentation

◆ MaxSamples

int Rti.Dds.Core.Policy.ResourceLimits.MaxSamples
get

Represents the maximum samples the middleware can store for any one Publication.DataWriter<T> (or Subscription.DataReader<T>).

The full documentation is available in the C API: DDS_ResourceLimitsQosPolicy_max_samples

◆ MaxInstances

int Rti.Dds.Core.Policy.ResourceLimits.MaxInstances
get

Represents the maximum number of instances a Publication.DataWriter<T> (or Subscription.DataReader<T>) can manage.

The full documentation is available in the C API: DDS_ResourceLimitsQosPolicy_max_instances

◆ MaxSamplesPerInstance

int Rti.Dds.Core.Policy.ResourceLimits.MaxSamplesPerInstance
get

Represents the maximum number of samples of any one instance a Publication.DataWriter<T> (or Subscription.DataReader<T>) can manage.

The full documentation is available in the C API: DDS_ResourceLimitsQosPolicy_max_samples_per_instance

◆ InitialSamples

int Rti.Dds.Core.Policy.ResourceLimits.InitialSamples
get

Represents the initial samples the middleware will store for any one Publication.DataWriter<T> (or Subscription.DataReader<T>).

The full documentation is available in the C API: DDS_ResourceLimitsQosPolicy_initial_samples

◆ InitialInstances

int Rti.Dds.Core.Policy.ResourceLimits.InitialInstances
get

Represents the initial number of instances a Publication.DataWriter<T> (or Subscription.DataReader<T>) will manage.

The full documentation is available in the C API: DDS_ResourceLimitsQosPolicy_initial_instances

◆ InstanceHashBuckets

int Rti.Dds.Core.Policy.ResourceLimits.InstanceHashBuckets
get

Number of hash buckets for instances.

The full documentation is available in the C API: DDS_ResourceLimitsQosPolicy_instance_hash_buckets

◆ Default

ResourceLimits Rti.Dds.Core.Policy.ResourceLimits.Default
staticget

Singleton containing the default value of a ResourceLimits