Package org.javacord.core.util.gateway

Enum WebSocketCloseCode

    • Enum Constant Detail

      • NORMAL

        public static final WebSocketCloseCode NORMAL
        1000. * 1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.

      • AWAY

        public static final WebSocketCloseCode AWAY
        1001. 1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.

      • UNCONFORMED

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

      • UNACCEPTABLE

        public static final WebSocketCloseCode UNACCEPTABLE
        1003. 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).

      • NONE

        public static final WebSocketCloseCode NONE
        1005. 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

        public static final WebSocketCloseCode ABNORMAL
        1006. 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.

      • INCONSISTENT

        public static final WebSocketCloseCode INCONSISTENT
        1007. 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).

      • VIOLATED

        public static final WebSocketCloseCode VIOLATED
        1008. 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.

      • OVERSIZE

        public static final WebSocketCloseCode OVERSIZE
        1009. 1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.

      • UNEXTENDED

        public static final WebSocketCloseCode UNEXTENDED
        1010. 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.

      • UNEXPECTED

        public static final WebSocketCloseCode UNEXPECTED
        1011. 1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.

      • INSECURE

        public static final WebSocketCloseCode INSECURE
        1015. 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).

      • UNKNOWN_ERROR

        public static final WebSocketCloseCode UNKNOWN_ERROR
        We're not sure what went wrong. Try reconnecting?

      • ALREADY_AUTHENTICATED

        public static final WebSocketCloseCode ALREADY_AUTHENTICATED
        You sent more than one identify payload. Don't do that!

      • SESSION_NO_LONGER_VALID

        public static final WebSocketCloseCode SESSION_NO_LONGER_VALID
        Your session is no longer valid.

      • INVALID_SEQ

        public static final WebSocketCloseCode INVALID_SEQ
        The sequence sent when resuming the session was invalid. Reconnect and start a new session.

      • RATE_LIMITED

        public static final WebSocketCloseCode RATE_LIMITED
        Woah nelly! You're sending payloads to us too quickly. Slow it down!

      • SESSION_TIMEOUT

        public static final WebSocketCloseCode SESSION_TIMEOUT
        Your session timed out. Reconnect and start a new one.

      • SHARDING_REQUIRED

        public static final WebSocketCloseCode SHARDING_REQUIRED
        The session would have handled too many guilds - you are required to shard your connection in order to connect.

      • SERVER_NOT_FOUND

        public static final WebSocketCloseCode SERVER_NOT_FOUND
        The session would have handled too many guilds - you are required to shard your connection in order to connect.

      • UNKNOWN_PROTOCOL

        public static final WebSocketCloseCode UNKNOWN_PROTOCOL
        The session would have handled too many guilds - you are required to shard your connection in order to connect.

      • DISCONNECTED

        public static final WebSocketCloseCode DISCONNECTED
        The session would have handled too many guilds - you are required to shard your connection in order to connect.

      • VOICE_SERVER_CRASHED

        public static final WebSocketCloseCode VOICE_SERVER_CRASHED
        The session would have handled too many guilds - you are required to shard your connection in order to connect.

      • UNKNOWN_ENCRYPTION_MODE

        public static final WebSocketCloseCode UNKNOWN_ENCRYPTION_MODE
        The session would have handled too many guilds - you are required to shard your connection in order to connect.

      • COMMANDED_RECONNECT

        public static final WebSocketCloseCode COMMANDED_RECONNECT
        Discord asked for a reconnect, and there is no pre-defined matching close reason, thus 4999 is used which is unlikely to get assigned by Discord.

    • Method Detail

      • values

        public static WebSocketCloseCode[] values​()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (WebSocketCloseCode c : WebSocketCloseCode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static WebSocketCloseCode valueOf​(String name)
        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.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • fromCode

        public static Optional<WebSocketCloseCode> fromCode​(int code)
        Gets the web socket close code by actual numeric close code.
        Parameters:
        code - The actual numeric close code.
        Returns:
        The web socket close code with the actual numeric close code.

      • fromCodeForVoice

        public static Optional<WebSocketCloseCode> fromCodeForVoice​(int code)
        Gets the voice web socket close code by actual numeric close code.
        Parameters:
        code - The actual numeric close code.
        Returns:
        The voice web socket close code with the actual numeric close code.

      • getCode

        public int getCode​()
        Gets the actual numeric close code.
        Returns:
        The actual numeric close code.