Class WebSocketCloseStatus
java.lang.Object
com.linecorp.armeria.common.websocket.WebSocketCloseStatus
WebSocket Defined Status Codes.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final WebSocketCloseStatus
1006
is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.static final WebSocketCloseStatus
1014
(IANA Registry, Non RFC 6455) indicates that the server was acting as a gateway or proxy and received an invalid response from the upstream server.static final WebSocketCloseStatus
1005
is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.static final WebSocketCloseStatus
1001
indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.static final WebSocketCloseStatus
1011
indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.static final WebSocketCloseStatus
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).static final WebSocketCloseStatus
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).static final WebSocketCloseStatus
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.static final WebSocketCloseStatus
1009
indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.static final WebSocketCloseStatus
1000
indicates a normal closure.static final WebSocketCloseStatus
1008
indicates that an endpoint is terminating the connection because it has received a message that violates its policy.static final WebSocketCloseStatus
1002
indicates that an endpoint is terminating the connection due to a protocol error.static final WebSocketCloseStatus
1012
(IANA Registry, Non RFC 6455) indicates that the service is restarted.static final WebSocketCloseStatus
1015
is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.static final WebSocketCloseStatus
1013
(IANA Registry, Non RFC 6455) indicates that the service is experiencing overload. -
Method Summary
Modifier and TypeMethodDescriptionint
code()
Returns the status code.boolean
Equality ofWebSocketCloseStatus
only depends oncode()
.int
hashCode()
static boolean
isValidStatusCode
(int code) Tells whether thecode
is valid.static WebSocketCloseStatus
ofPrivateUse
(int code, String reasonPhrase) Creates a newWebSocketCloseStatus
whose status is in the range 4000-4999 for private use.Returns the text that indicates the reason for closure.toString()
static WebSocketCloseStatus
valueOf
(int code) Returns aWebSocketCloseStatus
with thecode
.
-
Field Details
-
NORMAL_CLOSURE
1000
indicates a normal closure. -
ENDPOINT_UNAVAILABLE
1001
indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page. -
PROTOCOL_ERROR
1002
indicates that an endpoint is terminating the connection due to a protocol error. -
INVALID_MESSAGE_TYPE
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). -
INVALID_PAYLOAD_DATA
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). -
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
or1009
) or if there is a need to hide specific details about the policy. -
MESSAGE_TOO_BIG
1009
indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process. -
MANDATORY_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 thereason
part of the Close frame. Note that this status code is not used by the server, because it can fail the WebSocket handshake instead. -
INTERNAL_SERVER_ERROR
1011
indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request. -
SERVICE_RESTART
1012
(IANA Registry, Non RFC 6455) indicates that the service is restarted. A client may reconnect, and if it chooses to do, should reconnect using a randomized delay of 5 - 30 seconds. -
TRY_AGAIN_LATER
1013
(IANA Registry, Non RFC 6455) 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. -
BAD_GATEWAY
1014
(IANA Registry, Non RFC 6455) indicates that the server was acting as a gateway or proxy and received an invalid response from the upstream server. This is similar to 502 HTTP Status Code. -
EMPTY
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. -
ABNORMAL_CLOSURE
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. -
TLS_HANDSHAKE_FAILED
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).
-
-
Method Details
-
ofPrivateUse
Creates a newWebSocketCloseStatus
whose status is in the range 4000-4999 for private use. See rfc6455.Note that
reasonPhrase
must be 125 bytes or less. -
isValidStatusCode
public static boolean isValidStatusCode(int code) Tells whether thecode
is valid. -
valueOf
Returns aWebSocketCloseStatus
with thecode
. If thecode
is not predefined, a new instance is created. -
code
public int code()Returns the status code.- See Also:
-
reasonPhrase
Returns the text that indicates the reason for closure.- See Also:
-
equals
Equality ofWebSocketCloseStatus
only depends oncode()
. -
hashCode
public int hashCode() -
toString
-