Package apple.network.enums

Class nw_ws_close_code_t

  • public final class nw_ws_close_code_t
extends java.lang.Object
    [@typedef] nw_ws_close_code_t WebSocket close codes that describe the reason for closing a WebSocket connection. Endpoints MAY use the following pre-defined status codes when sending a Close frame.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int nw_ws_close_code_abnormal_closure
      [@const] nw_ws_close_code_abnormal_closure A reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
      static int nw_ws_close_code_going_away
      [@const] nw_ws_close_code_normal_going_away Indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.
      static int nw_ws_close_code_internal_server_error
      [@const] nw_ws_close_code_internal_server_error Indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
      static int nw_ws_close_code_invalid_frame_payload_data
      [@const] nw_ws_close_code_invalid_frame_payload_data 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 nw_ws_close_code_mandatory_extension
      [@const] nw_ws_close_code_mandatory_extension Indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extensions, but the server didn't return them in the response message of the WebSocket handshake.
      static int nw_ws_close_code_message_too_big
      [@const] nw_ws_close_code_message_too_big Indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.
      static int nw_ws_close_code_no_status_received
      [@const] nw_ws_close_code_no_status_received A reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
      static int nw_ws_close_code_normal_closure
      [@const] nw_ws_close_code_normal_closure Indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.
      static int nw_ws_close_code_policy_violation
      [@const] nw_ws_close_code_policy_violation Indicates that an endpoint is terminating the connection because it has received a message that violates its policy.
      static int nw_ws_close_code_protocol_error
      [@const] nw_ws_close_code_protocol_error Indicates that an endpoint is terminating the connection due to a protocol error.
      static int nw_ws_close_code_tls_handshake
      [@const] nw_ws_close_code_tls_handshake A reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
      static int nw_ws_close_code_unsupported_data
      [@const] nw_ws_close_code_normal_closure 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).

    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • nw_ws_close_code_normal_closure

        public static final int nw_ws_close_code_normal_closure
        [@const] nw_ws_close_code_normal_closure Indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.
        See Also:
        Constant Field Values

      • nw_ws_close_code_going_away

        public static final int nw_ws_close_code_going_away
        [@const] nw_ws_close_code_normal_going_away 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

      • nw_ws_close_code_protocol_error

        public static final int nw_ws_close_code_protocol_error
        [@const] nw_ws_close_code_protocol_error Indicates that an endpoint is terminating the connection due to a protocol error.
        See Also:
        Constant Field Values

      • nw_ws_close_code_unsupported_data

        public static final int nw_ws_close_code_unsupported_data
        [@const] nw_ws_close_code_normal_closure 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

      • nw_ws_close_code_no_status_received

        public static final int nw_ws_close_code_no_status_received
        [@const] nw_ws_close_code_no_status_received 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

      • nw_ws_close_code_abnormal_closure

        public static final int nw_ws_close_code_abnormal_closure
        [@const] nw_ws_close_code_abnormal_closure 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

      • nw_ws_close_code_invalid_frame_payload_data

        public static final int nw_ws_close_code_invalid_frame_payload_data
        [@const] nw_ws_close_code_invalid_frame_payload_data 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

      • nw_ws_close_code_policy_violation

        public static final int nw_ws_close_code_policy_violation
        [@const] nw_ws_close_code_policy_violation 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

      • nw_ws_close_code_message_too_big

        public static final int nw_ws_close_code_message_too_big
        [@const] nw_ws_close_code_message_too_big 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

      • nw_ws_close_code_mandatory_extension

        public static final int nw_ws_close_code_mandatory_extension
        [@const] nw_ws_close_code_mandatory_extension Indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extensions, 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

      • nw_ws_close_code_internal_server_error

        public static final int nw_ws_close_code_internal_server_error
        [@const] nw_ws_close_code_internal_server_error 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

      • nw_ws_close_code_tls_handshake

        public static final int nw_ws_close_code_tls_handshake
        [@const] nw_ws_close_code_tls_handshake 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