Specifies the multicast address on which a com.rti.dds.subscription.DataReader wants to receive its data. It can also specify a port number as well as a subset of the available (at the com.rti.dds.domain.DomainParticipant level) transports with which to receive the multicast data. More...
Public Attributes | |
| final TransportMulticastSettingsSeq | value |
| A sequence of multicast communications settings. More... | |
| TransportMulticastQosPolicyKind | kind |
| A value that specifies a way to determine how to obtain the multicast address. More... | |
 Public Attributes inherited from QosPolicy | |
| final QosPolicyId_t | id |
| The ID of this QoS policy. More... | |
| final String | policy_name |
| The name of this QoS policy. More... | |
Detailed Description
Specifies the multicast address on which a com.rti.dds.subscription.DataReader wants to receive its data. It can also specify a port number as well as a subset of the available (at the com.rti.dds.domain.DomainParticipant level) transports with which to receive the multicast data.
By default, a com.rti.dds.publication.DataWriter will send individually addressed packets for each com.rti.dds.subscription.DataReader that subscribes to the topic of the DataWriter – this is known as unicast delivery. Thus, as many copies of the data will be sent over the network as there are DataReaders for the data. The network bandwidth used by a DataWriter will thus increase linearly with the number of DataReaders.
Multicast addressing (on UDP/IP transports) allows multiple DataReaders to receive the same network packet. By using multicast, a com.rti.dds.publication.DataWriter can send a single network packet that is received by all subscribing applications. Thus the network bandwidth usage will be constant, independent of the number of DataReaders.
Coordinating the multicast address specified by DataReaders can help optimize network bandwidth usage in systems where there are multiple DataReaders for the same com.rti.dds.topic.Topic.
- Properties:
- RxO = N/A
Changeable = NO
Member Data Documentation
◆ value
| final TransportMulticastSettingsSeq value |
A sequence of multicast communications settings.
An empty sequence means that multicast is not used by the entity.
The RTPS wire protocol currently limits the maximum number of multicast locators to
- Note that this is a hard limit that cannot be increased. However, this limit can be decreased by configuring the 'dds.domain_participant.max_announced_locator_list_size' property in the com.rti.dds.infrastructure.PropertyQosPolicy associated with the com.rti.dds.domain.DomainParticipantQos.
[default] Empty sequence.
◆ kind
A value that specifies a way to determine how to obtain the multicast address.
This field can be set to one of the following two values: com.rti.dds.infrastructure.TransportMulticastQosPolicyKind.AUTOMATIC_TRANSPORT_MULTICAST_QOS or com.rti.dds.infrastructure.TransportMulticastQosPolicyKind.UNICAST_ONLY_TRANSPORT_MULTICAST_QOS.
-
If it is set to com.rti.dds.infrastructure.TransportMulticastQosPolicyKind.AUTOMATIC_TRANSPORT_MULTICAST_QOS, the behavior will depend on the com.rti.dds.infrastructure.TransportMulticastQosPolicy.value:
-
If com.rti.dds.infrastructure.TransportMulticastQosPolicy.value does not have any elements, then multicast will not be used.
-
If com.rti.dds.infrastructure.TransportMulticastQosPolicy.value first element has an empty address, then the address will be obtained from com.rti.dds.infrastructure.TransportMulticastMappingQosPolicy.
- If none of the elements in com.rti.dds.infrastructure.TransportMulticastQosPolicy.value is empty, and at least one element has a valid address, then that address will be used.
-
- If it is set to com.rti.dds.infrastructure.TransportMulticastQosPolicyKind.UNICAST_ONLY_TRANSPORT_MULTICAST_QOS, then multicast will not be used.
[default] com.rti.dds.infrastructure.TransportMulticastQosPolicyKind.AUTOMATIC_TRANSPORT_MULTICAST_QOS