Class WebSocketCloseCode



    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int 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
      static int 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
      static int 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)
      static int 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)
      static int 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
      static int NORMAL
      1000; 1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled
      static int 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
      static int 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)
      static int UNCONFORMED
      1002; 1002 indicates that an endpoint is terminating the connection due to a protocol error
      static int UNEXPECTED
      1011; 1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request
      static int 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
      static int 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
    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • NORMAL

        🡇    
        public static final int NORMAL
        1000; 1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        public static final int NORMAL = 1000;
        
      • AWAY

        🡅  🡇    
        public static final int 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
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        public static final int AWAY = 1001;
        
      • UNCONFORMED

        🡅  🡇    
        public static final int UNCONFORMED
        1002; 1002 indicates that an endpoint is terminating the connection due to a protocol error
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        public static final int UNCONFORMED = 1002;
        
      • UNACCEPTABLE

        🡅  🡇    
        public static final int 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)
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        public static final int UNACCEPTABLE = 1003;
        
      • NONE

        🡅  🡇    
        public static final int 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
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        public static final int NONE = 1005;
        
      • ABNORMAL

        🡅  🡇    
        public static final int 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
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        public static final int ABNORMAL = 1006;
        
      • INCONSISTENT

        🡅  🡇    
        public static final int 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)
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        public static final int INCONSISTENT = 1007;
        
      • VIOLATED

        🡅  🡇    
        public static final int 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
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        public static final int VIOLATED = 1008;
        
      • OVERSIZE

        🡅  🡇    
        public static final int 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
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        public static final int OVERSIZE = 1009;
        
      • UNEXTENDED

        🡅  🡇    
        public static final int 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
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        public static final int UNEXTENDED = 1010;
        
      • UNEXPECTED

        🡅  🡇    
        public static final int UNEXPECTED
        1011; 1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        public static final int UNEXPECTED = 1011;
        
      • INSECURE

        🡅    
        public static final int 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)
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        public static final int INSECURE = 1015;