1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
API reference
=============
.. currentmodule:: websockets
Features
--------
Check which implementations support which features and known limitations.
.. toctree::
:titlesonly:
features
:mod:`asyncio`
--------------
It's ideal for servers that handle many clients concurrently.
This is the default implementation.
.. toctree::
:titlesonly:
asyncio/server
asyncio/client
:mod:`threading`
----------------
This alternative implementation can be a good choice for clients.
.. toctree::
:titlesonly:
sync/server
sync/client
`Sans-I/O`_
-----------
This layer is designed for integrating in third-party libraries, typically
application servers.
.. _Sans-I/O: https://sans-io.readthedocs.io/
.. toctree::
:titlesonly:
sansio/server
sansio/client
Legacy
------
This is the historical implementation. It is deprecated. It will be removed by
2030.
.. toctree::
:titlesonly:
legacy/server
legacy/client
Extensions
----------
The Per-Message Deflate extension is built-in. You may also define custom
extensions.
.. toctree::
:titlesonly:
extensions
Shared
------
These low-level APIs are shared by all implementations.
.. toctree::
:titlesonly:
datastructures
exceptions
types
variables
API stability
-------------
Public APIs documented in this API reference are subject to the
:ref:`backwards-compatibility policy <backwards-compatibility policy>`.
Anything that isn't listed in the API reference is a private API. There's no
guarantees of behavior or backwards-compatibility for private APIs.
Convenience imports
-------------------
For convenience, some public APIs can be imported directly from the
``websockets`` package.
|
