| Modifier and Type | Field and Description |
|---|---|
| public static final CloseReasons | 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). |
| public static final CloseReasons | CLOSED_ABNORMALLY
1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. |
| private final CloseReason | |
| public static final CloseReasons | 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. |
| public static final CloseReasons | 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. |
| public static final CloseReasons | 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. |
| public static final CloseReasons | NORMAL_CLOSURE
1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled. |
| public static final CloseReasons | 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). |
| public static final CloseReasons | PROTOCOL_ERROR
1002 indicates that an endpoint is terminating the connection due to a protocol error. |
| public static final CloseReasons | RESERVED
Reserved. |
| public static final CloseReasons | SERVICE_RESTART
1012 indicates that the service will be restarted. |
| public static final CloseReasons | 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. |
| public static final CloseReasons | 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. |
| public static final CloseReasons | TRY_AGAIN_LATER
1013 indicates that the service is experiencing overload |
| public static final CloseReasons | UNEXPECTED_CONDITION
1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request. |
| public static final CloseReasons | VIOLATED_POLICY
1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy. |
| Access | Constructor and Description |
|---|---|
| private |
| Modifier and Type | Method and Description |
|---|---|
| public static CloseReason | |
| public CloseReason | |
| private static String | |
| private static byte[] | |
| public static CloseReasons | |
| public static CloseReasons[] |
| CANNOT_ACCEPT | back to summary |
|---|---|
| public static final CloseReasons 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 | back to summary |
|---|---|
| public static final CloseReasons CLOSED_ABNORMALLY 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. | |
| closeReason | back to summary |
|---|---|
| private final CloseReason closeReason | |
| GOING_AWAY | back to summary |
|---|---|
| public static final CloseReasons 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 | back to summary |
|---|---|
| public static final CloseReasons 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. 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. | |
| NO_STATUS_CODE | back to summary |
|---|---|
| public static final CloseReasons 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. It is designated for use in applications expecting a status code to indicate that no status code was actually present. | |
| NORMAL_CLOSURE | back to summary |
|---|---|
| public static final CloseReasons NORMAL_CLOSURE 1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled. | |
| NOT_CONSISTENT | back to summary |
|---|---|
| public static final CloseReasons 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 | back to summary |
|---|---|
| public static final CloseReasons PROTOCOL_ERROR 1002 indicates that an endpoint is terminating the connection due to a protocol error. | |
| RESERVED | back to summary |
|---|---|
| public static final CloseReasons RESERVED Reserved. The specific meaning might be defined in the future. | |
| SERVICE_RESTART | back to summary |
|---|---|
| public static final CloseReasons SERVICE_RESTART 1012 indicates that the service will be restarted. | |
| TLS_HANDSHAKE_FAILURE | back to summary |
|---|---|
| public static final CloseReasons 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. 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). | |
| TOO_BIG | back to summary |
|---|---|
| public static final CloseReasons 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 | back to summary |
|---|---|
| public static final CloseReasons TRY_AGAIN_LATER 1013 indicates that the service is experiencing overload | |
| UNEXPECTED_CONDITION | back to summary |
|---|---|
| public static final CloseReasons 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 | back to summary |
|---|---|
| public static final CloseReasons VIOLATED_POLICY 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. | |
| CloseReasons | back to summary |
|---|---|
| private CloseReasons(CloseReason. | |
| create | back to summary |
|---|---|
| public static CloseReason create(CloseReason. | |
| getCloseReason | back to summary |
|---|---|
| public CloseReason getCloseReason() Get close reason.
| |
| trimTo123Bytes | back to summary |
|---|---|
| private static String trimTo123Bytes(String reasonPhrase) | |
| trimTo123Bytes | back to summary |
|---|---|
| private static byte[] trimTo123Bytes(byte[] bytes) | |
| valueOf | back to summary |
|---|---|
| public static CloseReasons valueOf(String name) | |
| values | back to summary |
|---|---|
| public static CloseReasons[] values() | |