Package org.gnome.soup

Enum Class WebsocketError

java.lang.Object

java.lang.Enum<WebsocketError>

org.gnome.soup.WebsocketError

All Implemented Interfaces:

Enumeration, Serializable, Comparable<WebsocketError>, Constable

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

WebSocket-related errors.

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
BAD_HANDSHAKE	the WebSocket handshake failed because some detail was invalid (eg, incorrect accept key).
BAD_ORIGIN	the WebSocket handshake failed because the "Origin" header was not an allowed value.
FAILED	a generic error
NOT_WEBSOCKET	attempted to handshake with a server that does not appear to understand WebSockets.

Method Summary

Modifier and Type	Method	Description
static Type	getType()	Get the GType of the WebsocketError class
int	getValue()	Get the numeric value of this enum
static WebsocketError	of(int value)	Create a new WebsocketError for the provided value
static Quark	quark()	Registers error quark for SoupWebsocket if needed.
static WebsocketError	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WebsocketError[]	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

FAILED

public static final WebsocketError FAILED

a generic error

NOT_WEBSOCKET

public static final WebsocketError NOT_WEBSOCKET

attempted to handshake with a server that does not appear to understand WebSockets.

BAD_HANDSHAKE

public static final WebsocketError BAD_HANDSHAKE

the WebSocket handshake failed because some detail was invalid (eg, incorrect accept key).

BAD_ORIGIN

public static final WebsocketError BAD_ORIGIN

the WebSocket handshake failed because the "Origin" header was not an allowed value.

Method Details

values

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

Create a new WebsocketError 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

getType

public static Type getType()

Get the GType of the WebsocketError class

Returns:

the GType

quark

public static Quark quark()
                   throws UnsupportedPlatformException

Registers error quark for SoupWebsocket if needed.

Returns:

Error quark for SoupWebsocket.

Throws:

UnsupportedPlatformException - when run on a platform other than linux