Reasons¶

class websocket.reasons.Reason(code)[source]¶

classmethod get(code)[source]¶

This is the accepted way to dynamically acquire an Reason object. Prefer to use Enum Reasons when possible.

Parameters:	code – The code of the reason object you wish to get.
Returns:	`Reason`

class websocket.reasons.Reasons[source]¶

Enum with most defined reasons with their codes.

ABNORMAL_CLOSE = <websocket.reasons.Reason object>¶: 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.

EXTENSION_NOT_PRESENT = <websocket.reasons.Reason object>¶: 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.

GOING_AWAY = <websocket.reasons.Reason object>¶: indicates that an endpoint is “going away”, such as a server going down or a browser having navigated away from a page.

INCONSISTENT_DATA = <websocket.reasons.Reason object>¶: 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).

MESSAGE_TOO_BIG = <websocket.reasons.Reason object>¶: indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.

NORMAL = <websocket.reasons.Reason object>¶: indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.

NO_STATUS = <websocket.reasons.Reason object>¶: 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.

POLICY_VIOLATION = <websocket.reasons.Reason object>¶: 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.

PROTOCOL_ERROR = <websocket.reasons.Reason object>¶: indicates that an endpoint is terminating the connection due to a protocol error.

RESERVED = <websocket.reasons.Reason object>¶: The specific meaning might be defined in the future.

TLS_HANDSHAKE_FAILURE = <websocket.reasons.Reason object>¶: 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).

UNACCEPTABLE_DATA = <websocket.reasons.Reason object>¶: 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).

UNEXPECTED_CONDITION = <websocket.reasons.Reason object>¶: indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.