Serializable
, Comparable<CloseReason.CloseCodes>
, CloseReason.CloseCode
public static enum CloseReason.CloseCodes extends Enum<CloseReason.CloseCodes> implements CloseReason.CloseCode
Enum Constant | Description |
---|---|
CANNOT_ACCEPT |
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).
|
CLOSED_ABNORMALLY |
1006 is a reserved value and MUST NOT be set as a status code in a
Close control frame by an endpoint.
|
GOING_AWAY |
1001 indicates that an endpoint is "going away", such as a server
going down or a browser having navigated away from a page.
|
NO_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.
|
NO_STATUS_CODE |
1005 is a reserved value and MUST NOT be set as a status code in a
Close control frame by an endpoint.
|
NORMAL_CLOSURE |
1000 indicates a normal closure, meaning that the purpose for
which the connection was established has been fulfilled.
|
NOT_CONSISTENT |
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
data within a text message).
|
PROTOCOL_ERROR |
1002 indicates that an endpoint is terminating the connection due
to a protocol error.
|
RESERVED |
Reserved.
|
SERVICE_RESTART |
1012 indicates that the service will be restarted.
|
TLS_HANDSHAKE_FAILURE |
1015 is a reserved value and MUST NOT be set as a status code in a
Close control frame by an endpoint.
|
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.
|
TRY_AGAIN_LATER |
1013 indicates that the service is experiencing overload
|
UNEXPECTED_CONDITION |
1011 indicates that a server is terminating the connection because
it encountered an unexpected condition that prevented it from
fulfilling the request.
|
VIOLATED_POLICY |
1008 indicates that an endpoint is terminating the connection
because it has received a message that violates its policy.
|
Modifier and Type | Method | Description |
---|---|---|
static CloseReason.CloseCode |
getCloseCode(int code) |
Creates a CloseCode from the given int code number.
|
int |
getCode() |
Return the code number of this status code.
|
static CloseReason.CloseCodes |
valueOf(String name) |
Returns the enum constant of this type with the specified name.
|
static CloseReason.CloseCodes[] |
values() |
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final CloseReason.CloseCodes NORMAL_CLOSURE
public static final CloseReason.CloseCodes GOING_AWAY
public static final CloseReason.CloseCodes PROTOCOL_ERROR
public static final CloseReason.CloseCodes CANNOT_ACCEPT
public static final CloseReason.CloseCodes RESERVED
public static final CloseReason.CloseCodes NO_STATUS_CODE
public static final CloseReason.CloseCodes CLOSED_ABNORMALLY
public static final CloseReason.CloseCodes NOT_CONSISTENT
public static final CloseReason.CloseCodes VIOLATED_POLICY
public static final CloseReason.CloseCodes TOO_BIG
public static final CloseReason.CloseCodes NO_EXTENSION
public static final CloseReason.CloseCodes UNEXPECTED_CONDITION
public static final CloseReason.CloseCodes SERVICE_RESTART
public static final CloseReason.CloseCodes TRY_AGAIN_LATER
public static final CloseReason.CloseCodes TLS_HANDSHAKE_FAILURE
public static CloseReason.CloseCodes[] values()
for (CloseReason.CloseCodes c : CloseReason.CloseCodes.values()) System.out.println(c);
public static CloseReason.CloseCodes valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic static CloseReason.CloseCode getCloseCode(int code)
code
- the integer code numberIllegalArgumentException
- if the code is not a valid close codepublic int getCode()
getCode
in interface CloseReason.CloseCode
Copyright © 2019 JBoss by Red Hat. All rights reserved.