aboutsummaryrefslogtreecommitdiffstats
path: root/pathod/templates/docs_lang_websockets.html
blob: dd318e0b520340ef2d97ad1f3f6e8b3b26bdae39 (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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
<pre class="example">wf:[colon-separated list of features]</pre>
</p>

<table class="table table-bordered">
    <tbody>

        <tr>
            <td> b<a href="#valuespec">VALUE</a> </td>
            <td>
                Set the frame payload. If a masking key is present, the value is encoded automatically.
            </td>
        </tr>

        <tr>
            <td> c<a href="#valuespec">INTEGER</a> </td>
            <td>

                Set the op code. This can either be an integer from 0-15, or be one of the following
                opcode names: <b>text</b> (the default),
                <b>continue</b>, <b>binary</b>, <b>close</b>, <b>ping</b>,
                <b>pong</b>.

            </td>
        </tr>

        <tr>
            <td> d<a href="#offsetspec">OFFSET</a> </td>
            <td>
                Disconnect after OFFSET bytes.
            </td>
        </tr>

        <tr>
            <td> [-]fin </td>
            <td>
                Set or un-set the <b>fin</b> bit.
            </td>
        </tr>

        <tr>
            <td> i<a href="#offsetspec">OFFSET</a>,<a href="#valuespec">VALUE</a> </td>
            <td>
                Inject the specified value at the offset.
            </td>
        </tr>

        <tr>
            <td> k<a href="#valuespec">VALUE</a> </td>
            <td>
                Set the masking key. The resulting value must be exactly 4 bytes long. The special
                form
                <b>knone</b> specifies that no key should be set, even if the mask
                bit is on.
            </td>
        </tr>

        <tr>
            <td> l<a href="#valuespec">INTEGER</a> </td>
            <td>
                Set the payload length in the frame header, regardless of the actual body length.
            </td>
        </tr>

        <tr>
            <td> [-]mask </td>
            <td>
                Set or un-set the <b>mask</b> bit.
            </td>
        </tr>

        <tr>
            <td> p<a href="#offsetspec">OFFSET</a>,SECONDS </td>
            <td>
                Pause for SECONDS seconds after OFFSET bytes. SECONDS can be an integer or "f" to
                pause forever.
            </td>
        </tr>

        <tr>
            <td> r<a href="#valuespec">VALUE</a> </td>
            <td>
                Set the raw frame payload. This disables masking, even if the key is present.
            </td>
        </tr>

        <tr>
            <td> [-]rsv1 </td>
            <td>
                Set or un-set the <b>rsv1</b> bit.
            </td>
        </tr>

        <tr>
            <td> [-]rsv2 </td>
            <td>
                Set or un-set the <b>rsv2</b> bit.
            </td>
        </tr>

        <tr>
            <td> [-]rsv3 </td>
            <td>
                Set or un-set the <b>rsv3</b> bit.
            </td>
        </tr>

        <tr>
            <td> x<a href="#valuespec">INTEGER</a> </td>
            <td>
                Repeat this message N times.
            </td>
        </tr>

    </tbody>
</table>