RTI Connext C# API  6.1.1
DataReaderResourceLimitsBuilder Class Reference

A modifiable type used to create an immutable DataReaderResourceLimits More...

Public Member Functions

 DataReaderResourceLimitsBuilder (DataReaderResourceLimits data)
 Creates a builder with the values of an existing immutable instance More...
 
DataReaderResourceLimits Build ()
 Creates a new DataReaderResourceLimits immutable object from this one. More...
 

Properties

int MaxRemoteWriters [get, set]
 The maximum number of remote writers from which a DataReader<T> may read, including all instances. More...
 
int MaxRemoteWritersPerInstance [get, set]
 The maximum number of remote writers from which a DataReader<T> may read a single instance. More...
 
int MaxSamplesPerRemoteWriter [get, set]
 The maximum number of out-of-order samples from a given remote Publication.DataWriter<T> that a DataReader<T> may store when maintaining a reliable connection to the Publication.DataWriter<T>. More...
 
int MaxInfos [get, set]
 The maximum number of info units that a DataReader<T> can use to store SampleInfo. More...
 
int InitialRemoteWriters [get, set]
 The initial number of remote writers from which a DataReader<T> may read, including all instances. More...
 
int InitialRemoteWritersPerInstance [get, set]
 The initial number of remote writers from which a DataReader<T> may read a single instance. More...
 
int InitialInfos [get, set]
 The initial number of info units that a DataReader<T> can have, which are used to store SampleInfo. More...
 
int InitialOutstandingReads [get, set]
 The initial number of outstanding calls to read/take (or one of their variants) on the same DataReader<T> for which one or more LoanedSamples<T> objects have not been disposed. More...
 
int MaxOutstandingReads [get, set]
 The maximum number of outstanding read/take calls (or one of their variants) on the same DataReader<T> for which one or more LoanedSamples<T> objects have not been disposed. More...
 
int MaxSamplesPerRead [get, set]
 The maximum number of data samples that the application can receive from the middleware in a single call to DataReader<T>.Read or DataReader<T>.Take. If more data exists in the middleware, the application will need to issue multiple read/take calls. More...
 
bool DisableFragmentationSupport [get, set]
 Determines whether the DataReader<T> can receive fragmented samples. More...
 
int MaxFragmentedSamples [get, set]
 The maximum number of samples for which the DataReader<T> may store fragments at a given point in time. More...
 
int InitialFragmentedSamples [get, set]
 The initial number of samples for which a DataReader<T> may store fragments. More...
 
int MaxFragmentedSamplesPerRemoteWriter [get, set]
 The maximum number of samples per remote writer for which a DataReader<T> may store fragments. More...
 
int MaxFragmentsPerSample [get, set]
 Maximum number of fragments for a single sample. More...
 
bool DynamicallyAllocateFragmentedSamples [get, set]
 Determines whether the DataReader<T> pre-allocates storage for storing fragmented samples. More...
 
int MaxTotalInstances [get, set]
 Maximum number of instances for which a DataReader will keep state. More...
 
int MaxRemoteVirtualWriters [get, set]
 The maximum number of remote virtual writers from which a DataReader<T> may read, including all instances. More...
 
int InitialRemoteVirtualWriters [get, set]
 The initial number of remote virtual writers from which a DataReader<T> may read, including all instances. More...
 
int MaxRemoteVirtualWritersPerInstance [get, set]
 The maximum number of virtual remote writers that can be associated with an instance. More...
 
int InitialRemoteVirtualWritersPerInstance [get, set]
 The initial number of virtual remote writers per instance. More...
 
int MaxRemoteWritersPerSample [get, set]
 The maximum number of remote writers allowed to write the same sample. More...
 
int MaxQueryConditionFilters [get, set]
 The maximum number of query condition filters a reader is allowed. More...
 
int MaxAppAckResponseLength [get, set]
 Maximum length of application-level acknowledgment response data More...
 
bool KeepMinimumStateForInstances [get, set]
 Whether or not keep a minimum instance state for up to DataReaderResourceLimits.MaxTotalInstances. More...
 
int InitialTopicQueries [get, set]
 The initial number of TopicQueries allocated by a DataReader<T>. More...
 
int MaxTopicQueries [get, set]
 The maximum number of active TopicQueries that a DataReader<T> can create. More...
 
AllocationSettings ShmemRefTransferModeAttachedSegmentAllocation [get, set]
 Allocation resource for the shared memory segments attached by the DataReader<T>. More...
 
InstanceReplacementSettings InstanceReplacement [get, set]
 Sets the kind of instances allowed to be replaced for each instance state (Omg.Dds.Subscription.InstanceState) when a DataReader reaches ResourceLimits.MaxInstances. More...
 

Detailed Description

A modifiable type used to create an immutable DataReaderResourceLimits

Constructor & Destructor Documentation

◆ DataReaderResourceLimitsBuilder()

Creates a builder with the values of an existing immutable instance

Member Function Documentation

◆ Build()

Creates a new DataReaderResourceLimits immutable object from this one.

Property Documentation

◆ DisableFragmentationSupport

bool DisableFragmentationSupport
getset

Determines whether the DataReader<T> can receive fragmented samples.

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

◆ DynamicallyAllocateFragmentedSamples

bool DynamicallyAllocateFragmentedSamples
getset

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

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

◆ InitialFragmentedSamples

int InitialFragmentedSamples
getset

The initial number of samples for which a DataReader<T> may store fragments.

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

◆ InitialInfos

int InitialInfos
getset

The initial number of info units that a DataReader<T> can have, which are used to store SampleInfo.

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

◆ InitialOutstandingReads

int InitialOutstandingReads
getset

The initial number of outstanding calls to read/take (or one of their variants) on the same DataReader<T> for which one or more LoanedSamples<T> objects have not been disposed.

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

◆ InitialRemoteVirtualWriters

int InitialRemoteVirtualWriters
getset

The initial number of remote virtual writers from which a DataReader<T> may read, including all instances.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::initial_remote_virtual_writers

◆ InitialRemoteVirtualWritersPerInstance

int InitialRemoteVirtualWritersPerInstance
getset

The initial number of virtual remote writers per instance.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::initial_remote_virtual_writers_per_instance

◆ InitialRemoteWriters

int InitialRemoteWriters
getset

The initial number of remote writers from which a DataReader<T> may read, including all instances.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::initial_remote_writers

◆ InitialRemoteWritersPerInstance

int InitialRemoteWritersPerInstance
getset

The initial number of remote writers from which a DataReader<T> may read a single instance.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::initial_remote_writers_per_instance

◆ InitialTopicQueries

int InitialTopicQueries
getset

The initial number of TopicQueries allocated by a DataReader<T>.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::initial_topic_queries

◆ InstanceReplacement

InstanceReplacementSettings InstanceReplacement
getset

Sets the kind of instances allowed to be replaced for each instance state (Omg.Dds.Subscription.InstanceState) when a DataReader reaches ResourceLimits.MaxInstances.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::instance_replacement

◆ KeepMinimumStateForInstances

bool KeepMinimumStateForInstances
getset

Whether or not keep a minimum instance state for up to DataReaderResourceLimits.MaxTotalInstances.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::keep_minimum_state_for_instances

◆ MaxAppAckResponseLength

int MaxAppAckResponseLength
getset

Maximum length of application-level acknowledgment response data

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::max_app_ack_response_length

◆ MaxFragmentedSamples

int MaxFragmentedSamples
getset

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

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

◆ MaxFragmentedSamplesPerRemoteWriter

int MaxFragmentedSamplesPerRemoteWriter
getset

The maximum number of samples per remote writer for which a DataReader<T> may store fragments.

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

◆ MaxFragmentsPerSample

int MaxFragmentsPerSample
getset

Maximum number of fragments for a single sample.

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

◆ MaxInfos

int MaxInfos
getset

The maximum number of info units that a DataReader<T> can use to store SampleInfo.

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

◆ MaxOutstandingReads

int MaxOutstandingReads
getset

The maximum number of outstanding read/take calls (or one of their variants) on the same DataReader<T> for which one or more LoanedSamples<T> objects have not been disposed.

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

◆ MaxQueryConditionFilters

int MaxQueryConditionFilters
getset

The maximum number of query condition filters a reader is allowed.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::max_query_condition_filters

◆ MaxRemoteVirtualWriters

int MaxRemoteVirtualWriters
getset

The maximum number of remote virtual writers from which a DataReader<T> may read, including all instances.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::max_remote_virtual_writers

◆ MaxRemoteVirtualWritersPerInstance

int MaxRemoteVirtualWritersPerInstance
getset

The maximum number of virtual remote writers that can be associated with an instance.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::max_remote_virtual_writers_per_instance

◆ MaxRemoteWriters

int MaxRemoteWriters
getset

The maximum number of remote writers from which a DataReader<T> may read, including all instances.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::max_remote_writers

◆ MaxRemoteWritersPerInstance

int MaxRemoteWritersPerInstance
getset

The maximum number of remote writers from which a DataReader<T> may read a single instance.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::max_remote_writers_per_instance

◆ MaxRemoteWritersPerSample

int MaxRemoteWritersPerSample
getset

The maximum number of remote writers allowed to write the same sample.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::max_remote_writers_per_sample

◆ MaxSamplesPerRead

int MaxSamplesPerRead
getset

The maximum number of data samples that the application can receive from the middleware in a single call to DataReader<T>.Read or DataReader<T>.Take. If more data exists in the middleware, the application will need to issue multiple read/take calls.

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

◆ MaxSamplesPerRemoteWriter

int MaxSamplesPerRemoteWriter
getset

The maximum number of out-of-order samples from a given remote Publication.DataWriter<T> that a DataReader<T> may store when maintaining a reliable connection to the Publication.DataWriter<T>.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::max_samples_per_remote_writer

◆ MaxTopicQueries

int MaxTopicQueries
getset

The maximum number of active TopicQueries that a DataReader<T> can create.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::max_topic_queries

◆ MaxTotalInstances

int MaxTotalInstances
getset

Maximum number of instances for which a DataReader will keep state.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::max_total_instances

◆ ShmemRefTransferModeAttachedSegmentAllocation

AllocationSettings ShmemRefTransferModeAttachedSegmentAllocation
getset

Allocation resource for the shared memory segments attached by the DataReader<T>.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsQosPolicy::shmem_ref_transfer_mode_attached_segment_allocation