Various settings that configure how a com.rti.dds.domain.DomainParticipant allocates and uses physical memory for internal resources, including the maximum sizes of various properties. More...

Inheritance diagram for DomainParticipantResourceLimitsQosPolicy:

Public Attributes
final AllocationSettings_t	local_writer_allocation
	Allocation settings applied to local DataWriters.

final AllocationSettings_t	local_reader_allocation
	Allocation settings applied to local DataReaders.

final AllocationSettings_t	local_publisher_allocation
	Allocation settings applied to local Publisher.

final AllocationSettings_t	local_subscriber_allocation
	Allocation settings applied to local Subscriber.

final AllocationSettings_t	local_topic_allocation
	Allocation settings applied to local Topic.

final AllocationSettings_t	remote_writer_allocation
	Allocation settings applied to remote DataWriters.

final AllocationSettings_t	remote_reader_allocation
	Allocation settings applied to remote DataReaders.

final AllocationSettings_t	remote_participant_allocation
	Allocation settings applied to remote DomainParticipants.

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

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

final AllocationSettings_t	ignored_entity_allocation
	Allocation settings applied to ignored entities.

final AllocationSettings_t	content_filtered_topic_allocation
	Allocation settings applied to content filtered topic.

final AllocationSettings_t	content_filter_allocation
	Allocation settings applied to content filter.

final AllocationSettings_t	read_condition_allocation
	Allocation settings applied to read condition pool.

final AllocationSettings_t	query_condition_allocation
	Allocation settings applied to query condition pool.

final AllocationSettings_t	outstanding_asynchronous_sample_allocation
	Allocation settings applied to the maximum number of samples (from all com.rti.dds.publication.DataWriter) waiting to be asynchronously written.

final AllocationSettings_t	flow_controller_allocation
	Allocation settings applied to flow controllers.

int	local_writer_hash_buckets
	Hash_Buckets settings applied to local DataWriters.

int	local_reader_hash_buckets
	Number of hash buckets for local DataReaders.

int	local_publisher_hash_buckets
	Number of hash buckets for local Publisher.

int	local_subscriber_hash_buckets
	Number of hash buckets for local Subscriber.

int	local_topic_hash_buckets
	Number of hash buckets for local Topic.

int	remote_writer_hash_buckets
	Number of hash buckets for remote DataWriters.

int	remote_reader_hash_buckets
	Number of hash buckets for remote DataReaders.

int	remote_participant_hash_buckets
	Number of hash buckets for remote DomainParticipants.

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

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

int	ignored_entity_hash_buckets
	Number of hash buckets for ignored entities.

int	content_filtered_topic_hash_buckets
	Number of hash buckets for content filtered topics.

int	content_filter_hash_buckets
	Number of hash buckets for content filters.

int	flow_controller_hash_buckets
	Number of hash buckets for flow controllers.

int	max_gather_destinations
	Maximum number of destinations per RTI Connext send.

int	participant_user_data_max_length
	Maximum length of user data in com.rti.dds.domain.DomainParticipantQos and builtin.ParticipantBuiltinTopicData.

int	topic_data_max_length
	Maximum length of topic data in com.rti.dds.topic.TopicQos, builtin.TopicBuiltinTopicData, builtin.PublicationBuiltinTopicData and builtin.SubscriptionBuiltinTopicData.

int	publisher_group_data_max_length
	Maximum length of group data in com.rti.dds.publication.PublisherQos and builtin.PublicationBuiltinTopicData.

int	subscriber_group_data_max_length
	Maximum length of group data in com.rti.dds.subscription.SubscriberQos and builtin.SubscriptionBuiltinTopicData.

int	writer_user_data_max_length
	Maximum length of user data in com.rti.dds.publication.DataWriterQos and builtin.PublicationBuiltinTopicData.

int	reader_user_data_max_length
	Maximum length of user data in com.rti.dds.subscription.DataReaderQos and builtin.SubscriptionBuiltinTopicData.

int	max_partitions
	Maximum number of partition name strings allowable in a com.rti.dds.infrastructure.PartitionQosPolicy.

int	max_partition_cumulative_characters
	Maximum number of combined characters allowable in all partition names in a com.rti.dds.infrastructure.PartitionQosPolicy.

int	type_code_max_serialized_length
	Maximum size of serialized string for type code.

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

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

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

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

int	channel_seq_max_length
	Maximum number of channels that can be specified in com.rti.dds.infrastructure.MultiChannelQosPolicy for MultiChannel DataWriters.

int	channel_filter_expression_max_length
	Maximum length of a channel com.rti.dds.infrastructure.ChannelSettings_t.filter_expression in a MultiChannel DataWriter.

int	participant_property_list_max_length
	Maximum number of properties associated with the com.rti.dds.domain.DomainParticipant.

int	participant_property_string_max_length
	Maximum string length of the properties associated with the com.rti.dds.domain.DomainParticipant.

int	writer_property_list_max_length
	Maximum number of properties associated with a com.rti.dds.publication.DataWriter.

int	writer_property_string_max_length
	Maximum string length of the properties associated with a com.rti.dds.publication.DataWriter.

int	reader_property_list_max_length
	Maximum number of properties associated with a com.rti.dds.subscription.DataReader.

int	reader_property_string_max_length
	Maximum string length of the properties associated with a com.rti.dds.subscription.DataReader.

int	max_endpoint_groups
	Maximum number of com.rti.dds.infrastructure.EndpointGroup_t allowable in a com.rti.dds.infrastructure.AvailabilityQosPolicy.

int	max_endpoint_group_cumulative_characters
	Maximum number of combined role_name characters allowable in all com.rti.dds.infrastructure.EndpointGroup_t in a com.rti.dds.infrastructure.AvailabilityQosPolicy.

int	transport_info_list_max_length
	Maximum number of installed transports to send and receive information about in builtin.ParticipantBuiltinTopicData.transport_info.

Public Attributes inherited from QosPolicy
final QosPolicyId_t	id
	The ID of this QoS policy.

final String	policy_name
	The name of this QoS policy.

Additional Inherited Members
Public Member Functions inherited from Struct
abstract boolean	equals (Object obj)

abstract int	hashCode ()

String	toString ()

Protected Member Functions inherited from Struct
	Struct ()

abstract void	pull_from_nativeI (long native_status)

abstract void	push_to_nativeI (long native_status)

Detailed Description

Various settings that configure how a com.rti.dds.domain.DomainParticipant allocates and uses physical memory for internal resources, including the maximum sizes of various properties.

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 com.rti.dds.domain.DomainParticipant is allowed to dynamically allocate memory as needed as users create local Entities such as com.rti.dds.publication.DataWriter and com.rti.dds.subscription.DataReader objects or as the participant discovers new applications. By setting fixed values for the maximum parameters in this QoS policy, you can bound the memory that can be allocated by a com.rti.dds.domain.DomainParticipant. In addition, by setting the initial values to the maximum values, you can prevent DomainParticipants from allocating memory after the initialization period.

The maximum sizes of different variable-length parameters such as the number of partitions that can be stored in the com.rti.dds.infrastructure.PartitionQosPolicy, the maximum length of data store in the com.rti.dds.infrastructure.UserDataQosPolicy and com.rti.dds.infrastructure.GroupDataQosPolicy, 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 com.rti.dds.domain.DomainParticipant to another, a com.rti.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 com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.type_code_max_serialized_length.

This QoS policy is an extension to the DDS standard.

Entity:: com.rti.dds.domain.DomainParticipant

Properties:: RxO = N/A
Changeable = NO

Member Data Documentation

final AllocationSettings_t local_writer_allocation

Allocation settings applied to local DataWriters.

[default] initial_count = 16; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t local_reader_allocation

Allocation settings applied to local DataReaders.

[default] initial_count = 16; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t local_publisher_allocation

Allocation settings applied to local Publisher.

[default] initial_count = 4; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t local_subscriber_allocation

Allocation settings applied to local Subscriber.

[default] initial_count = 4; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t local_topic_allocation

Allocation settings applied to local Topic.

[default] initial_count = 16; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t remote_writer_allocation

Allocation settings applied to remote DataWriters.

Remote DataWriters include all DataWriters, both local and remote.

[default] initial_count = 64; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t remote_reader_allocation

Allocation settings applied to remote DataReaders.

Remote DataReaders include all DataReaders, both local and remote.

[default] initial_count = 64; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t remote_participant_allocation

Allocation settings applied to remote DomainParticipants.

Remote DomainParticipants include all DomainParticipants, both local and remote.

[default] initial_count = 16; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t matching_writer_reader_pair_allocation

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

[default] initial_count = 32; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t matching_reader_writer_pair_allocation

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

[default] initial_count = 32; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t ignored_entity_allocation

Allocation settings applied to ignored entities.

[default] initial_count = 8; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t content_filtered_topic_allocation

Allocation settings applied to content filtered topic.

[default] initial_count = 4; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t content_filter_allocation

Allocation settings applied to content filter.

[default] initial_count = 4; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED; incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t read_condition_allocation

Allocation settings applied to read condition pool.

[default] initial_count = 4; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED, incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t query_condition_allocation

Allocation settings applied to query condition pool.

[default] initial_count = 4; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED, incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t outstanding_asynchronous_sample_allocation

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

[default] initial_count = 64; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED, incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

final AllocationSettings_t flow_controller_allocation

Allocation settings applied to flow controllers.

[default] initial_count = 4; max_count = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED, incremental_count = -1

[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings_t

int local_writer_hash_buckets

Hash_Buckets settings applied to local DataWriters.

[default] 4

[range] [1, 10000]

int local_reader_hash_buckets

Number of hash buckets for local DataReaders.

[default] 4

[range] [1, 10000]

int local_publisher_hash_buckets

Number of hash buckets for local Publisher.

[default] 1

[range] [1, 10000]

int local_subscriber_hash_buckets

Number of hash buckets for local Subscriber.

[default] 1

[range] [1, 10000]

int local_topic_hash_buckets

Number of hash buckets for local Topic.

[default] 4

[range] [1, 10000]

int remote_writer_hash_buckets

Number of hash buckets for remote DataWriters.

Remote DataWriters include all DataWriters, both local and remote.

[default] 16

[range] [1, 10000]

int remote_reader_hash_buckets

Number of hash buckets for remote DataReaders.

Remote DataReaders include all DataReaders, both local and remote.

[default] 16

[range] [1, 10000]

int remote_participant_hash_buckets

Number of hash buckets for remote DomainParticipants.

Remote DomainParticipants include all DomainParticipants, both local and remote.

[default] 4

[range] [1, 10000]

int matching_writer_reader_pair_hash_buckets

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

[default] 32

[range] [1, 10000]

int matching_reader_writer_pair_hash_buckets

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

[default] 32

[range] [1, 10000]

int ignored_entity_hash_buckets

Number of hash buckets for ignored entities.

[default] 1

[range] [1, 10000]

int content_filtered_topic_hash_buckets

Number of hash buckets for content filtered topics.

[default] 1

[range] [1, 10000]

int content_filter_hash_buckets

Number of hash buckets for content filters.

[default] 1

[range] [1, 10000]

int flow_controller_hash_buckets

Number of hash buckets for flow controllers.

[default] 1

[range] [1, 10000]

int max_gather_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]

int participant_user_data_max_length

Maximum length of user data in com.rti.dds.domain.DomainParticipantQos and builtin.ParticipantBuiltinTopicData.

[default] 256

[range] [0,0x7fffffff]

int topic_data_max_length

Maximum length of topic data in com.rti.dds.topic.TopicQos, builtin.TopicBuiltinTopicData, builtin.PublicationBuiltinTopicData and builtin.SubscriptionBuiltinTopicData.

[default] 256

[range] [0,0x7fffffff]

int publisher_group_data_max_length

Maximum length of group data in com.rti.dds.publication.PublisherQos and builtin.PublicationBuiltinTopicData.

[default] 256

[range] [0,0x7fffffff]

int subscriber_group_data_max_length

Maximum length of group data in com.rti.dds.subscription.SubscriberQos and builtin.SubscriptionBuiltinTopicData.

[default] 256

[range] [0,0x7fffffff]

int writer_user_data_max_length

Maximum length of user data in com.rti.dds.publication.DataWriterQos and builtin.PublicationBuiltinTopicData.

[default] 256

[range] [0,0x7fffffff]

int reader_user_data_max_length

Maximum length of user data in com.rti.dds.subscription.DataReaderQos and builtin.SubscriptionBuiltinTopicData.

[default] 256

[range] [0,0x7fffffff]

int max_partitions

Maximum number of partition name strings allowable in a com.rti.dds.infrastructure.PartitionQosPolicy.

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]

int max_partition_cumulative_characters

Maximum number of combined characters allowable in all partition names in a com.rti.dds.infrastructure.PartitionQosPolicy.

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]

int type_code_max_serialized_length

Maximum size of serialized string for type code.

This parameter limits the size of the type code that a com.rti.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]

int type_object_max_serialized_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.

[default] 3072

[range] [0,0x7fffffff]

int type_object_max_deserialized_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] com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED

[range] [0,0x7fffffff] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED

int deserialized_type_object_dynamic_allocation_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] <= com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.type_object_max_deserialized_length

int contentfilter_property_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]

int channel_seq_max_length

Maximum number of channels that can be specified in com.rti.dds.infrastructure.MultiChannelQosPolicy for MultiChannel DataWriters.

[default] 32

[range] [0,0xffff]

int channel_filter_expression_max_length

Maximum length of a channel com.rti.dds.infrastructure.ChannelSettings_t.filter_expression in a MultiChannel DataWriter.

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

[default] 256

[range] [0,0xffff]

int participant_property_list_max_length

Maximum number of properties associated with the com.rti.dds.domain.DomainParticipant.

[default] 32

[range] [0,0xffff]

int participant_property_string_max_length

Maximum string length of the properties associated with the com.rti.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 com.rti.dds.domain.DomainParticipant properties.

[default] 2048

[range] [0,0xffff]

int writer_property_list_max_length

Maximum number of properties associated with a com.rti.dds.publication.DataWriter.

[range] [0,0xffff]

[default] 32

int writer_property_string_max_length

Maximum string length of the properties associated with a com.rti.dds.publication.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 com.rti.dds.publication.DataWriter properties.

[default] 1024

[range] [0,0xffff]

int reader_property_list_max_length

Maximum number of properties associated with a com.rti.dds.subscription.DataReader.

[default] 32

[range] [0,0xffff]

int reader_property_string_max_length

Maximum string length of the properties associated with a com.rti.dds.subscription.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 com.rti.dds.subscription.DataReader properties.

[default] 1024

[range] [0,0xffff]

int max_endpoint_groups

Maximum number of com.rti.dds.infrastructure.EndpointGroup_t allowable in a com.rti.dds.infrastructure.AvailabilityQosPolicy.

[default] 32

[range] [0,65535]

int max_endpoint_group_cumulative_characters

Maximum number of combined role_name characters allowable in all com.rti.dds.infrastructure.EndpointGroup_t in a com.rti.dds.infrastructure.AvailabilityQosPolicy.

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

[default] 1024

[range] [0,65535]

int transport_info_list_max_length

Maximum number of installed transports to send and receive information about in builtin.ParticipantBuiltinTopicData.transport_info.

[default] 6

[range] [0,100]

Public Attributes

Additional Inherited Members

Detailed Description

Member Data Documentation