RTI Connext DDS Micro C API  Version 4.0.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
DDS_DomainParticipantResourceLimitsQosPolicy Struct Reference

<<cert>> Resource limits that apply only to DDS_DomainParticipant instances. More...

#include <dds_c_infrastructure.h>

Data Fields

DDS_Long local_writer_allocation
 The maximum number of local Writers that can be created.
DDS_Long local_reader_allocation
 The maximum number of local Readers that can be created.
DDS_Long local_publisher_allocation
 The maximum number of local Publishers that can be created.
DDS_Long local_subscriber_allocation
 The maximum number of local Subscribers that can be created.
DDS_Long local_topic_allocation
 The maximum number of topics that can be created.
DDS_Long local_type_allocation
 The maximum number of local types that can be registered with this DomainParticipant.
DDS_Long remote_participant_allocation
 The maximum number of remote participants that can be discovered by this DomainParticipant.
DDS_Long remote_writer_allocation
 The maximum number of remote writers that can be discovered by this DomainParticipant.
DDS_Long remote_reader_allocation
 The maximum number of remote readers that can be discovered by this DomainParticipant.
DDS_Long matching_writer_reader_pair_allocation
 The maximum number of matching local writer and remote/local reader pairs.
DDS_Long matching_reader_writer_pair_allocation
 The maximum number of matching local reader and remote/local writer pairs contained in this DomainParticipant.
DDS_Long max_receive_ports
 Maximum number of addresses that can be listened on.
DDS_Long max_destination_ports
 Maximum number of unique destination addresses that a participant can reach.
DDS_UnsignedLong shmem_ref_transfer_mode_max_segments
 Maximum number of segments created by all DataWriters belonging to a DDS_DomainParticipant.
DDS_Long participant_user_data_max_length
 Maximum length of user data in DDS_DomainParticipantQos and DDS_ParticipantBuiltinTopicData.
DDS_Long participant_user_data_max_count
 Maximum number of unique user data sequences allowed across DomainParticipants (the local DDS_DomainParticipantQos and discovered participants).
DDS_Long topic_data_max_length
 Maximum length of topic data in DDS_TopicQos, DDS_PublicationBuiltinTopicData, and DDS_SubscriptionBuiltinTopicData.
DDS_Long topic_data_max_count
 Maximum number of unique topic data sequences allowed in the DDS_TopicQos across all local topics, discovered publications, and discovered subscriptions.
DDS_Long publisher_group_data_max_length
 Maximum length of group data in DDS_PublisherQos and DDS_PublicationBuiltinTopicData.
DDS_Long publisher_group_data_max_count
 Maximum number of unique group data sequences allowed in the DDS_PublisherQos across all local publishers and discovered publications.
DDS_Long subscriber_group_data_max_length
 Maximum length of group data in DDS_SubscriberQos and DDS_SubscriptionBuiltinTopicData.
DDS_Long subscriber_group_data_max_count
 Maximum number of unique group data sequences allowed in the DDS_SubscriberQos across all local subscribers and discovered subscriptions.
DDS_Long writer_user_data_max_length
 Maximum length of user data in DDS_DataWriterQos and DDS_PublicationBuiltinTopicData.
DDS_Long writer_user_data_max_count
 Maximum number of unique user data sequences allowed in the DDS_DataWriterQos across all local DataReaders and discovered publications.
DDS_Long reader_user_data_max_length
 Maximum length of user data in DDS_DataReaderQos and DDS_SubscriptionBuiltinTopicData.
DDS_Long reader_user_data_max_count
 Maximum number of unique user data sequences allowed in the DDS_DataReaderQos across all local DataReaders and discovered subscriptions.
DDS_Long max_partitions
 The maximum number of elements in the DDS_PartitionQosPolicy.
DDS_Long max_partition_cumulative_characters
 The maximum number of combined characters across all DDS_PartitionQosPolicy PARTITION.name sequence elements, including the NUL characters.
DDS_Long max_partition_string_size
 The maximum number of 8-bit characters in a PARTITION.name element, including the NUL termination.
DDS_Long max_partition_string_allocation
 The maximum number of 8-bit characters reserved for PARTITION.name strings to allocate for the PARTITION DDS_PartitionQosPolicy.

Detailed Description

<<cert>> Resource limits that apply only to DDS_DomainParticipant instances.

This QoS policy is an extension to the DDS standard.

Entity:
DDS_DomainParticipant
Properties:
RxO = N/A
Changeable = NO

Field Documentation

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::local_writer_allocation

The maximum number of local Writers that can be created.

[default] 1

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::local_reader_allocation

The maximum number of local Readers that can be created.

[default] 1

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::local_publisher_allocation

The maximum number of local Publishers that can be created.

[default] 1

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::local_subscriber_allocation

The maximum number of local Subscribers that can be created.

[default] 1

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::local_topic_allocation

The maximum number of topics that can be created.

[default] 1

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::local_type_allocation

The maximum number of local types that can be registered with this DomainParticipant.

[default] 1

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::remote_participant_allocation

The maximum number of remote participants that can be discovered by this DomainParticipant.

Remote DomainParticipants include all DomainParticipants, both local and remote.

[default] 1

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::remote_writer_allocation

The maximum number of remote writers that can be discovered by this DomainParticipant.

Remote DataWriters include all DataWriters, both local and remote.

[default] 1

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::remote_reader_allocation

The maximum number of remote readers that can be discovered by this DomainParticipant.

Remote DataReaders include all DataReaders, both local and remote.

[default] 1

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::matching_writer_reader_pair_allocation

The maximum number of matching local writer and remote/local reader pairs.

A resource is used for each discovery match between a writer of the participant and a reader of this or another participant.

[default] 32

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::matching_reader_writer_pair_allocation

The maximum number of matching local reader and remote/local writer pairs contained in this DomainParticipant.

A resource is used for each discovery match between a reader of the participant and a writer of this or another participant.

[default] 32

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::max_receive_ports

Maximum number of addresses that can be listened on.

Sets the maximum number of ports to receive discovery and user data on different transports. In general, each of the following counts as one resource:

  • User-traffic unicast port
  • Meta-traffic unicast port
  • User-traffic multicast address
  • Meta-traffic multicast address

[default] 8

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::max_destination_ports

Maximum number of unique destination addresses that a participant can reach.

[default] 8

DDS_UnsignedLong DDS_DomainParticipantResourceLimitsQosPolicy::shmem_ref_transfer_mode_max_segments

Maximum number of segments created by all DataWriters belonging to a DDS_DomainParticipant.

[default] 500

[range] [0,100000] but in practice, this value will be limited by the system-wide maximum number of shared memory segments. On a Linux machine, this value is provided by the kernel parameter shmmni.

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::participant_user_data_max_length

Maximum length of user data in DDS_DomainParticipantQos and DDS_ParticipantBuiltinTopicData.

[default] 0

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::participant_user_data_max_count

Maximum number of unique user data sequences allowed across DomainParticipants (the local DDS_DomainParticipantQos and discovered participants).

For example, if a discovered participant has the same user data as the local participant, then that unique sequence only counts once against this resource-limit.

[default] DDS_SIZE_AUTO

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::topic_data_max_length

Maximum length of topic data in DDS_TopicQos, DDS_PublicationBuiltinTopicData, and DDS_SubscriptionBuiltinTopicData.

[default] 0

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::topic_data_max_count

Maximum number of unique topic data sequences allowed in the DDS_TopicQos across all local topics, discovered publications, and discovered subscriptions.

For example, if a local topic has the same topic data as a the topic of a discovered publication or subscription, then that unique sequence only counts once against this resource-limit.

[default] DDS_SIZE_AUTO

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::publisher_group_data_max_length

Maximum length of group data in DDS_PublisherQos and DDS_PublicationBuiltinTopicData.

[default] 0

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::publisher_group_data_max_count

Maximum number of unique group data sequences allowed in the DDS_PublisherQos across all local publishers and discovered publications.

For example, if a local publisher has the same group data as a discovered publication, then that unique sequence only counts once against this resource-limit.

[default] DDS_SIZE_AUTO

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::subscriber_group_data_max_length

Maximum length of group data in DDS_SubscriberQos and DDS_SubscriptionBuiltinTopicData.

[default] 0

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::subscriber_group_data_max_count

Maximum number of unique group data sequences allowed in the DDS_SubscriberQos across all local subscribers and discovered subscriptions.

For example, if a local subscriber has the same group data as a discovered subscription, then that unique sequence only counts once against this resource-limit.

[default] DDS_SIZE_AUTO

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::writer_user_data_max_length

Maximum length of user data in DDS_DataWriterQos and DDS_PublicationBuiltinTopicData.

[default] 0

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::writer_user_data_max_count

Maximum number of unique user data sequences allowed in the DDS_DataWriterQos across all local DataReaders and discovered publications.

For example, if a local DataWriter has the same user data as a discovered publication, then that unique sequence only counts once against this resource-limit.

[default] DDS_SIZE_AUTO

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::reader_user_data_max_length

Maximum length of user data in DDS_DataReaderQos and DDS_SubscriptionBuiltinTopicData.

[default] 0

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::reader_user_data_max_count

Maximum number of unique user data sequences allowed in the DDS_DataReaderQos across all local DataReaders and discovered subscriptions.

For example, if a local DataReader has the same user data as a discovered subscription, then that unique sequence only counts once against this resource-limit.

[default] DDS_SIZE_AUTO

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::max_partitions

The maximum number of elements in the DDS_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]

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::max_partition_cumulative_characters

The maximum number of combined characters across all DDS_PartitionQosPolicy PARTITION.name sequence elements, including the NUL characters.

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]

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::max_partition_string_size

The maximum number of 8-bit characters in a PARTITION.name element, including the NUL termination.

[default] DDS_LENGTH_UNLIMITED

[range] DDS_LENGTH_UNLIMITED or greater than 0

DDS_Long DDS_DomainParticipantResourceLimitsQosPolicy::max_partition_string_allocation

The maximum number of 8-bit characters reserved for PARTITION.name strings to allocate for the PARTITION DDS_PartitionQosPolicy.

If max_partition_string_allocation is DDS_LENGTH_UNLIMITED then Memory will be allocated and freed during operation.

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.

[default] DDS_LENGTH_UNLIMITED

[range] DDS_LENGTH_UNLIMITED or greater than 1


RTI Connext DDS Micro C API Version 4.0.1 Copyright © Mon Jun 3 2024 Real-Time Innovations, Inc