Package com.linecorp.armeria.common.websocket

Class WebSocketCloseStatus

java.lang.Object
com.linecorp.armeria.common.websocket.WebSocketCloseStatus
@UnstableApi public final class WebSocketCloseStatus extends Object
WebSocket Defined Status Codes.

  • Field Details

    • NORMAL_CLOSURE

      public static final WebSocketCloseStatus NORMAL_CLOSURE
      1000 indicates a normal closure.

    • ENDPOINT_UNAVAILABLE

      public static final WebSocketCloseStatus 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

      public static final WebSocketCloseStatus PROTOCOL_ERROR
      1002 indicates that an endpoint is terminating the connection due to a protocol error.

    • INVALID_MESSAGE_TYPE

      public static final WebSocketCloseStatus 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

      public static final WebSocketCloseStatus 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

      public static final WebSocketCloseStatus 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.

    • MESSAGE_TOO_BIG

      public static final WebSocketCloseStatus 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

      public static final WebSocketCloseStatus 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 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.

    • INTERNAL_SERVER_ERROR

      public static final WebSocketCloseStatus 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

      public static final WebSocketCloseStatus 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

      public static final WebSocketCloseStatus 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

      public static final WebSocketCloseStatus 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

      public static final WebSocketCloseStatus 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

      public static final WebSocketCloseStatus 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

      public static final WebSocketCloseStatus 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

    • isValidStatusCode

      public static boolean isValidStatusCode(int code)
      Tells whether the code is valid.

    • valueOf

      public static WebSocketCloseStatus valueOf(int code)
      Returns a WebSocketCloseStatus with the code. If the code is not predefined, a new instance is created.

    • code

      public int code()
      Returns the status code.
      See Also:

    • reasonPhrase

      public String reasonPhrase()
      Returns the text that indicates the reason for closure.
      See Also:

    • equals

      public boolean equals(Object o)
      Equality of WebSocketCloseStatus only depends on code().
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object