Package org.gnome.gio

Enum Class SocketProtocol

java.lang.Object

java.lang.Enum<SocketProtocol>

org.gnome.gio.SocketProtocol

All Implemented Interfaces:

Serializable, Comparable<SocketProtocol>, Constable, Enumeration

@Generated("io.github.jwharm.JavaGI")
public enum SocketProtocol
extends Enum<SocketProtocol>
implements Enumeration

A protocol identifier is specified when creating a GSocket, which is a family/type specific identifier, where 0 means the default protocol for the particular family/type.

This enum contains a set of commonly available and used protocols. You can also pass any other identifiers handled by the platform in order to use protocols not listed here.

Since:

2.22

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	The default protocol for the family/type
SCTP	SCTP over IP
TCP	TCP over IP
UDP	UDP over IP
UNKNOWN	The protocol type is unknown

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final SocketProtocol UNKNOWN

The protocol type is unknown

DEFAULT

public static final SocketProtocol DEFAULT

The default protocol for the family/type

TCP

public static final SocketProtocol TCP

TCP over IP

UDP

public static final SocketProtocol UDP

UDP over IP

SCTP

public static final SocketProtocol SCTP

SCTP over IP

Method Details

values

public static SocketProtocol[] 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 SocketProtocol 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 SocketProtocol of(int value)

Create a new SocketProtocol 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 SocketProtocol of(MemorySegment address)

Create a new SocketProtocol 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 SocketProtocol class

Returns:

the GType