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