Class AFUNIXSocketChannel

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

org.newsclub.net.unix.AFUNIXSocketChannel

All Implemented Interfaces:

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

public final class AFUNIXSocketChannel
extends AFSocketChannel<AFUNIXSocketAddress>
implements AFUNIXSocketExtensions

A selectable channel for stream-oriented connecting sockets.

Author:

Christian Kohlschütter

Nested Class Summary

Nested classes/interfaces inherited from class AFSocketChannel

AFSocketChannel.AFSocketSupplier<A>

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

Method Summary

Modifier and Type	Method	Description
void	clearReceivedFileDescriptors()	Clears the queue of incoming FileDescriptors that were sent as ancillary messages.
AFUNIXSocketCredentials	getPeerCredentials()	Retrieves the "peer credentials" for this connection.
FileDescriptor[]	getReceivedFileDescriptors()	Retrieves an array of incoming FileDescriptors that were sent as ancillary messages, along with a call to InputStream.read(), etc.
boolean	hasOutboundFileDescriptors()	Returns true if there are pending file descriptors to be sent as part of an ancillary message.
static AFUNIXSocketChannel	open()	Opens a socket channel.
static AFUNIXSocketChannel	open(SocketAddress remote)	Opens a socket channel, connecting to the given socket address.
void	setOutboundFileDescriptors(FileDescriptor... fdescs)	Sets a list of FileDescriptors that should be sent as an ancillary message along with the next write.

Methods inherited from class AFSocketChannel

bind, connect, ensureAncillaryReceiveBufferSize, finishConnect, getAFSocket, getAncillaryReceiveBufferSize, getFileDescriptor, getLocalAddress, getLocalSocketAddress, getOption, getRemoteAddress, getRemoteSocketAddress, implCloseSelectableChannel, implConfigureBlocking, isConnected, isConnectionPending, open, open, open, read, read, setAncillaryReceiveBufferSize, setOption, setShutdownOnClose, shutdownInput, shutdownOutput, socket, supportedOptions, toString, write, write

Modifier and Type	Method	Description
final AFSocketChannel<AFUNIXSocketAddress>	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<AFUNIXSocketAddress>	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 AFUNIXSocketAddress	getLocalAddress()
final AFUNIXSocketAddress	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 AFUNIXSocketAddress	getRemoteAddress()
final AFUNIXSocketAddress	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<AFUNIXSocketAddress>	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<AFUNIXSocketAddress>	shutdownInput()
final AFSocketChannel<AFUNIXSocketAddress>	shutdownOutput()
final AFSocket<AFUNIXSocketAddress>	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 SocketChannel

read, validOps, write

Methods inherited from class AbstractSelectableChannel

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

Methods inherited from class SelectableChannel

register

Methods inherited from class AbstractInterruptibleChannel

begin, close, end, isOpen

Methods inherited from class Object

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

Methods inherited from interface AFSomeSocketChannel

configureBlocking, isBlocking

Modifier and Type	Method	Description
SelectableChannel	configureBlocking(boolean block)	Adjusts this channel's blocking mode.
boolean	isBlocking()	Checks if the channel is configured blocking.

Method Details

open

public static AFUNIXSocketChannel open()
                                throws IOException

Opens a socket channel.

Returns:

The new channel

Throws:

IOException - on error.

open

public static AFUNIXSocketChannel open(SocketAddress remote)
                                throws IOException

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

Parameters:

remote - The socket address to connect to.

Returns:

The new channel

Throws:

IOException - on error.

getReceivedFileDescriptors

public FileDescriptor[] getReceivedFileDescriptors()
                                            throws IOException

Description copied from interface: AFUNIXSocketExtensions

Retrieves an array of incoming FileDescriptors that were sent as ancillary messages, along with a call to InputStream.read(), etc. NOTE: Another call to this method will not return the same file descriptors again (most likely, an empty array will be returned).

Specified by:

getReceivedFileDescriptors in interface AFUNIXSocketExtensions

Returns:

The file descriptors, or an empty array if none were available.

Throws:

IOException - if the operation fails.

clearReceivedFileDescriptors

public void clearReceivedFileDescriptors()

Description copied from interface: AFUNIXSocketExtensions

Clears the queue of incoming FileDescriptors that were sent as ancillary messages.

Specified by:

clearReceivedFileDescriptors in interface AFUNIXSocketExtensions

setOutboundFileDescriptors

public void setOutboundFileDescriptors(FileDescriptor... fdescs)
                                throws IOException

Description copied from interface: AFUNIXSocketExtensions

Sets a list of FileDescriptors that should be sent as an ancillary message along with the next write. Important: There can only be one set of file descriptors active until the write completes. The socket also needs to be connected for this operation to succeed. It is also important to know that there may be an upper limit imposed by the operation system as to how many file descriptors can be sent at once. Linux, for example, may support up to 253. If the number of file descriptors exceeds the limit, an exception may be thrown when sending data along with the ancillary message containing the file descriptors.

Specified by:

setOutboundFileDescriptors in interface AFUNIXSocketExtensions

Parameters:

fdescs - The file descriptors, or null if none.

Throws:

IOException - if the operation fails.

hasOutboundFileDescriptors

public boolean hasOutboundFileDescriptors()

Description copied from interface: AFUNIXSocketExtensions

Returns true if there are pending file descriptors to be sent as part of an ancillary message.

Specified by:

hasOutboundFileDescriptors in interface AFUNIXSocketExtensions

Returns:

true if there are file descriptors pending.

getPeerCredentials

public AFUNIXSocketCredentials getPeerCredentials()
                                           throws IOException

Description copied from interface: AFUNIXSocketExtensions

Retrieves the "peer credentials" for this connection. These credentials may be useful to authenticate the other end of the socket (client or server). Depending on the socket/connection/environment, you may not receive any or all credentials. For example, on Linux, AFUNIXDatagramSocket and AFUNIXDatagramChannel may not be able to retrieve credentials at all.

Specified by:

getPeerCredentials in interface AFUNIXSocketExtensions

Returns:

The peer's credentials, or null if they couldn't be retrieved.

Throws:

IOException - If there was an error returning these credentials.