summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/tools/third_party/websockets/docs/reference/sansio/common.rst
blob: cd1ef3c63a585203cfadab0a760372f32d7bc1b4 (plain)
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
:orphan:

Both sides  (`Sans-I/O`_)
=========================

.. _Sans-I/O: https://sans-io.readthedocs.io/

.. automodule:: websockets.protocol

.. autoclass:: Protocol(side, state=State.OPEN, max_size=2 ** 20, logger=None)

    .. automethod:: receive_data

    .. automethod:: receive_eof

    .. automethod:: send_continuation

    .. automethod:: send_text

    .. automethod:: send_binary

    .. automethod:: send_close

    .. automethod:: send_ping

    .. automethod:: send_pong

    .. automethod:: fail

    .. automethod:: events_received

    .. automethod:: data_to_send

    .. automethod:: close_expected

    .. autoattribute:: id

    .. autoattribute:: logger

    .. autoproperty:: state

    .. autoproperty:: close_code

    .. autoproperty:: close_reason

    .. autoproperty:: close_exc

.. autoclass:: Side

    .. autoattribute:: SERVER

    .. autoattribute:: CLIENT

.. autoclass:: State

    .. autoattribute:: CONNECTING

    .. autoattribute:: OPEN

    .. autoattribute:: CLOSING

    .. autoattribute:: CLOSED

.. autodata:: SEND_EOF