RTI Connext C API  Version 5.1.0
DDS_TransportMulticastSettings_t Struct Reference

Type representing a list of multicast locators. More...

Data Fields

struct DDS_StringSeq transports
 A sequence of transport aliases that specifies the transports on which to receive multicast traffic for the entity.
 
char * receive_address
 The multicast group address on which the entity can receive data.
 
DDS_Long receive_port
 The multicast port on which the entity can receive data.
 

Detailed Description

Type representing a list of multicast locators.

A multicast locator specifies a transport class, a multicast address, and a multicast port number on which messages can be received by an entity.

QoS:
DDS_TransportMulticastQosPolicy

Field Documentation

struct DDS_StringSeq DDS_TransportMulticastSettings_t::transports

A sequence of transport aliases that specifies the transports on which to receive multicast traffic for the entity.

Of the transport instances available to the entity, only those with aliases matching an alias in this sequence are used to subscribe to the multicast group addresses. Thus, this list of aliases sub-selects from the transport s available to the entity.

An empty sequence is a special value that specifies all the transports available to the entity.

The memory for the strings in this sequence is managed according to the conventions described in Conventions. In particular, be careful to avoid a situation in which RTI Connext allocates a string on your behalf and you then reuse that string in such a way that RTI Connext believes it to have more memory allocated to it than it actually does.

Alias names for the builtin transports are defined in TRANSPORT_BUILTIN.

[default] Empty sequence; i.e. all the transports available to the entity.

[range] Any sequence of non-null, non-empty strings.

char* DDS_TransportMulticastSettings_t::receive_address

The multicast group address on which the entity can receive data.

Must must be an address in the proper format (see Address Format).

[default] NONE/INVALID. Required to specify a multicast group address to join.

[range] A valid IPv4 or IPv6 multicast address.

See Also
Address Format
DDS_Long DDS_TransportMulticastSettings_t::receive_port

The multicast port on which the entity can receive data.

[default] 0, which implies that the actual port number is determined by a formula as a function of the domain_id (see DDS_WireProtocolQosPolicy::participant_id).

[range] [0,0xffffffff]


RTI Connext C API Version 5.1.0 Copyright © Mon Feb 3 2014 Real-Time Innovations, Inc