{% extends "docframe.html" %} {% block body %}

Language Spec The mini-language at the heart of pathoc and pathod.

The general form of a response is as follows:

code:[colon-separated list of features]

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.

The general form of a request is as follows:

method:path:[colon-separated list of features]

method A VALUE specifying the HTTP method to use. Standard methods do not need to be quoted. The special method ws creates a valid websocket upgrade request.
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] }}

Requests and responses can be decorated with the ws prefix to create a websockets client or server handshake. Since the websocket specifier implies a request method (GET) and a response code (102), these can optionally be omitted. All other request and response features can be applied, and websocket-specific headers can be over-ridden explicitly.

Request

ws:[method:]path:[colon-separated list of features]

This will generate a wsocket client handshake with a GET method:

ws:/

This will do the same, but using the (invalid) PUT method:

ws:put:/

Response

ws[:code:][colon-separated list of features]

This will generate a simple protocol acceptance with a 101 response code:

ws

This will do the same, but using the (invalid) 202 code:

ws:202

Features

OFFSET

Offsets are calculated relative to the base message, before any injections or other transforms are applied. They have 3 flavors:

VALUE

Literals

Literal values are specified as a quoted strings: 

"foo"

Either single or double quotes are accepted, and quotes can be escaped with backslashes within the string:

'fo\'o'

Literal values can contain Python-style backslash escape sequences:

'foo\r\nbar'

Files

You can load a value from a specified file path. To do so, you have to specify a _staticdir_ option to pathod on the command-line, like so: 

pathod -d ~/myassets

All paths are relative paths under this directory. File loads are indicated by starting the value specifier with the left angle bracket: 

<my/path

The path value can also be a quoted string, with the same syntax as literals:

<"my/path"

Generated values

An @-symbol lead-in specifies that generated data should be used. There are two components to a generator specification - a size, and a data type. By default pathod assumes a data type of "bytes".

Here's a value specifier for generating 100 bytes: 

@100

You can use standard suffixes to indicate larger values. Here, for instance, is a specifier for generating 100 megabytes:

@100m

Data is generated and served efficiently - if you really want to send a terabyte of data to a client, pathod can do it. The supported suffixes are:

b 1024**0 (bytes)
k 1024**1 (kilobytes)
m 1024**2 (megabytes)
g 1024**3 (gigabytes)
t 1024**4 (terabytes)

Data types are separated from the size specification by a comma. This specification generates 100mb of ASCII:

@100m,ascii

Supported data types are:

ascii All ASCII characters
ascii_letters A-Za-z
ascii_lowercase a-z
ascii_uppercase A-Z
bytes All 256 byte values
digits 0-9
hexdigits 0-f
octdigits 0-7
punctuation 
!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~
whitespace 
\t\n\x0b\x0c\r and space
{% endblock %}