Class AFTIPCSocketChannel

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

org.newsclub.net.unix.tipc.AFTIPCSocketChannel

All Implemented Interfaces:

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

public final class AFTIPCSocketChannel
extends AFSocketChannel<AFTIPCSocketAddress>
implements AFTIPCSocketExtensions

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
AFTIPCDestName	getDestName()	Returns the TIPC "DestName" information from the ancillary receive buffer (if any was set), or null if no DestName was retrieved.
AFTIPCErrInfo	getErrInfo()	Returns the TIPC "ErrInfo" information from the ancillary receive buffer (if any was set), or null if no error was retrieved.
static AFTIPCSocketChannel	open()	Opens a datagram channel.

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<AFTIPCSocketAddress>	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<AFTIPCSocketAddress>	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 AFTIPCSocketAddress	getLocalAddress()
final AFTIPCSocketAddress	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 AFTIPCSocketAddress	getRemoteAddress()
final AFTIPCSocketAddress	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<AFTIPCSocketAddress>	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<AFTIPCSocketAddress>	shutdownInput()
final AFSocketChannel<AFTIPCSocketAddress>	shutdownOutput()
final AFSocket<AFTIPCSocketAddress>	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

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

getErrInfo

public AFTIPCErrInfo getErrInfo()

Description copied from interface: AFTIPCSocketExtensions

Returns the TIPC "ErrInfo" information from the ancillary receive buffer (if any was set), or null if no error was retrieved.

Specified by:

getErrInfo in interface AFTIPCSocketExtensions

Returns:

The ErrInfo.

getDestName

public AFTIPCDestName getDestName()

Description copied from interface: AFTIPCSocketExtensions

Returns the TIPC "DestName" information from the ancillary receive buffer (if any was set), or null if no DestName was retrieved.

Specified by:

getDestName in interface AFTIPCSocketExtensions

Returns:

The service address or range (without scope) that was specified by the sender of the message.

open

public static AFTIPCSocketChannel open()
                                throws IOException

Opens a datagram channel.

Returns:

The new channel

Throws:

IOException - if an I/O error occurs