Module org.newsclub.net.unix

Package org.newsclub.net.unix

Enum AFUNIXSocketCapability

java.lang.Object

java.lang.Enum<AFUNIXSocketCapability>

org.newsclub.net.unix.AFUNIXSocketCapability

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AFUNIXSocketCapability>

public enum AFUNIXSocketCapability
extends java.lang.Enum<AFUNIXSocketCapability>

Describes junixsocket capabilities the current environment (system platform, native library, etc.) may or may not support. You can check whether your environment supports a given capability by calling AFUNIXSocket.supports(AFUNIXSocketCapability).

Enum Constant Summary

Enum Constants

Enum Constant	Description
CAPABILITY_ABSTRACT_NAMESPACE	Socket addressing supports the abstract namespace (Linux/Windows).
CAPABILITY_ANCILLARY_MESSAGES	Socket supports sending and receiving ancillary messages.
CAPABILITY_FILE_DESCRIPTORS	Socket supports passing file descriptors via ancillary messages.
CAPABILITY_PEER_CREDENTIALS	Socket supports retrieving peer credentials.

Method Summary

Modifier and Type	Method	Description
static AFUNIXSocketCapability	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static AFUNIXSocketCapability[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CAPABILITY_PEER_CREDENTIALS

public static final AFUNIXSocketCapability CAPABILITY_PEER_CREDENTIALS

Socket supports retrieving peer credentials.

CAPABILITY_ANCILLARY_MESSAGES

public static final AFUNIXSocketCapability CAPABILITY_ANCILLARY_MESSAGES

Socket supports sending and receiving ancillary messages.

CAPABILITY_FILE_DESCRIPTORS

public static final AFUNIXSocketCapability CAPABILITY_FILE_DESCRIPTORS

Socket supports passing file descriptors via ancillary messages.

CAPABILITY_ABSTRACT_NAMESPACE

public static final AFUNIXSocketCapability CAPABILITY_ABSTRACT_NAMESPACE

Socket addressing supports the abstract namespace (Linux/Windows).

Method Detail

values

public static AFUNIXSocketCapability[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AFUNIXSocketCapability c : AFUNIXSocketCapability.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AFUNIXSocketCapability valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null