RTI Connext Java API  Version 5.0.0
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.
 
- Public Member Functions inherited from Struct
abstract boolean equals (Object obj)
 
abstract int hashCode ()
 
String toString ()
 

Public Attributes

int kind
 The kind of locator.
 
int port
 the port number
 
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.
 

Static Public Attributes

static final int KIND_INVALID
 Locator of this kind is invalid.
 
static final int PORT_INVALID
 An invalid port.
 
static final byte[] ADDRESS_INVALID
 An invalid address.
 
static final Locator_t INVALID
 An invalid locator.
 
static final int KIND_UDPv4
 A locator for a UDPv4 address.
 
static final int KIND_SHMEM
 A locator for an address acessed via shared memory.
 
static final int KIND_UDPv6
 A locator for a UDPv6 address.
 
static final int KIND_RESERVED
 Locator of this kind is reserved.
 
static final int ADDRESS_LENGTH_MAX = 16
 Declares length of address field in locator.
 

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

<<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 ( )

Constructor.

Member Data Documentation

final int KIND_INVALID
static

Locator of this kind is invalid.

final int PORT_INVALID
static

An invalid port.

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.

final Locator_t INVALID
static
Initial value:

An invalid locator.

final int KIND_UDPv4
static

A locator for a UDPv4 address.

final int KIND_SHMEM
static

A locator for an address acessed via shared memory.

final int KIND_UDPv6
static

A locator for a UDPv6 address.

final int KIND_RESERVED
static

Locator of this kind is reserved.

final int ADDRESS_LENGTH_MAX = 16
static

Declares length of address field in locator.

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.

int port

the port number

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.


RTI Connext Java API Version 5.0.0 Copyright © Thu Aug 30 2012 Real-Time Innovations, Inc