summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/tools/third_party/websockets/docs/reference/sync/server.rst
diff options
context:
space:
mode:
Diffstat (limited to 'testing/web-platform/tests/tools/third_party/websockets/docs/reference/sync/server.rst')
-rw-r--r--testing/web-platform/tests/tools/third_party/websockets/docs/reference/sync/server.rst60
1 files changed, 60 insertions, 0 deletions
diff --git a/testing/web-platform/tests/tools/third_party/websockets/docs/reference/sync/server.rst b/testing/web-platform/tests/tools/third_party/websockets/docs/reference/sync/server.rst
new file mode 100644
index 0000000000..35c112046a
--- /dev/null
+++ b/testing/web-platform/tests/tools/third_party/websockets/docs/reference/sync/server.rst
@@ -0,0 +1,60 @@
+Server (:mod:`threading`)
+=========================
+
+.. automodule:: websockets.sync.server
+
+Creating a server
+-----------------
+
+.. autofunction:: serve(handler, host=None, port=None, *, sock=None, ssl_context=None, origins=None, extensions=None, subprotocols=None, select_subprotocol=None, process_request=None, process_response=None, server_header="Python/x.y.z websockets/X.Y", compression="deflate", open_timeout=10, close_timeout=10, max_size=2 ** 20, logger=None, create_connection=None)
+
+.. autofunction:: unix_serve(handler, path=None, *, sock=None, ssl_context=None, origins=None, extensions=None, subprotocols=None, select_subprotocol=None, process_request=None, process_response=None, server_header="Python/x.y.z websockets/X.Y", compression="deflate", open_timeout=10, close_timeout=10, max_size=2 ** 20, logger=None, create_connection=None)
+
+Running a server
+----------------
+
+.. autoclass:: WebSocketServer
+
+ .. automethod:: serve_forever
+
+ .. automethod:: shutdown
+
+ .. automethod:: fileno
+
+Using a connection
+------------------
+
+.. autoclass:: ServerConnection
+
+ .. automethod:: __iter__
+
+ .. automethod:: recv
+
+ .. automethod:: recv_streaming
+
+ .. automethod:: send
+
+ .. automethod:: close
+
+ .. automethod:: ping
+
+ .. automethod:: pong
+
+ WebSocket connection objects also provide these attributes:
+
+ .. autoattribute:: id
+
+ .. autoattribute:: logger
+
+ .. autoproperty:: local_address
+
+ .. autoproperty:: remote_address
+
+ The following attributes are available after the opening handshake,
+ once the WebSocket connection is open:
+
+ .. autoattribute:: request
+
+ .. autoattribute:: response
+
+ .. autoproperty:: subprotocol