Locator_t Class Reference

<<extension>> Type used to represent the addressing information needed to send a message to an RTPS Endpoint using one of the supported transports. More...

Inherits Struct.

Public Member Functions
	Locator_t ()
	Constructor. More...

Public Attributes
int	kind
	The kind of locator. More...
int	port
	the port number More...
final byte []	address = new byte[ADDRESS_LENGTH_MAX]
	A com.rti.dds.infrastructure.Locator_t.ADDRESS_LENGTH_MAX octet field to hold the IP address. More...

Static Public Attributes
static final int	KIND_INVALID
	Locator of this kind is invalid. More...
static final int	PORT_INVALID
	An invalid port. More...
static final byte []	ADDRESS_INVALID
	An invalid address. More...
static final Locator_t	INVALID
	An invalid locator. More...
static final int	KIND_UDPv4
	A locator for a UDPv4 address. More...
static final int	KIND_UDPv4_WAN
	A locator for a UDPv4 asymmetric transport address. More...
static final int	KIND_SHMEM
	A locator for an address acessed via shared memory. More...
static final int	KIND_SHMEM_510
	A locator for an address acessed via shared memory for RTI Connext 5.1.0 and earlier. More...
static final int	KIND_UDPv6
	A locator for a UDPv6 address. More...
static final int	KIND_UDPv6_510
	A locator for a UDPv6 address for RTI Connext 5.1.0 and earlier. More...
static final int	KIND_RESERVED
	Locator of this kind is reserved. More...
static final int	ADDRESS_LENGTH_MAX = 16
	Declares length of address field in locator. More...

Detailed Description

<<extension>> Type used to represent the addressing information needed to send a message to an RTPS Endpoint using one of the supported transports.

Constructor & Destructor Documentation

Locator_t()

Locator_t

(

)

Constructor.

References ShortSeq.add(), ShortSeq.getMaximum(), ShortSeq.getShort(), Locator_t.kind, Locator_t.port, AbstractSequence.remove(), ShortSeq.setShort(), and AbstractPrimitiveSequence.size().

Member Data Documentation

KIND_INVALID

final int KIND_INVALID

static

Locator of this kind is invalid.

PORT_INVALID

final int PORT_INVALID

static

An invalid port.

ADDRESS_INVALID

final byte [] ADDRESS_INVALID

static

Initial value:

= {0,0,0,0,
                                                  0,0,0,0,
                                                  0,0,0,0,
                                                  0,0,0,0}

An invalid address.

INVALID

final Locator_t INVALID

static

Initial value:

= new Locator_t(
        KIND_INVALID, PORT_INVALID, ADDRESS_INVALID)

An invalid locator.

KIND_UDPv4

final int KIND_UDPv4

static

A locator for a UDPv4 address.

KIND_UDPv4_WAN

final int KIND_UDPv4_WAN

static

A locator for a UDPv4 asymmetric transport address.

KIND_SHMEM

final int KIND_SHMEM

static

A locator for an address acessed via shared memory.

KIND_SHMEM_510

final int KIND_SHMEM_510

static

A locator for an address acessed via shared memory for RTI Connext 5.1.0 and earlier.

KIND_UDPv6

final int KIND_UDPv6

static

A locator for a UDPv6 address.

KIND_UDPv6_510

final int KIND_UDPv6_510

static

A locator for a UDPv6 address for RTI Connext 5.1.0 and earlier.

KIND_RESERVED

final int KIND_RESERVED

static

Locator of this kind is reserved.

ADDRESS_LENGTH_MAX

final int ADDRESS_LENGTH_MAX = 16

static

Declares length of address field in locator.

kind

int kind

The kind of locator.

If the Locator_t kind is com.rti.dds.infrastructure.Locator_t.KIND_UDPv4, the address contains an IPv4 address. In this case, the leading 12 octets of the com.rti.dds.infrastructure.Locator_t.address must be zero. The last 4 octets of com.rti.dds.infrastructure.Locator_t.address are used to store the IPv4 address.

If the Locator_t kind is com.rti.dds.infrastructure.Locator_t.KIND_UDPv6, the address contains an IPv6 address. IPv6 addresses typically use a shorthand hexadecimal notation that maps one-to-one to the 16 octets in the com.rti.dds.infrastructure.Locator_t.address field.

Referenced by Locator_t.Locator_t().

port

int port

the port number

Referenced by Locator_t.Locator_t().

address

final byte [] address = new byte[ADDRESS_LENGTH_MAX]

A com.rti.dds.infrastructure.Locator_t.ADDRESS_LENGTH_MAX octet field to hold the IP address.