Module org.newsclub.net.unix.tipc

Package org.newsclub.net.unix.tipc

Class AFTIPCDatagramSocket

java.lang.Object

java.net.DatagramSocket

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

org.newsclub.net.unix.tipc.AFTIPCDatagramSocket

All Implemented Interfaces:

Closeable, AutoCloseable, AFSocketExtensions, AFSomeSocket, AFSomeSocketThing, FileDescriptorAccess, AFTIPCSocketExtensions

public final class AFTIPCDatagramSocket
extends AFDatagramSocket<AFTIPCSocketAddress>
implements AFTIPCSocketExtensions

A DatagramSocket implementation that works with AF_TIPC sockets.

Author:

Christian Kohlschütter

Nested Class Summary

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

AFDatagramSocket.Constructor<A extends AFSocketAddress>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TIPC_MAX_USER_MSG_SIZE	The maximum size for user messages.

Method Summary

Modifier and Type	Method	Description
AFTIPCDatagramChannel	getChannel()
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.
<T> T	getOption(SocketOption<T> name)
protected AFTIPCDatagramChannel	newChannel()	Creates a new DatagramChannel that is associated with this socket.
protected AFDatagramSocket<AFTIPCSocketAddress>	newDatagramSocketInstance()	Returns a new AFDatagramSocket instance to be used for AFDatagramSocket.accept(), i.e., no FileDescriptor is associated.
static AFTIPCDatagramSocket	newInstance()	Returns a new AFTIPCDatagramSocket instance, using the default AFSocketType.SOCK_DGRAM socket type.
static AFTIPCDatagramSocket	newInstance(AFSocketType socketType)	Returns a new AFTIPCDatagramSocket instance for the given socket type.
<T> DatagramSocket	setOption(SocketOption<T> name, T value)

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

Field Details

TIPC_MAX_USER_MSG_SIZE

public static final int TIPC_MAX_USER_MSG_SIZE

The maximum size for user messages.

See Also:

• Constant Field Values

Method Details

newChannel

protected AFTIPCDatagramChannel newChannel()

Description copied from class: AFDatagramSocket

Creates a new DatagramChannel that is associated with this socket.

Specified by:

newChannel in class AFDatagramSocket<AFTIPCSocketAddress>

Returns:

The channel.

newInstance

public static AFTIPCDatagramSocket newInstance()
                                        throws IOException

Returns a new AFTIPCDatagramSocket instance, using the default AFSocketType.SOCK_DGRAM socket type.

Returns:

The new instance.

Throws:

IOException - on error.

newInstance

public static AFTIPCDatagramSocket newInstance(AFSocketType socketType)
                                        throws IOException

Returns a new AFTIPCDatagramSocket instance for the given socket type.

Parameters:

socketType - The socket type.

Returns:

The new instance.

Throws:

IOException - on error.

getChannel

public AFTIPCDatagramChannel getChannel()

Overrides:

getChannel in class AFDatagramSocket<AFTIPCSocketAddress>

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.

newDatagramSocketInstance

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

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