DDS::DiscoveryQosPolicy Class Reference

Configures the mechanism used by the middleware to automatically discover and connect with new remote applications. More...

#include <managed_infrastructure.h>

Static Public Member Functions
static System::String^	get_discovery_qos_policy_name ()
	Stringified human-readable name for DDS::DiscoveryQosPolicy.

Public Attributes
StringSeq^	enabled_transports
	The transports available for use by the Discovery mechanism.
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.
StringSeq^	multicast_receive_addresses
	Specifies the multicast group addresses on which discovery-related meta-traffic can be received by the DomainParticipant.
System::Int32	metatraffic_transport_priority
	The transport priority to use for the Discovery meta-traffic.

Properties
System::Boolean	accept_unknown_peers [get, set]
	Whether to accept a new participant that is not in the initial peers list.

Detailed Description

Configures the mechanism used by the middleware to automatically discover and connect with new remote applications.

Entity:

DDS::DomainParticipant

Properties:

RxO = N/A
Changeable = NO

Usage

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.

See Also

NDDS_DISCOVERY_PEERS

DDS::DiscoveryConfigQosPolicy

Member Data Documentation

StringSeq ^ DDS::DiscoveryQosPolicy::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 DDS::DataReader and DDS::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.

StringSeq ^ DDS::DiscoveryQosPolicy::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 DDS::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 DDS::DomainParticipant is discovered by receiving participant announcements from a remote peer. When the new remote DDS::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.

See Also

Peer Descriptor Format

DDS::DomainParticipant::add_peer()

StringSeq ^ DDS::DiscoveryQosPolicy::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 DDS::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 DDS::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 DDS::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.

See Also

Address Format

System::Int32 DDS::DiscoveryQosPolicy::metatraffic_transport_priority

The transport priority to use for the Discovery meta-traffic.

The discovery metatraffic will be sent by the built-in DDS::DataWriter using this transport priority.

[default] 0

Property Documentation

System:: Boolean DDS::DiscoveryQosPolicy::accept_unknown_peers

getset

Whether to accept a new participant that is not in the initial peers list.

If false, the participant will only communicate with those in the initial peers list and those added via DDS::DomainParticipant::add_peer().

If true, the participant will also communicate with all discovered remote participants.

Note: If accept_unknown_peers is 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] true