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
|
:orphan:
Both sides (legacy)
===================
.. admonition:: The legacy :mod:`asyncio` implementation is deprecated.
:class: caution
The :doc:`upgrade guide <../../howto/upgrade>` provides complete instructions
to migrate your application.
.. automodule:: websockets.legacy.protocol
.. autoclass:: WebSocketCommonProtocol(*, logger=None, 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
|