Module org.newsclub.net.unix

Package org.newsclub.net.unix

Class AFSocketChannel<A extends AFSocketAddress>

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.SelectableChannel

java.nio.channels.spi.AbstractSelectableChannel

java.nio.channels.SocketChannel

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

Type Parameters:

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

All Implemented Interfaces:

Closeable, AutoCloseable, ByteChannel, Channel, GatheringByteChannel, InterruptibleChannel, NetworkChannel, ReadableByteChannel, ScatteringByteChannel, WritableByteChannel, AFSocketExtensions, AFSomeSocket, AFSomeSocketChannel, AFSomeSocketThing, FileDescriptorAccess

Direct Known Subclasses:

AFSYSTEMSocketChannel, AFTIPCSocketChannel, AFUNIXSocketChannel, AFVSOCKSocketChannel

public abstract class AFSocketChannel<A extends AFSocketAddress>
extends SocketChannel
implements AFSomeSocket, AFSocketExtensions, AFSomeSocketChannel

A selectable channel for stream-oriented connecting sockets.

Author:

Christian Kohlschütter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AFSocketChannel.AFSocketSupplier<A extends AFSocketAddress>	A reference to a method that provides an AFSocket instance.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AFSocketChannel(AFSocket<A> socket, AFSelectorProvider<A> sp)	Creates a new socket channel for the given socket, using the given SelectorProvider.

Method Summary

Modifier and Type	Method	Description
final AFSocketChannel<A>	bind(SocketAddress local)
final boolean	connect(SocketAddress remote)
final void	ensureAncillaryReceiveBufferSize(int minSize)	Ensures a minimum ancillary receive buffer size.
final boolean	finishConnect()
protected final AFSocket<A>	getAFSocket()	Returns the corresponding AFSocket.
final int	getAncillaryReceiveBufferSize()	Returns the size of the receive buffer for ancillary messages (in bytes).
final FileDescriptor	getFileDescriptor()	Returns the corresponding FileDescriptor.
final A	getLocalAddress()
final A	getLocalSocketAddress()	Returns the socket's local socket address, or null if unavailable or if there was a problem retrieving it.
final <T> T	getOption(SocketOption<T> name)
final A	getRemoteAddress()
final A	getRemoteSocketAddress()	Returns the socket's remote socket address, or null if unavailable/not connected, or if there was a problem retrieving it.
protected final void	implCloseSelectableChannel()
protected final void	implConfigureBlocking(boolean block)
final boolean	isConnected()
final boolean	isConnectionPending()
static SocketChannel	open(ProtocolFamily family)	Opens a socket channel.
protected static final <A extends AFSocketAddress> AFSocketChannel<A>	open(AFSocketChannel.AFSocketSupplier<A> supplier)	Opens a socket channel.
protected static final <A extends AFSocketAddress> AFSocketChannel<A>	open(AFSocketChannel.AFSocketSupplier<A> supplier, SocketAddress remote)	Opens a socket channel, connecting to the given socket address.
final int	read(ByteBuffer dst)
final long	read(ByteBuffer[] dsts, int offset, int length)
final void	setAncillaryReceiveBufferSize(int size)	Sets the size of the receive buffer for ancillary messages (in bytes).
final <T> AFSocketChannel<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 AFSocketChannel<A>	shutdownInput()
final AFSocketChannel<A>	shutdownOutput()
final AFSocket<A>	socket()
final Set<SocketOption<?>>	supportedOptions()
final String	toString()
final int	write(ByteBuffer src)
final long	write(ByteBuffer[] srcs, int offset, int length)

Methods inherited from class java.nio.channels.SocketChannel

open, open, read, validOps, write

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, 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

AFSocketChannel

protected AFSocketChannel(AFSocket<A> socket,
 AFSelectorProvider<A> sp)

Creates a new socket channel for the given socket, using the given SelectorProvider.

Parameters:

socket - The socket.

sp - The SelectorProvider.

Method Details

getAFSocket

protected final AFSocket<A> getAFSocket()

Returns the corresponding AFSocket.

Returns:

The corresponding socket.

open

protected static final <A extends AFSocketAddress>
AFSocketChannel<A> open(AFSocketChannel.AFSocketSupplier<A> supplier)
                 throws IOException

Opens a socket channel.

Type Parameters:

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

Parameters:

supplier - The AFSocketChannel constructor.

Returns:

The new channel

Throws:

IOException - on error.

open

protected static final <A extends AFSocketAddress>
AFSocketChannel<A> open(AFSocketChannel.AFSocketSupplier<A> supplier,
 SocketAddress remote)
                 throws IOException

Opens a socket channel, connecting to the given socket address.

Type Parameters:

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

Parameters:

supplier - The AFSocketChannel constructor.

remote - The socket address to connect to.

Returns:

The new channel

Throws:

IOException - on error.

getOption

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

Specified by:

getOption in interface NetworkChannel

Throws:

IOException

setOption

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

Specified by:

setOption in interface NetworkChannel

Specified by:

setOption in class SocketChannel

Throws:

IOException

supportedOptions

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

Specified by:

supportedOptions in interface NetworkChannel

bind

public final AFSocketChannel<A> bind(SocketAddress local)
                              throws IOException

Specified by:

bind in interface NetworkChannel

Specified by:

bind in class SocketChannel

Throws:

IOException

shutdownInput

public final AFSocketChannel<A> shutdownInput()
                                       throws IOException

Specified by:

shutdownInput in class SocketChannel

Throws:

IOException

shutdownOutput

public final AFSocketChannel<A> shutdownOutput()
                                        throws IOException

Specified by:

shutdownOutput in class SocketChannel

Throws:

IOException

socket

public final AFSocket<A> socket()

Specified by:

socket in class SocketChannel

isConnected

public final boolean isConnected()

Specified by:

isConnected in class SocketChannel

isConnectionPending

public final boolean isConnectionPending()

Specified by:

isConnectionPending in class SocketChannel

connect

public final boolean connect(SocketAddress remote)
                      throws IOException

Specified by:

connect in class SocketChannel

Throws:

IOException

finishConnect

public final boolean finishConnect()
                            throws IOException

Specified by:

finishConnect in class SocketChannel

Throws:

IOException

getRemoteAddress

public final A getRemoteAddress()
                         throws IOException

Specified by:

getRemoteAddress in class SocketChannel

Throws:

IOException

getRemoteSocketAddress

public final A getRemoteSocketAddress()

Description copied from interface: AFSomeSocket

Returns the socket's remote socket address, or null if unavailable/not connected, or if there was a problem retrieving it.

Specified by:

getRemoteSocketAddress in interface AFSomeSocket

Returns:

The remote socket address, or null.

read

public final int read(ByteBuffer dst)
               throws IOException

Specified by:

read in interface ReadableByteChannel

Specified by:

read in class SocketChannel

Throws:

IOException

read

public final long read(ByteBuffer[] dsts,
 int offset,
 int length)
                throws IOException

Specified by:

read in interface ScatteringByteChannel

Specified by:

read in class SocketChannel

Throws:

IOException

write

public final long write(ByteBuffer[] srcs,
 int offset,
 int length)
                 throws IOException

Specified by:

write in interface GatheringByteChannel

Specified by:

write in class SocketChannel

Throws:

IOException

write

public final int write(ByteBuffer src)
                throws IOException

Specified by:

write in interface WritableByteChannel

Specified by:

write in class SocketChannel

Throws:

IOException

getLocalAddress

public final A getLocalAddress()
                        throws IOException

Specified by:

getLocalAddress in interface NetworkChannel

Specified by:

getLocalAddress in class SocketChannel

Throws:

IOException

getLocalSocketAddress

public final 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.

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

getAncillaryReceiveBufferSize

public final int getAncillaryReceiveBufferSize()

Description copied from interface: AFSocketExtensions

Returns the size of the receive buffer for ancillary messages (in bytes).

Specified by:

getAncillaryReceiveBufferSize in interface AFSocketExtensions

Returns:

The size.

setAncillaryReceiveBufferSize

public final void setAncillaryReceiveBufferSize(int size)

Description copied from interface: AFSocketExtensions

Sets the size of the receive buffer for ancillary messages (in bytes). To disable handling ancillary messages, set it to 0 (default).

Specified by:

setAncillaryReceiveBufferSize in interface AFSocketExtensions

Parameters:

size - The size.

ensureAncillaryReceiveBufferSize

public final void ensureAncillaryReceiveBufferSize(int minSize)

Description copied from interface: AFSocketExtensions

Ensures a minimum ancillary receive buffer size.

Specified by:

ensureAncillaryReceiveBufferSize in interface AFSocketExtensions

Parameters:

minSize - The minimum size (in bytes).

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.

toString

public final String toString()

Overrides:

toString in class Object

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 SocketChannel open(ProtocolFamily family)
                          throws IOException

Opens a 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 SocketChannel.open().

Parameters:

family - The protocol family.

Returns:

The new SocketChannel.

Throws:

IOException - on error.