|
RTI Connext Java API
Version 5.3.1
|
<<extension>> Configures the mechanism used by the middleware to automatically discover and connect with new remote applications. More...
Public Attributes | |
| final StringSeq | enabled_transports |
| The transports available for use by the Discovery mechanism. | |
| final StringSeq | multicast_receive_addresses |
| Specifies the multicast group addresses on which discovery-related meta-traffic can be received by the DomainParticipant. | |
| int | metatraffic_transport_priority |
| The transport priority to use for the Discovery meta-traffic. | |
| final StringSeq | initial_peers |
| Determines the initial list of peers that will be contacted by the Discovery mechanism to send announcements about the presence of this participant. | |
| boolean | accept_unknown_peers |
| Whether to accept a new participant that is not in the initial peers list. | |
| boolean | enable_endpoint_discovery |
| Whether to automatically enable endpoint discovery for all the remote participants. | |
 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) |
<<extension>> Configures the mechanism used by the middleware to automatically discover and connect with new remote applications.
This QoS policy identifies where on the network this application can potentially discover other applications with which to communicate.
The middleware will periodically send network packets to these locations, announcing itself to any remote applications that may be present, and will listen for announcements from those applications.
This QoS policy is an extension to the DDS standard.
| final StringSeq enabled_transports |
The transports available for use by the Discovery mechanism.
Only these transports can be used by the discovery mechanism to send meta-traffic via the builtin endpoints (built-in com.rti.dds.subscription.DataReader and com.rti.dds.publication.DataWriter).
Also determines the unicast addresses on which the Discovery mechanism will listen for meta-traffic. These along with the domain_id and participant_id determine the unicast locators on which the Discovery mechanism can receive meta-data.
Alias names for the builtin transports are defined in TRANSPORT_BUILTIN.
[default] Empty sequence. All the transports available to the DomainParticipant are available for use by the Discovery mechanism.
[range] Sequence of non-null,non-empty strings.
| final StringSeq multicast_receive_addresses |
Specifies the multicast group addresses on which discovery-related meta-traffic can be received by the DomainParticipant.
The multicast group addresses on which the Discovery mechanism will listen for meta-traffic.
Each element of this list must be a valid multicast address (IPv4 or IPv6) in the proper format (see Address Format).
The domain_id determines the multicast port on which the Discovery mechanism can receive meta-data.
If NDDS_DISCOVERY_PEERS does not contain a multicast address, then the string sequence com.rti.dds.infrastructure.DiscoveryQosPolicy.multicast_receive_addresses is cleared and the RTI discovery process will not listen for discovery messages via multicast.
If NDDS_DISCOVERY_PEERS contains one or more multicast addresses, the addresses will be stored in com.rti.dds.infrastructure.DiscoveryQosPolicy.multicast_receive_addresses, starting at element 0. They will be stored in the order they appear NDDS_DISCOVERY_PEERS.
Note: Currently, RTI Connext will only listen for discovery traffic on the first multicast address (element 0) in com.rti.dds.infrastructure.DiscoveryQosPolicy.multicast_receive_addresses.
[default] builtin.udpv4://239.255.0.1 (See also NDDS_DISCOVERY_PEERS)
[range] Sequence of length [0,1], whose elements are multicast addresses. Currently only the first multicast address (if any) is used. The rest are ignored.
| int metatraffic_transport_priority |
The transport priority to use for the Discovery meta-traffic.
The discovery metatraffic will be sent by the built-in com.rti.dds.publication.DataWriter using this transport priority.
[default] 0
| final StringSeq initial_peers |
Determines the initial list of peers that will be contacted by the Discovery mechanism to send announcements about the presence of this participant.
As part of the participant discovery phase, the com.rti.dds.domain.DomainParticipant will announce itself to the domain by sending participant DATA messages. The initial_peers specifies the initial list of peers that will be contacted. A remote com.rti.dds.domain.DomainParticipant is discovered by receiving participant announcements from a remote peer. When the new remote com.rti.dds.domain.DomainParticipant has been added to the participant's database, the endpoint discovery phase commences and information about the DataWriters and DataReaders is exchanged.
Each element of this list must be a peer descriptor in the proper format (see Peer Descriptor Format).
[default] builtin.udpv4://239.255.0.1, builtin.udpv4://127.0.0.1, builtin.shmem:// (See also NDDS_DISCOVERY_PEERS)
[range] Sequence of arbitrary length.
| boolean accept_unknown_peers |
Whether to accept a new participant that is not in the initial peers list.
If com.rti.dds.infrastructure.false, the participant will only communicate with those in the initial peers list and those added via com.rti.dds.domain.DomainParticipant.add_peer().
If com.rti.dds.infrastructure.true, the participant will also communicate with all discovered remote participants.
Note: If accept_unknown_peers is com.rti.dds.infrastructure.false and shared memory is disabled, applications on the same node will not communicate if only 'localhost' is specified in the peers list. If shared memory is disabled or 'shmem://' is not specified in the peers list, to communicate with other applications on the same node through the loopback interface, you must put the actual node address or hostname in NDDS_DISCOVERY_PEERS.
[default] com.rti.dds.infrastructure.true
| boolean enable_endpoint_discovery |
Whether to automatically enable endpoint discovery for all the remote participants.
If com.rti.dds.infrastructure.true, endpoint discovery will automatically occur for every discovered remote participant.
If com.rti.dds.infrastructure.false, endpoint discovery will be initially disabled and manual activation is required for each discovered participant by calling com.rti.dds.domain.DomainParticipant.resume_endpoint_discovery.
[default] com.rti.dds.infrastructure.true
RTI Connext Java API Version 5.3.1
Copyright © Mon Feb 19 2018
Real-Time Innovations, Inc
