Package org.gnome.soup

Enum Class MessageFlags

java.lang.Object

java.lang.Enum<MessageFlags>

org.gnome.soup.MessageFlags

All Implemented Interfaces:

Serializable, Comparable<MessageFlags>, Constable, Enumeration

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

Various flags that can be set on a SoupMessage to alter its behavior.

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
COLLECT_METRICS	Metrics will be collected for this message.
DO_NOT_USE_AUTH_CACHE	The AuthManager should not use the credentials cache for this message, neither to use cached credentials to automatically authenticate this message nor to cache the credentials after the message is successfully authenticated.
IDEMPOTENT	The message is considered idempotent, regardless its Message:method, and allows reuse of existing idle connections, instead of always requiring a new one, unless SOUP_MESSAGE_NEW_CONNECTION is set.
NEW_CONNECTION	Requests that the message should be sent on a newly-created connection, not reusing an existing persistent connection.
NO_REDIRECT	The session should not follow redirect (3xx) responses received by this message.

Method Summary

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

NO_REDIRECT

public static final MessageFlags NO_REDIRECT

The session should not follow redirect (3xx) responses received by this message.

NEW_CONNECTION

public static final MessageFlags NEW_CONNECTION

Requests that the message should be sent on a newly-created connection, not reusing an existing persistent connection. Note that messages with non-idempotent Message:methods behave this way by default, unless SOUP_MESSAGE_IDEMPOTENT is set.

IDEMPOTENT

public static final MessageFlags IDEMPOTENT

The message is considered idempotent, regardless its Message:method, and allows reuse of existing idle connections, instead of always requiring a new one, unless SOUP_MESSAGE_NEW_CONNECTION is set.

DO_NOT_USE_AUTH_CACHE

public static final MessageFlags DO_NOT_USE_AUTH_CACHE

The AuthManager should not use the credentials cache for this message, neither to use cached credentials to automatically authenticate this message nor to cache the credentials after the message is successfully authenticated. This applies to both server and proxy authentication. Note that Message::authenticate signal will be emitted, if you want to disable authentication for a message use Message.disableFeature(org.gnome.glib.Type) passing SOUP_TYPE_AUTH_MANAGER instead.

COLLECT_METRICS

public static final MessageFlags COLLECT_METRICS

Metrics will be collected for this message.

Method Details

values

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

Create a new EnumSet<MessageFlags> for the provided bitfield

Parameters:

flags - the MessageFlags bitfield

Returns:

the EnumSet for the provided bitfield

of

public static Set<MessageFlags> of(MemorySegment address)

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

Returns:

the GType