Module axum::extract::ws::close_code
source · Available on crate feature
ws only.Expand description
Constants for CloseCodes.
Constants
Indicates an abnormal closure.
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.
Indicates that an endpoint is “going away”, such as a server going down or a browser having
navigated away from a page.
Indicates that a server is terminating the connection because it encountered an unexpected
condition that prevented it from fulfilling the request.
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.
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).
Indicates a normal closure, meaning that the purpose for which the connection was
established has been fulfilled.
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.Indicates that an endpoint is terminating the connection due to a protocol error.
Indicates that the server is restarting.
Indicates that an endpoint is terminating the connection because it has received a message
that is too big for it to process.
Indicates that no status code was included in a closing frame.
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).