From 179cc8dc1fd40fb44e8795af43ba6c4e22b22b0d Mon Sep 17 00:00:00 2001 From: Aldo Cortesi Date: Mon, 4 May 2015 09:54:59 +1200 Subject: Split up language docs, document websocket code specification. --- libpathod/templates/docs_lang.html | 248 +------------------------------------ 1 file changed, 4 insertions(+), 244 deletions(-) (limited to 'libpathod/templates/docs_lang.html') diff --git a/libpathod/templates/docs_lang.html b/libpathod/templates/docs_lang.html index ac3f8582..ce778dc9 100644 --- a/libpathod/templates/docs_lang.html +++ b/libpathod/templates/docs_lang.html @@ -16,257 +16,17 @@
- - 
code:[colon-separated list of features]

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
code -

An integer specifying the HTTP response code.

- -

The special method ws 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.

-
bVALUE - Set the body. The appropriate Content-Length header is - added automatically unless the "r" flag is set. -
cVALUE - A shortcut for setting the Content-Type header. Equivalent to - h"Content-Type"=VALUE -
dOFFSET - Disconnect after OFFSET bytes. -
hVALUE=VALUE - Set a header. -
iOFFSET,VALUE - Inject the specified value at the offset. -
lVALUE - A shortcut for setting the Location header. Equivalent to - h"Location"=VALUE -
mVALUE - HTTP Reason message. Automatically chosen according to - the response code if not specified. -
pOFFSET,SECONDS - Pause for SECONDS seconds after OFFSET bytes. SECONDS can - be an integer or "f" to pause forever. -
r - 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. -
+ {% include "docs_lang_responses.html" %}
- -
- - 
method:path:[colon-separated list of features]

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
method - -

A VALUE specifying the HTTP - method to use. Standard methods do not need to be - enclosed in quotes, while non-standard methods can be - specified as quoted strings.

- -

The special method ws creates a valid - websocket upgrade GET request, and signals to pathoc to - switch to websocket recieve mode if the server responds - correctly. Apart from that, websocket requests are just - like any other, and all aspects of the request can be - over-ridden.

-
bVALUE - Set the body. The appropriate Content-Length header is - added automatically unless the "r" flag is set. -
cVALUE - A shortcut for setting the Content-Type header. Equivalent to - h"Content-Type"=VALUE -
dOFFSET - Disconnect after OFFSET bytes. -
hVALUE=VALUE - Set a header. -
iOFFSET,VALUE - Inject the specified value at the offset. -
pOFFSET,SECONDS - Pause for SECONDS seconds after OFFSET bytes. SECONDS can - be an integer or "f" to pause forever. -
r - Set the "raw" flag on this response. Pathod will not - calculate a Content-Length header if a body is set. -
sVALUE - An embedded Response specification, appended to the path - of the request. -
uVALUE
uSHORTCUT 		- - Set a User-Agent header on this request. You can - specify either a complete VALUE, or a User-Agent shortcut: - - - {% for i in uastrings %} - - - - - {% endfor %} -
{{ i[1] }}{{ i[0] }}
- -
+ {% include "docs_lang_requests.html" %}
-
- - 
wf:[colon-separated list of features]

- - - - - - - - - - - - - - - - - - - - - - - - - -
bVALUE - Set the frame payload. If a masking key is present, the - value is encoded automatically. -
dOFFSET - Disconnect after OFFSET bytes. -
iOFFSET,VALUE - Inject the specified value at the offset. -
pOFFSET,SECONDS - Pause for SECONDS seconds after OFFSET bytes. SECONDS can - be an integer or "f" to pause forever. -
- - + {% include "docs_lang_websockets.html" %}
-
- - -
+

Features

-- cgit v1.2.3