RTI Connext Java API  Version 5.1.0
TransportMulticastSettings_t Class Reference

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

Inherits Struct.

Public Member Functions

 TransportMulticastSettings_t ()
 Constructor with default values.
 
 TransportMulticastSettings_t (TransportMulticastSettings_t src)
 Copy constructor.
 
- Public Member Functions inherited from Struct
abstract boolean equals (Object obj)
 
abstract int hashCode ()
 
String toString ()
 

Public Attributes

final StringSeq transports
 A sequence of transport aliases that specifies the transports on which to receive multicast traffic for the entity.
 
InetAddress receive_address
 The multicast group address on which the entity can receive data.
 
int receive_port
 The multicast port on which the entity can receive data.
 

Additional Inherited Members

- Protected Member Functions inherited from Struct
 Struct ()
 
abstract void pull_from_nativeI (long native_status)
 
abstract void push_to_nativeI (long native_status)
 

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:
com.rti.dds.infrastructure.TransportMulticastQosPolicy

Constructor & Destructor Documentation

Constructor with default values.

Member Data Documentation

final StringSeq 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.

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.

InetAddress 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
int 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 com.rti.dds.infrastructure.WireProtocolQosPolicy.participant_id).

[range] [0,0xffffffff]


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