aboutsummaryrefslogtreecommitdiffstats
path: root/pathod/libpathod/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
pre { line-height: 125%; margin: 0; }
td.linenos pre { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
span.linenos { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
td.linenos pre.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight { background: #ffffff; }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; f
<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>