RTI Connext .NET API (legacy)  Version 6.1.1
DDS::DataWriterResourceLimitsQosPolicy Struct Reference

Various settings that configure how a DDS::DataWriter allocates and uses physical memory for internal resources. More...

#include <managed_infrastructure.h>

Static Public Member Functions

static System::String ^ get_datawriterresourcelimits_qos_policy_name ()
 Stringified human-readable name for DDS::DataWriterResourceLimitsQosPolicy. More...
 

Public Attributes

System::Int32 initial_concurrent_blocking_threads
 The initial number of threads that are allowed to concurrently block on write call on the same DDS::DataWriter. More...
 
System::Int32 max_concurrent_blocking_threads
 The maximum number of threads that are allowed to concurrently block on write call on the same DDS::DataWriter. More...
 
System::Int32 max_remote_reader_filters
 The maximum number of remote DataReaders for which the DDS::DataWriter will perform content-based filtering. More...
 
System::Int32 initial_batches
 Represents the initial number of batches a DDS::DataWriter will manage. More...
 
System::Int32 max_batches
 Represents the maximum number of batches a DDS::DataWriter will manage. More...
 
DataWriterResourceLimitsInstanceReplacementKind instance_replacement
 Sets the kinds of instances allowed to be replaced when instance resource limits are reached. More...
 
System::Int32 initial_virtual_writers
 The initial number of virtual writers supported by a DDS::DataWriter. More...
 
System::Int32 max_virtual_writers
 The maximum number of virtual writers supported by a DDS::DataWriter. More...
 
System::Int32 max_remote_readers
 The maximum number of remote readers supported by a DDS::DataWriter. More...
 
System::Int32 max_app_ack_remote_readers
 The maximum number of application-level acknowledging remote readers supported by a DDS::DataWriter. More...
 
System::Int32 initial_active_topic_queries
 Represents the initial number of active topic queries a DDS::DataWriter will manage. More...
 
System::Int32 max_active_topic_queries
 Represents the maximum number of active topic queries a DDS::DataWriter will manage. More...
 

Properties

System::Boolean replace_empty_instances [get, set]
 Whether or not to replace empty instances during instance replacement. More...
 
System::Boolean autoregister_instances [get, set]
 Whether or not to automatically register new instances. More...
 

Detailed Description

Various settings that configure how a DDS::DataWriter allocates and uses physical memory for internal resources.

DataWriters must allocate internal structures to handle the simultaneously blocking of threads trying to call DDS::TypedDataWriter::write on the same DDS::DataWriter, for the storage used to batch small samples, and for content-based filters specified by DataReaders.

Most of these internal structures start at an initial size and, by default, will be grown as needed by dynamically allocating additional memory. You may set fixed, maximum sizes for these internal structures if you want to bound the amount of memory that can be used by a DDS::DataWriter. By setting the initial size to the maximum size, you will prevent RTI Connext from dynamically allocating any memory after the creation of the DDS::DataWriter.

This QoS policy is an extension to the DDS standard.

Entity:
DDS::DataWriter
Properties:
RxO = N/A
Changeable = NO

Member Data Documentation

◆ initial_concurrent_blocking_threads

System::Int32 DDS::DataWriterResourceLimitsQosPolicy::initial_concurrent_blocking_threads

The initial number of threads that are allowed to concurrently block on write call on the same DDS::DataWriter.

This value only applies if DDS::HistoryQosPolicy has its kind set to KEEP_ALL_HISTORY_QOS and DDS::ReliabilityQosPolicy::max_blocking_time is > 0.

[default] 1

[range] [1, 10000], <= max_concurrent_blocking_threads

◆ max_concurrent_blocking_threads

System::Int32 DDS::DataWriterResourceLimitsQosPolicy::max_concurrent_blocking_threads

The maximum number of threads that are allowed to concurrently block on write call on the same DDS::DataWriter.

This value only applies if DDS::HistoryQosPolicy has its kind set to KEEP_ALL_HISTORY_QOS and DDS::ReliabilityQosPolicy::max_blocking_time is > 0.

[default] DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED

[range] [1, 10000] or DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED, >= initial_concurrent_blocking_threads

◆ max_remote_reader_filters

System::Int32 DDS::DataWriterResourceLimitsQosPolicy::max_remote_reader_filters

The maximum number of remote DataReaders for which the DDS::DataWriter will perform content-based filtering.

[default] DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED

[range] [0, (2^31)-2] or DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED.

0: The DDS::DataWriter will not perform filtering for any DDS::DataReader.

1 to (2^31)-2: The DataWriter will filter for up to the specified number of DataReaders. In addition, the Datawriter will store the result of the filtering per sample per DataReader.

DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED: The DataWriter will filter for up to (2^31)-2 DataReaders. However, in this case, the DataWriter will not store the filtering result per sample per DataReader. Thus, if a sample is resent (such as due to a loss of reliable communication), the sample will be filtered again.

◆ initial_batches

System::Int32 DDS::DataWriterResourceLimitsQosPolicy::initial_batches

Represents the initial number of batches a DDS::DataWriter will manage.

[default] 8

[range] [1,100 million]

See also
DDS::BatchQosPolicy

◆ max_batches

System::Int32 DDS::DataWriterResourceLimitsQosPolicy::max_batches

Represents the maximum number of batches a DDS::DataWriter will manage.

[default] DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED

When batching is enabled, the maximum number of samples that a DDS::DataWriter can store is limited by this value and DDS::ResourceLimitsQosPolicy::max_samples.

[range] [1,100 million] or DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED >= DDS_RtpsReliableWriterProtocol_t::heartbeats_per_max_samples if batching is enabled

See also
DDS::BatchQosPolicy

◆ instance_replacement

DataWriterResourceLimitsInstanceReplacementKind DDS::DataWriterResourceLimitsQosPolicy::instance_replacement

Sets the kinds of instances allowed to be replaced when instance resource limits are reached.

When a DDS::DataWriter's number of active instances is greater than DDS::ResourceLimitsQosPolicy::max_instances, it will try to make room by replacing an existing instance. This field specifies the kinds of instances allowed to be replaced.

If a replaceable instance is not available, either an out-of-resources exception will be returned, or the writer may block if the instance reclamation was done when writing.

[default] DDS::DataWriterResourceLimitsInstanceReplacementKind::UNREGISTERED_INSTANCE_REPLACEMENT

See also
DDS::DataWriterResourceLimitsInstanceReplacementKind

◆ initial_virtual_writers

System::Int32 DDS::DataWriterResourceLimitsQosPolicy::initial_virtual_writers

The initial number of virtual writers supported by a DDS::DataWriter.

[default] 1

[range] [1, 1000000], or DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED

◆ max_virtual_writers

System::Int32 DDS::DataWriterResourceLimitsQosPolicy::max_virtual_writers

The maximum number of virtual writers supported by a DDS::DataWriter.

Sets the maximum number of unique virtual writers supported by a DDS::DataWriter, where virtual writers are added when samples are written with the virtual writer GUID.

This field is specially relevant in the configuration of Persistence Service DataWriters since these DataWriters will publish samples on behalf of multiple virtual writers.

[default] DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED

[range] [1, 1000000], or DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED

◆ max_remote_readers

System::Int32 DDS::DataWriterResourceLimitsQosPolicy::max_remote_readers

The maximum number of remote readers supported by a DDS::DataWriter.

[default] DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED

[range] [1, 1000000], or DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED

◆ max_app_ack_remote_readers

System::Int32 DDS::DataWriterResourceLimitsQosPolicy::max_app_ack_remote_readers

The maximum number of application-level acknowledging remote readers supported by a DDS::DataWriter.

[default] DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED

[range] [1, 1000000], or DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED

◆ initial_active_topic_queries

System::Int32 DDS::DataWriterResourceLimitsQosPolicy::initial_active_topic_queries

Represents the initial number of active topic queries a DDS::DataWriter will manage.

[default] 1

[range] [1, 1000000]

See also
DDS::TopicQueryDispatchQosPolicy

◆ max_active_topic_queries

System::Int32 DDS::DataWriterResourceLimitsQosPolicy::max_active_topic_queries

Represents the maximum number of active topic queries a DDS::DataWriter will manage.

When topic queries are enabled, the maximum number of topic queries that a DDS::DataWriter can publish data samples for at the same time is limited by this value.

When the DataWriter receives one topic query above this limit, it will wait to process it until it finishes publishing all the samples for at least one of the current topic queries.

[default] DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED

[range] [1, 1000000] or DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED

See also
DDS::TopicQueryDispatchQosPolicy

Property Documentation

◆ replace_empty_instances

System:: Boolean DDS::DataWriterResourceLimitsQosPolicy::replace_empty_instances
getset

Whether or not to replace empty instances during instance replacement.

When a DDS::DataWriter has more active instances than allowed by DDS::ResourceLimitsQosPolicy::max_instances, it tries to make room by replacing an existing instance. This field configures whether empty instances (i.e. instances with no samples) may be replaced. If set true, then a DDS::DataWriter will first try reclaiming empty instances, before trying to replace whatever is specified by DDS::DataWriterResourceLimitsQosPolicy::instance_replacement.

[default] false

See also
DDS::DataWriterResourceLimitsInstanceReplacementKind

◆ autoregister_instances

System:: Boolean DDS::DataWriterResourceLimitsQosPolicy::autoregister_instances
getset

Whether or not to automatically register new instances.

[default] false

When set to true, it is possible to write with a non-NIL handle of an instance that is not registered: the write operation will succeed and the instance will be registered. Otherwise, that write operation would fail.

See also
DDS::TypedDataWriter::write