Module org.newsclub.net.unix

Package org.newsclub.net.unix

Class AFDatagramSocket<A extends AFSocketAddress>

java.lang.Object

java.net.DatagramSocket

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

Type Parameters:

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

All Implemented Interfaces:

Closeable, AutoCloseable, AFSocketExtensions, AFSomeSocket, AFSomeSocketThing, FileDescriptorAccess

Direct Known Subclasses:

AFUNIXDatagramSocket

public abstract class AFDatagramSocket<A extends AFSocketAddress>
extends DatagramSocket
implements AFSomeSocket, AFSocketExtensions

A DatagramSocket implementation that works with junixsocket.

Author:

Christian Kohlschütter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AFDatagramSocket.Constructor<A extends AFSocketAddress>	A reference to the constructor of an AFDatagramSocket subclass.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AFDatagramSocket(AFDatagramSocketImpl<A> impl)	Creates a new AFDatagramSocket instance.

Method Summary

Modifier and Type	Method	Description
AFDatagramSocket<A>	accept()	Accepts a connection to this socket.
protected final AFAddressFamily<A>	addressFamily()	Returns the address family supported by this implementation.
final void	bind(SocketAddress addr)
final void	close()
final void	connect(InetAddress address, int port)
final void	connect(SocketAddress addr)
final void	ensureAncillaryReceiveBufferSize(int minSize)	Ensures a minimum ancillary receive buffer size.
final int	getAncillaryReceiveBufferSize()	Returns the size of the receive buffer for ancillary messages (in bytes).
AFDatagramChannel<A>	getChannel()
final FileDescriptor	getFileDescriptor()	Returns the corresponding FileDescriptor.
protected AFSocketImplExtensions<A>	getImplExtensions()	Returns the internal helper instance for address-specific extensions.
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)
<T> T	getOption(AFSocketOption<T> name)	Returns the value of a junixsocket socket option.
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.
final boolean	isBound()
final boolean	isClosed()
final boolean	isConnected()
final boolean	isDeleteOnClose()	Checks if this AFDatagramSocket's bound filename should be removed upon close().
final void	listen(int backlog)	Sets this socket into "listen" state, which allows subsequent calls to accept() receive any connection attempt.
protected abstract AFDatagramChannel<A>	newChannel()	Creates a new DatagramChannel that is associated with this socket.
protected abstract AFDatagramSocket<A>	newDatagramSocketInstance()	Returns a new AFDatagramSocket instance to be used for accept(), i.e., no FileDescriptor is associated.
protected static final <A extends AFSocketAddress> AFDatagramSocket<A>	newInstance(AFDatagramSocket.Constructor<A> constructor)	Returns a new AFDatagramSocket instance.
protected static final <A extends AFSocketAddress> AFDatagramSocket<A>	newInstance(AFDatagramSocket.Constructor<A> constructor, FileDescriptor fdObj, int localPort, int remotePort)	Creates a new AFDatagramSocket.
final void	peek(DatagramPacket p)	Reads the next received packet without actually removing it from the queue.
final void	receive(DatagramPacket p)
final void	send(DatagramPacket p)
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 AFDatagramSocket's bound filename upon close().
<T> DatagramSocket	setOption(SocketOption<T> name, T value)
<T> DatagramSocket	setOption(AFSocketOption<T> name, T value)	Sets the value of a socket option.
void	setShutdownOnClose(boolean enabled)	Configures whether the socket should be shutdown upon Closeable.close(), which is the default.
protected final Class<? extends AFSocketAddress>	socketAddressClass()	Returns the AFSocketAddress type supported by this socket.

Methods inherited from class java.net.DatagramSocket

disconnect, getBroadcast, getInetAddress, getLocalAddress, getLocalPort, getPort, getReceiveBufferSize, getReuseAddress, getSendBufferSize, getSoTimeout, getTrafficClass, joinGroup, leaveGroup, setBroadcast, setDatagramSocketImplFactory, setReceiveBufferSize, setReuseAddress, setSendBufferSize, setSoTimeout, setTrafficClass, supportedOptions

Methods inherited from class java.lang.Object

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

Constructor Details

AFDatagramSocket

protected AFDatagramSocket(AFDatagramSocketImpl<A> impl)

Creates a new AFDatagramSocket instance.

Parameters:

impl - The corresponding SocketImpl class.

Method Details

newChannel

protected abstract AFDatagramChannel<A> newChannel()

Creates a new DatagramChannel that is associated with this socket.

Returns:

The channel.

socketAddressClass

protected final Class<? extends AFSocketAddress> socketAddressClass()

Returns the AFSocketAddress type supported by this socket.

Returns:

The supported AFSocketAddress.

newInstance

protected static final <A extends AFSocketAddress>
AFDatagramSocket<A> newInstance(AFDatagramSocket.Constructor<A> constructor)
                         throws IOException

Returns a new AFDatagramSocket instance.

Type Parameters:

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

Parameters:

constructor - The supplying constructor.

Returns:

The new instance.

Throws:

IOException - on error.

newInstance

protected static final <A extends AFSocketAddress>
AFDatagramSocket<A> newInstance(AFDatagramSocket.Constructor<A> constructor,
 FileDescriptor fdObj,
 int localPort,
 int remotePort)
                         throws IOException

Creates a new AFDatagramSocket.

Type Parameters:

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

Parameters:

constructor - The supplying constructor.

fdObj - The file descriptor.

localPort - The local port.

remotePort - The remote port.

Returns:

The new instance.

Throws:

IOException - on error.

connect

public final void connect(InetAddress address,
 int port)

Overrides:

connect in class DatagramSocket

peek

public final void peek(DatagramPacket p)
                throws IOException

Reads the next received packet without actually removing it from the queue. In other words, once a packet is received, calling this method multiple times in a row will not have further effects on the packet contents. This call still blocks until at least one packet has been received and added to the queue.

Parameters:

p - The packet.

Throws:

IOException - on error.

send

public final void send(DatagramPacket p)
                throws IOException

Overrides:

send in class DatagramSocket

Throws:

IOException

connect

public final void connect(SocketAddress addr)
                   throws SocketException

Overrides:

connect in class DatagramSocket

Throws:

SocketException

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

Overrides:

getRemoteSocketAddress in class DatagramSocket

Returns:

The remote socket address, or null.

isConnected

public final boolean isConnected()

Overrides:

isConnected in class DatagramSocket

isBound

public final boolean isBound()

Overrides:

isBound in class DatagramSocket

close

public final void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class DatagramSocket

bind

public final void bind(SocketAddress addr)
                throws SocketException

Overrides:

bind in class DatagramSocket

Throws:

SocketException

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

Overrides:

getLocalSocketAddress in class DatagramSocket

Returns:

The local socket address, or null.

isDeleteOnClose

public final boolean isDeleteOnClose()

Checks if this AFDatagramSocket's bound filename should be removed upon 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 close().

setDeleteOnClose

public final void setDeleteOnClose(boolean b)

Enables/disables deleting this AFDatagramSocket's bound filename upon close(). Deletion is not guaranteed, especially when not supported (e.g., addresses in the abstract namespace).

Parameters:

b - Enabled if true.

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

isClosed

public final boolean isClosed()

Overrides:

isClosed in class DatagramSocket

getChannel

public AFDatagramChannel<A> getChannel()

Overrides:

getChannel in class DatagramSocket

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.

receive

public final void receive(DatagramPacket p)
                   throws IOException

Overrides:

receive in class DatagramSocket

Throws:

IOException

addressFamily

protected final AFAddressFamily<A> addressFamily()

Returns the address family supported by this implementation.

Returns:

The family.

getImplExtensions

protected AFSocketImplExtensions<A> getImplExtensions()

Returns the internal helper instance for address-specific extensions.

Returns:

The helper instance.

Throws:

UnsupportedOperationException - if such extensions are not supported for this address type.

getOption

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

Returns the value of a junixsocket socket option.

Type Parameters:

T - The type of the socket option value.

Parameters:

name - The socket option.

Returns:

The value of the socket option.

Throws:

IOException - on error.

setOption

public <T> DatagramSocket setOption(AFSocketOption<T> name,
 T value)
                             throws IOException

Sets the value of a socket option.

Type Parameters:

T - The type of the socket option value.

Parameters:

name - The socket option.

value - The value of the socket option.

Returns:

this DatagramSocket.

Throws:

IOException - on error.

accept

public AFDatagramSocket<A> accept()
                           throws IOException

Accepts a connection to this socket. Note that 1., the socket must be in listen state by calling bind(SocketAddress), followed by listen(int), and 2., the socket type must allow listen/accept. This is true for AFSocketType.SOCK_SEQPACKET AF_UNIX sockets, for example.

Returns:

The accepted datagram socket.

Throws:

IOException - on error.

See Also:

• listen(int)

listen

public final void listen(int backlog)
                  throws IOException

Sets this socket into "listen" state, which allows subsequent calls to accept() receive any connection attempt. Note that 1., the socket must be bound to a local address using bind(SocketAddress), and 2., the socket type must allow listen/accept. This is true for AFSocketType.SOCK_SEQPACKET AF_UNIX sockets, for example.

Parameters:

backlog - The backlog, or 0 for default.

Throws:

IOException - on error.

newDatagramSocketInstance

protected abstract AFDatagramSocket<A> newDatagramSocketInstance()
                                                          throws IOException

Returns a new AFDatagramSocket instance to be used for accept(), i.e., no FileDescriptor is associated.

Returns:

The new instance.

Throws:

IOException - on error.

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.

getOption

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

Overrides:

getOption in class DatagramSocket

Throws:

IOException

setOption

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

Overrides:

setOption in class DatagramSocket

Throws:

IOException