BuiltinTopicReaderResourceLimits Class Reference

Built-in topic reader's resource limits. More...

Inherits IEquatable< BuiltinTopicReaderResourceLimits >.

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

Properties
int	InitialSamples [get]
	Initial number of samples. More...
int	MaxSamples [get]
	Maximum number of samples. More...
int	InitialInfos [get]
	Initial number of sample infos. More...
int	MaxInfos [get]
	Maximum number of sample infos. More...
int	InitialOutstandingReads [get]
	The initial number of outstanding reads that have not call finish yet on the same built-in topic Subscription.DataReader<T>. More...
int	MaxOutstandingReads [get]
	The maximum number of outstanding reads that have not called finish yet on the same built-in topic Subscription.DataReader<T>. More...
int	MaxSamplesPerRead [get]
	Maximum number of samples that can be read/taken on a same built-in topic Subscription.DataReader<T>. More...
bool	DisableFragmentationSupport [get]
	Determines whether the built-in topic Subscription.DataReader<T> can receive fragmented samples. More...
int	MaxFragmentedSamples [get]
	The maximum number of samples for which the built-in topic Subscription.DataReader<T> may store fragments at a given point in time. More...
int	InitialFragmentedSamples [get]
	The initial number of samples for which a built-in topic Subscription.DataReader<T> may store fragments. More...
int	MaxFragmentedSamplesPerRemoteWriter [get]
	The maximum number of samples per remote writer for which a built-in topic Subscription.DataReader<T> may store fragments. More...
int	MaxFragmentsPerSample [get]
	Maximum number of fragments for a single sample. More...
bool	DynamicallyAllocateFragmentedSamples [get]
	Determines whether the built-in topic Subscription.DataReader<T> pre-allocates storage for storing fragmented samples. More...
static BuiltinTopicReaderResourceLimits	Default [get]
	Singleton containing the default value of a BuiltinTopicReaderResourceLimits More...

Detailed Description

Built-in topic reader's resource limits.

The full documentation is available in the C API: DDS_BuiltinTopicReaderResourceLimits_t

Member Function Documentation

Equals() [1/2]

bool Equals

(

BuiltinTopicReaderResourceLimits

other

)

Compares for equality

Equals() [2/2]

override bool Equals

(

object

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

With()

BuiltinTopicReaderResourceLimits With

(

Action< BuiltinTopicReaderResourceLimitsBuilder >

build

)

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

Returns

A new BuiltinTopicReaderResourceLimits with the changes applied by the Action

Property Documentation

Default

BuiltinTopicReaderResourceLimits Default

staticget

Singleton containing the default value of a BuiltinTopicReaderResourceLimits

DisableFragmentationSupport

bool DisableFragmentationSupport

get

Determines whether the built-in topic Subscription.DataReader<T> can receive fragmented samples.

The full documentation is available in the C API: DDS_BuiltinTopicReaderResourceLimits_t::disable_fragmentation_support

DynamicallyAllocateFragmentedSamples

bool DynamicallyAllocateFragmentedSamples

get

Determines whether the built-in topic Subscription.DataReader<T> pre-allocates storage for storing fragmented samples.

The full documentation is available in the C API: DDS_BuiltinTopicReaderResourceLimits_t::dynamically_allocate_fragmented_samples

InitialFragmentedSamples

int InitialFragmentedSamples

get

The initial number of samples for which a built-in topic Subscription.DataReader<T> may store fragments.

The full documentation is available in the C API: DDS_BuiltinTopicReaderResourceLimits_t::initial_fragmented_samples

InitialInfos

int InitialInfos

get

Initial number of sample infos.

The full documentation is available in the C API: DDS_BuiltinTopicReaderResourceLimits_t::initial_infos

InitialOutstandingReads

int InitialOutstandingReads

get

The initial number of outstanding reads that have not call finish yet on the same built-in topic Subscription.DataReader<T>.

The full documentation is available in the C API: DDS_BuiltinTopicReaderResourceLimits_t::initial_outstanding_reads

InitialSamples

int InitialSamples

get

Initial number of samples.

The full documentation is available in the C API: DDS_BuiltinTopicReaderResourceLimits_t::initial_samples

MaxFragmentedSamples

int MaxFragmentedSamples

get

The maximum number of samples for which the built-in topic Subscription.DataReader<T> may store fragments at a given point in time.

The full documentation is available in the C API: DDS_BuiltinTopicReaderResourceLimits_t::max_fragmented_samples

MaxFragmentedSamplesPerRemoteWriter

int MaxFragmentedSamplesPerRemoteWriter

get

The maximum number of samples per remote writer for which a built-in topic Subscription.DataReader<T> may store fragments.

The full documentation is available in the C API: DDS_BuiltinTopicReaderResourceLimits_t::max_fragmented_samples_per_remote_writer

MaxFragmentsPerSample

int MaxFragmentsPerSample

get

Maximum number of fragments for a single sample.

The full documentation is available in the C API: DDS_BuiltinTopicReaderResourceLimits_t::max_fragments_per_sample

MaxInfos

int MaxInfos

get

Maximum number of sample infos.

The full documentation is available in the C API: DDS_BuiltinTopicReaderResourceLimits_t::max_infos

MaxOutstandingReads

int MaxOutstandingReads

get

The maximum number of outstanding reads that have not called finish yet on the same built-in topic Subscription.DataReader<T>.

The full documentation is available in the C API: DDS_BuiltinTopicReaderResourceLimits_t::max_outstanding_reads

MaxSamples

int MaxSamples

get

Maximum number of samples.

The full documentation is available in the C API: DDS_BuiltinTopicReaderResourceLimits_t::max_samples

MaxSamplesPerRead

int MaxSamplesPerRead

get

Maximum number of samples that can be read/taken on a same built-in topic Subscription.DataReader<T>.

The full documentation is available in the C API: DDS_BuiltinTopicReaderResourceLimits_t::max_samples_per_read