Enum WsCloseStatus
-
- All Implemented Interfaces:
-
java.io.Serializable
,kotlin.Comparable
public enum WsCloseStatus extends Enum<WsCloseStatus>
WebSocket connection close codes.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
WsCloseStatus.Companion
-
Field Summary
Fields Modifier and Type Field Description private final Integer
code
private final String
name
private final Integer
ordinal
private final EnumEntries<WsCloseStatus>
entries
-
Enum Constant Summary
Enum Constants Enum Constant Description NORMAL_CLOSURE
The connection successfully completed the purpose for which it was created.
GOING_AWAY
The endpoint is going away, either because of a server failure or because the browser is navigating away from the page that opened the connection.
PROTOCOL_ERROR
The endpoint is terminating the connection due to a protocol error.
UNSUPPORTED_DATA
The connection is being terminated because the endpoint received data of a type it cannot accept (for example, a text-only endpoint received binary data).
RESERVED
Reserved. A meaning might be defined in the future.
NO_STATUS_RECEIVED
Reserved. Indicates that no status code was provided even though one was expected.
ABNORMAL_CLOSURE
Reserved. Used to indicate that a connection was closed abnormally (that is, with no close frame being sent) when a status code is expected.
INVALID_FRAME_PAYLOAD_DATA
The endpoint is terminating the connection because a message was received that contained inconsistent data (e.g., non-UTF-8 data within a text message).
POLICY_VIOLATION
The endpoint is terminating the connection because it received a message that violates its policy. This is a generic status code, used when codes 1003 and 1009 are not suitable.
MESSAGE_TOO_BIG
The endpoint is terminating the connection because a data frame was received that is too large.
MANDATORY_EXTENSION
The client is terminating the connection because it expected the server to negotiate one or more extension, but the server didn't.
SERVER_ERROR
The server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
SERVICE_RESTART
The server is terminating the connection because it is restarting.
TRY_AGAIN_LATER
The server is terminating the connection due to a temporary condition, e.g. it is overloaded and is casting off some of its clients.
BAD_GATEWAY
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.
FAILED_TLS_HANDSHAKE
The server cannot complete the request because it cannot negotiate the use of the TLS/SSL protocol.
UNKNOWN
For definition by future revisions of the WebSocket Protocol specification, and for definition by extension specifications.
-
Method Summary
Modifier and Type Method Description final String
message()
String
toString()
final WsCloseStatus
valueOf(String value)
Returns the enum constant of this type with the specified name. final Array<WsCloseStatus>
values()
Returns an array containing the constants of this enum type, in the order they're declared. final Integer
getCode()
final EnumEntries<WsCloseStatus>
getEntries()
WebSocket connection close codes. -
-
Method Detail
-
valueOf
final WsCloseStatus valueOf(String value)
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.)
-
values
final Array<WsCloseStatus> values()
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
-
getEntries
final EnumEntries<WsCloseStatus> getEntries()
WebSocket connection close codes.
-
-
-
-