org.ros.address.AdvertiseAddress Class Reference

List of all members.

Public Member Functions
	AdvertiseAddress (String host)
boolean	equals (Object obj)
String	getHost ()
int	getPort ()
int	hashCode ()
boolean	isLoopbackAddress ()
void	setPortCallable (Callable< Integer > portCallable)
void	setStaticPort (final int port)
InetAddress	toInetAddress ()
InetSocketAddress	toInetSocketAddress ()
String	toString ()
URI	toUri (String scheme)
Static Public Member Functions
static AdvertiseAddress	newPrivate ()
static AdvertiseAddress	newPublic ()
Private Attributes
final String	host
Callable< Integer >	portCallable

---

Detailed Description

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)

Definition at line 39 of file AdvertiseAddress.java.

---

Constructor & Destructor Documentation

org.ros.address.AdvertiseAddress.AdvertiseAddress

(

String

host

)

[inline]

Definition at line 60 of file AdvertiseAddress.java.

---

Member Function Documentation

boolean org.ros.address.AdvertiseAddress.equals

(

Object

obj

)

[inline]

Definition at line 142 of file AdvertiseAddress.java.

String org.ros.address.AdvertiseAddress.getHost

(

)

[inline]

Definition at line 65 of file AdvertiseAddress.java.

int org.ros.address.AdvertiseAddress.getPort

(

)

[inline]

Definition at line 78 of file AdvertiseAddress.java.

int org.ros.address.AdvertiseAddress.hashCode

(

)

[inline]

Definition at line 128 of file AdvertiseAddress.java.

boolean org.ros.address.AdvertiseAddress.isLoopbackAddress

(

)

[inline]

Definition at line 113 of file AdvertiseAddress.java.

static AdvertiseAddress org.ros.address.AdvertiseAddress.newPrivate

(

)

[inline, static]

Definition at line 45 of file AdvertiseAddress.java.

static AdvertiseAddress org.ros.address.AdvertiseAddress.newPublic

(

)

[inline, static]

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

Returns:

a suitable AdvertiseAddress for a publicly accessible BindAddress

Definition at line 56 of file AdvertiseAddress.java.

void org.ros.address.AdvertiseAddress.setPortCallable

(

Callable< Integer >

portCallable

)

[inline]

Definition at line 86 of file AdvertiseAddress.java.

void org.ros.address.AdvertiseAddress.setStaticPort

(

final int

port

)

[inline]

Definition at line 69 of file AdvertiseAddress.java.

InetAddress org.ros.address.AdvertiseAddress.toInetAddress

(

)

[inline]

Definition at line 90 of file AdvertiseAddress.java.

InetSocketAddress org.ros.address.AdvertiseAddress.toInetSocketAddress

(

)

[inline]

Definition at line 94 of file AdvertiseAddress.java.

String org.ros.address.AdvertiseAddress.toString

(

)

[inline]

Definition at line 118 of file AdvertiseAddress.java.

URI org.ros.address.AdvertiseAddress.toUri

(

String

scheme

)

[inline]

Definition at line 104 of file AdvertiseAddress.java.

---

Member Data Documentation

final String org.ros.address.AdvertiseAddress.host [private]

Definition at line 41 of file AdvertiseAddress.java.

Callable<Integer> org.ros.address.AdvertiseAddress.portCallable [private]

Definition at line 43 of file AdvertiseAddress.java.

---

The documentation for this class was generated from the following file:

• AdvertiseAddress.java