Module org.newsclub.net.unix

Package org.newsclub.net.unix

Class AFServerSocket<A extends AFSocketAddress>

java.lang.Object

java.net.ServerSocket

org.newsclub.net.unix.AFServerSocket<A>

Type Parameters:

A - The concrete AFSocketAddress that is supported by this type.

All Implemented Interfaces:

Closeable, AutoCloseable, AFSomeSocketThing, FileDescriptorAccess

Direct Known Subclasses:

AFUNIXServerSocket

public abstract class AFServerSocket<A extends AFSocketAddress>
extends ServerSocket
implements AFSomeSocketThing

The server part of a junixsocket socket.

Author:

Christian Kohlschütter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AFServerSocket.Constructor<A extends AFSocketAddress>	The constructor of the concrete subclass.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AFServerSocket()	Constructs a new, unconnected instance.
protected	AFServerSocket(FileDescriptor fdObj)	Constructs a new instance, optionally associated with the given file descriptor.

Method Summary

Modifier and Type	Method	Description
AFSocket<A>	accept()
final void	addCloseable(Closeable closeable)	Registers a Closeable that should be closed when this socket is closed.
protected final AFAddressFamily<A>	addressFamily()	Returns the address family supported by this implementation.
void	bind(SocketAddress endpoint)
final void	bind(SocketAddress endpoint, int backlog)
final AFServerSocket<A>	bindHook(SocketAddressFilter hook)	Sets the hook for any subsequent call to bind(SocketAddress) and bind(SocketAddress, int) to be the given function.
protected static <A extends AFSocketAddress> AFServerSocket<A>	bindOn(AFServerSocket.Constructor<A> instanceSupplier, A addr, boolean deleteOnClose)	Returns a new ServerSocket that is bound to the given AFSocketAddress.
protected static <A extends AFSocketAddress> AFServerSocket<A>	bindOn(AFServerSocket.Constructor<A> instanceSupplier, AFSocketAddress addr)	Returns a new ServerSocket that is bound to the given AFSocketAddress.
void	close()
final AFServerSocket<A>	forceBindAddress(SocketAddress endpoint)	Forces the address to be used for any subsequent call to bind(SocketAddress) to be the given one, regardless of what'll be passed to bind(SocketAddress, int), but doesn't bind yet.
protected static <A extends AFSocketAddress> AFServerSocket<A>	forceBindOn(AFServerSocket.Constructor<A> instanceSupplier, A forceAddr)	Returns a new, unbound ServerSocket that will always bind to the given address, regardless of any socket address used in a call to bind.
AFServerSocketChannel<?>	getChannel()
final FileDescriptor	getFileDescriptor()	Returns the corresponding FileDescriptor.
InetAddress	getInetAddress()
final int	getLocalPort()
final @Nullable A	getLocalSocketAddress()	Returns the socket's local socket address, or null if unavailable or if there was a problem retrieving it.
<T> T	getOption(SocketOption<T> name)
int	getReceiveBufferSize()
boolean	getReuseAddress()
int	getSoTimeout()
final boolean	isBound()
final boolean	isClosed()
final boolean	isDeleteOnClose()	Checks if this AFServerSocket's file should be removed upon close().
boolean	isLocalSocketAddressValid()	Checks if the local socket address returned by getLocalSocketAddress() is still valid.
static boolean	isSupported()	Checks whether everything is setup to support junixsocket sockets.
protected abstract AFServerSocketChannel<?>	newChannel()	Creates a new AFServerSocketChannel for this socket.
protected abstract AFSocketImpl<A>	newImpl(FileDescriptor fdObj)	Creates a new AFSocketImpl.
protected static <A extends AFSocketAddress> AFServerSocket<A>	newInstance(AFServerSocket.Constructor<A> instanceSupplier)	Creates a new AFServerSocket instance, using the given subclass constructor.
protected static <A extends AFSocketAddress> AFServerSocket<A>	newInstance(AFServerSocket.Constructor<A> instanceSupplier, FileDescriptor fdObj, int localPort, int remotePort)	Creates a new AFServerSocket instance, using the given subclass constructor.
protected abstract AFSocket<A>	newSocketInstance()	Returns a new AFSocket instance.
final void	removeCloseable(Closeable closeable)	Unregisters a previously registered Closeable.
final void	setDeleteOnClose(boolean b)	Enables/disables deleting this AFServerSocket's file (or other resource type) upon close().
<T> ServerSocket	setOption(SocketOption<T> name, T value)
void	setPerformancePreferences(int connectionTime, int latency, int bandwidth)
void	setReceiveBufferSize(int size)
void	setReuseAddress(boolean on)
void	setShutdownOnClose(boolean enabled)	Configures whether the socket should be shutdown upon Closeable.close(), which is the default.
void	setSoTimeout(int timeout)
Set<SocketOption<?>>	supportedOptions()
String	toString()

Methods inherited from class java.net.ServerSocket

implAccept, setSocketFactory

Methods inherited from class java.lang.Object

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

Constructor Details

AFServerSocket

protected AFServerSocket()
                  throws IOException

Constructs a new, unconnected instance.

Throws:

IOException - if the operation fails.

AFServerSocket

protected AFServerSocket(FileDescriptor fdObj)
                  throws IOException

Constructs a new instance, optionally associated with the given file descriptor.

Parameters:

fdObj - The file descriptor, or null.

Throws:

IOException - if the operation fails.

Method Details

newChannel

protected abstract AFServerSocketChannel<?> newChannel()

Creates a new AFServerSocketChannel for this socket.

Returns:

The new instance.

newImpl

protected abstract AFSocketImpl<A> newImpl(FileDescriptor fdObj)
                                    throws IOException

Creates a new AFSocketImpl.

Parameters:

fdObj - The file descriptor.

Returns:

The new instance.

Throws:

IOException - on error.

newInstance

protected static <A extends AFSocketAddress>
AFServerSocket<A> newInstance(AFServerSocket.Constructor<A> instanceSupplier)
                       throws IOException

Creates a new AFServerSocket instance, using the given subclass constructor.

Type Parameters:

A - The concrete AFSocketAddress that is supported by this type.

Parameters:

instanceSupplier - The subclass constructor.

Returns:

The new instance.

Throws:

IOException - on error.

newInstance

protected static <A extends AFSocketAddress>
AFServerSocket<A> newInstance(AFServerSocket.Constructor<A> instanceSupplier,
 FileDescriptor fdObj,
 int localPort,
 int remotePort)
                       throws IOException

Creates a new AFServerSocket instance, using the given subclass constructor.

Type Parameters:

A - The concrete AFSocketAddress that is supported by this type.

Parameters:

instanceSupplier - The subclass constructor.

fdObj - The file descriptor.

localPort - The local port.

remotePort - The remote port.

Returns:

The new instance.

Throws:

IOException - on error.

bindOn

protected static <A extends AFSocketAddress>
AFServerSocket<A> bindOn(AFServerSocket.Constructor<A> instanceSupplier,
 AFSocketAddress addr)
                  throws IOException

Returns a new ServerSocket that is bound to the given AFSocketAddress.

Type Parameters:

A - The concrete AFSocketAddress that is supported by this type.

Parameters:

instanceSupplier - The constructor of the concrete subclass.

addr - The socket file to bind to.

Returns:

The new, bound AFServerSocket.

Throws:

IOException - if the operation fails.

bindOn

protected static <A extends AFSocketAddress>
AFServerSocket<A> bindOn(AFServerSocket.Constructor<A> instanceSupplier,
 A addr,
 boolean deleteOnClose)
                  throws IOException

Returns a new ServerSocket that is bound to the given AFSocketAddress.

Type Parameters:

A - The concrete AFSocketAddress that is supported by this type.

Parameters:

instanceSupplier - The constructor of the concrete subclass.

addr - The socket file to bind to.

deleteOnClose - If true, the socket file (if the address points to a file) will be deleted upon close().

Returns:

The new, bound AFServerSocket.

Throws:

IOException - if the operation fails.

forceBindOn

protected static <A extends AFSocketAddress>
AFServerSocket<A> forceBindOn(AFServerSocket.Constructor<A> instanceSupplier,
 A forceAddr)
                       throws IOException

Returns a new, unbound ServerSocket that will always bind to the given address, regardless of any socket address used in a call to bind.

Type Parameters:

A - The concrete AFSocketAddress that is supported by this type.

Parameters:

instanceSupplier - The constructor of the concrete subclass.

forceAddr - The address to use.

Returns:

The new, yet unbound AFServerSocket.

Throws:

IOException - if an exception occurs.

forceBindAddress

public final AFServerSocket<A> forceBindAddress(SocketAddress endpoint)

Forces the address to be used for any subsequent call to bind(SocketAddress) to be the given one, regardless of what'll be passed to bind(SocketAddress, int), but doesn't bind yet.

Parameters:

endpoint - The forced endpoint address.

Returns:

This AFServerSocket.

bind

public final void bind(SocketAddress endpoint,
 int backlog)
                throws IOException

Overrides:

bind in class ServerSocket

Throws:

IOException

isBound

public final boolean isBound()

Overrides:

isBound in class ServerSocket

isClosed

public final boolean isClosed()

Overrides:

isClosed in class ServerSocket

accept

public AFSocket<A> accept()
                   throws IOException

Overrides:

accept in class ServerSocket

Throws:

IOException

newSocketInstance

protected abstract AFSocket<A> newSocketInstance()
                                          throws IOException

Returns a new AFSocket instance.

Returns:

The new instance.

Throws:

IOException - on error.

toString

public String toString()

Overrides:

toString in class ServerSocket

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class ServerSocket

Throws:

IOException

addCloseable

public final void addCloseable(Closeable closeable)

Registers a Closeable that should be closed when this socket is closed.

Parameters:

closeable - The closeable.

removeCloseable

public final void removeCloseable(Closeable closeable)

Unregisters a previously registered Closeable.

Parameters:

closeable - The closeable.

isSupported

public static boolean isSupported()

Checks whether everything is setup to support junixsocket sockets.

Returns:

true if supported.

getLocalSocketAddress

public final @Nullable A getLocalSocketAddress()

Description copied from interface: AFSomeSocketThing

Returns the socket's local socket address, or null if unavailable or if there was a problem retrieving it.

Specified by:

getLocalSocketAddress in interface AFSomeSocketThing

Overrides:

getLocalSocketAddress in class ServerSocket

Returns:

The local socket address, or null.

isLocalSocketAddressValid

public boolean isLocalSocketAddressValid()

Checks if the local socket address returned by getLocalSocketAddress() is still valid. The address is no longer valid if the server socket has been closed, null, or another server socket has been bound on that address.

Returns:

true iff still valid.

getLocalPort

public final int getLocalPort()

Overrides:

getLocalPort in class ServerSocket

isDeleteOnClose

public final boolean isDeleteOnClose()

Checks if this AFServerSocket's file should be removed upon close(). Deletion is not guaranteed, especially when not supported (e.g., addresses in the abstract namespace).

Returns:

true if an attempt is made to delete the socket file upon close().

setDeleteOnClose

public final void setDeleteOnClose(boolean b)

Enables/disables deleting this AFServerSocket's file (or other resource type) upon close(). Deletion is not guaranteed, especially when not supported (e.g., addresses in the abstract namespace).

Parameters:

b - Enabled if true.

getChannel

public AFServerSocketChannel<?> getChannel()

Overrides:

getChannel in class ServerSocket

getFileDescriptor

public final FileDescriptor getFileDescriptor()
                                       throws IOException

Description copied from interface: FileDescriptorAccess

Returns the corresponding FileDescriptor.

Specified by:

getFileDescriptor in interface FileDescriptorAccess

Returns:

The corresponding FileDescriptor.

Throws:

IOException - on error.

addressFamily

protected final AFAddressFamily<A> addressFamily()

Returns the address family supported by this implementation.

Returns:

The family.

bindHook

public final AFServerSocket<A> bindHook(SocketAddressFilter hook)

Sets the hook for any subsequent call to bind(SocketAddress) and bind(SocketAddress, int) to be the given function. The function can monitor calls or even alter the endpoint address.

Parameters:

hook - The function that gets called for each bind call.

Returns:

This instance.

bind

public void bind(SocketAddress endpoint)
          throws IOException

Overrides:

bind in class ServerSocket

Throws:

IOException

getInetAddress

public InetAddress getInetAddress()

Overrides:

getInetAddress in class ServerSocket

setReceiveBufferSize

public void setReceiveBufferSize(int size)
                          throws SocketException

Overrides:

setReceiveBufferSize in class ServerSocket

Throws:

SocketException

getReceiveBufferSize

public int getReceiveBufferSize()
                         throws SocketException

Overrides:

getReceiveBufferSize in class ServerSocket

Throws:

SocketException

setSoTimeout

public void setSoTimeout(int timeout)
                  throws SocketException

Overrides:

setSoTimeout in class ServerSocket

Throws:

SocketException

getSoTimeout

public int getSoTimeout()
                 throws IOException

Overrides:

getSoTimeout in class ServerSocket

Throws:

IOException

setReuseAddress

public void setReuseAddress(boolean on)
                     throws SocketException

Overrides:

setReuseAddress in class ServerSocket

Throws:

SocketException

getReuseAddress

public boolean getReuseAddress()
                        throws SocketException

Overrides:

getReuseAddress in class ServerSocket

Throws:

SocketException

setPerformancePreferences

public void setPerformancePreferences(int connectionTime,
 int latency,
 int bandwidth)

Overrides:

setPerformancePreferences in class ServerSocket

getOption

public <T> T getOption(SocketOption<T> name)
                throws IOException

Overrides:

getOption in class ServerSocket

Throws:

IOException

setOption

public <T> ServerSocket setOption(SocketOption<T> name,
 T value)
                           throws IOException

Overrides:

setOption in class ServerSocket

Throws:

IOException

supportedOptions

public Set<SocketOption<?>> supportedOptions()

Overrides:

supportedOptions in class ServerSocket

setShutdownOnClose

public void setShutdownOnClose(boolean enabled)

Description copied from interface: AFSomeSocketThing

Configures whether the socket should be shutdown upon Closeable.close(), which is the default.

Specified by:

setShutdownOnClose in interface AFSomeSocketThing

Parameters:

enabled - true if enabled.