Enum Class UnixSocketAddressType

java.lang.Object

java.lang.Enum<UnixSocketAddressType>

org.gnome.gio.UnixSocketAddressType

All Implemented Interfaces:

Serializable, Comparable<UnixSocketAddressType>, Constable, Enumeration

@Generated("org.javagi.JavaGI")
public enum UnixSocketAddressType
extends Enum<UnixSocketAddressType>
implements Enumeration

The type of name used by a GUnixSocketAddress. PATH indicates a traditional unix domain socket bound to a filesystem path. ANONYMOUS indicates a socket not bound to any name (eg, a client-side socket, or a socket created with socketpair()).

For abstract sockets, there are two incompatible ways of naming them; the man pages suggest using the entire struct sockaddr_un as the name, padding the unused parts of the sun_path field with zeroes; this corresponds to ABSTRACT_PADDED. However, many programs instead just use a portion of sun_path, and pass an appropriate smaller length to bind() or connect(). This is ABSTRACT.

Since:

2.26

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABSTRACT	an abstract name
ABSTRACT_PADDED	an abstract name, 0-padded to the full length of a unix socket name
ANONYMOUS	anonymous
INVALID	invalid
PATH	a filesystem path

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the UnixSocketAddressType class.
int	getValue()	Get the numeric value of this enum
static UnixSocketAddressType	of(int value)	Create a new UnixSocketAddressType for the provided value
static UnixSocketAddressType	of(MemorySegment address)	Create a new UnixSocketAddressType for the value in the provided memory address.
static UnixSocketAddressType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UnixSocketAddressType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INVALID

public static final UnixSocketAddressType INVALID

invalid

ANONYMOUS

public static final UnixSocketAddressType ANONYMOUS

anonymous

PATH

public static final UnixSocketAddressType PATH

a filesystem path

ABSTRACT

public static final UnixSocketAddressType ABSTRACT

an abstract name

ABSTRACT_PADDED

public static final UnixSocketAddressType ABSTRACT_PADDED

an abstract name, 0-padded to the full length of a unix socket name

Method Details

values

public static UnixSocketAddressType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static UnixSocketAddressType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

of

public static UnixSocketAddressType of(int value)

Create a new UnixSocketAddressType for the provided value

Parameters:

value - the enum value

Returns:

the enum for the provided value

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

of

public static UnixSocketAddressType of(MemorySegment address)

Create a new UnixSocketAddressType for the value in the provided memory address.

Parameters:

address - the memory address holding a enum value

Returns:

the enum for the value in the provided memory address

getType

public static @Nullable Type getType()

Get the GType of the UnixSocketAddressType class.

Returns:

the GType