RTI Connext Modern C++ API  Version 5.3.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::core::policy::DomainParticipantResourceLimits Class Reference

<<extension>> Configures the memory usage of certain dds::domain::DomainParticipant resources More...

#include <rti/core/policy/CorePolicy.hpp>

Public Member Functions

DomainParticipantResourceLimitslocal_writer_allocation (const AllocationSettings &settings)
 Allocation settings applied to local DataWriters.
 
AllocationSettings local_writer_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitslocal_reader_allocation (const AllocationSettings &settings)
 Allocation settings applied to local DataReaders.
 
AllocationSettings local_reader_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitslocal_publisher_allocation (const AllocationSettings &settings)
 Allocation settings applied to local Publisher.
 
AllocationSettings local_publisher_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitslocal_subscriber_allocation (const AllocationSettings &settings)
 Allocation settings applied to local Subscriber.
 
DomainParticipantResourceLimitslocal_topic_allocation (const AllocationSettings &settings)
 Allocation settings applied to local Topic.
 
AllocationSettings local_topic_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsremote_writer_allocation (const AllocationSettings &settings)
 Allocation settings applied to remote DataWriters.
 
AllocationSettings remote_writer_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsremote_reader_allocation (const AllocationSettings &settings)
 Allocation settings applied to remote DataReaders.
 
AllocationSettings remote_reader_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsremote_participant_allocation (const AllocationSettings &settings)
 Allocation settings applied to remote DomainParticipants.
 
AllocationSettings remote_participant_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsmatching_writer_reader_pair_allocation (const AllocationSettings &settings)
 Allocation settings applied to matching local writer and remote/local reader pairs.
 
AllocationSettings matching_writer_reader_pair_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsmatching_reader_writer_pair_allocation (const AllocationSettings &settings)
 Allocation settings applied to matching local reader and remote/local writer pairs.
 
AllocationSettings matching_reader_writer_pair_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsignored_entity_allocation (const AllocationSettings &settings)
 Allocation settings applied to ignored entities.
 
AllocationSettings ignored_entity_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitscontent_filtered_topic_allocation (const AllocationSettings &settings)
 Allocation settings applied to content filtered topic.
 
AllocationSettings content_filtered_topic_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitscontent_filter_allocation (const AllocationSettings &settings)
 Allocation settings applied to content filter.
 
AllocationSettings content_filter_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsread_condition_allocation (const AllocationSettings &settings)
 Allocation settings applied to read condition pool.
 
AllocationSettings read_condition_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsquery_condition_allocation (const AllocationSettings &settings)
 Allocation settings applied to query condition pool.
 
AllocationSettings query_condition_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsoutstanding_asynchronous_sample_allocation (const AllocationSettings &settings)
 Allocation settings applied to the maximum number of samples (from all dds::pub::DataWriter) waiting to be asynchronously written.
 
AllocationSettings outstanding_asynchronous_sample_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsflow_controller_allocation (const AllocationSettings &settings)
 Allocation settings applied to flow controllers.
 
AllocationSettings flow_controller_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitslocal_writer_hash_buckets (int32_t hash_buckets)
 Hash_Buckets settings applied to local DataWriters.
 
int32_t local_writer_hash_buckets () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitslocal_reader_hash_buckets (int32_t hash_buckets)
 Number of hash buckets for local DataReaders.
 
int32_t local_reader_hash_buckets () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitslocal_publisher_hash_buckets (int32_t hash_buckets)
 Number of hash buckets for local Publisher.
 
int32_t local_publisher_hash_buckets () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitslocal_subscriber_hash_buckets (int32_t hash_buckets)
 Number of hash buckets for local Subscriber.
 
int32_t local_subscriber_hash_buckets () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitslocal_topic_hash_buckets (int32_t hash_buckets)
 Number of hash buckets for local Topic.
 
int32_t local_topic_hash_buckets () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsremote_writer_hash_buckets (int32_t hash_buckets)
 Number of hash buckets for remote DataWriters.
 
int32_t remote_writer_hash_buckets () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsremote_reader_hash_buckets (int32_t hash_buckets)
 Number of hash buckets for remote DataReaders.
 
int32_t remote_reader_hash_buckets () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsremote_participant_hash_buckets (int32_t hash_buckets)
 Number of hash buckets for remote DomainParticipants.
 
int32_t remote_participant_hash_buckets () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsmatching_writer_reader_pair_hash_buckets (int32_t hash_buckets)
 Number of hash buckets for matching local writer and remote/local reader pairs.
 
int32_t matching_writer_reader_pair_hash_buckets () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsmatching_reader_writer_pair_hash_buckets (int32_t hash_buckets)
 Number of hash buckets for matching local reader and remote/local writer pairs.
 
int32_t matching_reader_writer_pair_hash_buckets () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsignored_entity_hash_buckets (int32_t hash_buckets)
 Number of hash buckets for ignored entities.
 
int32_t ignored_entity_hash_buckets () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitscontent_filtered_topic_hash_buckets (int32_t hash_buckets)
 Number of hash buckets for content filtered topics.
 
int32_t content_filtered_topic_hash_buckets () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitscontent_filter_hash_buckets (int32_t hash_buckets)
 Number of hash buckets for content filters.
 
int32_t content_filter_hash_buckets () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsflow_controller_hash_buckets (int32_t hash_buckets)
 Number of hash buckets for flow controllers.
 
int32_t flow_controller_hash_buckets () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsmax_gather_destinations (int32_t max_destinations)
 Maximum number of destinations per RTI Connext send.
 
int32_t max_gather_destinations () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsparticipant_user_data_max_length (int32_t max_length)
 Maximum length of user data in dds::domain::qos::DomainParticipantQos and dds::topic::ParticipantBuiltinTopicData.
 
int32_t participant_user_data_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitstopic_data_max_length (int32_t max_length)
 Maximum length of topic data in dds::topic::qos::TopicQos, dds::topic::TopicBuiltinTopicData, dds::topic::PublicationBuiltinTopicData and dds::topic::SubscriptionBuiltinTopicData.
 
int32_t topic_data_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitspublisher_group_data_max_length (int32_t max_length)
 Maximum length of group data in dds::pub::qos::PublisherQos and dds::topic::PublicationBuiltinTopicData.
 
int32_t publisher_group_data_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitssubscriber_group_data_max_length (int32_t max_length)
 Maximum length of group data in dds::sub::qos::SubscriberQos and dds::topic::SubscriptionBuiltinTopicData.
 
int32_t subscriber_group_data_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitswriter_user_data_max_length (int32_t max_length)
 Maximum length of user data in dds::pub::qos::DataWriterQos and dds::topic::PublicationBuiltinTopicData.
 
int32_t writer_user_data_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsreader_user_data_max_length (int32_t max_length)
 Maximum length of user data in dds::sub::qos::DataReaderQos and dds::topic::SubscriptionBuiltinTopicData.
 
int32_t reader_user_data_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsmax_partitions (int32_t partitions)
 Maximum number of partition name strings allowable in a dds::core::policy::Partition.
 
int32_t max_partitions () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsmax_partition_cumulative_characters (int32_t max_characters)
 Maximum number of combined characters allowable in all partition names in a dds::core::policy::Partition.
 
DomainParticipantResourceLimitstype_code_max_serialized_length (int32_t max_length)
 Maximum size of serialized string for type code.
 
int32_t type_code_max_serialized_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitstype_object_max_serialized_length (int32_t max_length)
 The maximum length, in bytes, that the buffer to serialize a TypeObject can consume.
 
int32_t type_object_max_serialized_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitstype_object_max_deserialized_length (int32_t max_length)
 The maximum number of bytes that a deserialized TypeObject can consume.
 
int32_t type_object_max_deserialized_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsdeserialized_type_object_dynamic_allocation_threshold (int32_t threshold)
 A threshold, in bytes, for dynamic memory allocation for the deserialized TypeObject.
 
int32_t deserialized_type_object_dynamic_allocation_threshold () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitscontentfilter_property_max_length (int32_t max_length)
 This field is the maximum length of all data related to a Content-filtered topic.
 
int32_t contentfilter_property_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitschannel_seq_max_length (int32_t max_length)
 Maximum number of channels that can be specified in rti::core::policy::MultiChannel for MultiChannel DataWriters.
 
int32_t channel_seq_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitschannel_filter_expression_max_length (int32_t max_length)
 Maximum length of a channel rti::core::ChannelSettings::filter_expression in a MultiChannel DataWriter.
 
int32_t channel_filter_expression_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsparticipant_property_list_max_length (int32_t max_length)
 Maximum number of properties associated with the dds::domain::DomainParticipant.
 
int32_t participant_property_list_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsparticipant_property_string_max_length (int32_t max_length)
 Maximum string length of the properties associated with the dds::domain::DomainParticipant.
 
int32_t participant_property_string_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitswriter_property_list_max_length (int32_t max_length)
 Maximum number of properties associated with a dds::pub::DataWriter.
 
int32_t writer_property_list_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitswriter_property_string_max_length (int32_t max_length)
 Maximum string length of the properties associated with a dds::pub::DataWriter.
 
int32_t writer_property_string_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsreader_property_list_max_length (int32_t max_length)
 Maximum number of properties associated with a dds::sub::DataReader.
 
int32_t reader_property_list_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsreader_property_string_max_length (int32_t max_length)
 Maximum string length of the properties associated with a dds::sub::DataReader.
 
int32_t reader_property_string_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsmax_endpoint_groups (int32_t max_groups)
 Maximum number of rti::core::EndpointGroup allowable in a rti::core::policy::Availability.
 
int32_t max_endpoint_groups () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsmax_endpoint_group_cumulative_characters (int32_t max_cumulative_characters)
 Maximum number of combined role_name characters allowable in all rti::core::EndpointGroup in a rti::core::policy::Availability.
 
int32_t max_endpoint_group_cumulative_characters () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitstransport_info_list_max_length (int32_t max_length)
 Maximum number of installed transports to send and receive information about in dds::topic::ParticipantBuiltinTopicData::transport_info.
 
int32_t transport_info_list_max_length () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsignored_entity_replacement_kind (IgnoredEntityReplacementKind max_length)
 Replacement policy for the ignored entities. It sets what entity can be replaced when resource limits set in rti::core::policy::DomainParticipantResourceLimits::ignored_entity_allocation are reached.
 
IgnoredEntityReplacementKind ignored_entity_replacement_kind () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsremote_topic_query_allocation (const AllocationSettings &settings)
 Allocation settings applied to remote TopicQueries.
 
AllocationSettings remote_topic_query_allocation () const
 Getter (see setter with the same name)
 
DomainParticipantResourceLimitsremote_topic_query_hash_buckets (int32_t hash_buckets)
 Number of hash buckets for remote TopicQueries.
 
int32_t remote_topic_query_hash_buckets () const
 Getter (see setter with the same name)
 

Detailed Description

<<extension>> Configures the memory usage of certain dds::domain::DomainParticipant resources

This QoS policy sets maximum size limits on variable-length parameters used by the participant and its contained Entities. It also controls the initial and maximum sizes of data structures used by the participant to store information about locally-created and remotely-discovered entities (such as DataWriters/DataReaders), as well as parameters used by the internal database to size the hash tables it uses.

By default, a dds::domain::DomainParticipant is allowed to dynamically allocate memory as needed as users create local Entities such as dds::pub::DataWriter and dds::sub::DataReader or as the participant discovers new applications to store their information. By setting fixed values for the maximum parameters in this QosPolicy, you can bound the memory that can be allocated by a DomainParticipant. In addition, by setting the initial values to the maximum values, you can reduce the amount of memory allocated by DomainParticipants after the initialization period. Notice that memory can still be allocated dynamically after the initialization period. For example, when a new local dds::pub::DataWriter or dds::sub::DataReader is created, the initial memory required for its queue is allocated dynamically.

The maximum sizes of different variable-length parameters such as the number of partitions that can be stored in the dds::core::policy::Partition, the maximum length of data store in the dds::core::policy::UserData and dds::core::policy::GroupData, and many others can be changed from their defaults using this QoS policy. However, it is important that all DomainParticipants that need to communicate with each other use the same set of maximum values. Otherwise, when these parameters are propagated from one dds::domain::DomainParticipant to another, a dds::domain::DomainParticipant with a smaller maximum length may reject the parameter, resulting in an error.

An important parameter in this QoS policy that is often changed by users is rti::core::policy::DomainParticipantResourceLimits::type_code_max_serialized_length.

This QoS policy is an extension to the DDS standard.

Entity:
dds::domain::DomainParticipant
Properties:
RxO = N/A
Changeable = NO

Member Function Documentation

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::local_writer_allocation ( const AllocationSettings settings)

Allocation settings applied to local DataWriters.

[default] initial_count = 16; max_count = dds::core::LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::local_writer_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::local_reader_allocation ( const AllocationSettings settings)

Allocation settings applied to local DataReaders.

[default] initial_count = 16; max_count = dds::core::LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::local_reader_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::local_publisher_allocation ( const AllocationSettings settings)

Allocation settings applied to local Publisher.

[default] initial_count = 4; max_count = dds::core::LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::local_publisher_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::local_subscriber_allocation ( const AllocationSettings settings)

Allocation settings applied to local Subscriber.

[default] initial_count = 4; max_count = dds::core::LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::local_topic_allocation ( const AllocationSettings settings)

Allocation settings applied to local Topic.

[default] initial_count = 16; max_count = dds::core::LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::local_topic_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::remote_writer_allocation ( const AllocationSettings settings)

Allocation settings applied to remote DataWriters.

Remote DataWriters include all DataWriters, both local and remote.

[default] initial_count = 64; max_count = dds::core::LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::remote_writer_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::remote_reader_allocation ( const AllocationSettings settings)

Allocation settings applied to remote DataReaders.

Remote DataReaders include all DataReaders, both local and remote.

[default] initial_count = 64; max_count = dds::core::LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::remote_reader_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::remote_participant_allocation ( const AllocationSettings settings)

Allocation settings applied to remote DomainParticipants.

Remote DomainParticipants include all DomainParticipants, both local and remote.

[default] initial_count = 16; max_count = dds::core::LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::remote_participant_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::matching_writer_reader_pair_allocation ( const AllocationSettings settings)

Allocation settings applied to matching local writer and remote/local reader pairs.

[default] initial_count = 32; max_count = dds::core::LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::matching_writer_reader_pair_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::matching_reader_writer_pair_allocation ( const AllocationSettings settings)

Allocation settings applied to matching local reader and remote/local writer pairs.

[default] initial_count = 32; max_count = dds::core::LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::matching_reader_writer_pair_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::ignored_entity_allocation ( const AllocationSettings settings)

Allocation settings applied to ignored entities.

[default] initial_count = 8; max_count = dds::core::LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::ignored_entity_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::content_filtered_topic_allocation ( const AllocationSettings settings)

Allocation settings applied to content filtered topic.

[default] initial_count = 4; max_count = dds::core::LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::content_filtered_topic_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::content_filter_allocation ( const AllocationSettings settings)

Allocation settings applied to content filter.

[default] initial_count = 4; max_count = dds::core::LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::content_filter_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::read_condition_allocation ( const AllocationSettings settings)

Allocation settings applied to read condition pool.

[default] initial_count = 4; max_count = dds::core::LENGTH_UNLIMITED, incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::read_condition_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::query_condition_allocation ( const AllocationSettings settings)

Allocation settings applied to query condition pool.

[default] initial_count = 4; max_count = dds::core::LENGTH_UNLIMITED, incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::query_condition_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::outstanding_asynchronous_sample_allocation ( const AllocationSettings settings)

Allocation settings applied to the maximum number of samples (from all dds::pub::DataWriter) waiting to be asynchronously written.

[default] initial_count = 64; max_count = dds::core::LENGTH_UNLIMITED, incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::outstanding_asynchronous_sample_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::flow_controller_allocation ( const AllocationSettings settings)

Allocation settings applied to flow controllers.

[default] initial_count = 4; max_count = dds::core::LENGTH_UNLIMITED, incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::flow_controller_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::local_writer_hash_buckets ( int32_t  hash_buckets)

Hash_Buckets settings applied to local DataWriters.

[default] 4

[range] [1, 10000]

int32_t rti::core::policy::DomainParticipantResourceLimits::local_writer_hash_buckets ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::local_reader_hash_buckets ( int32_t  hash_buckets)

Number of hash buckets for local DataReaders.

[default] 4

[range] [1, 10000]

int32_t rti::core::policy::DomainParticipantResourceLimits::local_reader_hash_buckets ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::local_publisher_hash_buckets ( int32_t  hash_buckets)

Number of hash buckets for local Publisher.

[default] 1

[range] [1, 10000]

int32_t rti::core::policy::DomainParticipantResourceLimits::local_publisher_hash_buckets ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::local_subscriber_hash_buckets ( int32_t  hash_buckets)

Number of hash buckets for local Subscriber.

[default] 1

[range] [1, 10000]

int32_t rti::core::policy::DomainParticipantResourceLimits::local_subscriber_hash_buckets ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::local_topic_hash_buckets ( int32_t  hash_buckets)

Number of hash buckets for local Topic.

[default] 4

[range] [1, 10000]

int32_t rti::core::policy::DomainParticipantResourceLimits::local_topic_hash_buckets ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::remote_writer_hash_buckets ( int32_t  hash_buckets)

Number of hash buckets for remote DataWriters.

Remote DataWriters include all DataWriters, both local and remote.

[default] 16

[range] [1, 10000]

int32_t rti::core::policy::DomainParticipantResourceLimits::remote_writer_hash_buckets ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::remote_reader_hash_buckets ( int32_t  hash_buckets)

Number of hash buckets for remote DataReaders.

Remote DataReaders include all DataReaders, both local and remote.

[default] 16

[range] [1, 10000]

int32_t rti::core::policy::DomainParticipantResourceLimits::remote_reader_hash_buckets ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::remote_participant_hash_buckets ( int32_t  hash_buckets)

Number of hash buckets for remote DomainParticipants.

Remote DomainParticipants include all DomainParticipants, both local and remote.

[default] 4

[range] [1, 10000]

int32_t rti::core::policy::DomainParticipantResourceLimits::remote_participant_hash_buckets ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::matching_writer_reader_pair_hash_buckets ( int32_t  hash_buckets)

Number of hash buckets for matching local writer and remote/local reader pairs.

[default] 32

[range] [1, 10000]

int32_t rti::core::policy::DomainParticipantResourceLimits::matching_writer_reader_pair_hash_buckets ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::matching_reader_writer_pair_hash_buckets ( int32_t  hash_buckets)

Number of hash buckets for matching local reader and remote/local writer pairs.

[default] 32

[range] [1, 10000]

int32_t rti::core::policy::DomainParticipantResourceLimits::matching_reader_writer_pair_hash_buckets ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::ignored_entity_hash_buckets ( int32_t  hash_buckets)

Number of hash buckets for ignored entities.

[default] 1

[range] [1, 10000]

int32_t rti::core::policy::DomainParticipantResourceLimits::ignored_entity_hash_buckets ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::content_filtered_topic_hash_buckets ( int32_t  hash_buckets)

Number of hash buckets for content filtered topics.

[default] 1

[range] [1, 10000]

int32_t rti::core::policy::DomainParticipantResourceLimits::content_filtered_topic_hash_buckets ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::content_filter_hash_buckets ( int32_t  hash_buckets)

Number of hash buckets for content filters.

[default] 1

[range] [1, 10000]

int32_t rti::core::policy::DomainParticipantResourceLimits::content_filter_hash_buckets ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::flow_controller_hash_buckets ( int32_t  hash_buckets)

Number of hash buckets for flow controllers.

[default] 1

[range] [1, 10000]

int32_t rti::core::policy::DomainParticipantResourceLimits::flow_controller_hash_buckets ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::max_gather_destinations ( int32_t  max_destinations)

Maximum number of destinations per RTI Connext send.

When RTI Connext sends out a message, it has the capability to send to multiple destinations to be more efficient. The maximum number of destinations per RTI Connext send is specified by max_gather_destinations.

[default] 8

[range] [4, 1 million]

int32_t rti::core::policy::DomainParticipantResourceLimits::max_gather_destinations ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::participant_user_data_max_length ( int32_t  max_length)

Maximum length of user data in dds::domain::qos::DomainParticipantQos and dds::topic::ParticipantBuiltinTopicData.

[default] 256

[range] [0,0x7fffffff]

int32_t rti::core::policy::DomainParticipantResourceLimits::participant_user_data_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::topic_data_max_length ( int32_t  max_length)
int32_t rti::core::policy::DomainParticipantResourceLimits::topic_data_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::publisher_group_data_max_length ( int32_t  max_length)

Maximum length of group data in dds::pub::qos::PublisherQos and dds::topic::PublicationBuiltinTopicData.

[default] 256

[range] [0,0x7fffffff]

int32_t rti::core::policy::DomainParticipantResourceLimits::publisher_group_data_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::subscriber_group_data_max_length ( int32_t  max_length)

Maximum length of group data in dds::sub::qos::SubscriberQos and dds::topic::SubscriptionBuiltinTopicData.

[default] 256

[range] [0,0x7fffffff]

int32_t rti::core::policy::DomainParticipantResourceLimits::subscriber_group_data_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::writer_user_data_max_length ( int32_t  max_length)

Maximum length of user data in dds::pub::qos::DataWriterQos and dds::topic::PublicationBuiltinTopicData.

[default] 256

[range] [0,0x7fffffff]

int32_t rti::core::policy::DomainParticipantResourceLimits::writer_user_data_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::reader_user_data_max_length ( int32_t  max_length)

Maximum length of user data in dds::sub::qos::DataReaderQos and dds::topic::SubscriptionBuiltinTopicData.

[default] 256

[range] [0,0x7fffffff]

int32_t rti::core::policy::DomainParticipantResourceLimits::reader_user_data_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::max_partitions ( int32_t  partitions)

Maximum number of partition name strings allowable in a dds::core::policy::Partition.

This setting is made on a per DomainParticipant basis; it cannot be set individually on a per Publisher/Subscriber basis. However, the limit is enforced and applies per Publisher/Subscriber.

This value cannot exceed 64.

[default] 64

[range] [0,64]

int32_t rti::core::policy::DomainParticipantResourceLimits::max_partitions ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::max_partition_cumulative_characters ( int32_t  max_characters)

Maximum number of combined characters allowable in all partition names in a dds::core::policy::Partition.

The maximum number of combined characters should account for a terminating NULL ('\0') character for each partition name string.

This setting is made on a per DomainParticipant basis; it cannot be set individually on a per Publisher/Subscriber basis. However, the limit is enforced and applies per Publisher/Subscriber.

This value cannot exceed 256.

[default] 256

[range] [0,256]

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::type_code_max_serialized_length ( int32_t  max_length)

Maximum size of serialized string for type code.

This parameter limits the size of the type code that a dds::domain::DomainParticipant is able to store and propagate for user data types. Type codes can be used by external applications to understand user data types without having the data type predefined in compiled form. However, since type codes contain all of the information of a data structure, including the strings that define the names of the members of a structure, complex data structures can result in type codes larger than the default maximum of 2048 bytes. So it is common for users to set this parameter to a larger value. However, as with all parameters in this QoS policy defining maximum sizes for variable-length elements, all DomainParticipants in the same domain should use the same value for this parameter.

[default] 2048

[range] [0,0xffff]

int32_t rti::core::policy::DomainParticipantResourceLimits::type_code_max_serialized_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::type_object_max_serialized_length ( int32_t  max_length)

The maximum length, in bytes, that the buffer to serialize a TypeObject can consume.

This parameter limits the size of the TypeObject that a DomainParticipant is able to propagate. Since TypeObjects contain all of the information of a data structure, including the strings that define the names of the members of a structure, complex data structures can result in TypeObjects larger than the default maximum of 3072 bytes. This field allows you to specify a larger value. The desired size for a given TypeCode can be obtained using TypeCode::get_type_object_serialized_size.

[default] 3072

[range] [0,0x7fffffff]

int32_t rti::core::policy::DomainParticipantResourceLimits::type_object_max_serialized_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::type_object_max_deserialized_length ( int32_t  max_length)

The maximum number of bytes that a deserialized TypeObject can consume.

This parameter limits the size of the TypeObject that a DomainParticipant is able to store.

[default] dds::core::LENGTH_UNLIMITED

[range] [0,0x7fffffff] or dds::core::LENGTH_UNLIMITED

int32_t rti::core::policy::DomainParticipantResourceLimits::type_object_max_deserialized_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::deserialized_type_object_dynamic_allocation_threshold ( int32_t  threshold)

A threshold, in bytes, for dynamic memory allocation for the deserialized TypeObject.

Above this threshold, the memory for a TypeObject is allocated dynamically. Below it, the memory is obtained from a pool of fixed-size buffers. The size of the buffers is equal to this threshold.

[default] 4096

[range] [0,0x7fffffff] <= rti::core::policy::DomainParticipantResourceLimits::type_object_max_deserialized_length

int32_t rti::core::policy::DomainParticipantResourceLimits::deserialized_type_object_dynamic_allocation_threshold ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::contentfilter_property_max_length ( int32_t  max_length)

This field is the maximum length of all data related to a Content-filtered topic.

This is the sum of the length of the ContentFilteredTopic name, the length of the related topic name, the length of the filter expression, the length of the filter parameters, and the length of the filter name. The maximum number of combined characters should account for a terminating NULL ('\0') character for each string.

[default] 256

[range] [0,0xffff]

int32_t rti::core::policy::DomainParticipantResourceLimits::contentfilter_property_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::channel_seq_max_length ( int32_t  max_length)

Maximum number of channels that can be specified in rti::core::policy::MultiChannel for MultiChannel DataWriters.

[default] 32

[range] [0,0xffff]

int32_t rti::core::policy::DomainParticipantResourceLimits::channel_seq_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::channel_filter_expression_max_length ( int32_t  max_length)

Maximum length of a channel rti::core::ChannelSettings::filter_expression in a MultiChannel DataWriter.

The length should account for a terminating NULL ('\0') character.

[default] 256

[range] [0,0xffff]

int32_t rti::core::policy::DomainParticipantResourceLimits::channel_filter_expression_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::participant_property_list_max_length ( int32_t  max_length)

Maximum number of properties associated with the dds::domain::DomainParticipant.

[default] 32

[range] [0,0xffff]

int32_t rti::core::policy::DomainParticipantResourceLimits::participant_property_list_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::participant_property_string_max_length ( int32_t  max_length)

Maximum string length of the properties associated with the dds::domain::DomainParticipant.

The string length is defined as the cumulative length in bytes, including the null terminating characters, of all the pair (name,value) associated with the dds::domain::DomainParticipant properties.

[default] 2048

[range] [0,0xffff]

int32_t rti::core::policy::DomainParticipantResourceLimits::participant_property_string_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::writer_property_list_max_length ( int32_t  max_length)

Maximum number of properties associated with a dds::pub::DataWriter.

[range] [0,0xffff]

[default] 32

int32_t rti::core::policy::DomainParticipantResourceLimits::writer_property_list_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::writer_property_string_max_length ( int32_t  max_length)

Maximum string length of the properties associated with a dds::pub::DataWriter.

The string length is defined as the cumulative length in bytes, including the null terminating characters, of all the pair (name,value) associated with the dds::pub::DataWriter properties.

[default] 1024

[range] [0,0xffff]

int32_t rti::core::policy::DomainParticipantResourceLimits::writer_property_string_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::reader_property_list_max_length ( int32_t  max_length)

Maximum number of properties associated with a dds::sub::DataReader.

[default] 32

[range] [0,0xffff]

int32_t rti::core::policy::DomainParticipantResourceLimits::reader_property_list_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::reader_property_string_max_length ( int32_t  max_length)

Maximum string length of the properties associated with a dds::sub::DataReader.

The string length is defined as the cumulative length in bytes, including the null terminating characters, of all the pair (name,value) associated with a dds::sub::DataReader properties.

[default] 1024

[range] [0,0xffff]

int32_t rti::core::policy::DomainParticipantResourceLimits::reader_property_string_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::max_endpoint_groups ( int32_t  max_groups)

Maximum number of rti::core::EndpointGroup allowable in a rti::core::policy::Availability.

[default] 32

[range] [0,65535]

int32_t rti::core::policy::DomainParticipantResourceLimits::max_endpoint_groups ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::max_endpoint_group_cumulative_characters ( int32_t  max_cumulative_characters)

Maximum number of combined role_name characters allowable in all rti::core::EndpointGroup in a rti::core::policy::Availability.

The maximum number of combined characters should account for a terminating NULL character for each role_name string.

[default] 1024

[range] [0,65535]

int32_t rti::core::policy::DomainParticipantResourceLimits::max_endpoint_group_cumulative_characters ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::transport_info_list_max_length ( int32_t  max_length)

Maximum number of installed transports to send and receive information about in dds::topic::ParticipantBuiltinTopicData::transport_info.

[default] 6

[range] [0,100]

int32_t rti::core::policy::DomainParticipantResourceLimits::transport_info_list_max_length ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::ignored_entity_replacement_kind ( IgnoredEntityReplacementKind  max_length)

Replacement policy for the ignored entities. It sets what entity can be replaced when resource limits set in rti::core::policy::DomainParticipantResourceLimits::ignored_entity_allocation are reached.

When a dds::domain::DomainParticipant's number of ignored entities is greater than rti::core::policy::DomainParticipantResourceLimits::ignored_entity_allocation, it will try to make room by replacing an existing ignored participant entry. This field specifies what entity is allowed to be replaced.

If a replaceable participant entry is not available, an out-of-resources exception will be returned.

[default] DomainParticipantResourceLimitsIgnoredEntityReplacementKind::NO_REPLACEMENT_IGNORED_ENTITY_REPLACEMENT

See Also
DomainParticipantResourceLimitsIgnoredEntityReplacementKind
IgnoredEntityReplacementKind rti::core::policy::DomainParticipantResourceLimits::ignored_entity_replacement_kind ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::remote_topic_query_allocation ( const AllocationSettings settings)

Allocation settings applied to remote TopicQueries.

Settings applied to the allocation of information about rti::sub::TopicQuery objects created by other participants and discovered by this participant.

When the participant receives a new topic query that would make the current count go above max_count, it is not processed until the current count drops (i.e. another topic query is cancelled). The topic query stays in the Built-in ServiceRequest DataReader queue until it can be processed or it is cancelled.

[default] initial_count = 1; max_count = dds::core::LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct rti::core::AllocationSettings

AllocationSettings rti::core::policy::DomainParticipantResourceLimits::remote_topic_query_allocation ( ) const

Getter (see setter with the same name)

DomainParticipantResourceLimits& rti::core::policy::DomainParticipantResourceLimits::remote_topic_query_hash_buckets ( int32_t  hash_buckets)

Number of hash buckets for remote TopicQueries.

[default] 1

[range] [1, 10000]

See Also
rti::core::policy::DomainParticipantResourceLimits::remote_topic_query_allocation
int32_t rti::core::policy::DomainParticipantResourceLimits::remote_topic_query_hash_buckets ( ) const

Getter (see setter with the same name)


RTI Connext Modern C++ API Version 5.3.0 Copyright © Sun Jun 25 2017 Real-Time Innovations, Inc