Package-level declarations

TODO

Types

Link copied to clipboard
interface WsSession

Properties

Link copied to clipboard
const val ABNORMAL: Int

Abnormal Close is a synonym for {@link #NO_CLOSE}, used to indicate a close * condition where no close frame was processed from the remote side.

Link copied to clipboard
const val BAD_DATA: Int = 1003

1003 indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands only text data MAY send this if it receives a binary message).

Link copied to clipboard
const val BAD_PAYLOAD: Int = 1007

1007 indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 RFC3629 data within a text message).

Link copied to clipboard
const val FAILED_TLS_HANDSHAKE: Int = 1015

1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified).

Link copied to clipboard
const val INVALID_UPSTREAM_RESPONSE: Int = 1014

1014 indicates that a gateway or proxy received and invalid upstream response.

Link copied to clipboard
const val MESSAGE_TOO_LARGE: Int = 1009

1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.

Link copied to clipboard
const val NO_CLOSE: Int = 1006

1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that the connection was closed abnormally, e.g., without sending or receiving a Close control frame.

Link copied to clipboard
const val NO_CODE: Int = 1005

1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that no status code was actually present.

Link copied to clipboard
const val NORMAL: Int = 1000

1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.

Link copied to clipboard
const val POLICY_VIOLATION: Int = 1008

1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy. This is a generic status code that can be returned when there is no other more suitable status code (e.g., 1003 or 1009) or if there is a need to hide specific details about the policy.

Link copied to clipboard
const val PROTOCOL: Int = 1002

1002 indicates that an endpoint is terminating the connection due to a protocol error.

Link copied to clipboard
const val REQUIRED_EXTENSION: Int = 1010

1010 indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake. The list of extensions that are needed SHOULD appear in the /reason/ part of the Close frame. Note that this status code is not used by the server, because it can fail the WebSocket handshake instead.

Link copied to clipboard
const val SERVER_ERROR: Int = 1011

1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.

Link copied to clipboard
const val SERVICE_RESTART: Int = 1012

1012 indicates that the service is restarted. a client may reconnect, and if it chooses to do, should reconnect using a randomized delay of 5 - 30s.

Link copied to clipboard
const val SHUTDOWN: Int = 1001

1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.

Link copied to clipboard
const val TRY_AGAIN_LATER: Int = 1013

1013 indicates that the service is experiencing overload. a client should only connect to a different IP (when there are multiple for the target) or reconnect to the same IP upon user action.

Link copied to clipboard
const val UNDEFINED: Int = 1004

Reserved. The specific meaning might be defined in the future.