com.cinchapi.concourse.util

Class Networking

Object

Networking

public final class Networking
extends Object

Utilities for dealing with networking.

Field Summary

Fields

Modifier and Type	Field and Description
static String	IP_REGEX Regex to match an IP Address.
static int	PREFERRED_OPEN_PORT_RANGE_END The inclusive upper bound for the preferred open-port range.
static int	PREFERRED_OPEN_PORT_RANGE_START The inclusive lower bound for the preferred open-port range.

Method Summary

Modifier and Type	Method and Description
static int	getCompanionPort(int port) Deprecated.
static int	getCompanionPort(int port, int rounds) Deprecated.
static String	getIpAddress(String host) Get the accessible IP Address for the host.
static int	getOpenPort() Deprecated. use getPreferredOpenPort() instead
static int	getOpenPortWithinRange(int rangeStart, int rangeEnd) Return an available port on the local machine in the inclusive range from rangeStart to rangeEnd.
static int	getPreferredOpenPort() Return an available port on the local machine in the preferred range.
static boolean	isLocalHost(String host) Return true if the host belongs to the local machine.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PREFERRED_OPEN_PORT_RANGE_START

public static final int PREFERRED_OPEN_PORT_RANGE_START

The inclusive lower bound for the preferred open-port range.

See Also:

Constant Field Values

PREFERRED_OPEN_PORT_RANGE_END

public static final int PREFERRED_OPEN_PORT_RANGE_END

The inclusive upper bound for the preferred open-port range.

See Also:

Constant Field Values

IP_REGEX

public static final String IP_REGEX

Regex to match an IP Address.

See Also:

Constant Field Values

Method Detail

getCompanionPort

@Deprecated
public static int getCompanionPort(int port)

Deprecated.

Return the companion port for the specified one. The companion port is one between and that is guaranteed to be different from port.

Parameters:

port -

Returns:

the companion port

getCompanionPort

@Deprecated
public static int getCompanionPort(int port,
                                               int rounds)

Deprecated.

Return the companion port for the specified one. The companion port is one between and that is guaranteed to be different from port.

Parameters:

port -

rounds -

Returns:

the companion port

getIpAddress

public static String getIpAddress(String host)

Get the accessible IP Address for the host.

Parameters:

host -

Returns:

the ip address

getOpenPort

@Deprecated
public static int getOpenPort()

Deprecated. use getPreferredOpenPort() instead

Get an open port on the local machine in the port range between and .

Returns:

the port

getOpenPortWithinRange

public static int getOpenPortWithinRange(int rangeStart,
                                         int rangeEnd)

Return an available port on the local machine in the inclusive range from rangeStart to rangeEnd.

Use this method when callers must constrain selection to a specific port range while still relying on Networking to enforce availability.

Parameters:

rangeStart - the first port in the allowed range (inclusive)

rangeEnd - the last port in the allowed range (inclusive)

Returns:

an available port in the specified range

Throws:

IllegalArgumentException - if rangeStart <= 0, rangeEnd < rangeStart, or rangeEnd >

getPreferredOpenPort

public static int getPreferredOpenPort()

Return an available port on the local machine in the preferred range.

Returns:

an available port between 16384 and 32767

isLocalHost

public static boolean isLocalHost(String host)

Return true if the host belongs to the local machine.

Parameters:

host -

Returns:

true if the host is local