summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/tools/third_party/websockets/docs/reference/asyncio/client.rst
diff options
context:
space:
mode:
Diffstat (limited to 'testing/web-platform/tests/tools/third_party/websockets/docs/reference/asyncio/client.rst')
-rw-r--r--testing/web-platform/tests/tools/third_party/websockets/docs/reference/asyncio/client.rst64
1 files changed, 64 insertions, 0 deletions
diff --git a/testing/web-platform/tests/tools/third_party/websockets/docs/reference/asyncio/client.rst b/testing/web-platform/tests/tools/third_party/websockets/docs/reference/asyncio/client.rst
new file mode 100644
index 0000000000..5086015b7b
--- /dev/null
+++ b/testing/web-platform/tests/tools/third_party/websockets/docs/reference/asyncio/client.rst
@@ -0,0 +1,64 @@
+Client (:mod:`asyncio`)
+=======================
+
+.. automodule:: websockets.client
+
+Opening a connection
+--------------------
+
+.. autofunction:: connect(uri, *, create_protocol=None, logger=None, compression="deflate", origin=None, extensions=None, subprotocols=None, extra_headers=None, user_agent_header="Python/x.y.z websockets/X.Y", open_timeout=10, ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2 ** 20, max_queue=2 ** 5, read_limit=2 ** 16, write_limit=2 ** 16, **kwds)
+ :async:
+
+.. autofunction:: unix_connect(path, uri="ws://localhost/", *, create_protocol=None, logger=None, compression="deflate", origin=None, extensions=None, subprotocols=None, extra_headers=None, user_agent_header="Python/x.y.z websockets/X.Y", open_timeout=10, ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2 ** 20, max_queue=2 ** 5, read_limit=2 ** 16, write_limit=2 ** 16, **kwds)
+ :async:
+
+Using a connection
+------------------
+
+.. autoclass:: WebSocketClientProtocol(*, logger=None, origin=None, extensions=None, subprotocols=None, extra_headers=None, user_agent_header="Python/x.y.z websockets/X.Y", ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2 ** 20, max_queue=2 ** 5, read_limit=2 ** 16, write_limit=2 ** 16)
+
+ .. automethod:: recv
+
+ .. automethod:: send
+
+ .. automethod:: close
+
+ .. automethod:: wait_closed
+
+ .. automethod:: ping
+
+ .. automethod:: pong
+
+ WebSocket connection objects also provide these attributes:
+
+ .. autoattribute:: id
+
+ .. autoattribute:: logger
+
+ .. autoproperty:: local_address
+
+ .. autoproperty:: remote_address
+
+ .. autoproperty:: open
+
+ .. autoproperty:: closed
+
+ .. autoattribute:: latency
+
+ The following attributes are available after the opening handshake,
+ once the WebSocket connection is open:
+
+ .. autoattribute:: path
+
+ .. autoattribute:: request_headers
+
+ .. autoattribute:: response_headers
+
+ .. autoattribute:: subprotocol
+
+ The following attributes are available after the closing handshake,
+ once the WebSocket connection is closed:
+
+ .. autoproperty:: close_code
+
+ .. autoproperty:: close_reason