WebSocket utilities

class aiohttp.WSCloseCode

An IntEnum for keeping close message code.

OK

A normal closure, meaning that the purpose for which the connection was established has been fulfilled.

GOING_AWAY

An endpoint is “going away”, such as a server going down or a browser having navigated away from a page.

PROTOCOL_ERROR

An endpoint is terminating the connection due to a protocol error.

UNSUPPORTED_DATA

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).

INVALID_TEXT

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 RFC 3629 data within a text message).

POLICY_VIOLATION

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_data or message_too_big) or if there is a need to hide specific details about the policy.

MESSAGE_TOO_BIG

An endpoint is terminating the connection because it has received a message that is too big for it to process.

MANDATORY_EXTENSION

An endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server did not 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.

INTERNAL_ERROR

A server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.

SERVICE_RESTART

The service is restarted. a client may reconnect, and if it chooses to do, should reconnect using a randomized delay of 5-30s.

TRY_AGAIN_LATER

The service is experiencing overload. A client should only connect to a different IP (when there are multiple for the target) or reconnect to the same IP upon user action.

class aiohttp.WSMsgType

An IntEnum for describing WSMessage type.

CONTINUATION

A mark for continuation frame, user will never get the message with this type.

TEXT

Text message, the value has str type.

BINARY

Binary message, the value has bytes type.

PING

Ping frame (sent by client peer).

PONG

Pong frame, answer on ping. Sent by server peer.

CLOSE

Close frame.

CLOSED FRAME

Actually not frame but a flag indicating that websocket was closed.

ERROR

Actually not frame but a flag indicating that websocket was received an error.

class aiohttp.WSMessage

Websocket message, returned by .receive() calls.

type

Message type, WSMsgType instance.

data

Message payload.

1. str for WSMsgType.TEXT messages.
2. bytes for WSMsgType.BINARY messages.
3. WSCloseCode for WSMsgType.CLOSE messages.
4. bytes for WSMsgType.PING messages.
5. bytes for WSMsgType.PONG messages.

extra

Additional info, str.

Makes sense only for WSMsgType.CLOSE messages, contains optional message description.

json(*, loads=json.loads)

Returns parsed JSON data.

Parameters:loads – optional JSON decoder function.