Class AFTIPCSocket

java.lang.Object

java.net.Socket

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

org.newsclub.net.unix.tipc.AFTIPCSocket

All Implemented Interfaces:

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

public final class AFTIPCSocket
extends AFSocket<AFTIPCSocketAddress>
implements AFTIPCSocketExtensions

Implementation of an AF_TIPC socket.

Author:

Christian Kohlschütter

Nested Class Summary

Nested classes/interfaces inherited from class AFSocket

AFSocket.Constructor<A>

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

Method Summary

Modifier and Type	Method	Description
static AFTIPCSocket	connectTo(AFTIPCSocketAddress addr)	Creates a new AFSocket and connects it to the given AFTIPCSocketAddress.
AFTIPCSocketChannel	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.
static String	getLinkName(int peerId, int bearerId)	Retrieves the link name given a node hash and a bearer ID.
static byte[]	getNodeIdentity(int peerId)	Retrieves the 16-byte node ID given a node hash.
byte[]	getNodeIdentity(AFTIPCSocketAddress address)	Retrieves the TIPC node identity given the node hash of the given address.
static String	getNodeIdHexString(int peerId)	Retrieves the node ID given a node hash, as a hexadecimal string.
static boolean	isSupported()	Returns true iff AFTIPCSockets (sockets of type "AF_TIPC") are supported by the current Java VM and the kernel.
static void	main(String[] args)	Very basic self-test function.
protected AFTIPCSocketChannel	newChannel()	Creates a new AFSocketChannel for this socket.
static AFTIPCSocket	newInstance()	Creates a new, unbound AFSocket.
static AFTIPCSocket	newStrictInstance()	Creates a new, unbound, "strict" AFSocket.

Methods inherited from class AFSocket

addCloseable, bind, checkConnectionClosed, close, connect, connect, connectHook, connectTo, connectTo, ensureAncillaryReceiveBufferSize, ensureSupported, ensureUnsafeSupported, forceConnectAddress, getAncillaryReceiveBufferSize, getFileDescriptor, getImplExtensions, getInputStream, getLoadedLibrary, getLocalSocketAddress, getOutputStream, getRemoteSocketAddress, getVersion, isBound, isClosed, isConnected, isRunningOnAndroid, newInstance, removeCloseable, setAncillaryReceiveBufferSize, setShutdownOnClose, socketAddressClass, supports, supports, toString

Modifier and Type	Method	Description
final void	addCloseable(Closeable closeable)	Registers a Closeable that should be closed when this socket is closed.
final void	bind(SocketAddress bindpoint)	Not fully supported, since it's not necessary for client sockets.
boolean	checkConnectionClosed()	Probes the status of the socket connection.
final void	close()
final void	connect(SocketAddress endpoint)
final void	connect(SocketAddress endpoint, int timeout)
final AFSocket<AFTIPCSocketAddress>	connectHook(SocketAddressFilter hook)	Sets the hook for any subsequent call to AFSocket.connect(SocketAddress) or AFSocket.connect(SocketAddress, int) to be the given function.
static final <A extends AFSocketAddress> AFSocket<?>	connectTo(@NonNull A addr)	Creates a new AFSocket and connects it to the given AFSocketAddress using the default implementation suited for that address type.
protected static final <A extends AFSocketAddress> @NonNull AFSocket<A>	connectTo(AFSocket.Constructor<A> constr, A addr)	Creates a new AFSocket and connects it to the given AFSocketAddress.
final void	ensureAncillaryReceiveBufferSize(int minSize)	Ensures a minimum ancillary receive buffer size.
static void	ensureSupported()	Checks if AFSockets are supported by the current Java VM.
static final void	ensureUnsafeSupported()	Checks if the current environment (system platform, native library, etc.) supports "unsafe" operations (as controlled via the AFSocketCapability.CAPABILITY_UNSAFE capability).
final AFSocket<AFTIPCSocketAddress>	forceConnectAddress(SocketAddress endpoint)	Forces the address to be used for any subsequent call to AFSocket.connect(SocketAddress) to be the given one, regardless of what'll be passed there.
final int	getAncillaryReceiveBufferSize()	Returns the size of the receive buffer for ancillary messages (in bytes).
final FileDescriptor	getFileDescriptor()	Returns the corresponding FileDescriptor.
protected final AFSocketImplExtensions<AFTIPCSocketAddress>	getImplExtensions()	Returns the internal helper instance for address-specific extensions.
final AFInputStream	getInputStream()
static final String	getLoadedLibrary()	Returns an identifier of the loaded native library, or null if the library hasn't been loaded yet.
final AFTIPCSocketAddress	getLocalSocketAddress()	Returns the socket's local socket address, or null if unavailable or if there was a problem retrieving it.
final AFOutputStream	getOutputStream()
final AFTIPCSocketAddress	getRemoteSocketAddress()	Returns the socket's remote socket address, or null if unavailable/not connected, or if there was a problem retrieving it.
static final String	getVersion()	Returns the version of the junixsocket library, as a string, for debugging purposes.
final boolean	isBound()
final boolean	isClosed()
final boolean	isConnected()
static boolean	isRunningOnAndroid()	Checks if we're running on Android (as far as junixsocket is concerned).
protected static final <A extends AFSocketAddress> AFSocket<A>	newInstance(AFSocket.Constructor<A> constr, AFSocketFactory<A> factory)	Creates a new, unbound AFSocket.
final void	removeCloseable(Closeable closeable)	Unregisters a previously registered Closeable.
final void	setAncillaryReceiveBufferSize(int size)	Sets the size of the receive buffer for ancillary messages (in bytes).
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.
static final boolean	supports(AFSocketCapability capability)	Checks if the current environment (system platform, native library, etc.) supports a given junixsocket capability.
static final boolean	supports(AFUNIXSocketCapability capability)	Deprecated.
final String	toString()

Methods inherited from class Socket

getInetAddress, getKeepAlive, getLocalAddress, getLocalPort, getOOBInline, getOption, getPort, getReceiveBufferSize, getReuseAddress, getSendBufferSize, getSoLinger, getSoTimeout, getTcpNoDelay, getTrafficClass, isInputShutdown, isOutputShutdown, sendUrgentData, setKeepAlive, setOOBInline, setOption, setPerformancePreferences, setReceiveBufferSize, setReuseAddress, setSendBufferSize, setSocketImplFactory, setSoLinger, setSoTimeout, setTcpNoDelay, setTrafficClass, shutdownInput, shutdownOutput, supportedOptions

Methods inherited from class Object

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

Method Details

isSupported

public static boolean isSupported()

Returns true iff AFTIPCSockets (sockets of type "AF_TIPC") are supported by the current Java VM and the kernel. To support AFTIPCSockets, a custom JNI library must be loaded that is supplied with junixsocket, and the system must support AF_TIPC sockets. This call is equivalent to checking AFSocket.isSupported() and AFSocket.supports(AFSocketCapability) with AFSocketCapability.CAPABILITY_TIPC.

Returns:

true iff supported.

newChannel

protected AFTIPCSocketChannel newChannel()

Description copied from class: AFSocket

Creates a new AFSocketChannel for this socket.

Specified by:

newChannel in class AFSocket<AFTIPCSocketAddress>

Returns:

The new instance.

newInstance

public static AFTIPCSocket newInstance()
                                throws IOException

Creates a new, unbound AFSocket. This "default" implementation is a bit "lenient" with respect to the specification. In particular, we ignore calls to Socket.getTcpNoDelay() and Socket.setTcpNoDelay(boolean).

Returns:

A new, unbound socket.

Throws:

IOException - if the operation fails.

newStrictInstance

public static AFTIPCSocket newStrictInstance()
                                      throws IOException

Creates a new, unbound, "strict" AFSocket. This call uses an implementation that tries to be closer to the specification than newInstance(), at least for some cases.

Returns:

A new, unbound socket.

Throws:

IOException - if the operation fails.

connectTo

public static AFTIPCSocket connectTo(AFTIPCSocketAddress addr)
                              throws IOException

Creates a new AFSocket and connects it to the given AFTIPCSocketAddress.

Parameters:

addr - The address to connect to.

Returns:

A new, connected socket.

Throws:

IOException - if the operation fails.

getChannel

public AFTIPCSocketChannel getChannel()

Overrides:

getChannel in class AFSocket<AFTIPCSocketAddress>

main

public static void main(String[] args)

Very basic self-test function. Prints "supported" and "capabilities" status to System.out.

Parameters:

args - ignored.

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.

getNodeIdentity

public static byte[] getNodeIdentity(int peerId)
                              throws IOException

Retrieves the 16-byte node ID given a node hash.

Parameters:

peerId - The node hash.

Returns:

The node ID, or null if unsupported.

Throws:

IOException - on error.

getNodeIdentity

public byte[] getNodeIdentity(AFTIPCSocketAddress address)
                       throws IOException

Retrieves the TIPC node identity given the node hash of the given address.

Parameters:

address - The address.

Returns:

The node identity, or null if unsupported.

Throws:

IOException - on error.

getNodeIdHexString

public static String getNodeIdHexString(int peerId)
                                 throws IOException

Retrieves the node ID given a node hash, as a hexadecimal string.

Parameters:

peerId - The node hash.

Returns:

The node ID, or null if unsupported.

Throws:

IOException - on error.

getLinkName

public static String getLinkName(int peerId,
 int bearerId)
                          throws IOException

Retrieves the link name given a node hash and a bearer ID.

Parameters:

peerId - The node hash.

bearerId - The bearer Id.

Returns:

The link name, or null if unsupported.

Throws:

IOException - on error.