Package org.ros.address

Class AdvertiseAddress

java.lang.Object

org.ros.address.AdvertiseAddress

public class AdvertiseAddress
extends Object

A wrapper for InetSocketAddress that emphasizes the difference between an address that should be used for binding a server port and one that should be advertised to external entities. An AdvertiseAddress encourages lazy lookups of port information to prevent accidentally storing a bind port (e.g. 0 for OS picked) instead of the advertised port.

Author:

damonkohler@google.com (Damon Kohler)

Constructor Summary

Constructors

Constructor	Description
AdvertiseAddress(String host)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getHost()
int	getPort()
int	hashCode()
boolean	isLoopbackAddress()
static AdvertiseAddress	newPrivate()
static AdvertiseAddress	newPublic()	Best effort method, returns a new AdvertiseAddress where the host is determined automatically.
void	setPortCallable(Callable<Integer> portCallable)
void	setStaticPort(int port)
InetAddress	toInetAddress()
InetSocketAddress	toInetSocketAddress()
String	toString()
URI	toUri(String scheme)

Methods inherited from class java.lang.Object

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

Constructor Details

AdvertiseAddress

public AdvertiseAddress(String host)

Method Details

newPrivate

public static AdvertiseAddress newPrivate()

newPublic

public static AdvertiseAddress newPublic()

Best effort method, returns a new AdvertiseAddress where the host is determined automatically.

Returns:

a suitable AdvertiseAddress for a publicly accessible BindAddress

getHost

public String getHost()

setStaticPort

public void setStaticPort(int port)

getPort

public int getPort()

setPortCallable

public void setPortCallable(Callable<Integer> portCallable)

toInetAddress

public InetAddress toInetAddress()

toInetSocketAddress

public InetSocketAddress toInetSocketAddress()

toUri

public URI toUri(String scheme)

isLoopbackAddress

public boolean isLoopbackAddress()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object