WebSocketStatusCode

The <a href="https://tools.ietf.org/html/rfc6455#section-7.4">RFC 6455 specified status codes</a> and <a href="https://www.iana.org/assignments/websocket/websocket.xml#close-code-number-rules">IANA: WebSocket Close Code Number Registry</a>

Members

Static functions

isTransmittable
bool isTransmittable(int statusCode)

Test if provided status code can be sent/received on a WebSocket close. <p> This honors the RFC6455 rules and IANA rules. </p>

Variables

ABNORMAL
enum int ABNORMAL;

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.

BAD_DATA
enum int BAD_DATA;

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). <p> See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.

BAD_PAYLOAD
enum int BAD_PAYLOAD;

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 [<a href="https://tools.ietf.org/html/rfc3629">RFC3629</a>] data within a text message). <p> See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.

FAILED_TLS_HANDSHAKE
enum int FAILED_TLS_HANDSHAKE;

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). <p> See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.

INVALID_UPSTREAM_RESPONSE
enum int INVALID_UPSTREAM_RESPONSE;

1014 indicates that a gateway or proxy received and invalid upstream response. <p> See <a href="https://www.ietf.org/mail-archive/web/hybi/current/msg10748.html">hybi WebSocket Subprotocol Close Code: Bad Gateway</a>

MESSAGE_TOO_LARGE
enum int MESSAGE_TOO_LARGE;

1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process. <p> See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.

NORMAL
enum int NORMAL;

1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled. <p> See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.

NO_CLOSE
enum int NO_CLOSE;

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. <p> See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.

NO_CODE
enum int NO_CODE;

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. <p> See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.

POLICY_VIOLATION
enum int POLICY_VIOLATION;

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. <p> See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.

PROTOCOL
enum int PROTOCOL;

1002 indicates that an endpoint is terminating the connection due to a protocol error. <p> See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.

REQUIRED_EXTENSION
enum int REQUIRED_EXTENSION;

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. <p> See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.

SERVER_ERROR
enum int SERVER_ERROR;

1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request. <p> See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.

SERVICE_RESTART
enum int SERVICE_RESTART;

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. <p> See <a href="https://www.ietf.org/mail-archive/web/hybi/current/msg09649.html">hybi Additional WebSocket Close Error Codes</a>

SHUTDOWN
enum int SHUTDOWN;

1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page. <p> See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.

TRY_AGAIN_LATER
enum int TRY_AGAIN_LATER;

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. <p> See <a href="https://www.ietf.org/mail-archive/web/hybi/current/msg09649.html">hybi Additional WebSocket Close Error Codes</a>

UNDEFINED
enum int UNDEFINED;

Reserved. The specific meaning might be defined in the future. <p> See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.

Meta