Class AFVSOCKSocketAddress

java.lang.Object

java.net.SocketAddress

java.net.InetSocketAddress

org.newsclub.net.unix.AFSocketAddress

org.newsclub.net.unix.AFVSOCKSocketAddress

All Implemented Interfaces:

Serializable

public final class AFVSOCKSocketAddress
extends AFSocketAddress

An AFSocketAddress for VSOCK sockets.

Author:

Christian Kohlschütter

See Also:

• Serialized Form

Nested Class Summary

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VMADDR_CID_ANY	"Any address for binding".
static final int	VMADDR_CID_HOST	The well-known address of the host.
static final int	VMADDR_CID_HYPERVISOR	Reserved for services built into the hypervisor.
static final int	VMADDR_CID_LOCAL	The well-known address for local communication (loopback).
static final int	VMADDR_PORT_ANY	Any port number for binding.

Method Summary

Modifier and Type	Method	Description
static AFAddressFamily<AFVSOCKSocketAddress>	addressFamily()	Returns the corresponding AFAddressFamily.
boolean	covers(AFSocketAddress covered)	Checks if the given address could cover another address.
File	getFile()	Returns the File corresponding with this address, if possible.
int	getVSOCKCID()	Returns the "VSOCK CID" part of this address.
int	getVSOCKPort()	Returns the "VSOCK port" part of this address.
int	getVSOCKReserved1()	Returns the "VSOCK reserved1" part of this 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 AFVSOCKSocketAddress.
static boolean	isSupportedAddress(SocketAddress addr)	Checks if a SocketAddress can be unwrapped to an AFVSOCKSocketAddress.
static AFVSOCKSocketAddress	of(URI uri)	Returns an AFVSOCKSocketAddress for the given URI, if possible.
static AFVSOCKSocketAddress	of(URI uri, int overridePort)	Returns an AFVSOCKSocketAddress for the given URI, if possible.
static AFVSOCKSocketAddress	ofAnyHostPort()	Returns an AFVSOCKSocketAddress, especially useful for binding, that refers to "any" port on the host; the "java port" is set to -1.
static AFVSOCKSocketAddress	ofAnyHypervisorPort()	Returns an AFVSOCKSocketAddress, especially useful for binding, that refers to "any" port on the hypervisor; the "java port" is set to -1.
static AFVSOCKSocketAddress	ofAnyLocalPort()	Returns an AFVSOCKSocketAddress, especially useful for binding, that refers to "any" port with the local/loopback CID; the "java port" is set to -1.
static AFVSOCKSocketAddress	ofAnyPort()	Returns an AFVSOCKSocketAddress, especially useful for binding, that refers to "any" port and CID; the "java port" is set to -1.
static AFVSOCKSocketAddress	ofHostPort(int port)	Returns an AFVSOCKSocketAddress that refers to a given VSOCK port on the host; the "java port" is set to -1.
static AFVSOCKSocketAddress	ofHypervisorPort(int port)	Returns an AFVSOCKSocketAddress that refers to a given VSOCK port on the hypervisor; the "java port" is set to -1.
static AFVSOCKSocketAddress	ofLocalPort(int port)	Returns an AFVSOCKSocketAddress that refers to the given port with the local/loopback CID; the "java port" is set to -1.
static AFVSOCKSocketAddress	ofPortAndCID(int port, int cid)	Returns an AFVSOCKSocketAddress that refers to a given VSOCK port and CID; the "java port" is set to -1.
static AFVSOCKSocketAddress	ofPortAndCID(int javaPort, int vsockPort, int cid)	Returns an AFVSOCKSocketAddress that refers to a given port and CID.
static AFVSOCKSocketAddress	ofPortWithAnyCID(int port)	Returns an AFVSOCKSocketAddress, especially useful for binding, that refers to the given port with "any CID"; the "java port" is set to -1.
String	toString()
URI	toURI(String scheme, URI template)	Tries to create a URI based on this AFSocketAddress.
static AFVSOCKSocketAddress	unwrap(String hostname, int port)	Returns an AFVSOCKSocketAddress given a special InetAddress hostname that encodes the byte sequence of an AF_VSOCK socket address, like those returned by AFSocketAddress.wrapAddress().
static AFVSOCKSocketAddress	unwrap(InetAddress address, int port)	Returns an AFVSOCKSocketAddress given a special InetAddress that encodes the byte sequence of an AF_VSOCK socket address, like those returned by AFSocketAddress.wrapAddress().
static AFVSOCKSocketAddress	unwrap(SocketAddress address)	Returns an AFVSOCKSocketAddress given a generic SocketAddress.

Methods inherited from class AFSocketAddress

canMap, canMap, 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.
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

Field Details

VMADDR_CID_ANY

public static final int VMADDR_CID_ANY

"Any address for binding".

See Also:

• Constant Field Values

VMADDR_CID_HYPERVISOR

public static final int VMADDR_CID_HYPERVISOR

Reserved for services built into the hypervisor.

See Also:

• Constant Field Values

VMADDR_CID_LOCAL

public static final int VMADDR_CID_LOCAL

The well-known address for local communication (loopback).

See Also:

• Constant Field Values

VMADDR_CID_HOST

public static final int VMADDR_CID_HOST

The well-known address of the host.

See Also:

• Constant Field Values

VMADDR_PORT_ANY

public static final int VMADDR_PORT_ANY

Any port number for binding.

See Also:

• Constant Field Values

Method Details

ofPortAndCID

public static AFVSOCKSocketAddress ofPortAndCID(int port,
 int cid)
                                         throws SocketException

Returns an AFVSOCKSocketAddress that refers to a given VSOCK port and CID; the "java port" is set to -1.

Parameters:

port - The VSOCK port

cid - The CID.

Returns:

A corresponding AFVSOCKSocketAddress instance.

Throws:

SocketException - if the operation fails.

ofHypervisorPort

public static AFVSOCKSocketAddress ofHypervisorPort(int port)
                                             throws SocketException

Returns an AFVSOCKSocketAddress that refers to a given VSOCK port on the hypervisor; the "java port" is set to -1.

Parameters:

port - The VSOCK port

Returns:

A corresponding AFVSOCKSocketAddress instance.

Throws:

SocketException - if the operation fails.

ofAnyHypervisorPort

public static AFVSOCKSocketAddress ofAnyHypervisorPort()
                                                throws SocketException

Returns an AFVSOCKSocketAddress, especially useful for binding, that refers to "any" port on the hypervisor; the "java port" is set to -1.

Returns:

A corresponding AFVSOCKSocketAddress instance.

Throws:

SocketException - if the operation fails.

ofLocalPort

public static AFVSOCKSocketAddress ofLocalPort(int port)
                                        throws SocketException

Returns an AFVSOCKSocketAddress that refers to the given port with the local/loopback CID; the "java port" is set to -1.

Parameters:

port - The VSOCK port.

Returns:

A corresponding AFVSOCKSocketAddress instance.

Throws:

SocketException - if the operation fails.

ofAnyLocalPort

public static AFVSOCKSocketAddress ofAnyLocalPort()
                                           throws SocketException

Returns an AFVSOCKSocketAddress, especially useful for binding, that refers to "any" port with the local/loopback CID; the "java port" is set to -1.

Returns:

A corresponding AFVSOCKSocketAddress instance.

Throws:

SocketException - if the operation fails.

ofHostPort

public static AFVSOCKSocketAddress ofHostPort(int port)
                                       throws SocketException

Returns an AFVSOCKSocketAddress that refers to a given VSOCK port on the host; the "java port" is set to -1.

Parameters:

port - The VSOCK port

Returns:

A corresponding AFVSOCKSocketAddress instance.

Throws:

SocketException - if the operation fails.

ofAnyHostPort

public static AFVSOCKSocketAddress ofAnyHostPort()
                                          throws SocketException

Returns an AFVSOCKSocketAddress, especially useful for binding, that refers to "any" port on the host; the "java port" is set to -1.

Returns:

A corresponding AFVSOCKSocketAddress instance.

Throws:

SocketException - if the operation fails.

ofAnyPort

public static AFVSOCKSocketAddress ofAnyPort()
                                      throws SocketException

Returns an AFVSOCKSocketAddress, especially useful for binding, that refers to "any" port and CID; the "java port" is set to -1.

Returns:

A corresponding AFVSOCKSocketAddress instance.

Throws:

SocketException - if the operation fails.

ofPortWithAnyCID

public static AFVSOCKSocketAddress ofPortWithAnyCID(int port)
                                             throws SocketException

Returns an AFVSOCKSocketAddress, especially useful for binding, that refers to the given port with "any CID"; the "java port" is set to -1.

Parameters:

port - The VSOCK port.

Returns:

A corresponding AFVSOCKSocketAddress instance.

Throws:

SocketException - if the operation fails.

ofPortAndCID

public static AFVSOCKSocketAddress ofPortAndCID(int javaPort,
 int vsockPort,
 int cid)
                                         throws SocketException

Returns an AFVSOCKSocketAddress that refers to a given port and CID.

Parameters:

javaPort - The Java port number.

vsockPort - The vsock port.

cid - The CID.

Returns:

A corresponding AFVSOCKSocketAddress instance.

Throws:

SocketException - if the operation fails.

unwrap

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

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

Parameters:

address - The "special" InetAddress.

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

Returns:

The AFVSOCKSocketAddress instance.

Throws:

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

unwrap

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

Returns an AFVSOCKSocketAddress given a special InetAddress hostname that encodes the byte sequence of an AF_VSOCK 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 AFVSOCKSocketAddress instance.

Throws:

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

unwrap

public static AFVSOCKSocketAddress unwrap(SocketAddress address)
                                   throws SocketException

Returns an AFVSOCKSocketAddress given a generic SocketAddress.

Parameters:

address - The address to unwrap.

Returns:

The AFVSOCKSocketAddress instance.

Throws:

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

getVSOCKPort

public int getVSOCKPort()

Returns the "VSOCK port" part of this address.

Returns:

The VSOCK port identifier

See Also:

• InetSocketAddress.getPort()

getVSOCKCID

public int getVSOCKCID()

Returns the "VSOCK CID" part of this address.

Returns:

The VSOCK CID identifier.

getVSOCKReserved1

public int getVSOCKReserved1()

Returns the "VSOCK reserved1" part of this address.

Returns:

The "reserved1" identifier, which should be 0.

toString

public String toString()

Overrides:

toString in class InetSocketAddress

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

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

Parameters:

addr - The instance to check.

Returns:

true if so.

See Also:

• unwrap(InetAddress, int)

addressFamily

public static AFAddressFamily<AFVSOCKSocketAddress> addressFamily()

Returns the corresponding AFAddressFamily.

Returns:

The address family instance.

of

public static AFVSOCKSocketAddress of(URI uri)
                               throws SocketException

Returns an AFVSOCKSocketAddress for the given URI, if possible.

Parameters:

uri - The URI.

Returns:

The address.

Throws:

SocketException - if the operation fails.

of

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

Returns an AFVSOCKSocketAddress 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.

covers

public boolean covers(AFSocketAddress covered)

Checks if the given address could cover another address. By default, this is only true if both addresses are regarded equal using InetSocketAddress.equals(Object). However, implementations may support "wildcard" addresses, and this method would compare a wildcard address against some non-wildcard address, for example.

Overrides:

covers in class AFSocketAddress

Parameters:

covered - The other address that could be covered by this address.

Returns:

true if the other address could be covered.