Module org.newsclub.net.unix

Package org.newsclub.net.unix

Class AFUNIXDatagramSocket

java.lang.Object

java.net.DatagramSocket

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

org.newsclub.net.unix.AFUNIXDatagramSocket

All Implemented Interfaces:

Closeable, AutoCloseable, AFSocketExtensions, AFSomeSocket, AFSomeSocketThing, AFUNIXSocketExtensions, FileDescriptorAccess

public final class AFUNIXDatagramSocket
extends AFDatagramSocket<AFUNIXSocketAddress>
implements AFUNIXSocketExtensions

A DatagramSocket implementation that works with AF_UNIX Unix domain sockets.

Author:

Christian Kohlschütter

Nested Class Summary

Nested classes/interfaces inherited from class org.newsclub.net.unix.AFDatagramSocket

AFDatagramSocket.Constructor<A extends AFSocketAddress>

Method Summary

Modifier and Type	Method	Description
void	clearReceivedFileDescriptors()	Clears the queue of incoming FileDescriptors that were sent as ancillary messages.
AFUNIXDatagramChannel	getChannel()
<T> T	getOption(SocketOption<T> name)
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.
protected AFUNIXDatagramChannel	newChannel()	Creates a new DatagramChannel that is associated with this socket.
protected AFDatagramSocket<AFUNIXSocketAddress>	newDatagramSocketInstance()	Returns a new AFDatagramSocket instance to be used for AFDatagramSocket.accept(), i.e., no FileDescriptor is associated.
static AFUNIXDatagramSocket	newInstance()	Returns a new AFUNIXDatagramSocket instance.
static AFUNIXDatagramSocket	newInstance(AFSocketType socketType)	Returns a new AFUNIXDatagramSocket instance for the given socket type.
<T> DatagramSocket	setOption(SocketOption<T> name, T value)
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 org.newsclub.net.unix.AFDatagramSocket

accept, addressFamily, bind, close, connect, connect, ensureAncillaryReceiveBufferSize, getAncillaryReceiveBufferSize, getFileDescriptor, getImplExtensions, getLocalSocketAddress, getOption, getRemoteSocketAddress, isBound, isClosed, isConnected, isDeleteOnClose, listen, newInstance, newInstance, peek, receive, send, setAncillaryReceiveBufferSize, setDeleteOnClose, setOption, setShutdownOnClose, socketAddressClass

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

Methods inherited from interface org.newsclub.net.unix.AFSocketExtensions

ensureAncillaryReceiveBufferSize, getAncillaryReceiveBufferSize, setAncillaryReceiveBufferSize

Method Details

newChannel

protected AFUNIXDatagramChannel newChannel()

Description copied from class: AFDatagramSocket

Creates a new DatagramChannel that is associated with this socket.

Specified by:

newChannel in class AFDatagramSocket<AFUNIXSocketAddress>

Returns:

The channel.

newInstance

public static AFUNIXDatagramSocket newInstance()
                                        throws IOException

Returns a new AFUNIXDatagramSocket instance.

Returns:

The new instance.

Throws:

IOException - on error.

newInstance

public static AFUNIXDatagramSocket newInstance(AFSocketType socketType)
                                        throws IOException

Returns a new AFUNIXDatagramSocket instance for the given socket type.

Parameters:

socketType - The socket type.

Returns:

The new instance.

Throws:

IOException - on error.

getChannel

public AFUNIXDatagramChannel getChannel()

Overrides:

getChannel in class AFDatagramSocket<AFUNIXSocketAddress>

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.

newDatagramSocketInstance

protected AFDatagramSocket<AFUNIXSocketAddress> newDatagramSocketInstance()
                                                                   throws IOException

Description copied from class: AFDatagramSocket

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

Specified by:

newDatagramSocketInstance in class AFDatagramSocket<AFUNIXSocketAddress>

Returns:

The new instance.

Throws:

IOException - on error.

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