Class AFUNIXServerSocket

java.lang.Object

java.net.ServerSocket

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

org.newsclub.net.unix.AFUNIXServerSocket

All Implemented Interfaces:

Closeable, AutoCloseable, AFSomeSocketThing, FileDescriptorAccess

public final class AFUNIXServerSocket
extends AFServerSocket<AFUNIXSocketAddress>

The server part of an AF_UNIX domain socket.

Author:

Christian Kohlschütter

Nested Class Summary

Nested classes/interfaces inherited from class AFServerSocket

AFServerSocket.Constructor<A>

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	AFUNIXServerSocket()	Constructs a new, unconnected instance.

Method Summary

Modifier and Type	Method	Description
AFUNIXSocket	accept()
static AFUNIXServerSocket	bindOn(File path, boolean deleteOnClose)	Returns a new AF_UNIX ServerSocket that is bound to the given path.
static AFUNIXServerSocket	bindOn(Path path, boolean deleteOnClose)	Returns a new AF_UNIX ServerSocket that is bound to the given path.
static AFUNIXServerSocket	bindOn(AFUNIXSocketAddress addr)	Returns a new AF_UNIX ServerSocket that is bound to the given AFUNIXSocketAddress.
static AFUNIXServerSocket	bindOn(AFUNIXSocketAddress addr, boolean deleteOnClose)	Returns a new AF_UNIX ServerSocket that is bound to the given AFSocketAddress.
static AFUNIXServerSocket	forceBindOn(AFUNIXSocketAddress forceAddr)	Returns a new, unbound AF_UNIX ServerSocket that will always bind to the given address, regardless of any socket address used in a call to bind.
AFUNIXServerSocketChannel	getChannel()
protected AFUNIXServerSocketChannel	newChannel()	Creates a new AFServerSocketChannel for this socket.
protected AFSocketImpl<AFUNIXSocketAddress>	newImpl(FileDescriptor fdObj)	Creates a new AFSocketImpl.
static AFUNIXServerSocket	newInstance()	Returns a new, unbound AF_UNIX ServerSocket.
protected AFUNIXSocket	newSocketInstance()	Returns a new AFSocket instance.

Methods inherited from class AFServerSocket

addCloseable, addressFamily, bind, bind, bindHook, bindOn, bindOn, close, forceBindAddress, forceBindOn, getFileDescriptor, getInetAddress, getLocalPort, getLocalSocketAddress, getOption, getReceiveBufferSize, getReuseAddress, getSoTimeout, isBound, isClosed, isDeleteOnClose, isLocalSocketAddressValid, isSupported, newInstance, newInstance, removeCloseable, setDeleteOnClose, setOption, setPerformancePreferences, setReceiveBufferSize, setReuseAddress, setShutdownOnClose, setSoTimeout, supportedOptions, toString

Modifier and Type	Method	Description
final void	addCloseable(Closeable closeable)	Registers a Closeable that should be closed when this socket is closed.
protected final AFAddressFamily<AFUNIXSocketAddress>	addressFamily()	Returns the address family supported by this implementation.
final void	bind(SocketAddress endpoint)
final void	bind(SocketAddress endpoint, int backlog)
final AFServerSocket<AFUNIXSocketAddress>	bindHook(SocketAddressFilter hook)	Sets the hook for any subsequent call to AFServerSocket.bind(SocketAddress) and AFServerSocket.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<AFUNIXSocketAddress>	forceBindAddress(SocketAddress endpoint)	Forces the address to be used for any subsequent call to AFServerSocket.bind(SocketAddress) to be the given one, regardless of what'll be passed to AFServerSocket.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.
final FileDescriptor	getFileDescriptor()	Returns the corresponding FileDescriptor.
InetAddress	getInetAddress()
final int	getLocalPort()
final AFUNIXSocketAddress	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 AFServerSocket.close().
boolean	isLocalSocketAddressValid()	Checks if the local socket address returned by AFServerSocket.getLocalSocketAddress() is still valid.
static boolean	isSupported()	Checks whether everything is setup to support junixsocket sockets.
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.
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 AFServerSocket.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 ServerSocket

implAccept, setSocketFactory

Methods inherited from class Object

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

Constructor Details

AFUNIXServerSocket

protected AFUNIXServerSocket()
                      throws IOException

Constructs a new, unconnected instance.

Throws:

IOException - if the operation fails.

Method Details

newChannel

protected AFUNIXServerSocketChannel newChannel()

Description copied from class: AFServerSocket

Creates a new AFServerSocketChannel for this socket.

Specified by:

newChannel in class AFServerSocket<AFUNIXSocketAddress>

Returns:

The new instance.

getChannel

public AFUNIXServerSocketChannel getChannel()

Overrides:

getChannel in class AFServerSocket<AFUNIXSocketAddress>

newInstance

public static AFUNIXServerSocket newInstance()
                                      throws IOException

Returns a new, unbound AF_UNIX ServerSocket.

Returns:

The new, unbound AFServerSocket.

Throws:

IOException - if the operation fails.

bindOn

public static AFUNIXServerSocket bindOn(AFUNIXSocketAddress addr)
                                 throws IOException

Returns a new AF_UNIX ServerSocket that is bound to the given AFUNIXSocketAddress.

Parameters:

addr - The socket file to bind to.

Returns:

The new, bound AFServerSocket.

Throws:

IOException - if the operation fails.

bindOn

public static AFUNIXServerSocket bindOn(AFUNIXSocketAddress addr,
 boolean deleteOnClose)
                                 throws IOException

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

Parameters:

addr - The socket file to bind to.

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

Returns:

The new, bound AFServerSocket.

Throws:

IOException - if the operation fails.

bindOn

public static AFUNIXServerSocket bindOn(File path,
 boolean deleteOnClose)
                                 throws IOException

Returns a new AF_UNIX ServerSocket that is bound to the given path.

Parameters:

path - The path to bind to.

deleteOnClose - If true, the socket file will be deleted upon AFServerSocket.close().

Returns:

The new, bound AFServerSocket.

Throws:

IOException - if the operation fails.

bindOn

public static AFUNIXServerSocket bindOn(Path path,
 boolean deleteOnClose)
                                 throws IOException

Returns a new AF_UNIX ServerSocket that is bound to the given path.

Parameters:

path - The path to bind to.

deleteOnClose - If true, the socket file will be deleted upon AFServerSocket.close().

Returns:

The new, bound AFServerSocket.

Throws:

IOException - if the operation fails.

forceBindOn

public static AFUNIXServerSocket forceBindOn(AFUNIXSocketAddress forceAddr)
                                      throws IOException

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

Parameters:

forceAddr - The address to use.

Returns:

The new, yet unbound AFServerSocket.

Throws:

IOException - if an exception occurs.

newImpl

protected AFSocketImpl<AFUNIXSocketAddress> newImpl(FileDescriptor fdObj)
                                             throws SocketException

Description copied from class: AFServerSocket

Creates a new AFSocketImpl.

Specified by:

newImpl in class AFServerSocket<AFUNIXSocketAddress>

Parameters:

fdObj - The file descriptor.

Returns:

The new instance.

Throws:

SocketException

newSocketInstance

protected AFUNIXSocket newSocketInstance()
                                  throws IOException

Returns a new AFSocket instance.

Specified by:

newSocketInstance in class AFServerSocket<AFUNIXSocketAddress>

Returns:

The new instance.

Throws:

IOException - on error.

accept

public AFUNIXSocket accept()
                    throws IOException

Overrides:

accept in class AFServerSocket<AFUNIXSocketAddress>

Throws:

IOException