soup/org.gtkkn.bindings.soup/WebsocketCloseCode

WebsocketCloseCode

enum WebsocketCloseCode : Enum<WebsocketCloseCode>

Pre-defined close codes that can be passed to method@WebsocketConnection.close or received from method@WebsocketConnection.get_close_code.

However, other codes are also allowed.

Entries

a normal, non-error close

the client/server is going away

a protocol error occurred

UNSUPPORTED_DATA

UNSUPPORTED_DATA

the endpoint received data of a type that it does not support.

reserved value indicating that no close code was present; must not be sent.

reserved value indicating that the connection was closed abnormally; must not be sent.

the endpoint received data that was invalid (eg, non-UTF-8 data in a text message).

POLICY_VIOLATION

POLICY_VIOLATION

generic error code indicating some sort of policy violation.

the endpoint received a message that is too big to process.

the client is closing the connection because the server failed to negotiate a required extension.

the server is closing the connection because it was unable to fulfill the request.

reserved value indicating that the TLS handshake failed; must not be sent.

Types

object Companion

Properties

val name: String

val nativeValue: <Error class: unknown class>

val ordinal: Int

Functions

fun valueOf(value: String): WebsocketCloseCode

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<WebsocketCloseCode>

Returns an array containing the constants of this enum type, in the order they're declared.