freenet.io

Class NetworkInterface

java.lang.Object

freenet.io.NetworkInterface

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

SSLNetworkInterface

public class NetworkInterface
extends java.lang.Object
implements java.io.Closeable

Replacement for ServerSocket that can handle multiple bind addresses and allows IP address level filtering.

Field Summary

Fields

Modifier and Type	Field and Description
protected AllowedHosts	allowedHosts AllowedHosts structure
static java.lang.String	DEFAULT_BIND_TO

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NetworkInterface(int port, java.lang.String allowedHosts, Executor executor) Creates a new network interface that can bind to several addresses and allows connection filtering on IP address level.

Method Summary

Modifier and Type	Method and Description
java.net.Socket	accept() Waits for a connection.
void	close() Closes this interface and all underlying server sockets.
static NetworkInterface	create(int port, java.lang.String bindTo, java.lang.String allowedHosts, Executor executor, boolean ignoreUnbindableIP6)
protected java.net.ServerSocket	createServerSocket()
java.lang.String	getAllowedHosts()
boolean	isBound()
void	setAllowedHosts(java.lang.String allowedHosts)
java.lang.String[]	setBindTo(java.lang.String bindTo, boolean ignoreUnbindableIP6) Sets the list of IP address this network interface binds to.
void	setSoTimeout(int timeout) Sets the SO_TIMEOUT value on the server sockets.
void	waitBound()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BIND_TO

public static final java.lang.String DEFAULT_BIND_TO

See Also:

Constant Field Values

allowedHosts

protected final AllowedHosts allowedHosts

AllowedHosts structure

Constructor Detail

NetworkInterface

protected NetworkInterface(int port,
                           java.lang.String allowedHosts,
                           Executor executor)
                    throws java.io.IOException

Creates a new network interface that can bind to several addresses and allows connection filtering on IP address level.

Parameters:

bindTo - A comma-separated list of addresses to bind to

allowedHosts - A comma-separated list of allowed addresses

Throws:

java.io.IOException

Method Detail

create

public static NetworkInterface create(int port,
                                      java.lang.String bindTo,
                                      java.lang.String allowedHosts,
                                      Executor executor,
                                      boolean ignoreUnbindableIP6)
                               throws java.io.IOException

Throws:

java.io.IOException

createServerSocket

protected java.net.ServerSocket createServerSocket()
                                            throws java.io.IOException

Throws:

java.io.IOException

setBindTo

public java.lang.String[] setBindTo(java.lang.String bindTo,
                                    boolean ignoreUnbindableIP6)

Sets the list of IP address this network interface binds to.

Parameters:

bindTo - A comma-separated list of IP address to bind to

Returns:

List of addresses that we failed to bind to, or null if completely successful.

setAllowedHosts

public void setAllowedHosts(java.lang.String allowedHosts)

setSoTimeout

public void setSoTimeout(int timeout)
                  throws java.net.SocketException

Sets the SO_TIMEOUT value on the server sockets.

Parameters:

timeout - The timeout in milliseconds, 0 to disable

Throws:

java.net.SocketException - if the SO_TIMEOUT value can not be set

See Also:

ServerSocket.setSoTimeout(int)

accept

public java.net.Socket accept()

Waits for a connection. If a timeout has been set using setSoTimeout(int) and no connection is established this method will return after the specified timeout has been expired, throwing a SocketTimeoutException. If no timeout has been set this method will wait until a connection has been established.

Returns:

The socket that is connected to the client or null if the timeout has expired waiting for a connection

close

public void close()
           throws java.io.IOException

Closes this interface and all underlying server sockets.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if an I/O exception occurs

See Also:

ServerSocket.close()

getAllowedHosts

public java.lang.String getAllowedHosts()

isBound

public boolean isBound()

waitBound

public void waitBound()