net.sf.jrtps.types

Class Locator

java.lang.Object

net.sf.jrtps.types.Locator

public class Locator
extends Object

Locator is used to tell remote participants how a participant can be reached.

Author:

mcr70

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOCATOR_KIND_INVALID An invalid Locator kind
static int	LOCATOR_KIND_UDPv4 This kind is used for communication with UDPv4
static int	LOCATOR_KIND_UDPv6 This kind is used for communication with UDPv6

Constructor Summary

Constructors

Constructor and Description
Locator(InetAddress addr, int port)
Locator(int kind, int port, byte[] address) Create new Locator.
Locator(RTPSByteBuffer is)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
byte[]	getAddress() Gets the address of this Locator.
int	getKind() Gets the kind of this Locator.
int	getPort() Gets the port of this Locator.
int	hashCode()
boolean	isMulticastLocator()
String	toString()
void	writeTo(RTPSByteBuffer buffer)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOCATOR_KIND_UDPv4

public static final int LOCATOR_KIND_UDPv4

This kind is used for communication with UDPv4

See Also:

Constant Field Values

LOCATOR_KIND_UDPv6

public static final int LOCATOR_KIND_UDPv6

This kind is used for communication with UDPv6

See Also:

Constant Field Values

LOCATOR_KIND_INVALID

public static final int LOCATOR_KIND_INVALID

An invalid Locator kind

See Also:

Constant Field Values

Constructor Detail

Locator

public Locator(InetAddress addr,
               int port)

Locator

public Locator(RTPSByteBuffer is)

Locator

public Locator(int kind,
               int port,
               byte[] address)

Create new Locator.

Parameters:

kind - Kind

port - port

address - address must be an array of length 16

Throws:

IllegalArgumentException - if address is not of length 16

Method Detail

getKind

public int getKind()

Gets the kind of this Locator. Each Locator has a kind associated with it to distinguish different types of communication mechanisms from each other. For example, kind can be used to distinguish UDP from TCP. RTPS specification defines only two mandatory kinds: for UDPv4 and UDPv6

Returns:

kind

getPort

public int getPort()

Gets the port of this Locator.

Returns:

port

getAddress

public byte[] getAddress()

Gets the address of this Locator.

Returns:

address

writeTo

public void writeTo(RTPSByteBuffer buffer)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isMulticastLocator

public boolean isMulticastLocator()