Skip to content

Latest commit

 

History

History
91 lines (61 loc) · 1.76 KB

api.rst

File metadata and controls

91 lines (61 loc) · 1.76 KB

wsproto API

This document details the API of wsproto.

Semantic Versioning

wsproto follows semantic versioning for its public API. Please note that the guarantees of semantic versioning apply only to the API that is documented here. Simply because a method or data field is not prefaced by an underscore does not make it part of wsproto's public API. Anything not documented here is subject to change at any time.

Connection

wsproto.WSConnection

Handshake

wsproto.handshake.H11Handshake

wsproto.handshake.client_extensions_handshake

wsproto.handshake.server_extensions_handshake

Events

wsproto.events.Event

wsproto.events.Request

wsproto.events.AcceptConnection

wsproto.events.RejectConnection

wsproto.events.RejectData

wsproto.events.CloseConnection

wsproto.events.Message

wsproto.events.TextMessage

wsproto.events.BytesMessage

wsproto.events.Ping

wsproto.events.Pong

Frame Protocol

wsproto.frame_protocol.Opcode

wsproto.frame_protocol.CloseReason

Extensions

wsproto.extensions.Extension

wsproto.extensions.SUPPORTED_EXTENSIONS

Exceptions

wsproto.utilities.LocalProtocolError

wsproto.utilities.RemoteProtocolError