Module axum::extract::ws::close_code

source ·
Expand description

Constants for CloseCodes.

Constants§

  • ABNORMAL
    Indicates an abnormal closure.
  • AGAIN
    Indicates that the server is overloaded and the client should either connect to a different IP (when multiple targets exist), or reconnect to the same IP when a user has performed an action.
  • AWAY
    Indicates that an endpoint is “going away”, such as a server going down or a browser having navigated away from a page.
  • ERROR
    Indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
  • EXTENSION
    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 be given as the reason for closing. Note that this status code is not used by the server, because it can fail the WebSocket handshake instead.
  • INVALID
    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).
  • NORMAL
    Indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.
  • POLICY
    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., UNSUPPORTED or SIZE) or if there is a need to hide specific details about the policy.
  • PROTOCOL
    Indicates that an endpoint is terminating the connection due to a protocol error.
  • RESTART
    Indicates that the server is restarting.
  • SIZE
    Indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.
  • STATUS
    Indicates that no status code was included in a closing frame.
  • UNSUPPORTED
    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).