Class AFSYSTEMSocketAddress

java.lang.Object

java.net.SocketAddress

java.net.InetSocketAddress

org.newsclub.net.unix.AFSocketAddress

org.newsclub.net.unix.AFSYSTEMSocketAddress

All Implemented Interfaces:

Serializable

public final class AFSYSTEMSocketAddress
extends AFSocketAddress

An AFSocketAddress for AF_SYSTEM sockets.

Author:

Christian Kohlschütter

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AFSYSTEMSocketAddress.SysAddr	The AF_SYSTEM system address.

Nested classes/interfaces inherited from class AFSocketAddress

AFSocketAddress.AFSocketAddressConstructor<T>

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

Method Summary

Modifier and Type	Method	Description
static AFAddressFamily<AFSYSTEMSocketAddress>	addressFamily()	Returns the corresponding AFAddressFamily.
File	getFile()	Returns the File corresponding with this address, if possible.
int	getId()	Returns the "id" part of the address.
@NonNull AFSYSTEMSocketAddress.SysAddr	getSysAddr()	Returns the "SysAddr" part of the address.
int	getUnit()	Returns the "unit" part of the address.
boolean	hasFilename()	Checks if the address can be resolved to a File.
static boolean	isSupportedAddress(InetAddress addr)	Checks if an InetAddress can be unwrapped to an AFSYSTEMSocketAddress.
static boolean	isSupportedAddress(SocketAddress addr)	Checks if a SocketAddress can be unwrapped to an AFSYSTEMSocketAddress.
static AFSYSTEMSocketAddress	of(URI uri)	Returns an AFSYSTEMSocketAddress for the given URI, if possible.
static AFSYSTEMSocketAddress	of(URI uri, int overridePort)	Returns an AFSYSTEMSocketAddress for the given URI, if possible.
static AFSYSTEMSocketAddress	ofSysAddrIdUnit(int javaPort, AFSYSTEMSocketAddress.SysAddr sysAddr, int id, int unit)	Returns an AFSYSTEMSocketAddress that refers to a given AF_SYSTEM socket address (i.e., referring to a particular socket instance instead of a service address).
static AFSYSTEMSocketAddress	ofSysAddrIdUnit(AFSYSTEMSocketAddress.SysAddr sysAddr, int id, int unit)	Returns an AFSYSTEMSocketAddress that refers to a given AF_SYSTEM socket address (i.e., referring to a particular socket instance instead of a service address).
String	toString()
URI	toURI(String scheme, URI template)	Tries to create a URI based on this AFSocketAddress.
static AFSYSTEMSocketAddress	unwrap(String hostname, int port)	Returns an AFSYSTEMSocketAddress given a special InetAddress hostname that encodes the byte sequence of an AF_SYSTEM socket address, like those returned by AFSocketAddress.wrapAddress().
static AFSYSTEMSocketAddress	unwrap(InetAddress address, int port)	Returns an AFSYSTEMSocketAddress given a special InetAddress that encodes the byte sequence of an AF_SYSTEM socket address, like those returned by AFSocketAddress.wrapAddress().
static AFSYSTEMSocketAddress	unwrap(SocketAddress address)	Returns an AFSYSTEMSocketAddress given a generic SocketAddress.

Methods inherited from class AFSocketAddress

canMap, canMap, covers, getAddressFamily, getBytes, getInetAddress, getInetAddress, getInetAddress, getSocketAddress, isSupportedAddress, isUseDeserializationForInit, mapOrFail, mapOrFail, newBoundServerSocket, newConnectedSocket, newDeserializedAFSocketAddress, newForceBoundServerSocket, parseUnsignedInt, resolveAddress, toSocatAddressString, unwrap, unwrap, wrapAddress, writeNativeAddressTo

Modifier and Type	Method	Description
static boolean	canMap(SocketAddress addr)	Checks if the given SocketAddress can be mapped to an AFSocketAddress.
static boolean	canMap(SocketAddress addr, Class<? extends AFSocketAddress> targetAddressClass)	Checks if the given SocketAddress can be mapped to a specific AFSocketAddress subclass.
boolean	covers(AFSocketAddress other)	Checks if the given address could cover another address.
final AFAddressFamily<?>	getAddressFamily()	Returns the corresponding AFAddressFamily.
protected final byte[]	getBytes()	Returns the (non-native) byte-level representation of this address.
protected final InetAddress	getInetAddress()	Wraps this address as an InetAddress.
protected static final InetAddress	getInetAddress(FileDescriptor fdesc, boolean peerName, AFAddressFamily<?> af)	Wraps the socket name/peer name of a file descriptor as an InetAddress.
protected final InetAddress	getInetAddress(AFAddressFamily<?> af)	Wraps an address as an InetAddress.
protected static final <A extends AFSocketAddress> @Nullable A	getSocketAddress(FileDescriptor fdesc, boolean requestPeerName, int port, AFAddressFamily<A> af)	Gets the socket name/peer name of a file descriptor as an AFSocketAddress.
protected static final boolean	isSupportedAddress(InetAddress addr, AFAddressFamily<?> af)	Checks if the given address is supported by this address family.
protected static boolean	isUseDeserializationForInit()	Checks if AFSocketAddress instantiation should be performed via deserialization.
static AFSocketAddress	mapOrFail(SocketAddress addr)	Maps the given address to an AFSocketAddress.
static <A extends AFSocketAddress> A	mapOrFail(SocketAddress addr, Class<A> targetAddressClass)	Maps the given address to a specific AFSocketAddress type.
AFServerSocket<?>	newBoundServerSocket()	Creates a new server socket bound to this address.
AFSocket<?>	newConnectedSocket()	Creates a new socket connected to this address.
protected static <A extends AFSocketAddress> A	newDeserializedAFSocketAddress(int port, byte[] socketAddress, ObjectPool.Lease<ByteBuffer> nativeAddress, AFAddressFamily<A> af, AFSocketAddress.AFSocketAddressConstructor<A> constructor)	Returns a new AFSocketAddress instance via deserialization.
AFServerSocket<?>	newForceBoundServerSocket()	Creates a new server socket force-bound to this address (i.e., any additional call to ServerSocket.bind(SocketAddress) will ignore the passed address and use this one instead.
protected static int	parseUnsignedInt(String s, int radix)	Parses the string argument as an unsigned integer in the radix specified by the second argument.
protected static final <A extends AFSocketAddress> A	resolveAddress(byte[] socketAddress, int port, AFAddressFamily<A> af)	Resolves a junixsocket-specific byte-array representation of an AFSocketAddress to an actual AFSocketAddress instance, possibly reusing a cached instance.
@Nullable String	toSocatAddressString(AFSocketType socketType, AFSocketProtocol socketProtocol)	Returns a address string that can be used with socat's SOCKET-CONNECT, SOCKET-LISTEN, SOCKET-DATAGRAM, etc., address types, or null if the address type is not natively supported by this platform.
protected static final <A extends AFSocketAddress> @NonNull A	unwrap(String hostname, int port, AFAddressFamily<A> af)	Returns an AFSocketAddress given a special InetAddress hostname that encodes the byte sequence of an AF_UNIX etc. socket address, like those returned by AFSocketAddress.wrapAddress().
protected static final <A extends AFSocketAddress> @NonNull A	unwrap(InetAddress address, int port, AFAddressFamily<A> af)	Returns an AFSocketAddress given a special InetAddress that encodes the byte sequence of an AF_UNIX etc. socket address, like those returned by AFSocketAddress.wrapAddress().
final InetAddress	wrapAddress()	Returns a "special" InetAddress that contains information about this AFSocketAddress.
final void	writeNativeAddressTo(ByteBuffer buf)	Writes the native (system-level) representation of this address to the given buffer.

Methods inherited from class InetSocketAddress

createUnresolved, equals, getAddress, getHostName, getHostString, getPort, hashCode, isUnresolved

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

ofSysAddrIdUnit

public static AFSYSTEMSocketAddress ofSysAddrIdUnit(int javaPort,
 AFSYSTEMSocketAddress.SysAddr sysAddr,
 int id,
 int unit)
                                             throws SocketException

Returns an AFSYSTEMSocketAddress that refers to a given AF_SYSTEM socket address (i.e., referring to a particular socket instance instead of a service address). A Java-only "IP port number" is stored along the instance for compatibility reasons.

Parameters:

javaPort - The emulated "port" number (not part of AF_SYSTEM).

sysAddr - 16-bit system address (e.g., AF_SYS_KERNCONTROL)

id - Controller unique identifier

unit - Developer private unit number, 0 means "unspecified".

Returns:

A corresponding AFSYSTEMSocketAddress instance.

Throws:

SocketException - if the operation fails.

ofSysAddrIdUnit

public static AFSYSTEMSocketAddress ofSysAddrIdUnit(AFSYSTEMSocketAddress.SysAddr sysAddr,
 int id,
 int unit)
                                             throws SocketException

Returns an AFSYSTEMSocketAddress that refers to a given AF_SYSTEM socket address (i.e., referring to a particular socket instance instead of a service address).

Parameters:

sysAddr - 16-bit system address (e.g., AF_SYS_KERNCONTROL)

id - Controller unique identifier

unit - Developer private unit number

Returns:

A corresponding AFSYSTEMSocketAddress instance.

Throws:

SocketException - if the operation fails.

unwrap

public static AFSYSTEMSocketAddress unwrap(InetAddress address,
 int port)
                                    throws SocketException

Returns an AFSYSTEMSocketAddress given a special InetAddress that encodes the byte sequence of an AF_SYSTEM socket address, like those returned by AFSocketAddress.wrapAddress().

Parameters:

address - The "special" InetAddress.

port - The port (use 0 for "none").

Returns:

The AFSYSTEMSocketAddress instance.

Throws:

SocketException - if the operation fails, for example when an unsupported address is specified.

unwrap

public static AFSYSTEMSocketAddress unwrap(String hostname,
 int port)
                                    throws SocketException

Returns an AFSYSTEMSocketAddress given a special InetAddress hostname that encodes the byte sequence of an AF_SYSTEM socket address, like those returned by AFSocketAddress.wrapAddress().

Parameters:

hostname - The "special" hostname, as provided by InetAddress.getHostName().

port - The port (use 0 for "none").

Returns:

The AFSYSTEMSocketAddress instance.

Throws:

SocketException - if the operation fails, for example when an unsupported address is specified.

unwrap

public static AFSYSTEMSocketAddress unwrap(SocketAddress address)
                                    throws SocketException

Returns an AFSYSTEMSocketAddress given a generic SocketAddress.

Parameters:

address - The address to unwrap.

Returns:

The AFSYSTEMSocketAddress instance.

Throws:

SocketException - if the operation fails, for example when an unsupported address is specified.

toString

public String toString()

Overrides:

toString in class InetSocketAddress

getSysAddr

public @NonNull AFSYSTEMSocketAddress.SysAddr getSysAddr()

Returns the "SysAddr" part of the address.

Returns:

The SysAddr part.

getId

public int getId()

Returns the "id" part of the address.

Returns:

The id part.

getUnit

public int getUnit()

Returns the "unit" part of the address.

Returns:

The unit part.

hasFilename

public boolean hasFilename()

Description copied from class: AFSocketAddress

Checks if the address can be resolved to a File.

Specified by:

hasFilename in class AFSocketAddress

Returns:

true if the address has a filename.

getFile

public File getFile()
             throws FileNotFoundException

Description copied from class: AFSocketAddress

Returns the File corresponding with this address, if possible. A FileNotFoundException is thrown if there is no filename associated with the address, which applies to addresses in the abstract namespace, for example.

Specified by:

getFile in class AFSocketAddress

Returns:

The filename.

Throws:

FileNotFoundException - if the address is not associated with a filename.

isSupportedAddress

public static boolean isSupportedAddress(InetAddress addr)

Checks if an InetAddress can be unwrapped to an AFSYSTEMSocketAddress.

Parameters:

addr - The instance to check.

Returns:

true if so.

See Also:

• AFSocketAddress.wrapAddress()
• unwrap(InetAddress, int)

isSupportedAddress

public static boolean isSupportedAddress(SocketAddress addr)

Checks if a SocketAddress can be unwrapped to an AFSYSTEMSocketAddress.

Parameters:

addr - The instance to check.

Returns:

true if so.

See Also:

• unwrap(InetAddress, int)

addressFamily

public static AFAddressFamily<AFSYSTEMSocketAddress> addressFamily()

Returns the corresponding AFAddressFamily.

Returns:

The address family instance.

of

public static AFSYSTEMSocketAddress of(URI uri)
                                throws SocketException

Returns an AFSYSTEMSocketAddress for the given URI, if possible.

Parameters:

uri - The URI.

Returns:

The address.

Throws:

SocketException - if the operation fails.

of

public static AFSYSTEMSocketAddress of(URI uri,
 int overridePort)
                                throws SocketException

Returns an AFSYSTEMSocketAddress for the given URI, if possible.

Parameters:

uri - The URI.

overridePort - The port to forcibly use, or -1 for "don't override".

Returns:

The address.

Throws:

SocketException - if the operation fails.

toURI

public URI toURI(String scheme,
 URI template)
          throws IOException

Description copied from class: AFSocketAddress

Tries to create a URI based on this AFSocketAddress.

Overrides:

toURI in class AFSocketAddress

Parameters:

scheme - The target scheme.

template - An optional template to reuse certain parameters (e.g., the "path" component for an http request), or null.

Returns:

The URI.

Throws:

IOException - on error.