Enum Class SocketMsgFlags

java.lang.Object

java.lang.Enum<SocketMsgFlags>

org.gnome.gio.SocketMsgFlags

All Implemented Interfaces:

Serializable, Comparable<SocketMsgFlags>, Constable, Enumeration

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

Flags used in g_socket_receive_message() and g_socket_send_message(). The flags listed in the enum are some commonly available flags, but the values used for them are the same as on the platform, and any other flags are passed in/out as is. So to use a platform specific flag, just include the right system header and pass in the flag.

Since:

2.22

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DONTROUTE	Don't use a gateway to send out the packet, only send to hosts on directly connected networks.
NONE	No flags.
OOB	Request to send/receive out of band data.
PEEK	Read data from the socket without removing it from the queue.

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the SocketMsgFlags class.
int	getValue()	Get the numeric value of this enum
static Set<SocketMsgFlags>	of(int flags)	Create a new EnumSet<SocketMsgFlags> for the provided bitfield
static Set<SocketMsgFlags>	of(MemorySegment address)	Create a new EnumSet<SocketMsgFlags> for the bitfield in the provided memory address.
static SocketMsgFlags	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SocketMsgFlags[]	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

NONE

public static final SocketMsgFlags NONE

No flags.

OOB

public static final SocketMsgFlags OOB

Request to send/receive out of band data.

PEEK

public static final SocketMsgFlags PEEK

Read data from the socket without removing it from the queue.

DONTROUTE

public static final SocketMsgFlags DONTROUTE

Don't use a gateway to send out the packet, only send to hosts on directly connected networks.

Method Details

values

public static SocketMsgFlags[] 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 SocketMsgFlags 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

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

of

public static Set<SocketMsgFlags> of(int flags)

Create a new EnumSet<SocketMsgFlags> for the provided bitfield

Parameters:

flags - the SocketMsgFlags bitfield

Returns:

the EnumSet for the provided bitfield

of

public static Set<SocketMsgFlags> of(MemorySegment address)

Create a new EnumSet<SocketMsgFlags> for the bitfield in the provided memory address.

Parameters:

address - the memory address holding a bitfield value

Returns:

the EnumSet for the bitfield in the provided memory address

getType

public static @Nullable Type getType()

Get the GType of the SocketMsgFlags class.

Returns:

the GType