Module org.newsclub.net.unix

Package org.newsclub.net.unix

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 org.newsclub.net.unix.AFServerSocket

AFServerSocket.Constructor<A extends AFSocketAddress>

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 org.newsclub.net.unix.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

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

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