Module org.newsclub.net.unix

Package org.newsclub.net.unix

Class AFDatagramChannel<A extends AFSocketAddress>

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.SelectableChannel

java.nio.channels.spi.AbstractSelectableChannel

java.nio.channels.DatagramChannel

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

Type Parameters:

A - The supported address type.

All Implemented Interfaces:

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

Direct Known Subclasses:

AFSYSTEMDatagramChannel, AFTIPCDatagramChannel, AFUNIXDatagramChannel, AFVSOCKDatagramChannel

public abstract class AFDatagramChannel<A extends AFSocketAddress>
extends DatagramChannel
implements AFSomeSocket, AFSocketExtensions, AFSomeSocketChannel

A DatagramChannel implementation that works with junixsocket.

Author:

Christian Kohlschütter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AFDatagramChannel(AFSelectorProvider<A> selectorProvider, AFDatagramSocket<A> socket)	Creates a new AFDatagramChannel instance.

Method Summary

Modifier and Type	Method	Description
final AFDatagramChannel<A>	bind(SocketAddress local)
final AFDatagramChannel<A>	connect(SocketAddress remote)
final AFDatagramChannel<A>	disconnect()
final void	ensureAncillaryReceiveBufferSize(int minSize)	Ensures a minimum ancillary receive buffer size.
protected final AFDatagramSocket<A>	getAFSocket()	Returns the corresponding Socket.
final int	getAncillaryReceiveBufferSize()	Returns the size of the receive buffer for ancillary messages (in bytes).
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.
final <T> T	getOption(SocketOption<T> name)
final @Nullable A	getRemoteAddress()
final @Nullable 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	isBound()	Returns the binding state of the socket.
final boolean	isConnected()
final boolean	isDeleteOnClose()	Checks if this DatagramSocket's bound filename should be removed upon AbstractInterruptibleChannel.close().
final MembershipKey	join(InetAddress group, NetworkInterface interf)
final MembershipKey	join(InetAddress group, NetworkInterface interf, InetAddress source)
static DatagramChannel	open(ProtocolFamily family)	Opens a datagram channel.
final int	read(ByteBuffer dst)
final long	read(ByteBuffer[] dsts, int offset, int length)
final A	receive(ByteBuffer dst)
final int	send(ByteBuffer src, SocketAddress target)
final void	setAncillaryReceiveBufferSize(int size)	Sets the size of the receive buffer for ancillary messages (in bytes).
final void	setDeleteOnClose(boolean b)	Enables/disables deleting this DatagramSocket's bound filename upon AbstractInterruptibleChannel.close().
final <T> AFDatagramChannel<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 AFDatagramSocket<A>	socket()
final Set<SocketOption<?>>	supportedOptions()
final int	write(ByteBuffer src)
final long	write(ByteBuffer[] srcs, int offset, int length)

Methods inherited from class java.nio.channels.DatagramChannel

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

Methods inherited from interface java.nio.channels.MulticastChannel

close

Constructor Details

AFDatagramChannel

protected AFDatagramChannel(AFSelectorProvider<A> selectorProvider,
 AFDatagramSocket<A> socket)

Creates a new AFDatagramChannel instance.

Parameters:

selectorProvider - The corresponding SelectorProvider.

socket - The corresponding Socket.

Method Details

getAFSocket

protected final AFDatagramSocket<A> getAFSocket()

Returns the corresponding Socket.

Returns:

The socket.

join

public final MembershipKey join(InetAddress group,
 NetworkInterface interf)
                         throws IOException

Specified by:

join in interface MulticastChannel

Throws:

IOException

join

public final MembershipKey join(InetAddress group,
 NetworkInterface interf,
 InetAddress source)
                         throws IOException

Specified by:

join in interface MulticastChannel

Throws:

IOException

bind

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

Specified by:

bind in interface NetworkChannel

Specified by:

bind in class DatagramChannel

Throws:

IOException

socket

public final AFDatagramSocket<A> socket()

Specified by:

socket in class DatagramChannel

isBound

public final boolean isBound()

Returns the binding state of the socket.

Returns:

true if the socket successfully bound to an address

isConnected

public final boolean isConnected()

Specified by:

isConnected in class DatagramChannel

connect

public final AFDatagramChannel<A> connect(SocketAddress remote)
                                   throws IOException

Specified by:

connect in class DatagramChannel

Throws:

IOException

disconnect

public final AFDatagramChannel<A> disconnect()
                                      throws IOException

Specified by:

disconnect in class DatagramChannel

Throws:

IOException

getRemoteAddress

public final @Nullable A getRemoteAddress()
                                   throws IOException

Specified by:

getRemoteAddress in class DatagramChannel

Throws:

IOException

getRemoteSocketAddress

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

getLocalAddress

public final @Nullable A getLocalAddress()
                                  throws IOException

Specified by:

getLocalAddress in interface NetworkChannel

Specified by:

getLocalAddress in class DatagramChannel

Throws:

IOException

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.

receive

public final A receive(ByteBuffer dst)
                throws IOException

Specified by:

receive in class DatagramChannel

Throws:

IOException

send

public final int send(ByteBuffer src,
 SocketAddress target)
               throws IOException

Specified by:

send in class DatagramChannel

Throws:

IOException

read

public final int read(ByteBuffer dst)
               throws IOException

Specified by:

read in interface ReadableByteChannel

Specified by:

read in class DatagramChannel

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 DatagramChannel

Throws:

IOException

write

public final int write(ByteBuffer src)
                throws IOException

Specified by:

write in interface WritableByteChannel

Specified by:

write in class DatagramChannel

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 DatagramChannel

Throws:

IOException

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).

setOption

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

Specified by:

setOption in interface NetworkChannel

Specified by:

setOption in class DatagramChannel

Throws:

IOException

getOption

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

Specified by:

getOption in interface NetworkChannel

Throws:

IOException

supportedOptions

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

Specified by:

supportedOptions in interface NetworkChannel

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 DatagramSocket's bound filename 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 DatagramSocket's bound filename 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 DatagramChannel open(ProtocolFamily family)
                            throws IOException

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

Parameters:

family - The protocol family.

Returns:

The new DatagramChannel.

Throws:

IOException - on error.