Module org.newsclub.net.unix

Package org.newsclub.net.unix

Class AFServerSocketChannel<A extends AFSocketAddress>

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.SelectableChannel

java.nio.channels.spi.AbstractSelectableChannel

java.nio.channels.ServerSocketChannel

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

Type Parameters:

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

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, InterruptibleChannel, NetworkChannel, AFSomeSocketChannel, AFSomeSocketThing, FileDescriptorAccess

Direct Known Subclasses:

AFUNIXServerSocketChannel

public abstract class AFServerSocketChannel<A extends AFSocketAddress>
extends ServerSocketChannel
implements FileDescriptorAccess, AFSomeSocketChannel

A selectable channel for stream-oriented listening sockets.

Author:

Christian Kohlschütter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AFServerSocketChannel(AFServerSocket<A> socket, AFSelectorProvider<A> sp)	Creates a new AFServerSocketChannel instance.

Method Summary

Modifier and Type	Method	Description
AFSocketChannel<A>	accept()
final AFServerSocketChannel<A>	bind(SocketAddress local, int backlog)
final FileDescriptor	getFileDescriptor()	Returns the corresponding FileDescriptor.
final @Nullable A	getLocalAddress()
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)
protected final void	implCloseSelectableChannel()
protected final void	implConfigureBlocking(boolean block)
final boolean	isDeleteOnClose()	Checks if this AFServerSocketChannel's file should be removed upon AbstractInterruptibleChannel.close().
final boolean	isLocalSocketAddressValid()	Checks if the local socket address returned by getLocalAddress() is still valid.
static ServerSocketChannel	open(ProtocolFamily family)	Opens a server-socket channel.
final void	setDeleteOnClose(boolean b)	Enables/disables deleting this AFServerSocketChannel's file (or other resource type) upon AbstractInterruptibleChannel.close().
<T> AFServerSocketChannel<A>	setOption(SocketOption<T> name, T value)
void	setShutdownOnClose(boolean enabled)	Configures whether the socket should be shutdown upon Closeable.close(), which is the default.
final AFServerSocket<A>	socket()
final Set<SocketOption<?>>	supportedOptions()

Methods inherited from class java.nio.channels.ServerSocketChannel

bind, open, validOps

Methods inherited from class java.nio.channels.spi.AbstractSelectableChannel

blockingLock, configureBlocking, implCloseChannel, isBlocking, isRegistered, keyFor, provider, register

Methods inherited from class java.nio.channels.SelectableChannel

register

Methods inherited from class java.nio.channels.spi.AbstractInterruptibleChannel

begin, close, end, isOpen

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.newsclub.net.unix.AFSomeSocketChannel

configureBlocking, isBlocking

Methods inherited from interface java.nio.channels.Channel

isOpen

Methods inherited from interface java.nio.channels.InterruptibleChannel

close

Constructor Details

AFServerSocketChannel

protected AFServerSocketChannel(AFServerSocket<A> socket,
 AFSelectorProvider<A> sp)

Creates a new AFServerSocketChannel instance.

Parameters:

socket - The corresponding ServerSocket.

sp - The corresponding SelectorProvider.

Method Details

getOption

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

Specified by:

getOption in interface NetworkChannel

Throws:

IOException

setOption

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

Specified by:

setOption in interface NetworkChannel

Specified by:

setOption in class ServerSocketChannel

Throws:

IOException

supportedOptions

public final Set<SocketOption<?>> supportedOptions()

Specified by:

supportedOptions in interface NetworkChannel

bind

public final AFServerSocketChannel<A> bind(SocketAddress local,
 int backlog)
                                    throws IOException

Specified by:

bind in class ServerSocketChannel

Throws:

IOException

socket

public final AFServerSocket<A> socket()

Specified by:

socket in class ServerSocketChannel

accept

public AFSocketChannel<A> accept()
                          throws IOException

Specified by:

accept in class ServerSocketChannel

Throws:

IOException

getLocalAddress

public final @Nullable A getLocalAddress()

Specified by:

getLocalAddress in interface NetworkChannel

Specified by:

getLocalAddress in class ServerSocketChannel

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

Returns:

The local socket address, or null.

isLocalSocketAddressValid

public final boolean isLocalSocketAddressValid()

Checks if the local socket address returned by getLocalAddress() 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.

implCloseSelectableChannel

protected final void implCloseSelectableChannel()
                                         throws IOException

Specified by:

implCloseSelectableChannel in class AbstractSelectableChannel

Throws:

IOException

implConfigureBlocking

protected final void implConfigureBlocking(boolean block)
                                    throws IOException

Specified by:

implConfigureBlocking in class AbstractSelectableChannel

Throws:

IOException

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.

isDeleteOnClose

public final boolean isDeleteOnClose()

Checks if this AFServerSocketChannel's file should be removed upon AbstractInterruptibleChannel.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 AbstractInterruptibleChannel.close().

setDeleteOnClose

public final void setDeleteOnClose(boolean b)

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

Parameters:

b - Enabled if true.

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.

open

public static ServerSocketChannel open(ProtocolFamily family)
                                throws IOException

Opens a server-socket channel. The family parameter specifies the protocol family of the channel's socket.

If the ProtocolFamily is of an AFProtocolFamily, or UNIX, the corresponding junixsocket implementation is used. In all other cases, the call is delegated to ServerSocketChannel.open().

Parameters:

family - The protocol family.

Returns:

The new ServerSocketChannel.

Throws:

IOException - on error.