org.apache.flink.runtime.net

Class NetUtils

java.lang.Object

org.apache.flink.runtime.net.NetUtils

public class NetUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
NetUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addStaticResolution(String host, String resolvedName) Adds a static resolution for host.
static void	connect(Socket socket, SocketAddress endpoint, int timeout)
static InetSocketAddress	createSocketAddr(String target) Util method to build socket addr from either: : ://:/
static InetSocketAddress	createSocketAddr(String target, int defaultPort) Util method to build socket addr from either: : ://:/
static List<String[]>	getAllStaticResolutions() This is used to get all the resolutions that were added using addStaticResolution(String, String).
static InetSocketAddress	getConnectAddress(Server server) Returns InetSocketAddress that a client can use to connect to the server.
static SocketFactory	getDefaultSocketFactory()
static InputStream	getInputStream(Socket socket) Same as getInputStream(socket, socket.getSoTimeout()). From documentation for getInputStream(Socket, long): Returns InputStream for the socket.
static InputStream	getInputStream(Socket socket, long timeout) Returns InputStream for the socket.
static OutputStream	getOutputStream(Socket socket) Same as getOutputStream(socket, 0).
static OutputStream	getOutputStream(Socket socket, long timeout) Returns OutputStream for the socket.
static SocketFactory	getSocketFactory()
static String	getStaticResolution(String host) Retrieves the resolved name for the passed host.
static String	normalizeHostName(String name) Given a string representation of a host, return its ip address in textual presentation.
static List<String>	normalizeHostNames(Collection<String> names) Given a collection of string representation of hosts, return a list of corresponding IP addresses in the textual representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetUtils

public NetUtils()

Method Detail

getSocketFactory

public static SocketFactory getSocketFactory()

getDefaultSocketFactory

public static SocketFactory getDefaultSocketFactory()

createSocketAddr

public static InetSocketAddress createSocketAddr(String target)

Util method to build socket addr from either: : ://:/

createSocketAddr

public static InetSocketAddress createSocketAddr(String target,
                                 int defaultPort)

Util method to build socket addr from either: : ://:/

addStaticResolution

public static void addStaticResolution(String host,
                       String resolvedName)

Adds a static resolution for host. This can be used for setting up hostnames with names that are fake to point to a well known host. For e.g. in some testcases we require to have daemons with different hostnames running on the same machine. In order to create connections to these daemons, one can set up mappings from those hostnames to "localhost". getStaticResolution(String) can be used to query for the actual hostname.

Parameters:

host -

resolvedName -

getStaticResolution

public static String getStaticResolution(String host)

Retrieves the resolved name for the passed host. The resolved name must have been set earlier using addStaticResolution(String, String)

Parameters:

host -

Returns:

the resolution

getAllStaticResolutions

public static List<String[]> getAllStaticResolutions()

This is used to get all the resolutions that were added using addStaticResolution(String, String). The return value is a List each element of which contains an array of String of the form String[0]=hostname, String[1]=resolved-hostname

Returns:

the list of resolutions

getConnectAddress

public static InetSocketAddress getConnectAddress(Server server)

Returns InetSocketAddress that a client can use to connect to the server. Server.getListenerAddress() is not correct when the server binds to "0.0.0.0". This returns "127.0.0.1:port" when the getListenerAddress() returns "0.0.0.0:port".

Parameters:

server -

Returns:

socket address that a client can use to connect to the server.

getInputStream

public static InputStream getInputStream(Socket socket)
                                  throws IOException

Same as getInputStream(socket, socket.getSoTimeout()).

From documentation for getInputStream(Socket, long):
Returns InputStream for the socket. If the socket has an associated SocketChannel then it returns a SocketInputStream with the given timeout. If the socket does not have a channel, Socket.getInputStream() is returned. In the later case, the timeout argument is ignored and the timeout set with Socket.setSoTimeout(int) applies for reads.

Any socket created using socket factories returned by NetUtils(), must use this interface instead of Socket.getInputStream().

Parameters:

socket -

Returns:

InputStream for reading from the socket.

Throws:

IOException

See Also:

getInputStream(Socket, long)

getInputStream

public static InputStream getInputStream(Socket socket,
                         long timeout)
                                  throws IOException

Returns InputStream for the socket. If the socket has an associated SocketChannel then it returns a SocketInputStream with the given timeout. If the socket does not have a channel, Socket.getInputStream() is returned. In the later case, the timeout argument is ignored and the timeout set with Socket.setSoTimeout(int) applies for reads.

Any socket created using socket factories returned by NetUtils(), must use this interface instead of Socket.getInputStream().

Parameters:

socket -

timeout - timeout in milliseconds. This may not always apply. zero for waiting as long as necessary.

Returns:

InputStream for reading from the socket.

Throws:

IOException

See Also:

Socket.getChannel()

getOutputStream

public static OutputStream getOutputStream(Socket socket)
                                    throws IOException

Same as getOutputStream(socket, 0). Timeout of zero implies write will wait until data is available.

From documentation for getOutputStream(Socket, long) :
Returns OutputStream for the socket. If the socket has an associated SocketChannel then it returns a SocketOutputStream with the given timeout. If the socket does not have a channel, Socket.getOutputStream() is returned. In the later case, the timeout argument is ignored and the write will wait until data is available.

Any socket created using socket factories returned by NetUtils(), must use this interface instead of Socket.getOutputStream().

Parameters:

socket -

Returns:

OutputStream for writing to the socket.

Throws:

IOException

See Also:

getOutputStream(Socket, long)

getOutputStream

public static OutputStream getOutputStream(Socket socket,
                           long timeout)
                                    throws IOException

Returns OutputStream for the socket. If the socket has an associated SocketChannel then it returns a SocketOutputStream with the given timeout. If the socket does not have a channel, Socket.getOutputStream() is returned. In the later case, the timeout argument is ignored and the write will wait until data is available.

Any socket created using socket factories returned by NetUtils(), must use this interface instead of Socket.getOutputStream().

Parameters:

socket -

timeout - timeout in milliseconds. This may not always apply. zero for waiting as long as necessary.

Returns:

OutputStream for writing to the socket.

Throws:

IOException

See Also:

Socket.getChannel()

connect

public static void connect(Socket socket,
           SocketAddress endpoint,
           int timeout)
                    throws IOException

Throws:

IOException

normalizeHostName

public static String normalizeHostName(String name)

Given a string representation of a host, return its ip address in textual presentation.

Parameters:

name - a string representation of a host: either a textual representation its IP address or its host name

Returns:

its IP address in the string format

normalizeHostNames

public static List<String> normalizeHostNames(Collection<String> names)

Given a collection of string representation of hosts, return a list of corresponding IP addresses in the textual representation.

Parameters:

names - a collection of string representations of hosts

Returns:

a list of corresponding IP addresses in the string format

See Also:

normalizeHostName(String)