Module org.newsclub.net.unix

Package org.newsclub.net.unix

Class AFUNIXDatagramChannel

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

org.newsclub.net.unix.AFUNIXDatagramChannel

All Implemented Interfaces:

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

public final class AFUNIXDatagramChannel
extends AFDatagramChannel<AFUNIXSocketAddress>
implements AFUNIXSocketExtensions

A DatagramChannel implementation that works with AF_UNIX Unix domain sockets.

Author:

Christian Kohlschütter

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 AFUNIXDatagramChannel	open()	Opens a datagram channel.
static AFUNIXDatagramChannel	open(ProtocolFamily family)	Opens a datagram channel.
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.AFDatagramChannel

bind, connect, disconnect, ensureAncillaryReceiveBufferSize, getAFSocket, getAncillaryReceiveBufferSize, getFileDescriptor, getLocalAddress, getLocalSocketAddress, getOption, getRemoteAddress, getRemoteSocketAddress, implCloseSelectableChannel, implConfigureBlocking, isBound, isConnected, isDeleteOnClose, join, join, read, read, receive, send, setAncillaryReceiveBufferSize, setDeleteOnClose, setOption, setShutdownOnClose, socket, supportedOptions, write, write

Methods inherited from class java.nio.channels.DatagramChannel

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

ensureAncillaryReceiveBufferSize, getAncillaryReceiveBufferSize, setAncillaryReceiveBufferSize

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

Method Details

open

public static AFUNIXDatagramChannel open()
                                  throws IOException

Opens a datagram channel.

Returns:

The new channel

Throws:

IOException - if an I/O error occurs

open

public static AFUNIXDatagramChannel open(ProtocolFamily family)
                                  throws IOException

Opens a datagram channel.

Parameters:

family - The protocol family

Returns:

A new datagram channel

Throws:

UnsupportedOperationException - if the specified protocol family is not supported

IOException - if an I/O error occurs

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.