aboutsummaryrefslogtreecommitdiffstats
path: root/libpathod/templates/docs_lang_responses.html
blob: e8590addb81b9d53d1920b1ab76276d2602fea1c (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
<pre class="example">code:[colon-separated list of features]</pre></p>

<table class="table table-bordered">
    <tbody >
        <tr>
            <td> code </td>
            <td>
                <p>An integer specifying the HTTP response code.</p>

                <p>The special method <b>ws</b> creates a valid
                websocket upgrade response (code 101), and moves pathod
                to websocket mode. Apart from that, websocket responses
                are just like any other, and all aspects of the
                response can be over-ridden.</p>
            </td>
        </tr>

        <tr>
            <td> b<a href="#valuespec">VALUE</a> </td>
            <td>
                Set the body. The appropriate Content-Length header is
                added automatically unless the "r" flag is set.
            </td>
        </tr>

        <tr>
            <td> c<a href="#valuespec">VALUE</a> </td>
            <td>
                A shortcut for setting the Content-Type header. Equivalent to
                h"Content-Type"=VALUE
            </td>
        </tr>

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

        <tr>
            <td> h<a href="#valuespec">VALUE</a>=<a href="#valuespec">VALUE</a> </td>
            <td>
                Set a header.
            </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> l<a href="#valuespec">VALUE</a> </td>
            <td>
                A shortcut for setting the Location header. Equivalent to
                h"Location"=VALUE
            </td>
        </tr>

        <tr>
            <td> m<a href="#valuespec">VALUE</a> </td>
            <td>
                HTTP Reason message. Automatically chosen according to
                the response code if not specified.
            </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 </td>
            <td>
                Set the "raw" flag on this response. Pathod will not
                calculate a Content-Length header if a body is set, or add
                a Date header to the response.
            </td>
        </tr>
    </tbody>
</table>