diff options
| author | Loïc Hoguin <[email protected]> | 2018-11-19 13:29:35 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2018-11-19 13:29:35 +0100 |
| commit | 3edee0ace8f3f12653381e8038461689363c9541 (patch) | |
| tree | 25c351b121ff008ed7a73ee945dc1f2d28a025c1 /docs | |
| parent | 4ddd4e856a43c800227878c4b145aca15ce3f579 (diff) | |
| download | ninenines.eu-3edee0ace8f3f12653381e8038461689363c9541.tar.gz ninenines.eu-3edee0ace8f3f12653381e8038461689363c9541.tar.bz2 ninenines.eu-3edee0ace8f3f12653381e8038461689363c9541.zip | |
Cowboy 2.6.0
Diffstat (limited to 'docs')
732 files changed, 42788 insertions, 0 deletions
diff --git a/docs/en/cowboy/2.0/guide/constraints/index.html b/docs/en/cowboy/2.0/guide/constraints/index.html index 0ea0dba4..40254e6c 100644 --- a/docs/en/cowboy/2.0/guide/constraints/index.html +++ b/docs/en/cowboy/2.0/guide/constraints/index.html @@ -198,6 +198,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/cookies/index.html b/docs/en/cowboy/2.0/guide/cookies/index.html index ff9cab45..d11f38ff 100644 --- a/docs/en/cowboy/2.0/guide/cookies/index.html +++ b/docs/en/cowboy/2.0/guide/cookies/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/erlang_web/index.html b/docs/en/cowboy/2.0/guide/erlang_web/index.html index d0a72267..cd45c640 100644 --- a/docs/en/cowboy/2.0/guide/erlang_web/index.html +++ b/docs/en/cowboy/2.0/guide/erlang_web/index.html @@ -164,6 +164,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/flow_diagram/index.html b/docs/en/cowboy/2.0/guide/flow_diagram/index.html index 52df9172..cf079f57 100644 --- a/docs/en/cowboy/2.0/guide/flow_diagram/index.html +++ b/docs/en/cowboy/2.0/guide/flow_diagram/index.html @@ -142,6 +142,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/getting_started/index.html b/docs/en/cowboy/2.0/guide/getting_started/index.html index 5e97f30b..b3409aba 100644 --- a/docs/en/cowboy/2.0/guide/getting_started/index.html +++ b/docs/en/cowboy/2.0/guide/getting_started/index.html @@ -216,6 +216,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/handlers/index.html b/docs/en/cowboy/2.0/guide/handlers/index.html index d47c153c..6fdc5ac0 100644 --- a/docs/en/cowboy/2.0/guide/handlers/index.html +++ b/docs/en/cowboy/2.0/guide/handlers/index.html @@ -169,6 +169,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/index.html b/docs/en/cowboy/2.0/guide/index.html index 2a0e3272..ea3295af 100644 --- a/docs/en/cowboy/2.0/guide/index.html +++ b/docs/en/cowboy/2.0/guide/index.html @@ -169,6 +169,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/introduction/index.html b/docs/en/cowboy/2.0/guide/introduction/index.html index 758623f7..8471d0c6 100644 --- a/docs/en/cowboy/2.0/guide/introduction/index.html +++ b/docs/en/cowboy/2.0/guide/introduction/index.html @@ -152,6 +152,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/listeners/index.html b/docs/en/cowboy/2.0/guide/listeners/index.html index 63607df5..c1c8c8ee 100644 --- a/docs/en/cowboy/2.0/guide/listeners/index.html +++ b/docs/en/cowboy/2.0/guide/listeners/index.html @@ -173,6 +173,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/loop_handlers/index.html b/docs/en/cowboy/2.0/guide/loop_handlers/index.html index a7a89a06..58d90775 100644 --- a/docs/en/cowboy/2.0/guide/loop_handlers/index.html +++ b/docs/en/cowboy/2.0/guide/loop_handlers/index.html @@ -184,6 +184,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/middlewares/index.html b/docs/en/cowboy/2.0/guide/middlewares/index.html index e2b71e9b..f7c6a525 100644 --- a/docs/en/cowboy/2.0/guide/middlewares/index.html +++ b/docs/en/cowboy/2.0/guide/middlewares/index.html @@ -150,6 +150,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/migrating_from_1.0/index.html b/docs/en/cowboy/2.0/guide/migrating_from_1.0/index.html index a29536d3..40fd24f9 100644 --- a/docs/en/cowboy/2.0/guide/migrating_from_1.0/index.html +++ b/docs/en/cowboy/2.0/guide/migrating_from_1.0/index.html @@ -230,6 +230,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/modern_web/index.html b/docs/en/cowboy/2.0/guide/modern_web/index.html index 958c661f..07152819 100644 --- a/docs/en/cowboy/2.0/guide/modern_web/index.html +++ b/docs/en/cowboy/2.0/guide/modern_web/index.html @@ -146,6 +146,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/multipart/index.html b/docs/en/cowboy/2.0/guide/multipart/index.html index 9e1e31cc..694f1bc8 100644 --- a/docs/en/cowboy/2.0/guide/multipart/index.html +++ b/docs/en/cowboy/2.0/guide/multipart/index.html @@ -219,6 +219,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/req/index.html b/docs/en/cowboy/2.0/guide/req/index.html index 387f16bf..80f12f50 100644 --- a/docs/en/cowboy/2.0/guide/req/index.html +++ b/docs/en/cowboy/2.0/guide/req/index.html @@ -395,6 +395,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/req_body/index.html b/docs/en/cowboy/2.0/guide/req_body/index.html index a32e84da..788e3c9c 100644 --- a/docs/en/cowboy/2.0/guide/req_body/index.html +++ b/docs/en/cowboy/2.0/guide/req_body/index.html @@ -205,6 +205,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/resource_design/index.html b/docs/en/cowboy/2.0/guide/resource_design/index.html index 334c02c5..d3eaec46 100644 --- a/docs/en/cowboy/2.0/guide/resource_design/index.html +++ b/docs/en/cowboy/2.0/guide/resource_design/index.html @@ -178,6 +178,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/resp/index.html b/docs/en/cowboy/2.0/guide/resp/index.html index 8e63f915..374ea597 100644 --- a/docs/en/cowboy/2.0/guide/resp/index.html +++ b/docs/en/cowboy/2.0/guide/resp/index.html @@ -330,6 +330,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/rest_flowcharts/index.html b/docs/en/cowboy/2.0/guide/rest_flowcharts/index.html index 883fcb14..890b95fc 100644 --- a/docs/en/cowboy/2.0/guide/rest_flowcharts/index.html +++ b/docs/en/cowboy/2.0/guide/rest_flowcharts/index.html @@ -176,6 +176,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/rest_handlers/index.html b/docs/en/cowboy/2.0/guide/rest_handlers/index.html index 07cedb49..d031404c 100644 --- a/docs/en/cowboy/2.0/guide/rest_handlers/index.html +++ b/docs/en/cowboy/2.0/guide/rest_handlers/index.html @@ -274,6 +274,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/rest_principles/index.html b/docs/en/cowboy/2.0/guide/rest_principles/index.html index 39d55bd4..0eb73605 100644 --- a/docs/en/cowboy/2.0/guide/rest_principles/index.html +++ b/docs/en/cowboy/2.0/guide/rest_principles/index.html @@ -150,6 +150,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/routing/index.html b/docs/en/cowboy/2.0/guide/routing/index.html index fe04affb..dcdc5e05 100644 --- a/docs/en/cowboy/2.0/guide/routing/index.html +++ b/docs/en/cowboy/2.0/guide/routing/index.html @@ -293,6 +293,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/specs/index.html b/docs/en/cowboy/2.0/guide/specs/index.html index 06bd4f3d..8dce3e80 100644 --- a/docs/en/cowboy/2.0/guide/specs/index.html +++ b/docs/en/cowboy/2.0/guide/specs/index.html @@ -445,6 +445,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/static_files/index.html b/docs/en/cowboy/2.0/guide/static_files/index.html index 15afe71c..e6517dbf 100644 --- a/docs/en/cowboy/2.0/guide/static_files/index.html +++ b/docs/en/cowboy/2.0/guide/static_files/index.html @@ -213,6 +213,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/streams/index.html b/docs/en/cowboy/2.0/guide/streams/index.html index 5ab7b927..d5bfaa40 100644 --- a/docs/en/cowboy/2.0/guide/streams/index.html +++ b/docs/en/cowboy/2.0/guide/streams/index.html @@ -135,6 +135,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/ws_handlers/index.html b/docs/en/cowboy/2.0/guide/ws_handlers/index.html index fdbb62b5..5a88a116 100644 --- a/docs/en/cowboy/2.0/guide/ws_handlers/index.html +++ b/docs/en/cowboy/2.0/guide/ws_handlers/index.html @@ -282,6 +282,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/guide/ws_protocol/index.html b/docs/en/cowboy/2.0/guide/ws_protocol/index.html index 4661f018..82e74ab9 100644 --- a/docs/en/cowboy/2.0/guide/ws_protocol/index.html +++ b/docs/en/cowboy/2.0/guide/ws_protocol/index.html @@ -134,6 +134,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.0/manual/cowboy.set_env/index.html index 09821584..47d64d22 100644 --- a/docs/en/cowboy/2.0/manual/cowboy.set_env/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy.set_env/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy.start_clear/index.html b/docs/en/cowboy/2.0/manual/cowboy.start_clear/index.html index f3f0daf6..370c074d 100644 --- a/docs/en/cowboy/2.0/manual/cowboy.start_clear/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy.start_clear/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy.start_tls/index.html b/docs/en/cowboy/2.0/manual/cowboy.start_tls/index.html index 8bff8296..abae2821 100644 --- a/docs/en/cowboy/2.0/manual/cowboy.start_tls/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy.start_tls/index.html @@ -172,6 +172,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy.stop_listener/index.html b/docs/en/cowboy/2.0/manual/cowboy.stop_listener/index.html index b47e8d9d..4eab80bc 100644 --- a/docs/en/cowboy/2.0/manual/cowboy.stop_listener/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy.stop_listener/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy/index.html b/docs/en/cowboy/2.0/manual/cowboy/index.html index 1b605580..4bf2bf2c 100644 --- a/docs/en/cowboy/2.0/manual/cowboy/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_app/index.html b/docs/en/cowboy/2.0/manual/cowboy_app/index.html index 4a630dd3..70b94d77 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_app/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_app/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_constraints.int/index.html b/docs/en/cowboy/2.0/manual/cowboy_constraints.int/index.html index 1e0a2452..4cc1defd 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_constraints.int/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_constraints.int/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_constraints.nonempty/index.html b/docs/en/cowboy/2.0/manual/cowboy_constraints.nonempty/index.html index 6186cabe..3c6248da 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_constraints.nonempty/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_constraints.nonempty/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_constraints/index.html b/docs/en/cowboy/2.0/manual/cowboy_constraints/index.html index 45466709..2e81fe6b 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_constraints/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_constraints/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_handler.terminate/index.html b/docs/en/cowboy/2.0/manual/cowboy_handler.terminate/index.html index 5fcf1a52..713af51a 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_handler.terminate/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_handler.terminate/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_handler/index.html b/docs/en/cowboy/2.0/manual/cowboy_handler/index.html index 354db94d..c8ebac74 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_handler/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_handler/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_http/index.html b/docs/en/cowboy/2.0/manual/cowboy_http/index.html index 5d62f3a0..3ad692b8 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_http/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_http/index.html @@ -200,6 +200,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_http2/index.html b/docs/en/cowboy/2.0/manual/cowboy_http2/index.html index 52a2b1d0..7393ef49 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_http2/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_http2/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_loop/index.html b/docs/en/cowboy/2.0/manual/cowboy_loop/index.html index 256a7c31..19837cd0 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_loop/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_loop/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.0/manual/cowboy_middleware/index.html index c048bf82..e91b4c75 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_middleware/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_middleware/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.binding/index.html index 3a5d1c69..328a1a9e 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.binding/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.binding/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.bindings/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.bindings/index.html index 32f652d7..7fd4bf4a 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.bindings/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.bindings/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.body_length/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.body_length/index.html index 1c484cfa..363841ef 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.body_length/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.body_length/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.delete_resp_header/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.delete_resp_header/index.html index 31c69464..3345c8ad 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.delete_resp_header/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.delete_resp_header/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.has_body/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.has_body/index.html index d51ffe4b..40d5f9f7 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.has_body/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.has_body/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.has_resp_body/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.has_resp_body/index.html index 334d0fa2..2bc55b36 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.has_resp_body/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.has_resp_body/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.has_resp_header/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.has_resp_header/index.html index d58cb61c..99e69b8c 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.has_resp_header/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.has_resp_header/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.header/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.header/index.html index ad471d5b..a0777d03 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.header/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.header/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.headers/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.headers/index.html index 3bdbecf3..0a5cbc7e 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.headers/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.headers/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.host/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.host/index.html index e12f9f33..9a7c1be3 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.host/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.host/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.host_info/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.host_info/index.html index 2a1e104f..7858c3f6 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.host_info/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.host_info/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.match_cookies/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.match_cookies/index.html index 51e2c7e4..599a7605 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.match_cookies/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.match_cookies/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.match_qs/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.match_qs/index.html index dc5cf0df..6aa8bfc6 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.match_qs/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.match_qs/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.method/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.method/index.html index 5357601c..2d14f95a 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.method/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.method/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.parse_cookies/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.parse_cookies/index.html index b1b6baee..4d44fb1a 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.parse_cookies/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.parse_cookies/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.parse_header/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.parse_header/index.html index 5bcf7685..b21787b3 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.parse_header/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.parse_header/index.html @@ -308,6 +308,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.parse_qs/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.parse_qs/index.html index 5196788a..c4bfd0c3 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.parse_qs/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.parse_qs/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.path/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.path/index.html index 660d8d1f..113a5b6b 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.path/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.path/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.path_info/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.path_info/index.html index cc7870cb..746e0ebc 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.path_info/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.path_info/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.peer/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.peer/index.html index c3cf2643..252b31a7 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.peer/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.peer/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.port/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.port/index.html index 1563c5cc..9fefac89 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.port/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.port/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.push/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.push/index.html index a820a175..387c3e2a 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.push/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.push/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.qs/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.qs/index.html index 3481dd90..7bc3b34e 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.qs/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.qs/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.read_body/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.read_body/index.html index 844402c0..db316f30 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.read_body/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.read_body/index.html @@ -162,6 +162,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.read_part/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.read_part/index.html index 50c6f5d2..46d34147 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.read_part/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.read_part/index.html @@ -184,6 +184,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.read_part_body/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.read_part_body/index.html index 5e432951..80e95222 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.read_part_body/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.read_part_body/index.html @@ -160,6 +160,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.read_urlencoded_body/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.read_urlencoded_body/index.html index 76fa5044..5b560ab2 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.read_urlencoded_body/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.read_urlencoded_body/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.reply/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.reply/index.html index fead01ac..1f71699c 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.reply/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.reply/index.html @@ -177,6 +177,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.resp_header/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.resp_header/index.html index 527d93bd..3600180b 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.resp_header/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.resp_header/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.resp_headers/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.resp_headers/index.html index 5ff7beb4..1acdd47c 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.resp_headers/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.resp_headers/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.scheme/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.scheme/index.html index 75e5cee6..8926305b 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.scheme/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.scheme/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_body/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_body/index.html index 2313cec1..77cfea86 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_body/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_body/index.html @@ -169,6 +169,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_cookie/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_cookie/index.html index b84863f7..a07a7ef0 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_cookie/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_cookie/index.html @@ -194,6 +194,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_header/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_header/index.html index c7b45203..260372cc 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_header/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_header/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_headers/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_headers/index.html index af12f582..e5289afe 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_headers/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_headers/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.stream_body/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.stream_body/index.html index 5befffef..73bfb2af 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.stream_body/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.stream_body/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.stream_reply/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.stream_reply/index.html index e1d523e4..e8a47257 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.stream_reply/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.stream_reply/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.uri/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.uri/index.html index 10091092..03935d24 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.uri/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.uri/index.html @@ -196,6 +196,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.version/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.version/index.html index 3d787f2a..26712f7f 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.version/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.version/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_req/index.html b/docs/en/cowboy/2.0/manual/cowboy_req/index.html index b7447447..acd52ef5 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req/index.html @@ -296,6 +296,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_rest/index.html b/docs/en/cowboy/2.0/manual/cowboy_rest/index.html index bd6538fa..cf8cba5d 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_rest/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_rest/index.html @@ -554,6 +554,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_router.compile/index.html b/docs/en/cowboy/2.0/manual/cowboy_router.compile/index.html index 98ac5611..e8f2bde8 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_router.compile/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_router.compile/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_router/index.html b/docs/en/cowboy/2.0/manual/cowboy_router/index.html index a479a166..fedaf0fd 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_router/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_router/index.html @@ -155,6 +155,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_static/index.html b/docs/en/cowboy/2.0/manual/cowboy_static/index.html index 2fffe902..6a2c0f42 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_static/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_static/index.html @@ -200,6 +200,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_stream/index.html b/docs/en/cowboy/2.0/manual/cowboy_stream/index.html index 5ae7a5f9..91d95c0c 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_stream/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_stream/index.html @@ -372,6 +372,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/cowboy_websocket/index.html b/docs/en/cowboy/2.0/manual/cowboy_websocket/index.html index d52ee4fd..b4fedb73 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_websocket/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_websocket/index.html @@ -234,6 +234,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/http_status_codes/index.html b/docs/en/cowboy/2.0/manual/http_status_codes/index.html index 14248a95..5dfda381 100644 --- a/docs/en/cowboy/2.0/manual/http_status_codes/index.html +++ b/docs/en/cowboy/2.0/manual/http_status_codes/index.html @@ -182,6 +182,8 @@ + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.0/manual/index.html b/docs/en/cowboy/2.0/manual/index.html index 3fcef778..a1c89b6b 100644 --- a/docs/en/cowboy/2.0/manual/index.html +++ b/docs/en/cowboy/2.0/manual/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/constraints/index.html b/docs/en/cowboy/2.1/guide/constraints/index.html index 28bbc69e..946e11ba 100644 --- a/docs/en/cowboy/2.1/guide/constraints/index.html +++ b/docs/en/cowboy/2.1/guide/constraints/index.html @@ -198,6 +198,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/cookies/index.html b/docs/en/cowboy/2.1/guide/cookies/index.html index eedd9cc1..fd71e2ff 100644 --- a/docs/en/cowboy/2.1/guide/cookies/index.html +++ b/docs/en/cowboy/2.1/guide/cookies/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/erlang_web/index.html b/docs/en/cowboy/2.1/guide/erlang_web/index.html index a1ffdeb5..ffc9d013 100644 --- a/docs/en/cowboy/2.1/guide/erlang_web/index.html +++ b/docs/en/cowboy/2.1/guide/erlang_web/index.html @@ -164,6 +164,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/flow_diagram/index.html b/docs/en/cowboy/2.1/guide/flow_diagram/index.html index a580ec6f..3e56bde1 100644 --- a/docs/en/cowboy/2.1/guide/flow_diagram/index.html +++ b/docs/en/cowboy/2.1/guide/flow_diagram/index.html @@ -142,6 +142,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/getting_started/index.html b/docs/en/cowboy/2.1/guide/getting_started/index.html index ac3d501e..6fdcca01 100644 --- a/docs/en/cowboy/2.1/guide/getting_started/index.html +++ b/docs/en/cowboy/2.1/guide/getting_started/index.html @@ -216,6 +216,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/handlers/index.html b/docs/en/cowboy/2.1/guide/handlers/index.html index dbc6ad77..33a5e2ac 100644 --- a/docs/en/cowboy/2.1/guide/handlers/index.html +++ b/docs/en/cowboy/2.1/guide/handlers/index.html @@ -169,6 +169,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/index.html b/docs/en/cowboy/2.1/guide/index.html index af8fffcc..6b41a68d 100644 --- a/docs/en/cowboy/2.1/guide/index.html +++ b/docs/en/cowboy/2.1/guide/index.html @@ -171,6 +171,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/introduction/index.html b/docs/en/cowboy/2.1/guide/introduction/index.html index 80b7d341..d4ecea1a 100644 --- a/docs/en/cowboy/2.1/guide/introduction/index.html +++ b/docs/en/cowboy/2.1/guide/introduction/index.html @@ -152,6 +152,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/listeners/index.html b/docs/en/cowboy/2.1/guide/listeners/index.html index 9222d23b..6724db35 100644 --- a/docs/en/cowboy/2.1/guide/listeners/index.html +++ b/docs/en/cowboy/2.1/guide/listeners/index.html @@ -173,6 +173,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/loop_handlers/index.html b/docs/en/cowboy/2.1/guide/loop_handlers/index.html index 56ab30d7..a5e362b0 100644 --- a/docs/en/cowboy/2.1/guide/loop_handlers/index.html +++ b/docs/en/cowboy/2.1/guide/loop_handlers/index.html @@ -184,6 +184,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/middlewares/index.html b/docs/en/cowboy/2.1/guide/middlewares/index.html index 5453ba59..12d585fb 100644 --- a/docs/en/cowboy/2.1/guide/middlewares/index.html +++ b/docs/en/cowboy/2.1/guide/middlewares/index.html @@ -150,6 +150,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/migrating_from_1.0/index.html b/docs/en/cowboy/2.1/guide/migrating_from_1.0/index.html index aef5c570..ce569cc7 100644 --- a/docs/en/cowboy/2.1/guide/migrating_from_1.0/index.html +++ b/docs/en/cowboy/2.1/guide/migrating_from_1.0/index.html @@ -232,6 +232,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/migrating_from_2.0/index.html b/docs/en/cowboy/2.1/guide/migrating_from_2.0/index.html index c0de585d..58cf7a1a 100644 --- a/docs/en/cowboy/2.1/guide/migrating_from_2.0/index.html +++ b/docs/en/cowboy/2.1/guide/migrating_from_2.0/index.html @@ -167,6 +167,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/modern_web/index.html b/docs/en/cowboy/2.1/guide/modern_web/index.html index 29df5fe1..1a137680 100644 --- a/docs/en/cowboy/2.1/guide/modern_web/index.html +++ b/docs/en/cowboy/2.1/guide/modern_web/index.html @@ -146,6 +146,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/multipart/index.html b/docs/en/cowboy/2.1/guide/multipart/index.html index 8dd8ac72..0872cd10 100644 --- a/docs/en/cowboy/2.1/guide/multipart/index.html +++ b/docs/en/cowboy/2.1/guide/multipart/index.html @@ -219,6 +219,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/req/index.html b/docs/en/cowboy/2.1/guide/req/index.html index 86744be7..c3481e21 100644 --- a/docs/en/cowboy/2.1/guide/req/index.html +++ b/docs/en/cowboy/2.1/guide/req/index.html @@ -395,6 +395,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/req_body/index.html b/docs/en/cowboy/2.1/guide/req_body/index.html index b4a4b0fe..208ee661 100644 --- a/docs/en/cowboy/2.1/guide/req_body/index.html +++ b/docs/en/cowboy/2.1/guide/req_body/index.html @@ -205,6 +205,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/resource_design/index.html b/docs/en/cowboy/2.1/guide/resource_design/index.html index a0035c94..0bdf50de 100644 --- a/docs/en/cowboy/2.1/guide/resource_design/index.html +++ b/docs/en/cowboy/2.1/guide/resource_design/index.html @@ -178,6 +178,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/resp/index.html b/docs/en/cowboy/2.1/guide/resp/index.html index 53a12444..02f099d0 100644 --- a/docs/en/cowboy/2.1/guide/resp/index.html +++ b/docs/en/cowboy/2.1/guide/resp/index.html @@ -343,6 +343,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/rest_flowcharts/index.html b/docs/en/cowboy/2.1/guide/rest_flowcharts/index.html index 92b82796..30dc86c0 100644 --- a/docs/en/cowboy/2.1/guide/rest_flowcharts/index.html +++ b/docs/en/cowboy/2.1/guide/rest_flowcharts/index.html @@ -176,6 +176,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/rest_handlers/index.html b/docs/en/cowboy/2.1/guide/rest_handlers/index.html index 1eddd2ec..c51eadcd 100644 --- a/docs/en/cowboy/2.1/guide/rest_handlers/index.html +++ b/docs/en/cowboy/2.1/guide/rest_handlers/index.html @@ -274,6 +274,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/rest_principles/index.html b/docs/en/cowboy/2.1/guide/rest_principles/index.html index 9fba533f..30a8d5ea 100644 --- a/docs/en/cowboy/2.1/guide/rest_principles/index.html +++ b/docs/en/cowboy/2.1/guide/rest_principles/index.html @@ -150,6 +150,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/routing/index.html b/docs/en/cowboy/2.1/guide/routing/index.html index eb73ea7c..48bcfb66 100644 --- a/docs/en/cowboy/2.1/guide/routing/index.html +++ b/docs/en/cowboy/2.1/guide/routing/index.html @@ -293,6 +293,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/specs/index.html b/docs/en/cowboy/2.1/guide/specs/index.html index eff3c95a..4cbfad05 100644 --- a/docs/en/cowboy/2.1/guide/specs/index.html +++ b/docs/en/cowboy/2.1/guide/specs/index.html @@ -445,6 +445,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/static_files/index.html b/docs/en/cowboy/2.1/guide/static_files/index.html index e79734bc..e3dc76d6 100644 --- a/docs/en/cowboy/2.1/guide/static_files/index.html +++ b/docs/en/cowboy/2.1/guide/static_files/index.html @@ -213,6 +213,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/streams/index.html b/docs/en/cowboy/2.1/guide/streams/index.html index f8e27b51..e0f72ced 100644 --- a/docs/en/cowboy/2.1/guide/streams/index.html +++ b/docs/en/cowboy/2.1/guide/streams/index.html @@ -135,6 +135,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/ws_handlers/index.html b/docs/en/cowboy/2.1/guide/ws_handlers/index.html index f84ca129..14c48cc0 100644 --- a/docs/en/cowboy/2.1/guide/ws_handlers/index.html +++ b/docs/en/cowboy/2.1/guide/ws_handlers/index.html @@ -283,6 +283,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/guide/ws_protocol/index.html b/docs/en/cowboy/2.1/guide/ws_protocol/index.html index af22723b..10bb8b53 100644 --- a/docs/en/cowboy/2.1/guide/ws_protocol/index.html +++ b/docs/en/cowboy/2.1/guide/ws_protocol/index.html @@ -134,6 +134,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.1/manual/cowboy.set_env/index.html index 1dd7bf7e..2bfe02f3 100644 --- a/docs/en/cowboy/2.1/manual/cowboy.set_env/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy.set_env/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy.start_clear/index.html b/docs/en/cowboy/2.1/manual/cowboy.start_clear/index.html index e2703f38..43bbd183 100644 --- a/docs/en/cowboy/2.1/manual/cowboy.start_clear/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy.start_clear/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy.start_tls/index.html b/docs/en/cowboy/2.1/manual/cowboy.start_tls/index.html index 95d041c7..1ae22b0a 100644 --- a/docs/en/cowboy/2.1/manual/cowboy.start_tls/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy.start_tls/index.html @@ -172,6 +172,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy.stop_listener/index.html b/docs/en/cowboy/2.1/manual/cowboy.stop_listener/index.html index 721f3ba1..5fc8c72e 100644 --- a/docs/en/cowboy/2.1/manual/cowboy.stop_listener/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy.stop_listener/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy/index.html b/docs/en/cowboy/2.1/manual/cowboy/index.html index a58c15aa..868f9da2 100644 --- a/docs/en/cowboy/2.1/manual/cowboy/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_app/index.html b/docs/en/cowboy/2.1/manual/cowboy_app/index.html index cab9e027..b193ffdd 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_app/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_app/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_constraints.int/index.html b/docs/en/cowboy/2.1/manual/cowboy_constraints.int/index.html index 7b194ef7..72133bfe 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_constraints.int/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_constraints.int/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_constraints.nonempty/index.html b/docs/en/cowboy/2.1/manual/cowboy_constraints.nonempty/index.html index 027718d0..caf12eee 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_constraints.nonempty/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_constraints.nonempty/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_constraints/index.html b/docs/en/cowboy/2.1/manual/cowboy_constraints/index.html index 061884a3..102f87cd 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_constraints/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_constraints/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_handler.terminate/index.html b/docs/en/cowboy/2.1/manual/cowboy_handler.terminate/index.html index e3eb517f..f5438023 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_handler.terminate/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_handler.terminate/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_handler/index.html b/docs/en/cowboy/2.1/manual/cowboy_handler/index.html index 8745ead4..2d2c8149 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_handler/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_handler/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_http/index.html b/docs/en/cowboy/2.1/manual/cowboy_http/index.html index 8dff46ed..aefa301f 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_http/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_http/index.html @@ -200,6 +200,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_http2/index.html b/docs/en/cowboy/2.1/manual/cowboy_http2/index.html index 4a688c42..a9faaba4 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_http2/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_http2/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_loop/index.html b/docs/en/cowboy/2.1/manual/cowboy_loop/index.html index a4bd89f7..32c1ed7a 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_loop/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_loop/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.1/manual/cowboy_middleware/index.html index c8273d72..87ff8020 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_middleware/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_middleware/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.binding/index.html index 0539427f..5bd8e9fb 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.binding/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.binding/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.bindings/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.bindings/index.html index e9f63888..0248fb28 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.bindings/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.bindings/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.body_length/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.body_length/index.html index d9d09cfe..312b1d4b 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.body_length/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.body_length/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.cert/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.cert/index.html index 5bcc796e..482b8db1 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.cert/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.cert/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.delete_resp_header/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.delete_resp_header/index.html index a4e071b8..dc08bca6 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.delete_resp_header/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.delete_resp_header/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.has_body/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.has_body/index.html index efdcab38..8ac5158d 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.has_body/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.has_body/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.has_resp_body/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.has_resp_body/index.html index 37d6bec2..2ccbeb04 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.has_resp_body/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.has_resp_body/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.has_resp_header/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.has_resp_header/index.html index f9611ee7..c19e99ec 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.has_resp_header/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.has_resp_header/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.header/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.header/index.html index ae120f4b..a873b1f6 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.header/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.header/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.headers/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.headers/index.html index 7915c981..9385ecd1 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.headers/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.headers/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.host/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.host/index.html index 1f1593c6..70deaad9 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.host/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.host/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.host_info/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.host_info/index.html index 2ce43492..ab90f85d 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.host_info/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.host_info/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.inform/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.inform/index.html index 992781bb..c41a5c6a 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.inform/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.inform/index.html @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.match_cookies/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.match_cookies/index.html index 58b9a675..36e6d3f9 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.match_cookies/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.match_cookies/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.match_qs/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.match_qs/index.html index fc23319a..b514644c 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.match_qs/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.match_qs/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.method/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.method/index.html index 80e5d40c..5e7d0949 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.method/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.method/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.parse_cookies/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.parse_cookies/index.html index 2dfd34af..334efb41 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.parse_cookies/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.parse_cookies/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.parse_header/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.parse_header/index.html index 4ef148c4..28f5212b 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.parse_header/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.parse_header/index.html @@ -308,6 +308,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.parse_qs/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.parse_qs/index.html index 48539d09..94b16900 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.parse_qs/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.parse_qs/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.path/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.path/index.html index d181aabf..6196b341 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.path/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.path/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.path_info/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.path_info/index.html index f3015b48..160e007b 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.path_info/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.path_info/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.peer/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.peer/index.html index 150ac6fe..e513f15e 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.peer/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.peer/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.port/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.port/index.html index 2d05a2d1..98c5aba7 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.port/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.port/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.push/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.push/index.html index 15e21010..9fe278e3 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.push/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.push/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.qs/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.qs/index.html index ea655839..4a27a75e 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.qs/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.qs/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.read_body/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.read_body/index.html index 3e6ff276..b734162b 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.read_body/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.read_body/index.html @@ -162,6 +162,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.read_part/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.read_part/index.html index ee7b91c0..edf6bfba 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.read_part/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.read_part/index.html @@ -184,6 +184,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.read_part_body/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.read_part_body/index.html index 9258244b..0aed9baf 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.read_part_body/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.read_part_body/index.html @@ -160,6 +160,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.read_urlencoded_body/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.read_urlencoded_body/index.html index 7aca65f8..952a050f 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.read_urlencoded_body/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.read_urlencoded_body/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.reply/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.reply/index.html index 5e478c45..432106e6 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.reply/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.reply/index.html @@ -177,6 +177,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.resp_header/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.resp_header/index.html index 35f22ecf..f0718963 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.resp_header/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.resp_header/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.resp_headers/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.resp_headers/index.html index c89d79d8..d53728f0 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.resp_headers/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.resp_headers/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.scheme/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.scheme/index.html index 2f2abcb4..1f4a1030 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.scheme/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.scheme/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_body/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_body/index.html index 1a332e41..349c6666 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_body/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_body/index.html @@ -169,6 +169,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_cookie/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_cookie/index.html index 0d03a10d..76a4efb8 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_cookie/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_cookie/index.html @@ -194,6 +194,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_header/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_header/index.html index 2b86533c..6272d0a0 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_header/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_header/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_headers/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_headers/index.html index 3344b079..1f24bc39 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_headers/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.set_resp_headers/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.sock/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.sock/index.html index 71fe9851..b2d2cf1b 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.sock/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.sock/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.stream_body/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.stream_body/index.html index c2de2690..93b754e7 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.stream_body/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.stream_body/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.stream_reply/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.stream_reply/index.html index 39eb5580..97984a62 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.stream_reply/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.stream_reply/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.uri/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.uri/index.html index 18168e82..1527e190 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.uri/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.uri/index.html @@ -196,6 +196,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req.version/index.html b/docs/en/cowboy/2.1/manual/cowboy_req.version/index.html index 4f29ea80..9fc12fbd 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req.version/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req.version/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_req/index.html b/docs/en/cowboy/2.1/manual/cowboy_req/index.html index 98fe4153..021239a5 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_req/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_req/index.html @@ -306,6 +306,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_rest/index.html b/docs/en/cowboy/2.1/manual/cowboy_rest/index.html index f35a6f41..2a9df0a6 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_rest/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_rest/index.html @@ -565,6 +565,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_router.compile/index.html b/docs/en/cowboy/2.1/manual/cowboy_router.compile/index.html index a350db16..811a2564 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_router.compile/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_router.compile/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_router/index.html b/docs/en/cowboy/2.1/manual/cowboy_router/index.html index 49a315a4..c9aab554 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_router/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_router/index.html @@ -155,6 +155,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_static/index.html b/docs/en/cowboy/2.1/manual/cowboy_static/index.html index ec115f9c..70a02b41 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_static/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_static/index.html @@ -200,6 +200,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_stream/index.html b/docs/en/cowboy/2.1/manual/cowboy_stream/index.html index f7b9aa74..41ee26e1 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_stream/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_stream/index.html @@ -372,6 +372,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/cowboy_websocket/index.html b/docs/en/cowboy/2.1/manual/cowboy_websocket/index.html index 2847b4ce..6b3e6287 100644 --- a/docs/en/cowboy/2.1/manual/cowboy_websocket/index.html +++ b/docs/en/cowboy/2.1/manual/cowboy_websocket/index.html @@ -234,6 +234,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/http_status_codes/index.html b/docs/en/cowboy/2.1/manual/http_status_codes/index.html index c6b8ee0e..9a325cff 100644 --- a/docs/en/cowboy/2.1/manual/http_status_codes/index.html +++ b/docs/en/cowboy/2.1/manual/http_status_codes/index.html @@ -182,6 +182,8 @@ + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.1/manual/index.html b/docs/en/cowboy/2.1/manual/index.html index 91e23859..284b65fa 100644 --- a/docs/en/cowboy/2.1/manual/index.html +++ b/docs/en/cowboy/2.1/manual/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/constraints/index.html b/docs/en/cowboy/2.2/guide/constraints/index.html index 0d8860a2..08464159 100644 --- a/docs/en/cowboy/2.2/guide/constraints/index.html +++ b/docs/en/cowboy/2.2/guide/constraints/index.html @@ -198,6 +198,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/cookies/index.html b/docs/en/cowboy/2.2/guide/cookies/index.html index e49d4ff2..17dc25e4 100644 --- a/docs/en/cowboy/2.2/guide/cookies/index.html +++ b/docs/en/cowboy/2.2/guide/cookies/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/erlang_web/index.html b/docs/en/cowboy/2.2/guide/erlang_web/index.html index 90c1ec2d..f7c39228 100644 --- a/docs/en/cowboy/2.2/guide/erlang_web/index.html +++ b/docs/en/cowboy/2.2/guide/erlang_web/index.html @@ -164,6 +164,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/flow_diagram/index.html b/docs/en/cowboy/2.2/guide/flow_diagram/index.html index 4a3c0914..5b86cdce 100644 --- a/docs/en/cowboy/2.2/guide/flow_diagram/index.html +++ b/docs/en/cowboy/2.2/guide/flow_diagram/index.html @@ -142,6 +142,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/getting_started/index.html b/docs/en/cowboy/2.2/guide/getting_started/index.html index f349a73c..d3ece6b3 100644 --- a/docs/en/cowboy/2.2/guide/getting_started/index.html +++ b/docs/en/cowboy/2.2/guide/getting_started/index.html @@ -216,6 +216,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/handlers/index.html b/docs/en/cowboy/2.2/guide/handlers/index.html index 75d5f9ed..81903632 100644 --- a/docs/en/cowboy/2.2/guide/handlers/index.html +++ b/docs/en/cowboy/2.2/guide/handlers/index.html @@ -169,6 +169,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/index.html b/docs/en/cowboy/2.2/guide/index.html index 33737c98..490ed401 100644 --- a/docs/en/cowboy/2.2/guide/index.html +++ b/docs/en/cowboy/2.2/guide/index.html @@ -175,6 +175,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/introduction/index.html b/docs/en/cowboy/2.2/guide/introduction/index.html index 42bfec37..fdbcb9e0 100644 --- a/docs/en/cowboy/2.2/guide/introduction/index.html +++ b/docs/en/cowboy/2.2/guide/introduction/index.html @@ -152,6 +152,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/listeners/index.html b/docs/en/cowboy/2.2/guide/listeners/index.html index 82a85fa7..7e9d5c91 100644 --- a/docs/en/cowboy/2.2/guide/listeners/index.html +++ b/docs/en/cowboy/2.2/guide/listeners/index.html @@ -173,6 +173,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/loop_handlers/index.html b/docs/en/cowboy/2.2/guide/loop_handlers/index.html index 24a0cb7d..3925cb68 100644 --- a/docs/en/cowboy/2.2/guide/loop_handlers/index.html +++ b/docs/en/cowboy/2.2/guide/loop_handlers/index.html @@ -184,6 +184,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/middlewares/index.html b/docs/en/cowboy/2.2/guide/middlewares/index.html index 0832a90c..3035be7c 100644 --- a/docs/en/cowboy/2.2/guide/middlewares/index.html +++ b/docs/en/cowboy/2.2/guide/middlewares/index.html @@ -150,6 +150,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/migrating_from_1.0/index.html b/docs/en/cowboy/2.2/guide/migrating_from_1.0/index.html index 8d2b005d..02ef43e5 100644 --- a/docs/en/cowboy/2.2/guide/migrating_from_1.0/index.html +++ b/docs/en/cowboy/2.2/guide/migrating_from_1.0/index.html @@ -232,6 +232,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/migrating_from_2.0/index.html b/docs/en/cowboy/2.2/guide/migrating_from_2.0/index.html index 91c18cfe..27a59c1e 100644 --- a/docs/en/cowboy/2.2/guide/migrating_from_2.0/index.html +++ b/docs/en/cowboy/2.2/guide/migrating_from_2.0/index.html @@ -167,6 +167,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/migrating_from_2.1/index.html b/docs/en/cowboy/2.2/guide/migrating_from_2.1/index.html index 59d7c53a..60f7e7e6 100644 --- a/docs/en/cowboy/2.2/guide/migrating_from_2.1/index.html +++ b/docs/en/cowboy/2.2/guide/migrating_from_2.1/index.html @@ -178,6 +178,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/migrating_from_2.2/index.html b/docs/en/cowboy/2.2/guide/migrating_from_2.2/index.html index eede519d..00d154fb 100644 --- a/docs/en/cowboy/2.2/guide/migrating_from_2.2/index.html +++ b/docs/en/cowboy/2.2/guide/migrating_from_2.2/index.html @@ -132,6 +132,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/modern_web/index.html b/docs/en/cowboy/2.2/guide/modern_web/index.html index 36305c0d..bd9f5e1f 100644 --- a/docs/en/cowboy/2.2/guide/modern_web/index.html +++ b/docs/en/cowboy/2.2/guide/modern_web/index.html @@ -146,6 +146,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/multipart/index.html b/docs/en/cowboy/2.2/guide/multipart/index.html index 11755292..9de1e4b6 100644 --- a/docs/en/cowboy/2.2/guide/multipart/index.html +++ b/docs/en/cowboy/2.2/guide/multipart/index.html @@ -219,6 +219,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/req/index.html b/docs/en/cowboy/2.2/guide/req/index.html index dd708faa..2c7d1c9e 100644 --- a/docs/en/cowboy/2.2/guide/req/index.html +++ b/docs/en/cowboy/2.2/guide/req/index.html @@ -395,6 +395,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/req_body/index.html b/docs/en/cowboy/2.2/guide/req_body/index.html index 31c47936..165fcecf 100644 --- a/docs/en/cowboy/2.2/guide/req_body/index.html +++ b/docs/en/cowboy/2.2/guide/req_body/index.html @@ -205,6 +205,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/resource_design/index.html b/docs/en/cowboy/2.2/guide/resource_design/index.html index a3a2afb8..30a67364 100644 --- a/docs/en/cowboy/2.2/guide/resource_design/index.html +++ b/docs/en/cowboy/2.2/guide/resource_design/index.html @@ -178,6 +178,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/resp/index.html b/docs/en/cowboy/2.2/guide/resp/index.html index 3b685004..d9765cf6 100644 --- a/docs/en/cowboy/2.2/guide/resp/index.html +++ b/docs/en/cowboy/2.2/guide/resp/index.html @@ -362,6 +362,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/rest_flowcharts/index.html b/docs/en/cowboy/2.2/guide/rest_flowcharts/index.html index 77f0666f..4479c10c 100644 --- a/docs/en/cowboy/2.2/guide/rest_flowcharts/index.html +++ b/docs/en/cowboy/2.2/guide/rest_flowcharts/index.html @@ -176,6 +176,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/rest_handlers/index.html b/docs/en/cowboy/2.2/guide/rest_handlers/index.html index f63c88d1..3c06848b 100644 --- a/docs/en/cowboy/2.2/guide/rest_handlers/index.html +++ b/docs/en/cowboy/2.2/guide/rest_handlers/index.html @@ -274,6 +274,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/rest_principles/index.html b/docs/en/cowboy/2.2/guide/rest_principles/index.html index f76d9761..3921d93a 100644 --- a/docs/en/cowboy/2.2/guide/rest_principles/index.html +++ b/docs/en/cowboy/2.2/guide/rest_principles/index.html @@ -150,6 +150,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/routing/index.html b/docs/en/cowboy/2.2/guide/routing/index.html index 23cd6305..868a2b6b 100644 --- a/docs/en/cowboy/2.2/guide/routing/index.html +++ b/docs/en/cowboy/2.2/guide/routing/index.html @@ -293,6 +293,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/specs/index.html b/docs/en/cowboy/2.2/guide/specs/index.html index dacf057e..55917bf1 100644 --- a/docs/en/cowboy/2.2/guide/specs/index.html +++ b/docs/en/cowboy/2.2/guide/specs/index.html @@ -447,6 +447,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/static_files/index.html b/docs/en/cowboy/2.2/guide/static_files/index.html index bbea4e6d..36e18a03 100644 --- a/docs/en/cowboy/2.2/guide/static_files/index.html +++ b/docs/en/cowboy/2.2/guide/static_files/index.html @@ -213,6 +213,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/streams/index.html b/docs/en/cowboy/2.2/guide/streams/index.html index f4e51ab7..cbf7bb7a 100644 --- a/docs/en/cowboy/2.2/guide/streams/index.html +++ b/docs/en/cowboy/2.2/guide/streams/index.html @@ -135,6 +135,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/ws_handlers/index.html b/docs/en/cowboy/2.2/guide/ws_handlers/index.html index d6d86f1c..7b9a77e2 100644 --- a/docs/en/cowboy/2.2/guide/ws_handlers/index.html +++ b/docs/en/cowboy/2.2/guide/ws_handlers/index.html @@ -283,6 +283,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/guide/ws_protocol/index.html b/docs/en/cowboy/2.2/guide/ws_protocol/index.html index 1190ff9f..e20a0a0d 100644 --- a/docs/en/cowboy/2.2/guide/ws_protocol/index.html +++ b/docs/en/cowboy/2.2/guide/ws_protocol/index.html @@ -134,6 +134,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.2/manual/cowboy.set_env/index.html index 66540548..5b389c33 100644 --- a/docs/en/cowboy/2.2/manual/cowboy.set_env/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy.set_env/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy.start_clear/index.html b/docs/en/cowboy/2.2/manual/cowboy.start_clear/index.html index da2e2564..fba5b51c 100644 --- a/docs/en/cowboy/2.2/manual/cowboy.start_clear/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy.start_clear/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy.start_tls/index.html b/docs/en/cowboy/2.2/manual/cowboy.start_tls/index.html index 3f11c828..9a816a66 100644 --- a/docs/en/cowboy/2.2/manual/cowboy.start_tls/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy.start_tls/index.html @@ -172,6 +172,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy.stop_listener/index.html b/docs/en/cowboy/2.2/manual/cowboy.stop_listener/index.html index ff4a1694..403ed961 100644 --- a/docs/en/cowboy/2.2/manual/cowboy.stop_listener/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy.stop_listener/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy/index.html b/docs/en/cowboy/2.2/manual/cowboy/index.html index 9a29979a..5594feb9 100644 --- a/docs/en/cowboy/2.2/manual/cowboy/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_app/index.html b/docs/en/cowboy/2.2/manual/cowboy_app/index.html index 5cda5441..719b6c02 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_app/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_app/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_constraints.int/index.html b/docs/en/cowboy/2.2/manual/cowboy_constraints.int/index.html index 0ba29079..f70d0004 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_constraints.int/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_constraints.int/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_constraints.nonempty/index.html b/docs/en/cowboy/2.2/manual/cowboy_constraints.nonempty/index.html index ab862393..16e6035a 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_constraints.nonempty/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_constraints.nonempty/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_constraints/index.html b/docs/en/cowboy/2.2/manual/cowboy_constraints/index.html index febc3f7a..82e9b34d 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_constraints/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_constraints/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_handler.terminate/index.html b/docs/en/cowboy/2.2/manual/cowboy_handler.terminate/index.html index 92e48386..11d24a34 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_handler.terminate/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_handler.terminate/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_handler/index.html b/docs/en/cowboy/2.2/manual/cowboy_handler/index.html index af96be4e..ead0d509 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_handler/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_handler/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_http/index.html b/docs/en/cowboy/2.2/manual/cowboy_http/index.html index 8a7cecfa..fa8b3408 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_http/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_http/index.html @@ -206,6 +206,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_http2/index.html b/docs/en/cowboy/2.2/manual/cowboy_http2/index.html index 48bf8364..fbbe052f 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_http2/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_http2/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_loop/index.html b/docs/en/cowboy/2.2/manual/cowboy_loop/index.html index c7c50875..a6feb7f5 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_loop/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_loop/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.2/manual/cowboy_middleware/index.html index dbc5b93e..bce3824a 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_middleware/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_middleware/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.binding/index.html index 0edf5d01..65c70d12 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.binding/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.binding/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.bindings/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.bindings/index.html index 4edf023e..5b028aa7 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.bindings/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.bindings/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.body_length/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.body_length/index.html index 9994924d..228f0a04 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.body_length/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.body_length/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.cert/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.cert/index.html index f8ce841b..03bd7402 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.cert/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.cert/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.delete_resp_header/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.delete_resp_header/index.html index 9f33d577..e5a38ff2 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.delete_resp_header/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.delete_resp_header/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.has_body/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.has_body/index.html index 3016ef98..0c775b7f 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.has_body/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.has_body/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.has_resp_body/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.has_resp_body/index.html index 14707e99..ed3260bb 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.has_resp_body/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.has_resp_body/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.has_resp_header/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.has_resp_header/index.html index c309c8dc..dc54fefb 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.has_resp_header/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.has_resp_header/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.header/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.header/index.html index d3b02a0d..929e136a 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.header/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.header/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.headers/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.headers/index.html index 83d03b96..553f8691 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.headers/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.headers/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.host/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.host/index.html index 4e95c0ca..07c57175 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.host/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.host/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.host_info/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.host_info/index.html index 1e2f9337..ae33ef79 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.host_info/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.host_info/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.inform/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.inform/index.html index 01705915..e6c84405 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.inform/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.inform/index.html @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.match_cookies/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.match_cookies/index.html index 4ee7a1bd..ddc1c4b9 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.match_cookies/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.match_cookies/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.match_qs/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.match_qs/index.html index 04e90b0a..1ff370ee 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.match_qs/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.match_qs/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.method/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.method/index.html index ffc96f2b..99bb11ff 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.method/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.method/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.parse_cookies/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.parse_cookies/index.html index 4b67c579..c1788e50 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.parse_cookies/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.parse_cookies/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.parse_header/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.parse_header/index.html index c51ee1f9..c5ebe103 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.parse_header/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.parse_header/index.html @@ -308,6 +308,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.parse_qs/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.parse_qs/index.html index 57ec22dd..6e9bcfd2 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.parse_qs/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.parse_qs/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.path/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.path/index.html index b3d286e9..67d4423d 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.path/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.path/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.path_info/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.path_info/index.html index a81cd2c5..598b1c85 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.path_info/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.path_info/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.peer/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.peer/index.html index 2d7e8476..6d336e61 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.peer/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.peer/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.port/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.port/index.html index c2f8d180..641b4010 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.port/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.port/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.push/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.push/index.html index 69fde8f0..d79e1a3e 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.push/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.push/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.qs/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.qs/index.html index a9944286..7a1397b0 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.qs/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.qs/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.read_body/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.read_body/index.html index 876b6070..7c73171d 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.read_body/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.read_body/index.html @@ -162,6 +162,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.read_part/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.read_part/index.html index 87c6cd58..53374618 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.read_part/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.read_part/index.html @@ -184,6 +184,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.read_part_body/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.read_part_body/index.html index a8503761..ae8bfce2 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.read_part_body/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.read_part_body/index.html @@ -160,6 +160,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.read_urlencoded_body/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.read_urlencoded_body/index.html index 058eb9ba..746e3aae 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.read_urlencoded_body/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.read_urlencoded_body/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.reply/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.reply/index.html index a9da08ce..5df014b0 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.reply/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.reply/index.html @@ -177,6 +177,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.resp_header/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.resp_header/index.html index 4fe4c74e..d869044c 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.resp_header/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.resp_header/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.resp_headers/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.resp_headers/index.html index 5c0af5bc..3a355f40 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.resp_headers/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.resp_headers/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.scheme/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.scheme/index.html index ddff66e3..1f7aa59d 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.scheme/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.scheme/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_body/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_body/index.html index 0251cd75..5223b2bc 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_body/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_body/index.html @@ -169,6 +169,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_cookie/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_cookie/index.html index 5ed21718..ec4ef5ef 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_cookie/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_cookie/index.html @@ -194,6 +194,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_header/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_header/index.html index 4746fcbc..2a924bb4 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_header/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_header/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_headers/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_headers/index.html index 48a7246d..d067f77b 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_headers/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_headers/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.sock/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.sock/index.html index b70c2445..75cfbd33 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.sock/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.sock/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.stream_body/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.stream_body/index.html index 80940f1c..1208b7c0 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.stream_body/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.stream_body/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.stream_reply/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.stream_reply/index.html index 814dc042..ab811819 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.stream_reply/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.stream_reply/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.stream_trailers/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.stream_trailers/index.html index e074d5d3..175bbba7 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.stream_trailers/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.stream_trailers/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.uri/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.uri/index.html index 0bcd71f3..4b864b29 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.uri/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.uri/index.html @@ -196,6 +196,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.version/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.version/index.html index 0c3fd668..1baf7630 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.version/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.version/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_req/index.html b/docs/en/cowboy/2.2/manual/cowboy_req/index.html index ee3bf156..2a0b9704 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req/index.html @@ -308,6 +308,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_rest/index.html b/docs/en/cowboy/2.2/manual/cowboy_rest/index.html index aa62b37a..bc748646 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_rest/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_rest/index.html @@ -565,6 +565,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_router.compile/index.html b/docs/en/cowboy/2.2/manual/cowboy_router.compile/index.html index 9ef7717e..b88f71f9 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_router.compile/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_router.compile/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_router/index.html b/docs/en/cowboy/2.2/manual/cowboy_router/index.html index b89960e3..e6a1ff18 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_router/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_router/index.html @@ -155,6 +155,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_static/index.html b/docs/en/cowboy/2.2/manual/cowboy_static/index.html index 46b5fec2..505bd285 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_static/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_static/index.html @@ -200,6 +200,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_stream/index.html b/docs/en/cowboy/2.2/manual/cowboy_stream/index.html index 75c150fd..5055839c 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_stream/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_stream/index.html @@ -397,6 +397,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/cowboy_websocket/index.html b/docs/en/cowboy/2.2/manual/cowboy_websocket/index.html index 54a3fe71..3bd153c6 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_websocket/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_websocket/index.html @@ -234,6 +234,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/http_status_codes/index.html b/docs/en/cowboy/2.2/manual/http_status_codes/index.html index c4ac8756..edf0e2d0 100644 --- a/docs/en/cowboy/2.2/manual/http_status_codes/index.html +++ b/docs/en/cowboy/2.2/manual/http_status_codes/index.html @@ -182,6 +182,8 @@ + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.2/manual/index.html b/docs/en/cowboy/2.2/manual/index.html index b5ffcee7..5e79cea7 100644 --- a/docs/en/cowboy/2.2/manual/index.html +++ b/docs/en/cowboy/2.2/manual/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/constraints/index.html b/docs/en/cowboy/2.3/guide/constraints/index.html index cab391c7..fb90c4d7 100644 --- a/docs/en/cowboy/2.3/guide/constraints/index.html +++ b/docs/en/cowboy/2.3/guide/constraints/index.html @@ -198,6 +198,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/cookies/index.html b/docs/en/cowboy/2.3/guide/cookies/index.html index cdf6d6fc..6a1f84b0 100644 --- a/docs/en/cowboy/2.3/guide/cookies/index.html +++ b/docs/en/cowboy/2.3/guide/cookies/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/erlang_web/index.html b/docs/en/cowboy/2.3/guide/erlang_web/index.html index ef7b497d..6841d869 100644 --- a/docs/en/cowboy/2.3/guide/erlang_web/index.html +++ b/docs/en/cowboy/2.3/guide/erlang_web/index.html @@ -164,6 +164,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/flow_diagram/index.html b/docs/en/cowboy/2.3/guide/flow_diagram/index.html index 0fe4f3d1..f0af3fca 100644 --- a/docs/en/cowboy/2.3/guide/flow_diagram/index.html +++ b/docs/en/cowboy/2.3/guide/flow_diagram/index.html @@ -142,6 +142,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/getting_started/index.html b/docs/en/cowboy/2.3/guide/getting_started/index.html index 5129483b..0cbea9c2 100644 --- a/docs/en/cowboy/2.3/guide/getting_started/index.html +++ b/docs/en/cowboy/2.3/guide/getting_started/index.html @@ -216,6 +216,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/handlers/index.html b/docs/en/cowboy/2.3/guide/handlers/index.html index 5ab83ee5..7e7b13f2 100644 --- a/docs/en/cowboy/2.3/guide/handlers/index.html +++ b/docs/en/cowboy/2.3/guide/handlers/index.html @@ -169,6 +169,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/index.html b/docs/en/cowboy/2.3/guide/index.html index ee81ac12..d916b1d0 100644 --- a/docs/en/cowboy/2.3/guide/index.html +++ b/docs/en/cowboy/2.3/guide/index.html @@ -175,6 +175,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/introduction/index.html b/docs/en/cowboy/2.3/guide/introduction/index.html index 28d803bf..64924beb 100644 --- a/docs/en/cowboy/2.3/guide/introduction/index.html +++ b/docs/en/cowboy/2.3/guide/introduction/index.html @@ -152,6 +152,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/listeners/index.html b/docs/en/cowboy/2.3/guide/listeners/index.html index 62374488..d5a1c751 100644 --- a/docs/en/cowboy/2.3/guide/listeners/index.html +++ b/docs/en/cowboy/2.3/guide/listeners/index.html @@ -173,6 +173,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/loop_handlers/index.html b/docs/en/cowboy/2.3/guide/loop_handlers/index.html index 322b98e3..31f2c0f7 100644 --- a/docs/en/cowboy/2.3/guide/loop_handlers/index.html +++ b/docs/en/cowboy/2.3/guide/loop_handlers/index.html @@ -184,6 +184,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/middlewares/index.html b/docs/en/cowboy/2.3/guide/middlewares/index.html index 53fbd992..f303a776 100644 --- a/docs/en/cowboy/2.3/guide/middlewares/index.html +++ b/docs/en/cowboy/2.3/guide/middlewares/index.html @@ -150,6 +150,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/migrating_from_1.0/index.html b/docs/en/cowboy/2.3/guide/migrating_from_1.0/index.html index bdb35292..5fd5bbab 100644 --- a/docs/en/cowboy/2.3/guide/migrating_from_1.0/index.html +++ b/docs/en/cowboy/2.3/guide/migrating_from_1.0/index.html @@ -232,6 +232,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/migrating_from_2.0/index.html b/docs/en/cowboy/2.3/guide/migrating_from_2.0/index.html index 31efced5..45fc3833 100644 --- a/docs/en/cowboy/2.3/guide/migrating_from_2.0/index.html +++ b/docs/en/cowboy/2.3/guide/migrating_from_2.0/index.html @@ -167,6 +167,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/migrating_from_2.1/index.html b/docs/en/cowboy/2.3/guide/migrating_from_2.1/index.html index 13141c98..5d507742 100644 --- a/docs/en/cowboy/2.3/guide/migrating_from_2.1/index.html +++ b/docs/en/cowboy/2.3/guide/migrating_from_2.1/index.html @@ -178,6 +178,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/migrating_from_2.2/index.html b/docs/en/cowboy/2.3/guide/migrating_from_2.2/index.html index f2a90fa5..073c2685 100644 --- a/docs/en/cowboy/2.3/guide/migrating_from_2.2/index.html +++ b/docs/en/cowboy/2.3/guide/migrating_from_2.2/index.html @@ -150,6 +150,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/modern_web/index.html b/docs/en/cowboy/2.3/guide/modern_web/index.html index 44b6214c..eecd0638 100644 --- a/docs/en/cowboy/2.3/guide/modern_web/index.html +++ b/docs/en/cowboy/2.3/guide/modern_web/index.html @@ -146,6 +146,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/multipart/index.html b/docs/en/cowboy/2.3/guide/multipart/index.html index ffa3f637..4a59fde0 100644 --- a/docs/en/cowboy/2.3/guide/multipart/index.html +++ b/docs/en/cowboy/2.3/guide/multipart/index.html @@ -219,6 +219,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/req/index.html b/docs/en/cowboy/2.3/guide/req/index.html index 8a30655f..977d816d 100644 --- a/docs/en/cowboy/2.3/guide/req/index.html +++ b/docs/en/cowboy/2.3/guide/req/index.html @@ -395,6 +395,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/req_body/index.html b/docs/en/cowboy/2.3/guide/req_body/index.html index 05bd6a45..bf387ece 100644 --- a/docs/en/cowboy/2.3/guide/req_body/index.html +++ b/docs/en/cowboy/2.3/guide/req_body/index.html @@ -205,6 +205,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/resource_design/index.html b/docs/en/cowboy/2.3/guide/resource_design/index.html index eb49a59d..3cb01ff4 100644 --- a/docs/en/cowboy/2.3/guide/resource_design/index.html +++ b/docs/en/cowboy/2.3/guide/resource_design/index.html @@ -178,6 +178,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/resp/index.html b/docs/en/cowboy/2.3/guide/resp/index.html index 24752fee..b0262ed0 100644 --- a/docs/en/cowboy/2.3/guide/resp/index.html +++ b/docs/en/cowboy/2.3/guide/resp/index.html @@ -361,6 +361,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/rest_flowcharts/index.html b/docs/en/cowboy/2.3/guide/rest_flowcharts/index.html index c2792a75..ce06567b 100644 --- a/docs/en/cowboy/2.3/guide/rest_flowcharts/index.html +++ b/docs/en/cowboy/2.3/guide/rest_flowcharts/index.html @@ -176,6 +176,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/rest_handlers/index.html b/docs/en/cowboy/2.3/guide/rest_handlers/index.html index 5c24bce3..8ba115b6 100644 --- a/docs/en/cowboy/2.3/guide/rest_handlers/index.html +++ b/docs/en/cowboy/2.3/guide/rest_handlers/index.html @@ -274,6 +274,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/rest_principles/index.html b/docs/en/cowboy/2.3/guide/rest_principles/index.html index c9cd2704..30ab5088 100644 --- a/docs/en/cowboy/2.3/guide/rest_principles/index.html +++ b/docs/en/cowboy/2.3/guide/rest_principles/index.html @@ -150,6 +150,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/routing/index.html b/docs/en/cowboy/2.3/guide/routing/index.html index fd84179e..65129a49 100644 --- a/docs/en/cowboy/2.3/guide/routing/index.html +++ b/docs/en/cowboy/2.3/guide/routing/index.html @@ -293,6 +293,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/specs/index.html b/docs/en/cowboy/2.3/guide/specs/index.html index 966efd08..b0d2474d 100644 --- a/docs/en/cowboy/2.3/guide/specs/index.html +++ b/docs/en/cowboy/2.3/guide/specs/index.html @@ -453,6 +453,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/static_files/index.html b/docs/en/cowboy/2.3/guide/static_files/index.html index a8123982..b1c27dd7 100644 --- a/docs/en/cowboy/2.3/guide/static_files/index.html +++ b/docs/en/cowboy/2.3/guide/static_files/index.html @@ -213,6 +213,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/streams/index.html b/docs/en/cowboy/2.3/guide/streams/index.html index ff26dd00..9602d9cc 100644 --- a/docs/en/cowboy/2.3/guide/streams/index.html +++ b/docs/en/cowboy/2.3/guide/streams/index.html @@ -135,6 +135,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/ws_handlers/index.html b/docs/en/cowboy/2.3/guide/ws_handlers/index.html index 30723a64..9ff12163 100644 --- a/docs/en/cowboy/2.3/guide/ws_handlers/index.html +++ b/docs/en/cowboy/2.3/guide/ws_handlers/index.html @@ -302,6 +302,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/guide/ws_protocol/index.html b/docs/en/cowboy/2.3/guide/ws_protocol/index.html index 50b3a781..a0a24b33 100644 --- a/docs/en/cowboy/2.3/guide/ws_protocol/index.html +++ b/docs/en/cowboy/2.3/guide/ws_protocol/index.html @@ -134,6 +134,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.3/manual/cowboy.set_env/index.html index a08796e0..c4b9112e 100644 --- a/docs/en/cowboy/2.3/manual/cowboy.set_env/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy.set_env/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy.start_clear/index.html b/docs/en/cowboy/2.3/manual/cowboy.start_clear/index.html index 8ae0b9e9..cd10a83c 100644 --- a/docs/en/cowboy/2.3/manual/cowboy.start_clear/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy.start_clear/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy.start_tls/index.html b/docs/en/cowboy/2.3/manual/cowboy.start_tls/index.html index 9c8d9d5a..faefdb3d 100644 --- a/docs/en/cowboy/2.3/manual/cowboy.start_tls/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy.start_tls/index.html @@ -172,6 +172,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy.stop_listener/index.html b/docs/en/cowboy/2.3/manual/cowboy.stop_listener/index.html index af020c47..c415938e 100644 --- a/docs/en/cowboy/2.3/manual/cowboy.stop_listener/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy.stop_listener/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy/index.html b/docs/en/cowboy/2.3/manual/cowboy/index.html index b2e83a5c..9b47af47 100644 --- a/docs/en/cowboy/2.3/manual/cowboy/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_app/index.html b/docs/en/cowboy/2.3/manual/cowboy_app/index.html index 21361e04..aaaa17b5 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_app/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_app/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_constraints.int/index.html b/docs/en/cowboy/2.3/manual/cowboy_constraints.int/index.html index f7c597da..83246bb5 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_constraints.int/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_constraints.int/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_constraints.nonempty/index.html b/docs/en/cowboy/2.3/manual/cowboy_constraints.nonempty/index.html index c96f3954..0dda6376 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_constraints.nonempty/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_constraints.nonempty/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_constraints/index.html b/docs/en/cowboy/2.3/manual/cowboy_constraints/index.html index 4422bc7e..340e2c6d 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_constraints/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_constraints/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_handler.terminate/index.html b/docs/en/cowboy/2.3/manual/cowboy_handler.terminate/index.html index 2a911db5..8527970c 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_handler.terminate/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_handler.terminate/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_handler/index.html b/docs/en/cowboy/2.3/manual/cowboy_handler/index.html index 0531e322..50b156f8 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_handler/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_handler/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_http/index.html b/docs/en/cowboy/2.3/manual/cowboy_http/index.html index 869a8f04..7ba320c0 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_http/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_http/index.html @@ -206,6 +206,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_http2/index.html b/docs/en/cowboy/2.3/manual/cowboy_http2/index.html index 86d05d6a..a08358ea 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_http2/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_http2/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_loop/index.html b/docs/en/cowboy/2.3/manual/cowboy_loop/index.html index c41c99ee..cbf037bc 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_loop/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_loop/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.3/manual/cowboy_middleware/index.html index 12f40874..45c09127 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_middleware/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_middleware/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.binding/index.html index 43757b97..cf31df2d 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.binding/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.binding/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.bindings/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.bindings/index.html index 8600c6b6..22d4a3b5 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.bindings/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.bindings/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.body_length/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.body_length/index.html index 014ea283..789e44fd 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.body_length/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.body_length/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.cert/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.cert/index.html index 65f13026..8554d30c 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.cert/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.cert/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.delete_resp_header/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.delete_resp_header/index.html index aa0a3cc6..541cffb4 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.delete_resp_header/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.delete_resp_header/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.has_body/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.has_body/index.html index 4787f437..6296175b 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.has_body/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.has_body/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.has_resp_body/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.has_resp_body/index.html index 2a326cd5..85fc9fd6 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.has_resp_body/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.has_resp_body/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.has_resp_header/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.has_resp_header/index.html index 5889c921..593ad89e 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.has_resp_header/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.has_resp_header/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.header/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.header/index.html index f8dcad0f..ef38cc8a 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.header/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.header/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.headers/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.headers/index.html index 641d735a..29901467 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.headers/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.headers/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.host/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.host/index.html index 4fcc893f..e691e371 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.host/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.host/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.host_info/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.host_info/index.html index 003f12e4..02b2cb3e 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.host_info/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.host_info/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.inform/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.inform/index.html index 3cf6e27c..f5b4d3ae 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.inform/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.inform/index.html @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.match_cookies/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.match_cookies/index.html index 45866b26..37f06479 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.match_cookies/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.match_cookies/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.match_qs/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.match_qs/index.html index 3bdb8fe3..e8c666da 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.match_qs/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.match_qs/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.method/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.method/index.html index c93f6246..24664035 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.method/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.method/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.parse_cookies/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.parse_cookies/index.html index 9e283aab..35371670 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.parse_cookies/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.parse_cookies/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.parse_header/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.parse_header/index.html index 88ab0c85..1d1a5a5f 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.parse_header/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.parse_header/index.html @@ -308,6 +308,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.parse_qs/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.parse_qs/index.html index 3c06c393..0cd2d5a1 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.parse_qs/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.parse_qs/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.path/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.path/index.html index 64068d2c..92751658 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.path/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.path/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.path_info/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.path_info/index.html index 12b8ec83..ea74efb4 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.path_info/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.path_info/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.peer/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.peer/index.html index 855a084f..279b91b5 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.peer/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.peer/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.port/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.port/index.html index 473af2d0..9d66bcef 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.port/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.port/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.push/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.push/index.html index c30f2025..92985817 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.push/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.push/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.qs/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.qs/index.html index 5c2e09a9..6a98c011 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.qs/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.qs/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.read_body/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.read_body/index.html index 5b2760ac..354a001d 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.read_body/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.read_body/index.html @@ -162,6 +162,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.read_part/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.read_part/index.html index b1ddf2be..4d80dc81 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.read_part/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.read_part/index.html @@ -184,6 +184,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.read_part_body/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.read_part_body/index.html index f0dd6823..576f56ed 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.read_part_body/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.read_part_body/index.html @@ -160,6 +160,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.read_urlencoded_body/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.read_urlencoded_body/index.html index a9ff0767..5e66cabd 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.read_urlencoded_body/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.read_urlencoded_body/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.reply/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.reply/index.html index 32af6dea..9d14d21e 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.reply/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.reply/index.html @@ -177,6 +177,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.resp_header/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.resp_header/index.html index 4426aabc..febc2e86 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.resp_header/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.resp_header/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.resp_headers/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.resp_headers/index.html index d011eefc..8cca4ab4 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.resp_headers/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.resp_headers/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.scheme/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.scheme/index.html index 1a8c1ba8..ccfcd7af 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.scheme/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.scheme/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_body/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_body/index.html index 83a6dead..ed32dc19 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_body/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_body/index.html @@ -169,6 +169,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_cookie/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_cookie/index.html index 025b089e..d37233d2 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_cookie/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_cookie/index.html @@ -194,6 +194,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_header/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_header/index.html index 818a1ed0..c6c2f37e 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_header/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_header/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_headers/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_headers/index.html index a69670a0..f500db8a 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_headers/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_headers/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.sock/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.sock/index.html index 47d65c9e..d8ce0eac 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.sock/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.sock/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.stream_body/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.stream_body/index.html index 07a14db9..bc3805a0 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.stream_body/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.stream_body/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.stream_reply/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.stream_reply/index.html index c5235d35..46f6c1d2 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.stream_reply/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.stream_reply/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.stream_trailers/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.stream_trailers/index.html index 77b93217..89b24186 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.stream_trailers/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.stream_trailers/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.uri/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.uri/index.html index 5070366e..f959b34f 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.uri/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.uri/index.html @@ -196,6 +196,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.version/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.version/index.html index fadec356..fe05caa0 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.version/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.version/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_req/index.html b/docs/en/cowboy/2.3/manual/cowboy_req/index.html index 2408d53d..323a97d0 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req/index.html @@ -308,6 +308,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_rest/index.html b/docs/en/cowboy/2.3/manual/cowboy_rest/index.html index 54fc8d65..89b1ae90 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_rest/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_rest/index.html @@ -565,6 +565,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_router.compile/index.html b/docs/en/cowboy/2.3/manual/cowboy_router.compile/index.html index a05e62c2..7d3456cc 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_router.compile/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_router.compile/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_router/index.html b/docs/en/cowboy/2.3/manual/cowboy_router/index.html index dd6c871c..d4374121 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_router/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_router/index.html @@ -155,6 +155,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_static/index.html b/docs/en/cowboy/2.3/manual/cowboy_static/index.html index 6114b8ee..68aa1c4e 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_static/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_static/index.html @@ -200,6 +200,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_stream/index.html b/docs/en/cowboy/2.3/manual/cowboy_stream/index.html index c40149c2..81577088 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_stream/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_stream/index.html @@ -397,6 +397,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/cowboy_websocket/index.html b/docs/en/cowboy/2.3/manual/cowboy_websocket/index.html index b98f8e35..8f46a262 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_websocket/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_websocket/index.html @@ -238,6 +238,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/http_status_codes/index.html b/docs/en/cowboy/2.3/manual/http_status_codes/index.html index 53c0f7de..edd4229d 100644 --- a/docs/en/cowboy/2.3/manual/http_status_codes/index.html +++ b/docs/en/cowboy/2.3/manual/http_status_codes/index.html @@ -182,6 +182,8 @@ + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.3/manual/index.html b/docs/en/cowboy/2.3/manual/index.html index de5a7a47..0a4da2c9 100644 --- a/docs/en/cowboy/2.3/manual/index.html +++ b/docs/en/cowboy/2.3/manual/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/constraints/index.html b/docs/en/cowboy/2.4/guide/constraints/index.html index e94c6838..0aca3a9a 100644 --- a/docs/en/cowboy/2.4/guide/constraints/index.html +++ b/docs/en/cowboy/2.4/guide/constraints/index.html @@ -198,6 +198,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/cookies/index.html b/docs/en/cowboy/2.4/guide/cookies/index.html index 60b77b12..99e847f6 100644 --- a/docs/en/cowboy/2.4/guide/cookies/index.html +++ b/docs/en/cowboy/2.4/guide/cookies/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/erlang_web/index.html b/docs/en/cowboy/2.4/guide/erlang_web/index.html index be7ccd5b..56624e21 100644 --- a/docs/en/cowboy/2.4/guide/erlang_web/index.html +++ b/docs/en/cowboy/2.4/guide/erlang_web/index.html @@ -164,6 +164,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/flow_diagram/index.html b/docs/en/cowboy/2.4/guide/flow_diagram/index.html index e70a7c5d..5e1f5929 100644 --- a/docs/en/cowboy/2.4/guide/flow_diagram/index.html +++ b/docs/en/cowboy/2.4/guide/flow_diagram/index.html @@ -142,6 +142,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/getting_started/index.html b/docs/en/cowboy/2.4/guide/getting_started/index.html index eee6d7f1..de103712 100644 --- a/docs/en/cowboy/2.4/guide/getting_started/index.html +++ b/docs/en/cowboy/2.4/guide/getting_started/index.html @@ -216,6 +216,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/handlers/index.html b/docs/en/cowboy/2.4/guide/handlers/index.html index 54c08422..ffabc014 100644 --- a/docs/en/cowboy/2.4/guide/handlers/index.html +++ b/docs/en/cowboy/2.4/guide/handlers/index.html @@ -169,6 +169,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/index.html b/docs/en/cowboy/2.4/guide/index.html index 56c4a299..cd3b9c8c 100644 --- a/docs/en/cowboy/2.4/guide/index.html +++ b/docs/en/cowboy/2.4/guide/index.html @@ -177,6 +177,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/introduction/index.html b/docs/en/cowboy/2.4/guide/introduction/index.html index 75a024cf..0f2e47e9 100644 --- a/docs/en/cowboy/2.4/guide/introduction/index.html +++ b/docs/en/cowboy/2.4/guide/introduction/index.html @@ -152,6 +152,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/listeners/index.html b/docs/en/cowboy/2.4/guide/listeners/index.html index b81fc307..ddec371a 100644 --- a/docs/en/cowboy/2.4/guide/listeners/index.html +++ b/docs/en/cowboy/2.4/guide/listeners/index.html @@ -173,6 +173,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/loop_handlers/index.html b/docs/en/cowboy/2.4/guide/loop_handlers/index.html index 8b418cf9..5085ac7c 100644 --- a/docs/en/cowboy/2.4/guide/loop_handlers/index.html +++ b/docs/en/cowboy/2.4/guide/loop_handlers/index.html @@ -184,6 +184,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/middlewares/index.html b/docs/en/cowboy/2.4/guide/middlewares/index.html index 70a81d51..550ceea2 100644 --- a/docs/en/cowboy/2.4/guide/middlewares/index.html +++ b/docs/en/cowboy/2.4/guide/middlewares/index.html @@ -150,6 +150,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/migrating_from_1.0/index.html b/docs/en/cowboy/2.4/guide/migrating_from_1.0/index.html index 1097d78c..65d3b3e8 100644 --- a/docs/en/cowboy/2.4/guide/migrating_from_1.0/index.html +++ b/docs/en/cowboy/2.4/guide/migrating_from_1.0/index.html @@ -232,6 +232,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/migrating_from_2.0/index.html b/docs/en/cowboy/2.4/guide/migrating_from_2.0/index.html index 5a99778d..5570097a 100644 --- a/docs/en/cowboy/2.4/guide/migrating_from_2.0/index.html +++ b/docs/en/cowboy/2.4/guide/migrating_from_2.0/index.html @@ -167,6 +167,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/migrating_from_2.1/index.html b/docs/en/cowboy/2.4/guide/migrating_from_2.1/index.html index 008f187e..1c03f180 100644 --- a/docs/en/cowboy/2.4/guide/migrating_from_2.1/index.html +++ b/docs/en/cowboy/2.4/guide/migrating_from_2.1/index.html @@ -178,6 +178,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/migrating_from_2.2/index.html b/docs/en/cowboy/2.4/guide/migrating_from_2.2/index.html index 45032c4f..0f5c7c90 100644 --- a/docs/en/cowboy/2.4/guide/migrating_from_2.2/index.html +++ b/docs/en/cowboy/2.4/guide/migrating_from_2.2/index.html @@ -150,6 +150,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/migrating_from_2.3/index.html b/docs/en/cowboy/2.4/guide/migrating_from_2.3/index.html index 1d671137..86ddd102 100644 --- a/docs/en/cowboy/2.4/guide/migrating_from_2.3/index.html +++ b/docs/en/cowboy/2.4/guide/migrating_from_2.3/index.html @@ -152,6 +152,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/modern_web/index.html b/docs/en/cowboy/2.4/guide/modern_web/index.html index c9840bcb..438d870c 100644 --- a/docs/en/cowboy/2.4/guide/modern_web/index.html +++ b/docs/en/cowboy/2.4/guide/modern_web/index.html @@ -146,6 +146,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/multipart/index.html b/docs/en/cowboy/2.4/guide/multipart/index.html index 1c113032..79ece716 100644 --- a/docs/en/cowboy/2.4/guide/multipart/index.html +++ b/docs/en/cowboy/2.4/guide/multipart/index.html @@ -219,6 +219,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/req/index.html b/docs/en/cowboy/2.4/guide/req/index.html index a1ef6b4c..79e7f914 100644 --- a/docs/en/cowboy/2.4/guide/req/index.html +++ b/docs/en/cowboy/2.4/guide/req/index.html @@ -394,6 +394,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/req_body/index.html b/docs/en/cowboy/2.4/guide/req_body/index.html index 807c26a5..d428b640 100644 --- a/docs/en/cowboy/2.4/guide/req_body/index.html +++ b/docs/en/cowboy/2.4/guide/req_body/index.html @@ -205,6 +205,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/resource_design/index.html b/docs/en/cowboy/2.4/guide/resource_design/index.html index 076eaec5..923b06aa 100644 --- a/docs/en/cowboy/2.4/guide/resource_design/index.html +++ b/docs/en/cowboy/2.4/guide/resource_design/index.html @@ -178,6 +178,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/resp/index.html b/docs/en/cowboy/2.4/guide/resp/index.html index 7ff982cd..9b865090 100644 --- a/docs/en/cowboy/2.4/guide/resp/index.html +++ b/docs/en/cowboy/2.4/guide/resp/index.html @@ -361,6 +361,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/rest_flowcharts/index.html b/docs/en/cowboy/2.4/guide/rest_flowcharts/index.html index fe2b4d67..4ae9fab2 100644 --- a/docs/en/cowboy/2.4/guide/rest_flowcharts/index.html +++ b/docs/en/cowboy/2.4/guide/rest_flowcharts/index.html @@ -176,6 +176,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/rest_handlers/index.html b/docs/en/cowboy/2.4/guide/rest_handlers/index.html index 2ab70c2a..6607a92a 100644 --- a/docs/en/cowboy/2.4/guide/rest_handlers/index.html +++ b/docs/en/cowboy/2.4/guide/rest_handlers/index.html @@ -274,6 +274,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/rest_principles/index.html b/docs/en/cowboy/2.4/guide/rest_principles/index.html index 9d2b3eac..4907e8b1 100644 --- a/docs/en/cowboy/2.4/guide/rest_principles/index.html +++ b/docs/en/cowboy/2.4/guide/rest_principles/index.html @@ -150,6 +150,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/routing/index.html b/docs/en/cowboy/2.4/guide/routing/index.html index ac083b08..ed6f5323 100644 --- a/docs/en/cowboy/2.4/guide/routing/index.html +++ b/docs/en/cowboy/2.4/guide/routing/index.html @@ -293,6 +293,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/specs/index.html b/docs/en/cowboy/2.4/guide/specs/index.html index 94184f28..42bceec6 100644 --- a/docs/en/cowboy/2.4/guide/specs/index.html +++ b/docs/en/cowboy/2.4/guide/specs/index.html @@ -453,6 +453,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/static_files/index.html b/docs/en/cowboy/2.4/guide/static_files/index.html index f383fee7..daf9385d 100644 --- a/docs/en/cowboy/2.4/guide/static_files/index.html +++ b/docs/en/cowboy/2.4/guide/static_files/index.html @@ -213,6 +213,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/streams/index.html b/docs/en/cowboy/2.4/guide/streams/index.html index 5cfbb7de..dd3bfe53 100644 --- a/docs/en/cowboy/2.4/guide/streams/index.html +++ b/docs/en/cowboy/2.4/guide/streams/index.html @@ -135,6 +135,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/ws_handlers/index.html b/docs/en/cowboy/2.4/guide/ws_handlers/index.html index 9bcdca4d..9f5a011f 100644 --- a/docs/en/cowboy/2.4/guide/ws_handlers/index.html +++ b/docs/en/cowboy/2.4/guide/ws_handlers/index.html @@ -302,6 +302,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/guide/ws_protocol/index.html b/docs/en/cowboy/2.4/guide/ws_protocol/index.html index ed930bc3..95a46411 100644 --- a/docs/en/cowboy/2.4/guide/ws_protocol/index.html +++ b/docs/en/cowboy/2.4/guide/ws_protocol/index.html @@ -134,6 +134,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.4/manual/cowboy.set_env/index.html index 6e5183b3..700c6c5a 100644 --- a/docs/en/cowboy/2.4/manual/cowboy.set_env/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy.set_env/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy.start_clear/index.html b/docs/en/cowboy/2.4/manual/cowboy.start_clear/index.html index 998505c9..92ebab0b 100644 --- a/docs/en/cowboy/2.4/manual/cowboy.start_clear/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy.start_clear/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy.start_tls/index.html b/docs/en/cowboy/2.4/manual/cowboy.start_tls/index.html index 29e2fb6f..34b08fc0 100644 --- a/docs/en/cowboy/2.4/manual/cowboy.start_tls/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy.start_tls/index.html @@ -172,6 +172,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy.stop_listener/index.html b/docs/en/cowboy/2.4/manual/cowboy.stop_listener/index.html index 1c8ec9d3..7ba68ba6 100644 --- a/docs/en/cowboy/2.4/manual/cowboy.stop_listener/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy.stop_listener/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy/index.html b/docs/en/cowboy/2.4/manual/cowboy/index.html index c6e90d94..28aa88cb 100644 --- a/docs/en/cowboy/2.4/manual/cowboy/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_app/index.html b/docs/en/cowboy/2.4/manual/cowboy_app/index.html index 6cd2ec6f..1637bf94 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_app/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_app/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_constraints.int/index.html b/docs/en/cowboy/2.4/manual/cowboy_constraints.int/index.html index 706b6cff..d20e7f39 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_constraints.int/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_constraints.int/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_constraints.nonempty/index.html b/docs/en/cowboy/2.4/manual/cowboy_constraints.nonempty/index.html index 14b4d4d7..defda573 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_constraints.nonempty/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_constraints.nonempty/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_constraints/index.html b/docs/en/cowboy/2.4/manual/cowboy_constraints/index.html index 5085ed38..ea99b287 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_constraints/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_constraints/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_handler.terminate/index.html b/docs/en/cowboy/2.4/manual/cowboy_handler.terminate/index.html index 2ec4864b..a48565db 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_handler.terminate/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_handler.terminate/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_handler/index.html b/docs/en/cowboy/2.4/manual/cowboy_handler/index.html index 203c842f..2fca034a 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_handler/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_handler/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_http/index.html b/docs/en/cowboy/2.4/manual/cowboy_http/index.html index cfc23308..7b86dfb9 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_http/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_http/index.html @@ -206,6 +206,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_http2/index.html b/docs/en/cowboy/2.4/manual/cowboy_http2/index.html index c00279fd..7163bd4e 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_http2/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_http2/index.html @@ -192,6 +192,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_loop/index.html b/docs/en/cowboy/2.4/manual/cowboy_loop/index.html index b261c5dc..222a77f3 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_loop/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_loop/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.4/manual/cowboy_middleware/index.html index de00c440..58e6f44d 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_middleware/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_middleware/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.binding/index.html index ad439661..609b8d27 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.binding/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.binding/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.bindings/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.bindings/index.html index 8ee7e820..87c125ff 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.bindings/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.bindings/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.body_length/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.body_length/index.html index 50a8ff9e..9106fe8d 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.body_length/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.body_length/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.cert/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.cert/index.html index 7edc2bca..a9c8df37 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.cert/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.cert/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.delete_resp_header/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.delete_resp_header/index.html index 884e1aa0..569e5083 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.delete_resp_header/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.delete_resp_header/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.has_body/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.has_body/index.html index 712b46a5..963057f4 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.has_body/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.has_body/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.has_resp_body/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.has_resp_body/index.html index 5c3566ca..885d6a2f 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.has_resp_body/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.has_resp_body/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.has_resp_header/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.has_resp_header/index.html index 3c808422..092e10cc 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.has_resp_header/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.has_resp_header/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.header/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.header/index.html index 2bc1f527..ed0bbceb 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.header/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.header/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.headers/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.headers/index.html index fdf8eeb3..e686e508 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.headers/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.headers/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.host/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.host/index.html index 86c9a4e5..c05311e3 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.host/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.host/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.host_info/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.host_info/index.html index b06af1fa..ed62ce32 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.host_info/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.host_info/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.inform/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.inform/index.html index 7d84a6d0..f45d069a 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.inform/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.inform/index.html @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.match_cookies/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.match_cookies/index.html index 0dc0d44c..b32e121c 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.match_cookies/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.match_cookies/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.match_qs/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.match_qs/index.html index 32829b7e..29f3c65a 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.match_qs/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.match_qs/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.method/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.method/index.html index 48576f75..86b2aa3a 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.method/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.method/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.parse_cookies/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.parse_cookies/index.html index 9c9bd150..ce3de9ad 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.parse_cookies/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.parse_cookies/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.parse_header/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.parse_header/index.html index 038bcb09..e419bdf3 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.parse_header/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.parse_header/index.html @@ -308,6 +308,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.parse_qs/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.parse_qs/index.html index 3ab7017c..65d8420c 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.parse_qs/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.parse_qs/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.path/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.path/index.html index 752b92af..d895b94d 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.path/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.path/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.path_info/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.path_info/index.html index e8fb0f4d..f679ea83 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.path_info/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.path_info/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.peer/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.peer/index.html index 9c9f923e..11b14b0d 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.peer/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.peer/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.port/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.port/index.html index bd8ae869..af73250b 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.port/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.port/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.push/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.push/index.html index e0e21bd5..dd98a772 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.push/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.push/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.qs/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.qs/index.html index 8270f3d0..a84da010 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.qs/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.qs/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.read_body/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.read_body/index.html index 22c998b6..5d8a6058 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.read_body/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.read_body/index.html @@ -162,6 +162,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.read_part/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.read_part/index.html index 0c5d828e..d016d073 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.read_part/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.read_part/index.html @@ -184,6 +184,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.read_part_body/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.read_part_body/index.html index 34e9d410..5679ebbb 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.read_part_body/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.read_part_body/index.html @@ -160,6 +160,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.read_urlencoded_body/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.read_urlencoded_body/index.html index c72467f1..d93a97bb 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.read_urlencoded_body/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.read_urlencoded_body/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.reply/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.reply/index.html index 3f33f72d..a785bce9 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.reply/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.reply/index.html @@ -177,6 +177,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.resp_header/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.resp_header/index.html index 41d5e3a1..6bfbd84d 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.resp_header/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.resp_header/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.resp_headers/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.resp_headers/index.html index 59936d69..2ff4a99f 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.resp_headers/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.resp_headers/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.scheme/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.scheme/index.html index d65c2637..20021520 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.scheme/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.scheme/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_body/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_body/index.html index b335c543..9356a5fe 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_body/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_body/index.html @@ -169,6 +169,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_cookie/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_cookie/index.html index bfd03105..371f721d 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_cookie/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_cookie/index.html @@ -194,6 +194,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_header/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_header/index.html index 7e9fba9f..a7f29ade 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_header/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_header/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_headers/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_headers/index.html index 424b4821..1954558b 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_headers/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.set_resp_headers/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.sock/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.sock/index.html index 96dfe9c8..e9e39838 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.sock/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.sock/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.stream_body/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.stream_body/index.html index 0e047d80..9cb84830 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.stream_body/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.stream_body/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.stream_reply/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.stream_reply/index.html index 1c7784df..d144c126 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.stream_reply/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.stream_reply/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.stream_trailers/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.stream_trailers/index.html index 5d077874..9ae49f1b 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.stream_trailers/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.stream_trailers/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.uri/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.uri/index.html index b379d699..370116c3 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.uri/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.uri/index.html @@ -196,6 +196,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.version/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.version/index.html index 90cf558c..d991ecde 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.version/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.version/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_req/index.html b/docs/en/cowboy/2.4/manual/cowboy_req/index.html index 6783024f..b7acea95 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req/index.html @@ -308,6 +308,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_rest/index.html b/docs/en/cowboy/2.4/manual/cowboy_rest/index.html index b990e7bb..614c96a0 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_rest/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_rest/index.html @@ -565,6 +565,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_router.compile/index.html b/docs/en/cowboy/2.4/manual/cowboy_router.compile/index.html index 8e24111e..4007d29d 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_router.compile/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_router.compile/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_router/index.html b/docs/en/cowboy/2.4/manual/cowboy_router/index.html index e8504aed..f1312ced 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_router/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_router/index.html @@ -155,6 +155,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_static/index.html b/docs/en/cowboy/2.4/manual/cowboy_static/index.html index 461bc25d..9a015572 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_static/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_static/index.html @@ -200,6 +200,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_stream/index.html b/docs/en/cowboy/2.4/manual/cowboy_stream/index.html index 4ed9ebd7..73ac09b4 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_stream/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_stream/index.html @@ -396,6 +396,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/cowboy_websocket/index.html b/docs/en/cowboy/2.4/manual/cowboy_websocket/index.html index d408d2dd..f3d14e9d 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_websocket/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_websocket/index.html @@ -238,6 +238,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/http_status_codes/index.html b/docs/en/cowboy/2.4/manual/http_status_codes/index.html index 2c03340c..c2e55d0e 100644 --- a/docs/en/cowboy/2.4/manual/http_status_codes/index.html +++ b/docs/en/cowboy/2.4/manual/http_status_codes/index.html @@ -182,6 +182,8 @@ + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.4/manual/index.html b/docs/en/cowboy/2.4/manual/index.html index 493c0d9f..fa8809e3 100644 --- a/docs/en/cowboy/2.4/manual/index.html +++ b/docs/en/cowboy/2.4/manual/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/constraints/index.html b/docs/en/cowboy/2.5/guide/constraints/index.html index bf22afc2..cf02edb4 100644 --- a/docs/en/cowboy/2.5/guide/constraints/index.html +++ b/docs/en/cowboy/2.5/guide/constraints/index.html @@ -198,6 +198,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/cookies/index.html b/docs/en/cowboy/2.5/guide/cookies/index.html index c3e07678..de579cb0 100644 --- a/docs/en/cowboy/2.5/guide/cookies/index.html +++ b/docs/en/cowboy/2.5/guide/cookies/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/erlang_web/index.html b/docs/en/cowboy/2.5/guide/erlang_web/index.html index 63e8406b..e2ff6dbf 100644 --- a/docs/en/cowboy/2.5/guide/erlang_web/index.html +++ b/docs/en/cowboy/2.5/guide/erlang_web/index.html @@ -164,6 +164,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/flow_diagram/index.html b/docs/en/cowboy/2.5/guide/flow_diagram/index.html index 145150bb..bf80752c 100644 --- a/docs/en/cowboy/2.5/guide/flow_diagram/index.html +++ b/docs/en/cowboy/2.5/guide/flow_diagram/index.html @@ -142,6 +142,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/getting_started/index.html b/docs/en/cowboy/2.5/guide/getting_started/index.html index 4942b267..e32eb245 100644 --- a/docs/en/cowboy/2.5/guide/getting_started/index.html +++ b/docs/en/cowboy/2.5/guide/getting_started/index.html @@ -216,6 +216,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/handlers/index.html b/docs/en/cowboy/2.5/guide/handlers/index.html index 3320372e..a80d51a0 100644 --- a/docs/en/cowboy/2.5/guide/handlers/index.html +++ b/docs/en/cowboy/2.5/guide/handlers/index.html @@ -169,6 +169,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/index.html b/docs/en/cowboy/2.5/guide/index.html index 49c921bf..560bebc0 100644 --- a/docs/en/cowboy/2.5/guide/index.html +++ b/docs/en/cowboy/2.5/guide/index.html @@ -179,6 +179,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/introduction/index.html b/docs/en/cowboy/2.5/guide/introduction/index.html index 10dc71d1..6aed9d25 100644 --- a/docs/en/cowboy/2.5/guide/introduction/index.html +++ b/docs/en/cowboy/2.5/guide/introduction/index.html @@ -152,6 +152,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/listeners/index.html b/docs/en/cowboy/2.5/guide/listeners/index.html index 29a5323a..ee41df04 100644 --- a/docs/en/cowboy/2.5/guide/listeners/index.html +++ b/docs/en/cowboy/2.5/guide/listeners/index.html @@ -173,6 +173,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/loop_handlers/index.html b/docs/en/cowboy/2.5/guide/loop_handlers/index.html index 035c86ed..e789d205 100644 --- a/docs/en/cowboy/2.5/guide/loop_handlers/index.html +++ b/docs/en/cowboy/2.5/guide/loop_handlers/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/middlewares/index.html b/docs/en/cowboy/2.5/guide/middlewares/index.html index a5de3e56..8689d78e 100644 --- a/docs/en/cowboy/2.5/guide/middlewares/index.html +++ b/docs/en/cowboy/2.5/guide/middlewares/index.html @@ -150,6 +150,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/migrating_from_1.0/index.html b/docs/en/cowboy/2.5/guide/migrating_from_1.0/index.html index fca2f396..507b5f2d 100644 --- a/docs/en/cowboy/2.5/guide/migrating_from_1.0/index.html +++ b/docs/en/cowboy/2.5/guide/migrating_from_1.0/index.html @@ -232,6 +232,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/migrating_from_2.0/index.html b/docs/en/cowboy/2.5/guide/migrating_from_2.0/index.html index fae13337..f17b9a1d 100644 --- a/docs/en/cowboy/2.5/guide/migrating_from_2.0/index.html +++ b/docs/en/cowboy/2.5/guide/migrating_from_2.0/index.html @@ -167,6 +167,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/migrating_from_2.1/index.html b/docs/en/cowboy/2.5/guide/migrating_from_2.1/index.html index c6658610..a49d0406 100644 --- a/docs/en/cowboy/2.5/guide/migrating_from_2.1/index.html +++ b/docs/en/cowboy/2.5/guide/migrating_from_2.1/index.html @@ -178,6 +178,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/migrating_from_2.2/index.html b/docs/en/cowboy/2.5/guide/migrating_from_2.2/index.html index f267835b..f296dd8f 100644 --- a/docs/en/cowboy/2.5/guide/migrating_from_2.2/index.html +++ b/docs/en/cowboy/2.5/guide/migrating_from_2.2/index.html @@ -150,6 +150,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/migrating_from_2.3/index.html b/docs/en/cowboy/2.5/guide/migrating_from_2.3/index.html index 6604812d..4d10a40f 100644 --- a/docs/en/cowboy/2.5/guide/migrating_from_2.3/index.html +++ b/docs/en/cowboy/2.5/guide/migrating_from_2.3/index.html @@ -152,6 +152,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/migrating_from_2.4/index.html b/docs/en/cowboy/2.5/guide/migrating_from_2.4/index.html index b08960b8..ae89d842 100644 --- a/docs/en/cowboy/2.5/guide/migrating_from_2.4/index.html +++ b/docs/en/cowboy/2.5/guide/migrating_from_2.4/index.html @@ -180,6 +180,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/modern_web/index.html b/docs/en/cowboy/2.5/guide/modern_web/index.html index 2b3839f8..d4aa86d2 100644 --- a/docs/en/cowboy/2.5/guide/modern_web/index.html +++ b/docs/en/cowboy/2.5/guide/modern_web/index.html @@ -146,6 +146,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/multipart/index.html b/docs/en/cowboy/2.5/guide/multipart/index.html index ce6dc6cc..45523e4a 100644 --- a/docs/en/cowboy/2.5/guide/multipart/index.html +++ b/docs/en/cowboy/2.5/guide/multipart/index.html @@ -219,6 +219,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/req/index.html b/docs/en/cowboy/2.5/guide/req/index.html index 31c5abf3..1230fef4 100644 --- a/docs/en/cowboy/2.5/guide/req/index.html +++ b/docs/en/cowboy/2.5/guide/req/index.html @@ -394,6 +394,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/req_body/index.html b/docs/en/cowboy/2.5/guide/req_body/index.html index c1887bbe..49102aeb 100644 --- a/docs/en/cowboy/2.5/guide/req_body/index.html +++ b/docs/en/cowboy/2.5/guide/req_body/index.html @@ -205,6 +205,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/resource_design/index.html b/docs/en/cowboy/2.5/guide/resource_design/index.html index b59092b8..9aa54536 100644 --- a/docs/en/cowboy/2.5/guide/resource_design/index.html +++ b/docs/en/cowboy/2.5/guide/resource_design/index.html @@ -178,6 +178,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/resp/index.html b/docs/en/cowboy/2.5/guide/resp/index.html index 99417c06..9337b032 100644 --- a/docs/en/cowboy/2.5/guide/resp/index.html +++ b/docs/en/cowboy/2.5/guide/resp/index.html @@ -361,6 +361,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/rest_flowcharts/index.html b/docs/en/cowboy/2.5/guide/rest_flowcharts/index.html index 74410d60..6510d11d 100644 --- a/docs/en/cowboy/2.5/guide/rest_flowcharts/index.html +++ b/docs/en/cowboy/2.5/guide/rest_flowcharts/index.html @@ -176,6 +176,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/rest_handlers/index.html b/docs/en/cowboy/2.5/guide/rest_handlers/index.html index 0db991ad..d0fd9632 100644 --- a/docs/en/cowboy/2.5/guide/rest_handlers/index.html +++ b/docs/en/cowboy/2.5/guide/rest_handlers/index.html @@ -274,6 +274,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/rest_principles/index.html b/docs/en/cowboy/2.5/guide/rest_principles/index.html index b249a4d5..2d0f5b8c 100644 --- a/docs/en/cowboy/2.5/guide/rest_principles/index.html +++ b/docs/en/cowboy/2.5/guide/rest_principles/index.html @@ -150,6 +150,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/routing/index.html b/docs/en/cowboy/2.5/guide/routing/index.html index 9dc7e82b..36ebf8da 100644 --- a/docs/en/cowboy/2.5/guide/routing/index.html +++ b/docs/en/cowboy/2.5/guide/routing/index.html @@ -293,6 +293,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/specs/index.html b/docs/en/cowboy/2.5/guide/specs/index.html index fcbd2395..3e144c0c 100644 --- a/docs/en/cowboy/2.5/guide/specs/index.html +++ b/docs/en/cowboy/2.5/guide/specs/index.html @@ -459,6 +459,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/static_files/index.html b/docs/en/cowboy/2.5/guide/static_files/index.html index 9305f11f..0679b36c 100644 --- a/docs/en/cowboy/2.5/guide/static_files/index.html +++ b/docs/en/cowboy/2.5/guide/static_files/index.html @@ -213,6 +213,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/streams/index.html b/docs/en/cowboy/2.5/guide/streams/index.html index 988f0c7e..688b4ed4 100644 --- a/docs/en/cowboy/2.5/guide/streams/index.html +++ b/docs/en/cowboy/2.5/guide/streams/index.html @@ -135,6 +135,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/ws_handlers/index.html b/docs/en/cowboy/2.5/guide/ws_handlers/index.html index f543cac2..45abed09 100644 --- a/docs/en/cowboy/2.5/guide/ws_handlers/index.html +++ b/docs/en/cowboy/2.5/guide/ws_handlers/index.html @@ -302,6 +302,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/guide/ws_protocol/index.html b/docs/en/cowboy/2.5/guide/ws_protocol/index.html index 9978a49f..9abc41f9 100644 --- a/docs/en/cowboy/2.5/guide/ws_protocol/index.html +++ b/docs/en/cowboy/2.5/guide/ws_protocol/index.html @@ -134,6 +134,8 @@ + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.5/manual/cowboy.set_env/index.html index c5cabde4..84eb3a4e 100644 --- a/docs/en/cowboy/2.5/manual/cowboy.set_env/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy.set_env/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy.start_clear/index.html b/docs/en/cowboy/2.5/manual/cowboy.start_clear/index.html index 1e19255d..c8fd4453 100644 --- a/docs/en/cowboy/2.5/manual/cowboy.start_clear/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy.start_clear/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy.start_tls/index.html b/docs/en/cowboy/2.5/manual/cowboy.start_tls/index.html index fbb12367..d610f421 100644 --- a/docs/en/cowboy/2.5/manual/cowboy.start_tls/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy.start_tls/index.html @@ -172,6 +172,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy.stop_listener/index.html b/docs/en/cowboy/2.5/manual/cowboy.stop_listener/index.html index 8257ccb3..c9ba29da 100644 --- a/docs/en/cowboy/2.5/manual/cowboy.stop_listener/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy.stop_listener/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy/index.html b/docs/en/cowboy/2.5/manual/cowboy/index.html index e36a8eb9..450d4db5 100644 --- a/docs/en/cowboy/2.5/manual/cowboy/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_app/index.html b/docs/en/cowboy/2.5/manual/cowboy_app/index.html index 61a41536..31eafda4 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_app/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_app/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_constraints.int/index.html b/docs/en/cowboy/2.5/manual/cowboy_constraints.int/index.html index be949a3f..3c489edf 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_constraints.int/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_constraints.int/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_constraints.nonempty/index.html b/docs/en/cowboy/2.5/manual/cowboy_constraints.nonempty/index.html index be080cac..bf86c961 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_constraints.nonempty/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_constraints.nonempty/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_constraints/index.html b/docs/en/cowboy/2.5/manual/cowboy_constraints/index.html index abe94f8d..b850b4a0 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_constraints/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_constraints/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_handler.terminate/index.html b/docs/en/cowboy/2.5/manual/cowboy_handler.terminate/index.html index 406c1a8e..e70f5b63 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_handler.terminate/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_handler.terminate/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_handler/index.html b/docs/en/cowboy/2.5/manual/cowboy_handler/index.html index dd9b32ac..92ee3038 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_handler/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_handler/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_http/index.html b/docs/en/cowboy/2.5/manual/cowboy_http/index.html index 468a7201..f0e47531 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_http/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_http/index.html @@ -212,6 +212,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_http2/index.html b/docs/en/cowboy/2.5/manual/cowboy_http2/index.html index a5eff42b..b9f6f1cc 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_http2/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_http2/index.html @@ -192,6 +192,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_loop/index.html b/docs/en/cowboy/2.5/manual/cowboy_loop/index.html index 76ffaf27..a24e01b2 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_loop/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_loop/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.5/manual/cowboy_middleware/index.html index df431364..9c452a02 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_middleware/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_middleware/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.binding/index.html index 4ec44daa..367c893a 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.binding/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.binding/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.bindings/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.bindings/index.html index 620b152a..bc081b71 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.bindings/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.bindings/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.body_length/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.body_length/index.html index 6e680821..9b8f77a2 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.body_length/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.body_length/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.cert/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.cert/index.html index e3bb01e2..b4fbe222 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.cert/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.cert/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.delete_resp_header/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.delete_resp_header/index.html index a6e38185..c1edec56 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.delete_resp_header/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.delete_resp_header/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.has_body/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.has_body/index.html index 12912511..c3fe5388 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.has_body/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.has_body/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.has_resp_body/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.has_resp_body/index.html index d9a8fb61..f1a1bdbc 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.has_resp_body/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.has_resp_body/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.has_resp_header/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.has_resp_header/index.html index e2aef6cb..781deee7 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.has_resp_header/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.has_resp_header/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.header/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.header/index.html index 8d9ca34d..8d2154ec 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.header/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.header/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.headers/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.headers/index.html index 9ac41d6c..5178e070 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.headers/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.headers/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.host/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.host/index.html index 4fd7e66a..b360a50f 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.host/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.host/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.host_info/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.host_info/index.html index fb880190..bfe46d32 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.host_info/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.host_info/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.inform/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.inform/index.html index 71b83809..b7de785e 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.inform/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.inform/index.html @@ -155,6 +155,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.match_cookies/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.match_cookies/index.html index bc8d98ce..b3413779 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.match_cookies/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.match_cookies/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.match_qs/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.match_qs/index.html index 79860fc4..fc0dea88 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.match_qs/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.match_qs/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.method/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.method/index.html index ab70dd43..d4a57d69 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.method/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.method/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.parse_cookies/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.parse_cookies/index.html index c4c277ff..1bac4d29 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.parse_cookies/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.parse_cookies/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.parse_header/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.parse_header/index.html index 17c48a29..44c858e7 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.parse_header/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.parse_header/index.html @@ -308,6 +308,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.parse_qs/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.parse_qs/index.html index b1fabd15..de8272ef 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.parse_qs/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.parse_qs/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.path/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.path/index.html index 6ef746c1..83019d3a 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.path/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.path/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.path_info/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.path_info/index.html index 6f022bd8..9f4d29ba 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.path_info/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.path_info/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.peer/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.peer/index.html index 35df2c1f..9674478f 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.peer/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.peer/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.port/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.port/index.html index 8d811f08..0023d363 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.port/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.port/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.push/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.push/index.html index c9ac73b0..7f048c65 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.push/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.push/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.qs/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.qs/index.html index a7ddd0f3..8ad0da22 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.qs/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.qs/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.read_and_match_urlencoded_body/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.read_and_match_urlencoded_body/index.html index 1b34dddb..710580a5 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.read_and_match_urlencoded_body/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.read_and_match_urlencoded_body/index.html @@ -188,6 +188,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.read_body/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.read_body/index.html index fdf9a02a..e4ae1113 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.read_body/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.read_body/index.html @@ -162,6 +162,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.read_part/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.read_part/index.html index c311332b..86e2534a 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.read_part/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.read_part/index.html @@ -184,6 +184,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.read_part_body/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.read_part_body/index.html index 35e07484..0eed4d33 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.read_part_body/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.read_part_body/index.html @@ -160,6 +160,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.read_urlencoded_body/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.read_urlencoded_body/index.html index 70c74b7e..cb56f26f 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.read_urlencoded_body/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.read_urlencoded_body/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.reply/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.reply/index.html index b50013c6..3dae4fb2 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.reply/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.reply/index.html @@ -176,6 +176,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.resp_header/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.resp_header/index.html index fd9d2d2f..df36efff 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.resp_header/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.resp_header/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.resp_headers/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.resp_headers/index.html index 5305fb81..2876e9d1 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.resp_headers/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.resp_headers/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.scheme/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.scheme/index.html index d40f8b6e..2a8ffe77 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.scheme/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.scheme/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_body/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_body/index.html index a0c08404..59e13fff 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_body/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_body/index.html @@ -169,6 +169,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_cookie/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_cookie/index.html index 86d779da..226f5abc 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_cookie/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_cookie/index.html @@ -194,6 +194,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_header/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_header/index.html index 26c6da0f..7b99cb20 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_header/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_header/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_headers/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_headers/index.html index a8e17498..a589e91f 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_headers/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.set_resp_headers/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.sock/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.sock/index.html index 809ad0f3..9ecdbc9d 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.sock/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.sock/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.stream_body/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.stream_body/index.html index ef2e6824..1127d964 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.stream_body/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.stream_body/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.stream_events/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.stream_events/index.html index c0d72054..5b3cd9ae 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.stream_events/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.stream_events/index.html @@ -162,6 +162,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.stream_reply/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.stream_reply/index.html index e6a95138..d71a79ed 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.stream_reply/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.stream_reply/index.html @@ -165,6 +165,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.stream_trailers/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.stream_trailers/index.html index ba675a21..b382200d 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.stream_trailers/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.stream_trailers/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.uri/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.uri/index.html index a212796e..b3b19ece 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.uri/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.uri/index.html @@ -196,6 +196,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.version/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.version/index.html index 6a0cb312..5b36e467 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req.version/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req.version/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_req/index.html b/docs/en/cowboy/2.5/manual/cowboy_req/index.html index 9c73587b..84f39920 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_req/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_req/index.html @@ -312,6 +312,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_rest/index.html b/docs/en/cowboy/2.5/manual/cowboy_rest/index.html index 5119c633..5f4452f6 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_rest/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_rest/index.html @@ -565,6 +565,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_router.compile/index.html b/docs/en/cowboy/2.5/manual/cowboy_router.compile/index.html index 80e10b9d..7aad452d 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_router.compile/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_router.compile/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_router/index.html b/docs/en/cowboy/2.5/manual/cowboy_router/index.html index 0b9ce0bf..04b84d1f 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_router/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_router/index.html @@ -155,6 +155,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_static/index.html b/docs/en/cowboy/2.5/manual/cowboy_static/index.html index 54251883..2e4e3499 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_static/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_static/index.html @@ -200,6 +200,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_stream/index.html b/docs/en/cowboy/2.5/manual/cowboy_stream/index.html index 4fa0a8e7..c6c8f0c5 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_stream/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_stream/index.html @@ -383,6 +383,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/cowboy_websocket/index.html b/docs/en/cowboy/2.5/manual/cowboy_websocket/index.html index e8c43894..e8684097 100644 --- a/docs/en/cowboy/2.5/manual/cowboy_websocket/index.html +++ b/docs/en/cowboy/2.5/manual/cowboy_websocket/index.html @@ -238,6 +238,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/http_status_codes/index.html b/docs/en/cowboy/2.5/manual/http_status_codes/index.html index 036de9e3..f2368cb7 100644 --- a/docs/en/cowboy/2.5/manual/http_status_codes/index.html +++ b/docs/en/cowboy/2.5/manual/http_status_codes/index.html @@ -182,6 +182,8 @@ + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.5/manual/index.html b/docs/en/cowboy/2.5/manual/index.html index bf4e3e23..1ef46ec9 100644 --- a/docs/en/cowboy/2.5/manual/index.html +++ b/docs/en/cowboy/2.5/manual/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> diff --git a/docs/en/cowboy/2.6/guide/constraints.asciidoc b/docs/en/cowboy/2.6/guide/constraints.asciidoc new file mode 100644 index 00000000..6cc10752 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/constraints.asciidoc @@ -0,0 +1,123 @@ +[[constraints]] +== Constraints + +Constraints are validation and conversion functions applied +to user input. + +They are used in various places in Cowboy, including the +router and the `cowboy_req` match functions. + +=== Syntax + +Constraints are provided as a list of fields. For each field +in the list, specific constraints can be applied, as well as +a default value if the field is missing. + +A field can take the form of an atom `field`, a tuple with +constraints `{field, Constraints}` or a tuple with constraints +and a default value `{field, Constraints, Default}`. +The `field` form indicates the field is mandatory. + +Note that when used with the router, only the second form +makes sense, as it does not use the default and the field +is always defined. + +Constraints for each field are provided as an ordered list +of atoms or funs to apply. Built-in constraints are provided +as atoms, while custom constraints are provided as funs. + +When multiple constraints are provided, they are applied in +the order given. If the value has been modified by a constraint +then the next one receives the new value. + +For example, the following constraints will first validate +and convert the field `my_value` to an integer, and then +check that the integer is positive: + +[source,erlang] +---- +PositiveFun = fun + (_, V) when V > 0 -> + {ok, V}; + (_, _) -> + {error, not_positive} +end, +{my_value, [int, PositiveFun]}. +---- + +We ignore the first fun argument in this snippet. We shouldn't. +We will simply learn what it is later in this chapter. + +When there's only one constraint, it can be provided directly +without wrapping it into a list: + +[source,erlang] +---- +{my_value, int} +---- + +=== Built-in constraints + +Built-in constraints are specified as an atom: + +[cols="<,<",options="header"] +|=== +| Constraint | Description +| int | Converts binary value to integer. +| nonempty | Ensures the binary value is non-empty. +|=== + +=== Custom constraints + +Custom constraints are specified as a fun. This fun takes +two arguments. The first argument indicates the operation +to be performed, and the second is the value. What the +value is and what must be returned depends on the operation. + +Cowboy currently defines three operations. The operation +used for validating and converting user input is the `forward` +operation. + +[source,erlang] +---- +int(forward, Value) -> + try + {ok, binary_to_integer(Value)} + catch _:_ -> + {error, not_an_integer} + end; +---- + +The value must be returned even if it is not converted +by the constraint. + +The `reverse` operation does the opposite: it +takes a converted value and changes it back to what the +user input would have been. + +[source,erlang] +---- +int(reverse, Value) -> + try + {ok, integer_to_binary(Value)} + catch _:_ -> + {error, not_an_integer} + end; +---- + +Finally, the `format_error` operation takes an error +returned by any other operation and returns a formatted +human-readable error message. + +[source,erlang] +---- +int(format_error, {not_an_integer, Value}) -> + io_lib:format("The value ~p is not an integer.", [Value]). +---- + +Notice that for this case you get both the error and +the value that was given to the constraint that produced +this error. + +Cowboy will not catch exceptions coming from constraint +functions. They should be written to not emit any exceptions. diff --git a/docs/en/cowboy/2.6/guide/constraints/index.html b/docs/en/cowboy/2.6/guide/constraints/index.html new file mode 100644 index 00000000..7cafc39b --- /dev/null +++ b/docs/en/cowboy/2.6/guide/constraints/index.html @@ -0,0 +1,248 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Constraints</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Constraints</span></h1> + +<p>Constraints are validation and conversion functions applied to user input.</p> +<p>They are used in various places in Cowboy, including the router and the <code>cowboy_req</code> match functions.</p> +<h2 id="_syntax">Syntax</h2> +<p>Constraints are provided as a list of fields. For each field in the list, specific constraints can be applied, as well as a default value if the field is missing.</p> +<p>A field can take the form of an atom <code>field</code>, a tuple with constraints <code>{field, Constraints}</code> or a tuple with constraints and a default value <code>{field, Constraints, Default}</code>. The <code>field</code> form indicates the field is mandatory.</p> +<p>Note that when used with the router, only the second form makes sense, as it does not use the default and the field is always defined.</p> +<p>Constraints for each field are provided as an ordered list of atoms or funs to apply. Built-in constraints are provided as atoms, while custom constraints are provided as funs.</p> +<p>When multiple constraints are provided, they are applied in the order given. If the value has been modified by a constraint then the next one receives the new value.</p> +<p>For example, the following constraints will first validate and convert the field <code>my_value</code> to an integer, and then check that the integer is positive:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PositiveFun</font> <font color="#990000">=</font> <b><font color="#0000FF">fun</font></b> + (<font color="#990000">_</font>, <font color="#009900">V</font>) <b><font color="#0000FF">when</font></b> <font color="#009900">V</font> <font color="#990000">></font> <font color="#993399">0</font> <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">V</font>}; + (<font color="#990000">_</font>, <font color="#990000">_</font>) <font color="#990000">-></font> + {<font color="#FF6600">error</font>, <font color="#FF6600">not_positive</font>} +<b><font color="#0000FF">end</font></b>, +{<font color="#FF6600">my_value</font>, [<font color="#FF6600">int</font>, <font color="#009900">PositiveFun</font>]}<font color="#990000">.</font></tt></pre> +</div></div> +<p>We ignore the first fun argument in this snippet. We shouldn't. We will simply learn what it is later in this chapter.</p> +<p>When there's only one constraint, it can be provided directly without wrapping it into a list:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">my_value</font>, <font color="#FF6600">int</font>}</tt></pre> +</div></div> +<h2 id="_built_in_constraints">Built-in constraints</h2> +<p>Built-in constraints are specified as an atom:</p> +<table rules="all" width="100%" frame="border" + cellspacing="0" cellpadding="4"> +<thead><tr><th>Constraint</th> +<th>Description</th> +</tr></thead><tbody><tr><td>int</td> +<td>Converts binary value to integer.</td> +</tr> +<tr><td>nonempty</td> +<td>Ensures the binary value is non-empty.</td> +</tr> +</tbody></table> +<h2 id="_custom_constraints">Custom constraints</h2> +<p>Custom constraints are specified as a fun. This fun takes two arguments. The first argument indicates the operation to be performed, and the second is the value. What the value is and what must be returned depends on the operation.</p> +<p>Cowboy currently defines three operations. The operation used for validating and converting user input is the <code>forward</code> operation.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">int</font></b>(<font color="#FF6600">forward</font>, <font color="#009900">Value</font>) <font color="#990000">-></font> + <b><font color="#0000FF">try</font></b> + {<font color="#FF6600">ok</font>, <b><font color="#000000">binary_to_integer</font></b>(<font color="#009900">Value</font>)} + <b><font color="#0000FF">catch</font></b> <font color="#990000">_:_</font> <font color="#990000">-></font> + {<font color="#FF6600">error</font>, <font color="#FF6600">not_an_integer</font>} + <b><font color="#0000FF">end</font></b>;</tt></pre> +</div></div> +<p>The value must be returned even if it is not converted by the constraint.</p> +<p>The <code>reverse</code> operation does the opposite: it takes a converted value and changes it back to what the user input would have been.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">int</font></b>(<font color="#FF6600">reverse</font>, <font color="#009900">Value</font>) <font color="#990000">-></font> + <b><font color="#0000FF">try</font></b> + {<font color="#FF6600">ok</font>, <b><font color="#000000">integer_to_binary</font></b>(<font color="#009900">Value</font>)} + <b><font color="#0000FF">catch</font></b> <font color="#990000">_:_</font> <font color="#990000">-></font> + {<font color="#FF6600">error</font>, <font color="#FF6600">not_an_integer</font>} + <b><font color="#0000FF">end</font></b>;</tt></pre> +</div></div> +<p>Finally, the <code>format_error</code> operation takes an error returned by any other operation and returns a formatted human-readable error message.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">int</font></b>(<font color="#FF6600">format_error</font>, {<font color="#FF6600">not_an_integer</font>, <font color="#009900">Value</font>}) <font color="#990000">-></font> + <b><font color="#000000">io_lib:format</font></b>(<font color="#FF0000">"The value ~p is not an integer."</font>, [<font color="#009900">Value</font>])<font color="#990000">.</font></tt></pre> +</div></div> +<p>Notice that for this case you get both the error and the value that was given to the constraint that produced this error.</p> +<p>Cowboy will not catch exceptions coming from constraint functions. They should be written to not emit any exceptions.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/routing/"> + Routing + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/handlers/"> + Handlers + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/cookies.asciidoc b/docs/en/cowboy/2.6/guide/cookies.asciidoc new file mode 100644 index 00000000..4825031b --- /dev/null +++ b/docs/en/cowboy/2.6/guide/cookies.asciidoc @@ -0,0 +1,139 @@ +[[cookies]] +== Using cookies + +Cookies are a mechanism allowing applications to maintain +state on top of the stateless HTTP protocol. + +Cookies are a name/value store where the names and values are +stored in plain text. They expire either after a delay +or when the browser closes. They can be configured on a +specific domain name or path, and restricted to secure +resources (sent or downloaded over HTTPS), or restricted +to the server (disallowing access from client-side scripts). + +Cookie names are de facto case sensitive. + +Cookies are stored client-side and sent with every subsequent +request that matches the domain and path for which they were +stored, until they expire. This can create a non-negligible +cost. + +Cookies should not be considered secure. They are stored on +the user's computer in plain text, and can be read by any +program. They can also be read by proxies when using clear +connections. Always validate the value before using it, +and never store any sensitive information inside it. + +Cookies set by the server are only available in requests +following the client reception of the response containing +them. + +Cookies may be sent repeatedly. This is often useful to +update the expiration time and avoid losing a cookie. + +=== Setting cookies + +By default cookies are defined for the duration of the session: + +[source,erlang] +---- +SessionID = generate_session_id(), +Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0). +---- + +They can also be set for a duration in seconds: + +[source,erlang] +---- +SessionID = generate_session_id(), +Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0, + #{max_age => 3600}). +---- + +To delete cookies, set `max_age` to 0: + +[source,erlang] +---- +SessionID = generate_session_id(), +Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0, + #{max_age => 0}). +---- + +To restrict cookies to a specific domain and path, the options +of the same name can be used: + +[source,erlang] +---- +Req = cowboy_req:set_resp_cookie(<<"inaccount">>, <<"1">>, Req0, + #{domain => "my.example.org", path => "/account"}). +---- + +Cookies will be sent with requests to this domain and all +its subdomains, and to resources on this path or deeper +in the path hierarchy. + +To restrict cookies to secure channels (typically resources +available over HTTPS): + +[source,erlang] +---- +SessionID = generate_session_id(), +Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0, + #{secure => true}). +---- + +To prevent client-side scripts from accessing a cookie: + +[source,erlang] +---- +SessionID = generate_session_id(), +Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0, + #{http_only => true}). +---- + +Cookies may also be set client-side, for example using +Javascript. + +=== Reading cookies + +The client only ever sends back the cookie name and value. +All other options that can be set are never sent back. + +Cowboy provides two functions for reading cookies. Both +involve parsing the cookie header(s) and so should not +be called repeatedly. + +You can get all cookies as a key/value list: + +[source,erlang] +Cookies = cowboy_req:parse_cookies(Req), +{_, Lang} = lists:keyfind(<<"lang">>, 1, Cookies). + +Or you can perform a match against cookies and retrieve +only the ones you need, while at the same time doing +any required post processing using xref:constraints[constraints]. +This function returns a map: + +[source,erlang] +#{id := ID, lang := Lang} = cowboy_req:match_cookies([id, lang], Req). + +You can use constraints to validate the values while matching +them. The following snippet will crash if the `id` cookie is +not an integer number or if the `lang` cookie is empty. Additionally +the `id` cookie value will be converted to an integer term: + +[source,erlang] +CookiesMap = cowboy_req:match_cookies([{id, int}, {lang, nonempty}], Req). + +Note that if two cookies share the same name, then the map value +will be a list of the two cookie values. + +A default value can be provided. The default will be used +if the `lang` cookie is not found. It will not be used if +the cookie is found but has an empty value: + +[source,erlang] +#{lang := Lang} = cowboy_req:match_cookies([{lang, [], <<"en-US">>}], Req). + +If no default is provided and the value is missing, an +exception is thrown. diff --git a/docs/en/cowboy/2.6/guide/cookies/index.html b/docs/en/cowboy/2.6/guide/cookies/index.html new file mode 100644 index 00000000..edaa38c0 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/cookies/index.html @@ -0,0 +1,265 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Using cookies</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Using cookies</span></h1> + +<p>Cookies are a mechanism allowing applications to maintain state on top of the stateless HTTP protocol.</p> +<p>Cookies are a name/value store where the names and values are stored in plain text. They expire either after a delay or when the browser closes. They can be configured on a specific domain name or path, and restricted to secure resources (sent or downloaded over HTTPS), or restricted to the server (disallowing access from client-side scripts).</p> +<p>Cookie names are de facto case sensitive.</p> +<p>Cookies are stored client-side and sent with every subsequent request that matches the domain and path for which they were stored, until they expire. This can create a non-negligible cost.</p> +<p>Cookies should not be considered secure. They are stored on the user's computer in plain text, and can be read by any program. They can also be read by proxies when using clear connections. Always validate the value before using it, and never store any sensitive information inside it.</p> +<p>Cookies set by the server are only available in requests following the client reception of the response containing them.</p> +<p>Cookies may be sent repeatedly. This is often useful to update the expiration time and avoid losing a cookie.</p> +<h2 id="_setting_cookies">Setting cookies</h2> +<p>By default cookies are defined for the duration of the session:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">SessionID</font> <font color="#990000">=</font> <b><font color="#000000">generate_session_id</font></b>(), +<font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_cookie</font></b>(<font color="#990000"><<</font><font color="#FF0000">"sessionid"</font><font color="#990000">>></font>, <font color="#009900">SessionID</font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>They can also be set for a duration in seconds:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">SessionID</font> <font color="#990000">=</font> <b><font color="#000000">generate_session_id</font></b>(), +<font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_cookie</font></b>(<font color="#990000"><<</font><font color="#FF0000">"sessionid"</font><font color="#990000">>></font>, <font color="#009900">SessionID</font>, <font color="#009900">Req0</font>, + #{<font color="#0000FF">max_age</font> <font color="#990000">=></font> <font color="#993399">3600</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<p>To delete cookies, set <code>max_age</code> to 0:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">SessionID</font> <font color="#990000">=</font> <b><font color="#000000">generate_session_id</font></b>(), +<font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_cookie</font></b>(<font color="#990000"><<</font><font color="#FF0000">"sessionid"</font><font color="#990000">>></font>, <font color="#009900">SessionID</font>, <font color="#009900">Req0</font>, + #{<font color="#0000FF">max_age</font> <font color="#990000">=></font> <font color="#993399">0</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<p>To restrict cookies to a specific domain and path, the options of the same name can be used:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_cookie</font></b>(<font color="#990000"><<</font><font color="#FF0000">"inaccount"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"1"</font><font color="#990000">>></font>, <font color="#009900">Req0</font>, + #{<font color="#0000FF">domain</font> <font color="#990000">=></font> <font color="#FF0000">"my.example.org"</font>, <font color="#0000FF">path</font> <font color="#990000">=></font> <font color="#FF0000">"/account"</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<p>Cookies will be sent with requests to this domain and all its subdomains, and to resources on this path or deeper in the path hierarchy.</p> +<p>To restrict cookies to secure channels (typically resources available over HTTPS):</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">SessionID</font> <font color="#990000">=</font> <b><font color="#000000">generate_session_id</font></b>(), +<font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_cookie</font></b>(<font color="#990000"><<</font><font color="#FF0000">"sessionid"</font><font color="#990000">>></font>, <font color="#009900">SessionID</font>, <font color="#009900">Req0</font>, + #{<font color="#0000FF">secure</font> <font color="#990000">=></font> <font color="#000080">true</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<p>To prevent client-side scripts from accessing a cookie:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">SessionID</font> <font color="#990000">=</font> <b><font color="#000000">generate_session_id</font></b>(), +<font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_cookie</font></b>(<font color="#990000"><<</font><font color="#FF0000">"sessionid"</font><font color="#990000">>></font>, <font color="#009900">SessionID</font>, <font color="#009900">Req0</font>, + #{<font color="#0000FF">http_only</font> <font color="#990000">=></font> <font color="#000080">true</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<p>Cookies may also be set client-side, for example using Javascript.</p> +<h2 id="_reading_cookies">Reading cookies</h2> +<p>The client only ever sends back the cookie name and value. All other options that can be set are never sent back.</p> +<p>Cowboy provides two functions for reading cookies. Both involve parsing the cookie header(s) and so should not be called repeatedly.</p> +<p>You can get all cookies as a key/value list:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Cookies</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:parse_cookies</font></b>(<font color="#009900">Req</font>), +{<font color="#990000">_</font>, <font color="#009900">Lang</font>} <font color="#990000">=</font> <b><font color="#000000">lists:keyfind</font></b>(<font color="#990000"><<</font><font color="#FF0000">"lang"</font><font color="#990000">>></font>, <font color="#993399">1</font>, <font color="#009900">Cookies</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Or you can perform a match against cookies and retrieve only the ones you need, while at the same time doing any required post processing using <a href="../constraints">constraints</a>. This function returns a map:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">id</font> <font color="#990000">:=</font> <font color="#009900">ID</font>, <font color="#FF6600">lang</font> <font color="#990000">:=</font> <font color="#009900">Lang</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:match_cookies</font></b>([<font color="#FF6600">id</font>, <font color="#FF6600">lang</font>], <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>You can use constraints to validate the values while matching them. The following snippet will crash if the <code>id</code> cookie is not an integer number or if the <code>lang</code> cookie is empty. Additionally the <code>id</code> cookie value will be converted to an integer term:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">CookiesMap</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:match_cookies</font></b>([{<font color="#FF6600">id</font>, <font color="#FF6600">int</font>}, {<font color="#FF6600">lang</font>, <font color="#FF6600">nonempty</font>}], <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Note that if two cookies share the same name, then the map value will be a list of the two cookie values.</p> +<p>A default value can be provided. The default will be used if the <code>lang</code> cookie is not found. It will not be used if the cookie is found but has an empty value:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">lang</font> <font color="#990000">:=</font> <font color="#009900">Lang</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:match_cookies</font></b>([{<font color="#FF6600">lang</font>, [], <font color="#990000"><<</font><font color="#FF0000">"en-US"</font><font color="#990000">>></font>}], <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>If no default is provided and the value is missing, an exception is thrown.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/resp/"> + Sending a response + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/multipart/"> + Multipart requests + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/cowboy.sty b/docs/en/cowboy/2.6/guide/cowboy.sty new file mode 100644 index 00000000..d5e0d3be --- /dev/null +++ b/docs/en/cowboy/2.6/guide/cowboy.sty @@ -0,0 +1,8 @@ +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{asciidoc-dblatex}[2012/10/24 AsciiDoc DocBook Style] + +%% Just use the original package and pass the options. +\RequirePackageWithOptions{docbook} + +%% Define an alias for make snippets to be compatible with source-highlighter. +\lstalias{makefile}{make} diff --git a/docs/en/cowboy/2.6/guide/erlang_web.asciidoc b/docs/en/cowboy/2.6/guide/erlang_web.asciidoc new file mode 100644 index 00000000..f528adc3 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/erlang_web.asciidoc @@ -0,0 +1,209 @@ +[[erlang_web]] +== Erlang and the Web + +Erlang is the ideal platform for writing Web applications. +Its features are a perfect match for the requirements of +modern Web applications. + +=== The Web is concurrent + +When you access a website there is little concurrency +involved. A few connections are opened and requests +are sent through these connections. Then the web page +is displayed on your screen. Your browser will only +open up to 4 or 8 connections to the server, depending +on your settings. This isn't much. + +But think about it. You are not the only one accessing +the server at the same time. There can be hundreds, if +not thousands, if not millions of connections to the +same server at the same time. + +Even today a lot of systems used in production haven't +solved the C10K problem (ten thousand concurrent connections). +And the ones who did are trying hard to get to the next +step, C100K, and are pretty far from it. + +Erlang meanwhile has no problem handling millions of +connections. At the time of writing there are application +servers written in Erlang that can handle more than two +million connections on a single server in a real production +application, with spare memory and CPU! + +The Web is concurrent, and Erlang is a language designed +for concurrency, so it is a perfect match. + +Of course, various platforms need to scale beyond a few +million connections. This is where Erlang's built-in +distribution mechanisms come in. If one server isn't +enough, add more! Erlang allows you to use the same code +for talking to local processes or to processes in other +parts of your cluster, which means you can scale very +quickly if the need arises. + +The Web has large userbases, and the Erlang platform was +designed to work in a distributed setting, so it is a +perfect match. + +Or is it? Surely you can find solutions to handle that many +concurrent connections with your favorite language... But all +these solutions will break down in the next few years. Why? +Firstly because servers don't get any more powerful, they +instead get a lot more cores and memory. This is only useful +if your application can use them properly, and Erlang is +light-years away from anything else in that area. Secondly, +today your computer and your phone are online, tomorrow your +watch, goggles, bike, car, fridge and tons of other devices +will also connect to various applications on the Internet. + +Only Erlang is prepared to deal with what's coming. + +=== The Web is soft real time + +What does soft real time mean, you ask? It means we want the +operations done as quickly as possible, and in the case of +web applications, it means we want the data propagated fast. + +In comparison, hard real time has a similar meaning, but also +has a hard time constraint, for example an operation needs to +be done in under N milliseconds otherwise the system fails +entirely. + +Users aren't that needy yet, they just want to get access +to their content in a reasonable delay, and they want the +actions they make to register at most a few seconds after +they submitted them, otherwise they'll start worrying about +whether it successfully went through. + +The Web is soft real time because taking longer to perform an +operation would be seen as bad quality of service. + +Erlang is a soft real time system. It will always run +processes fairly, a little at a time, switching to another +process after a while and preventing a single process to +steal resources from all others. This means that Erlang +can guarantee stable low latency of operations. + +Erlang provides the guarantees that the soft real time Web +requires. + +=== The Web is asynchronous + +Long ago, the Web was synchronous because HTTP was synchronous. +You fired a request, and then waited for a response. Not anymore. +It all began when XmlHttpRequest started being used. It allowed +the client to perform asynchronous calls to the server. + +Then Websocket appeared and allowed both the server and the client +to send data to the other endpoint completely asynchronously. The +data is contained within frames and no response is necessary. + +Erlang processes work the same. They send each other data contained +within messages and then continue running without needing a response. +They tend to spend most of their time inactive, waiting for a new +message, and the Erlang VM happily activate them when one is received. + +It is therefore quite easy to imagine Erlang being good at receiving +Websocket frames, which may come in at unpredictable times, pass the +data to the responsible processes which are always ready waiting for +new messages, and perform the operations required by only activating +the required parts of the system. + +The more recent Web technologies, like Websocket of course, but also +HTTP/2.0, are all fully asynchronous protocols. The concept +of requests and responses is retained of course, but anything could +be sent in between, by both the client or the browser, and the +responses could also be received in a completely different order. + +Erlang is by nature asynchronous and really good at it thanks to the +great engineering that has been done in the VM over the years. It's +only natural that it's so good at dealing with the asynchronous Web. + +=== The Web is omnipresent + +The Web has taken a very important part of our lives. We're +connected at all times, when we're on our phone, using our computer, +passing time using a tablet while in the bathroom... And this +isn't going to slow down, every single device at home or on us +will be connected. + +All these devices are always connected. And with the number of +alternatives to give you access to the content you seek, users +tend to not stick around when problems arise. Users today want +their applications to be always available and if it's having +too many issues they just move on. + +Despite this, when developers choose a product to use for building +web applications, their only concern seems to be "Is it fast?", +and they look around for synthetic benchmarks showing which one +is the fastest at sending "Hello world" with only a handful +concurrent connections. Web benchmarks haven't been representative +of reality in a long time, and are drifting further away as +time goes on. + +What developers should really ask themselves is "Can I service +all my users with no interruption?" and they'd find that they have +two choices. They can either hope for the best, or they can use +Erlang. + +Erlang is built for fault tolerance. When writing code in any other +language, you have to check all the return values and act accordingly +to avoid any unforeseen issues. If you're lucky, you won't miss +anything important. When writing Erlang code, you can just check +the success condition and ignore all errors. If an error happens, +the Erlang process crashes and is then restarted by a special +process called a supervisor. + +Erlang developers thus have no need to fear unhandled +errors, and can focus on handling only the errors that should +give some feedback to the user and let the system take care of +the rest. This also has the advantage of allowing them to write +a lot less code, and let them sleep at night. + +Erlang's fault tolerance oriented design is the first piece of +what makes it the best choice for the omnipresent, always available +Web. + +The second piece is Erlang's built-in distribution. Distribution +is a key part of building a fault tolerant system, because it +allows you to handle bigger failures, like a whole server going +down, or even a data center entirely. + +Fault tolerance and distribution are important today, and will be +vital in the future of the Web. Erlang is ready. + +=== Learn Erlang + +If you are new to Erlang, you may want to grab a book or +two to get started. Those are my recommendations as the +author of Cowboy. + +==== The Erlanger Playbook + +The Erlanger Playbook is an ebook I am currently writing, +which covers a number of different topics from code to +documentation to testing Erlang applications. It also has +an Erlang section where it covers directly the building +blocks and patterns, rather than details like the syntax. + +You can most likely read it as a complete beginner, but +you will need a companion book to make the most of it. +Buy it from the https://ninenines.eu[Nine Nines website]. + +==== Programming Erlang + +This book is from one of the creator of Erlang, Joe +Armstrong. It provides a very good explanation of what +Erlang is and why it is so. It serves as a very good +introduction to the language and platform. + +The book is http://pragprog.com/book/jaerlang2/programming-erlang[Programming Erlang], +and it also features a chapter on Cowboy. + +==== Learn You Some Erlang for Great Good! + +http://learnyousomeerlang.com[LYSE] is a much more complete +book covering many aspects of Erlang, while also providing +stories and humor. Be warned: it's pretty verbose. It comes +with a free online version and a more refined paper and +ebook version. diff --git a/docs/en/cowboy/2.6/guide/erlang_web/index.html b/docs/en/cowboy/2.6/guide/erlang_web/index.html new file mode 100644 index 00000000..cf110f4a --- /dev/null +++ b/docs/en/cowboy/2.6/guide/erlang_web/index.html @@ -0,0 +1,214 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Erlang and the Web</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Erlang and the Web</span></h1> + +<p>Erlang is the ideal platform for writing Web applications. Its features are a perfect match for the requirements of modern Web applications.</p> +<h2 id="_the_web_is_concurrent">The Web is concurrent</h2> +<p>When you access a website there is little concurrency involved. A few connections are opened and requests are sent through these connections. Then the web page is displayed on your screen. Your browser will only open up to 4 or 8 connections to the server, depending on your settings. This isn't much.</p> +<p>But think about it. You are not the only one accessing the server at the same time. There can be hundreds, if not thousands, if not millions of connections to the same server at the same time.</p> +<p>Even today a lot of systems used in production haven't solved the C10K problem (ten thousand concurrent connections). And the ones who did are trying hard to get to the next step, C100K, and are pretty far from it.</p> +<p>Erlang meanwhile has no problem handling millions of connections. At the time of writing there are application servers written in Erlang that can handle more than two million connections on a single server in a real production application, with spare memory and CPU!</p> +<p>The Web is concurrent, and Erlang is a language designed for concurrency, so it is a perfect match.</p> +<p>Of course, various platforms need to scale beyond a few million connections. This is where Erlang's built-in distribution mechanisms come in. If one server isn't enough, add more! Erlang allows you to use the same code for talking to local processes or to processes in other parts of your cluster, which means you can scale very quickly if the need arises.</p> +<p>The Web has large userbases, and the Erlang platform was designed to work in a distributed setting, so it is a perfect match.</p> +<p>Or is it? Surely you can find solutions to handle that many concurrent connections with your favorite language... But all these solutions will break down in the next few years. Why? Firstly because servers don't get any more powerful, they instead get a lot more cores and memory. This is only useful if your application can use them properly, and Erlang is light-years away from anything else in that area. Secondly, today your computer and your phone are online, tomorrow your watch, goggles, bike, car, fridge and tons of other devices will also connect to various applications on the Internet.</p> +<p>Only Erlang is prepared to deal with what's coming.</p> +<h2 id="_the_web_is_soft_real_time">The Web is soft real time</h2> +<p>What does soft real time mean, you ask? It means we want the operations done as quickly as possible, and in the case of web applications, it means we want the data propagated fast.</p> +<p>In comparison, hard real time has a similar meaning, but also has a hard time constraint, for example an operation needs to be done in under N milliseconds otherwise the system fails entirely.</p> +<p>Users aren't that needy yet, they just want to get access to their content in a reasonable delay, and they want the actions they make to register at most a few seconds after they submitted them, otherwise they'll start worrying about whether it successfully went through.</p> +<p>The Web is soft real time because taking longer to perform an operation would be seen as bad quality of service.</p> +<p>Erlang is a soft real time system. It will always run processes fairly, a little at a time, switching to another process after a while and preventing a single process to steal resources from all others. This means that Erlang can guarantee stable low latency of operations.</p> +<p>Erlang provides the guarantees that the soft real time Web requires.</p> +<h2 id="_the_web_is_asynchronous">The Web is asynchronous</h2> +<p>Long ago, the Web was synchronous because HTTP was synchronous. You fired a request, and then waited for a response. Not anymore. It all began when XmlHttpRequest started being used. It allowed the client to perform asynchronous calls to the server.</p> +<p>Then Websocket appeared and allowed both the server and the client to send data to the other endpoint completely asynchronously. The data is contained within frames and no response is necessary.</p> +<p>Erlang processes work the same. They send each other data contained within messages and then continue running without needing a response. They tend to spend most of their time inactive, waiting for a new message, and the Erlang VM happily activate them when one is received.</p> +<p>It is therefore quite easy to imagine Erlang being good at receiving Websocket frames, which may come in at unpredictable times, pass the data to the responsible processes which are always ready waiting for new messages, and perform the operations required by only activating the required parts of the system.</p> +<p>The more recent Web technologies, like Websocket of course, but also HTTP/2.0, are all fully asynchronous protocols. The concept of requests and responses is retained of course, but anything could be sent in between, by both the client or the browser, and the responses could also be received in a completely different order.</p> +<p>Erlang is by nature asynchronous and really good at it thanks to the great engineering that has been done in the VM over the years. It's only natural that it's so good at dealing with the asynchronous Web.</p> +<h2 id="_the_web_is_omnipresent">The Web is omnipresent</h2> +<p>The Web has taken a very important part of our lives. We're connected at all times, when we're on our phone, using our computer, passing time using a tablet while in the bathroom... And this isn't going to slow down, every single device at home or on us will be connected.</p> +<p>All these devices are always connected. And with the number of alternatives to give you access to the content you seek, users tend to not stick around when problems arise. Users today want their applications to be always available and if it's having too many issues they just move on.</p> +<p>Despite this, when developers choose a product to use for building web applications, their only concern seems to be "Is it fast?", and they look around for synthetic benchmarks showing which one is the fastest at sending "Hello world" with only a handful concurrent connections. Web benchmarks haven't been representative of reality in a long time, and are drifting further away as time goes on.</p> +<p>What developers should really ask themselves is "Can I service all my users with no interruption?" and they'd find that they have two choices. They can either hope for the best, or they can use Erlang.</p> +<p>Erlang is built for fault tolerance. When writing code in any other language, you have to check all the return values and act accordingly to avoid any unforeseen issues. If you're lucky, you won't miss anything important. When writing Erlang code, you can just check the success condition and ignore all errors. If an error happens, the Erlang process crashes and is then restarted by a special process called a supervisor.</p> +<p>Erlang developers thus have no need to fear unhandled errors, and can focus on handling only the errors that should give some feedback to the user and let the system take care of the rest. This also has the advantage of allowing them to write a lot less code, and let them sleep at night.</p> +<p>Erlang's fault tolerance oriented design is the first piece of what makes it the best choice for the omnipresent, always available Web.</p> +<p>The second piece is Erlang's built-in distribution. Distribution is a key part of building a fault tolerant system, because it allows you to handle bigger failures, like a whole server going down, or even a data center entirely.</p> +<p>Fault tolerance and distribution are important today, and will be vital in the future of the Web. Erlang is ready.</p> +<h2 id="_learn_erlang">Learn Erlang</h2> +<p>If you are new to Erlang, you may want to grab a book or two to get started. Those are my recommendations as the author of Cowboy.</p> +<h4 id="_the_erlanger_playbook">The Erlanger Playbook</h4> +<p>The Erlanger Playbook is an ebook I am currently writing, which covers a number of different topics from code to documentation to testing Erlang applications. It also has an Erlang section where it covers directly the building blocks and patterns, rather than details like the syntax.</p> +<p>You can most likely read it as a complete beginner, but you will need a companion book to make the most of it. Buy it from the <a href="https://ninenines.eu">Nine Nines website</a>.</p> +<h4 id="_programming_erlang">Programming Erlang</h4> +<p>This book is from one of the creator of Erlang, Joe Armstrong. It provides a very good explanation of what Erlang is and why it is so. It serves as a very good introduction to the language and platform.</p> +<p>The book is <a href="http://pragprog.com/book/jaerlang2/programming-erlang">Programming Erlang</a>, and it also features a chapter on Cowboy.</p> +<h4 id="_learn_you_some_erlang_for_great_good">Learn You Some Erlang for Great Good!</h4> +<p><a href="http://learnyousomeerlang.com">LYSE</a> is a much more complete book covering many aspects of Erlang, while also providing stories and humor. Be warned: it's pretty verbose. It comes with a free online version and a more refined paper and ebook version.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/modern_web/"> + The modern Web + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/introduction/"> + Introduction + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/flow_diagram.asciidoc b/docs/en/cowboy/2.6/guide/flow_diagram.asciidoc new file mode 100644 index 00000000..2d35d4d6 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/flow_diagram.asciidoc @@ -0,0 +1,109 @@ +[[flow_diagram]] +== Flow diagram + +Cowboy is a lightweight HTTP server with support for HTTP/1.1, +HTTP/2 and Websocket. + +It is built on top of Ranch. Please see the Ranch guide for more +information about how the network connections are handled. + +=== Overview + +image::http_req_resp.png[HTTP request/response flowchart] + +As you can see on the diagram, the client +begins by connecting to the server. This step is handled +by a Ranch acceptor, which is a process dedicated to +accepting new connections. + +After Ranch accepts a new connection, whether it is an +HTTP/1.1 or HTTP/2 connection, Cowboy starts receiving +requests and handling them. + +In HTTP/1.1 all requests come sequentially. In HTTP/2 +the requests may arrive and be processed concurrently. + +When a request comes in, Cowboy creates a stream, which +is a set of request/response and all the events associated +with them. The protocol code in Cowboy defers the handling +of these streams to stream handler modules. When you +configure Cowboy you may define one or more module that +will receive all events associated with a stream, including +the request, response, bodies, Erlang messages and more. + +By default Cowboy comes configured with a stream handler +called `cowboy_stream_h`. This stream handler will create +a new process for every request coming in, and then +communicate with this process to read the body or send +a response back. The request process executes middlewares +which, by default, including the router and then the +execution of handlers. Like stream handlers, middlewares +may also be customized. + +A response may be sent at almost any point in this +diagram. If the response must be sent before the stream +is initialized (because an error occurred early, for +example) then stream handlers receive a special event +indicating this error. + +=== Protocol-specific headers + +Cowboy takes care of protocol-specific headers and prevents +you from sending them manually. For HTTP/1.1 this includes +the `transfer-encoding` and `connection` headers. For HTTP/2 +this includes the colon headers like `:status`. + +Cowboy will also remove protocol-specific headers from +requests before passing them to stream handlers. Cowboy +tries to hide the implementation details of all protocols +as well as possible. + +=== Number of processes per connection + +By default, Cowboy will use one process per connection, +plus one process per set of request/response (called a +stream, internally). + +The reason it creates a new process for every request is due +to the requirements of HTTP/2 where requests are executed +concurrently and independently from the connection. The +frames from the different requests end up interleaved on +the single TCP connection. + +The request processes are never reused. There is therefore +no need to perform any cleanup after the response has been +sent. The process will terminate and Erlang/OTP will reclaim +all memory at once. + +Cowboy ultimately does not require more than one process +per connection. It is possible to interact with the connection +directly from a stream handler, a low level interface to Cowboy. +They are executed from within the connection process, and can +handle the incoming requests and send responses. This is however +not recommended in normal circumstances, as a stream handler +taking too long to execute could have a negative impact on +concurrent requests or the state of the connection itself. + +=== Date header + +Because querying for the current date and time can be expensive, +Cowboy generates one 'Date' header value every second, shares it +to all other processes, which then simply copy it in the response. +This allows compliance with HTTP/1.1 with no actual performance loss. + +=== Binaries + +Cowboy makes extensive use of binaries. + +Binaries are more efficient than lists for representing +strings because they take less memory space. Processing +performance can vary depending on the operation. Binaries +are known for generally getting a great boost if the code +is compiled natively. Please see the HiPE documentation +for more details. + +Binaries may end up being shared between processes. This +can lead to some large memory usage when one process keeps +the binary data around forever without freeing it. If you +see some weird memory usage in your application, this might +be the cause. diff --git a/docs/en/cowboy/2.6/guide/flow_diagram/index.html b/docs/en/cowboy/2.6/guide/flow_diagram/index.html new file mode 100644 index 00000000..d3c97215 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/flow_diagram/index.html @@ -0,0 +1,192 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Flow diagram</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Flow diagram</span></h1> + +<p>Cowboy is a lightweight HTTP server with support for HTTP/1.1, HTTP/2 and Websocket.</p> +<p>It is built on top of Ranch. Please see the Ranch guide for more information about how the network connections are handled.</p> +<h2 id="_overview">Overview</h2> +<img src="../http_req_resp.png" alt="HTTP request/response flowchart"/><p>As you can see on the diagram, the client begins by connecting to the server. This step is handled by a Ranch acceptor, which is a process dedicated to accepting new connections.</p> +<p>After Ranch accepts a new connection, whether it is an HTTP/1.1 or HTTP/2 connection, Cowboy starts receiving requests and handling them.</p> +<p>In HTTP/1.1 all requests come sequentially. In HTTP/2 the requests may arrive and be processed concurrently.</p> +<p>When a request comes in, Cowboy creates a stream, which is a set of request/response and all the events associated with them. The protocol code in Cowboy defers the handling of these streams to stream handler modules. When you configure Cowboy you may define one or more module that will receive all events associated with a stream, including the request, response, bodies, Erlang messages and more.</p> +<p>By default Cowboy comes configured with a stream handler called <code>cowboy_stream_h</code>. This stream handler will create a new process for every request coming in, and then communicate with this process to read the body or send a response back. The request process executes middlewares which, by default, including the router and then the execution of handlers. Like stream handlers, middlewares may also be customized.</p> +<p>A response may be sent at almost any point in this diagram. If the response must be sent before the stream is initialized (because an error occurred early, for example) then stream handlers receive a special event indicating this error.</p> +<h2 id="_protocol_specific_headers">Protocol-specific headers</h2> +<p>Cowboy takes care of protocol-specific headers and prevents you from sending them manually. For HTTP/1.1 this includes the <code>transfer-encoding</code> and <code>connection</code> headers. For HTTP/2 this includes the colon headers like <code>:status</code>.</p> +<p>Cowboy will also remove protocol-specific headers from requests before passing them to stream handlers. Cowboy tries to hide the implementation details of all protocols as well as possible.</p> +<h2 id="_number_of_processes_per_connection">Number of processes per connection</h2> +<p>By default, Cowboy will use one process per connection, plus one process per set of request/response (called a stream, internally).</p> +<p>The reason it creates a new process for every request is due to the requirements of HTTP/2 where requests are executed concurrently and independently from the connection. The frames from the different requests end up interleaved on the single TCP connection.</p> +<p>The request processes are never reused. There is therefore no need to perform any cleanup after the response has been sent. The process will terminate and Erlang/OTP will reclaim all memory at once.</p> +<p>Cowboy ultimately does not require more than one process per connection. It is possible to interact with the connection directly from a stream handler, a low level interface to Cowboy. They are executed from within the connection process, and can handle the incoming requests and send responses. This is however not recommended in normal circumstances, as a stream handler taking too long to execute could have a negative impact on concurrent requests or the state of the connection itself.</p> +<h2 id="_date_header">Date header</h2> +<p>Because querying for the current date and time can be expensive, Cowboy generates one <em>Date</em> header value every second, shares it to all other processes, which then simply copy it in the response. This allows compliance with HTTP/1.1 with no actual performance loss.</p> +<h2 id="_binaries">Binaries</h2> +<p>Cowboy makes extensive use of binaries.</p> +<p>Binaries are more efficient than lists for representing strings because they take less memory space. Processing performance can vary depending on the operation. Binaries are known for generally getting a great boost if the code is compiled natively. Please see the HiPE documentation for more details.</p> +<p>Binaries may end up being shared between processes. This can lead to some large memory usage when one process keeps the binary data around forever without freeing it. If you see some weird memory usage in your application, this might be the cause.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/getting_started/"> + Getting started + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/listeners/"> + Listeners + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/getting_started.asciidoc b/docs/en/cowboy/2.6/guide/getting_started.asciidoc new file mode 100644 index 00000000..75022df7 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/getting_started.asciidoc @@ -0,0 +1,148 @@ +[[getting_started]] +== Getting started + +Erlang is more than a language, it is also an operating system +for your applications. Erlang developers rarely write standalone +modules, they write libraries or applications, and then bundle +those into what is called a release. A release contains the +Erlang VM plus all applications required to run the node, so +it can be pushed to production directly. + +This chapter walks you through all the steps of setting up +Cowboy, writing your first application and generating your first +release. At the end of this chapter you should know everything +you need to push your first Cowboy application to production. + +=== Prerequisites + +We are going to use the https://github.com/ninenines/erlang.mk[Erlang.mk] +build system. If you are using Windows, please check the +http://erlang.mk/guide/installation.html[Installation instructions] +to get your environment setup before you continue. + +=== Bootstrap + +First, let's create the directory for our application. + +[source,bash] +$ mkdir hello_erlang +$ cd hello_erlang + +Then we need to download Erlang.mk. Either use the following +command or download it manually. + +[source,bash] +$ wget https://erlang.mk/erlang.mk + +We can now bootstrap our application. Since we are going to generate +a release, we will also bootstrap it at the same time. + +[source,bash] +$ make -f erlang.mk bootstrap bootstrap-rel + +This creates a Makefile, a base application, and the release files +necessary for creating the release. We can already build and start +this release. + +[source,bash] +---- +$ make run +... +([email protected])1> +---- + +Entering the command `i().` will show the running processes, including +one called `hello_erlang_sup`. This is the supervisor for our +application. + +The release currently does nothing. In the rest of this chapter we +will add Cowboy as a dependency and write a simple "Hello world!" +handler. + +=== Cowboy setup + +We will modify the 'Makefile' to tell the build system it needs to +fetch and compile Cowboy: + +[source,makefile] +---- +PROJECT = hello_erlang + +DEPS = cowboy +dep_cowboy_commit = 2.6.0 + +DEP_PLUGINS = cowboy + +include erlang.mk +---- + +The `DEP_PLUGINS` line tells the build system to load the plugins +Cowboy provides. These include predefined templates that we will +use soon. + +If you do `make run` now, Cowboy will be included in the release +and started automatically. This is not enough however, as Cowboy +doesn't do anything by default. We still need to tell Cowboy to +listen for connections. + +=== Listening for connections + +First we define the routes that Cowboy will use to map requests +to handler modules, and then we start the listener. This is best +done at application startup. + +Open the 'src/hello_erlang_app.erl' file and add the necessary +code to the `start/2` function to make it look like this: + +[source,erlang] +---- +start(_Type, _Args) -> + Dispatch = cowboy_router:compile([ + {'_', [{"/", hello_handler, []}]} + ]), + {ok, _} = cowboy:start_clear(my_http_listener, + [{port, 8080}], + #{env => #{dispatch => Dispatch}} + ), + hello_erlang_sup:start_link(). +---- + +Routes are explained in details in the xref:routing[Routing] +chapter. For this tutorial we map the path `/` to the handler +module `hello_handler`. This module doesn't exist yet. + +Build and start the release, then open http://localhost:8080 +in your browser. You will get a 500 error because the module is missing. +Any other URL, like http://localhost:8080/test, will result in a +404 error. + +=== Handling requests + +Cowboy features different kinds of handlers, including REST +and Websocket handlers. For this tutorial we will use a plain +HTTP handler. + +Generate a handler from a template: + +[source,bash] +$ make new t=cowboy.http n=hello_handler + +Then, open the 'src/hello_handler.erl' file and modify +the `init/2` function like this to send a reply. + +[source,erlang] +---- +init(Req0, State) -> + Req = cowboy_req:reply(200, + #{<<"content-type">> => <<"text/plain">>}, + <<"Hello Erlang!">>, + Req0), + {ok, Req, State}. +---- + +What the above code does is send a 200 OK reply, with the +Content-type header set to `text/plain` and the response +body set to `Hello Erlang!`. + +If you run the release and open http://localhost:8080 +in your browser, you should get a nice `Hello Erlang!` displayed! diff --git a/docs/en/cowboy/2.6/guide/getting_started/index.html b/docs/en/cowboy/2.6/guide/getting_started/index.html new file mode 100644 index 00000000..b0efe72e --- /dev/null +++ b/docs/en/cowboy/2.6/guide/getting_started/index.html @@ -0,0 +1,266 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Getting started</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Getting started</span></h1> + +<p>Erlang is more than a language, it is also an operating system for your applications. Erlang developers rarely write standalone modules, they write libraries or applications, and then bundle those into what is called a release. A release contains the Erlang VM plus all applications required to run the node, so it can be pushed to production directly.</p> +<p>This chapter walks you through all the steps of setting up Cowboy, writing your first application and generating your first release. At the end of this chapter you should know everything you need to push your first Cowboy application to production.</p> +<h2 id="_prerequisites">Prerequisites</h2> +<p>We are going to use the <a href="https://github.com/ninenines/erlang.mk">Erlang.mk</a> build system. If you are using Windows, please check the <a href="http://erlang.mk/guide/installation.html">Installation instructions</a> to get your environment setup before you continue.</p> +<h2 id="_bootstrap">Bootstrap</h2> +<p>First, let's create the directory for our application.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>$ mkdir hello_erlang +$ cd hello_erlang</tt></pre> +</div></div> +<p>Then we need to download Erlang.mk. Either use the following command or download it manually.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>$ wget https<font color="#990000">:</font>//erlang<font color="#990000">.</font>mk/erlang<font color="#990000">.</font>mk</tt></pre> +</div></div> +<p>We can now bootstrap our application. Since we are going to generate a release, we will also bootstrap it at the same time.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>$ make -f erlang<font color="#990000">.</font>mk bootstrap bootstrap-rel</tt></pre> +</div></div> +<p>This creates a Makefile, a base application, and the release files necessary for creating the release. We can already build and start this release.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>$ make run +<font color="#990000">...</font> +<font color="#990000">(</font>hello_erlang@<font color="#993399">127.0</font><font color="#990000">.</font><font color="#993399">0.1</font><font color="#990000">)</font><font color="#993399">1</font><font color="#990000">></font></tt></pre> +</div></div> +<p>Entering the command <code>i().</code> will show the running processes, including one called <code>hello_erlang_sup</code>. This is the supervisor for our application.</p> +<p>The release currently does nothing. In the rest of this chapter we will add Cowboy as a dependency and write a simple "Hello world!" handler.</p> +<h2 id="_cowboy_setup">Cowboy setup</h2> +<p>We will modify the <em>Makefile</em> to tell the build system it needs to fetch and compile Cowboy:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PROJECT =</font> hello_erlang + +<font color="#009900">DEPS =</font> cowboy +<font color="#009900">dep_cowboy_commit =</font> 2.6.0 + +<font color="#009900">DEP_PLUGINS =</font> cowboy + +include erlang.mk</tt></pre> +</div></div> +<p>The <code>DEP_PLUGINS</code> line tells the build system to load the plugins Cowboy provides. These include predefined templates that we will use soon.</p> +<p>If you do <code>make run</code> now, Cowboy will be included in the release and started automatically. This is not enough however, as Cowboy doesn't do anything by default. We still need to tell Cowboy to listen for connections.</p> +<h2 id="_listening_for_connections">Listening for connections</h2> +<p>First we define the routes that Cowboy will use to map requests to handler modules, and then we start the listener. This is best done at application startup.</p> +<p>Open the <em>src/hello_erlang_app.erl</em> file and add the necessary code to the <code>start/2</code> function to make it look like this:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">start</font></b>(<font color="#009900">_Type</font>, <font color="#009900">_Args</font>) <font color="#990000">-></font> + <font color="#009900">Dispatch</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_router:compile</font></b>([ + {<font color="#FF6600">'_'</font>, [{<font color="#FF0000">"/"</font>, <font color="#FF6600">hello_handler</font>, []}]} + ]), + {<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy:start_clear</font></b>(<font color="#FF6600">my_http_listener</font>, + [{<font color="#FF6600">port</font>, <font color="#993399">8080</font>}], + #{<font color="#0000FF">env</font> <font color="#990000">=></font> #{<font color="#0000FF">dispatch</font> <font color="#990000">=></font> <font color="#009900">Dispatch</font>}} + ), + <b><font color="#000000">hello_erlang_sup:start_link</font></b>()<font color="#990000">.</font></tt></pre> +</div></div> +<p>Routes are explained in details in the <a href="../routing">Routing</a> chapter. For this tutorial we map the path <code>/</code> to the handler module <code>hello_handler</code>. This module doesn't exist yet.</p> +<p>Build and start the release, then open <a href="http://localhost:8080">http://localhost:8080</a> in your browser. You will get a 500 error because the module is missing. Any other URL, like <a href="http://localhost:8080/test">http://localhost:8080/test</a>, will result in a 404 error.</p> +<h2 id="_handling_requests">Handling requests</h2> +<p>Cowboy features different kinds of handlers, including REST and Websocket handlers. For this tutorial we will use a plain HTTP handler.</p> +<p>Generate a handler from a template:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>$ make new <font color="#009900">t</font><font color="#990000">=</font>cowboy<font color="#990000">.</font>http <font color="#009900">n</font><font color="#990000">=</font>hello_handler</tt></pre> +</div></div> +<p>Then, open the <em>src/hello_handler.erl</em> file and modify the <code>init/2</code> function like this to send a reply.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req0</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + <font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, + #{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>}, + <font color="#990000"><<</font><font color="#FF0000">"Hello Erlang!"</font><font color="#990000">>></font>, + <font color="#009900">Req0</font>), + {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>What the above code does is send a 200 OK reply, with the Content-type header set to <code>text/plain</code> and the response body set to <code>Hello Erlang!</code>.</p> +<p>If you run the release and open <a href="http://localhost:8080">http://localhost:8080</a> in your browser, you should get a nice <code>Hello Erlang!</code> displayed!</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/introduction/"> + Introduction + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/flow_diagram/"> + Flow diagram + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/handlers.asciidoc b/docs/en/cowboy/2.6/guide/handlers.asciidoc new file mode 100644 index 00000000..fe6f4623 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/handlers.asciidoc @@ -0,0 +1,90 @@ +[[handlers]] +== Handlers + +Handlers are Erlang modules that handle HTTP requests. + +=== Plain HTTP handlers + +The most basic handler in Cowboy implements the mandatory +`init/2` callback, manipulates the request, optionally +sends a response and then returns. + +This callback receives the xref:req[Req object] and the initial +state defined in the xref:routing[router configuration]. + +A handler that does nothing would look like this: + +[source,erlang] +---- +init(Req, State) -> + {ok, Req, State}. +---- + +Despite sending no reply, a `204 No Content` response will be +sent to the client, as Cowboy makes sure that a response is +sent for every request. + +We need to use the Req object to reply. + +[source,erlang] +---- +init(Req0, State) -> + Req = cowboy_req:reply(200, #{ + <<"content-type">> => <<"text/plain">> + }, <<"Hello World!">>, Req0), + {ok, Req, State}. +---- + +Cowboy will immediately send a response when `cowboy:reply/4` +is called. + +We then return a 3-tuple. `ok` means that the handler ran +successfully. We also give the modified Req back to Cowboy. + +The last value of the tuple is a state that will be used +in every subsequent callbacks to this handler. Plain HTTP +handlers only have one additional callback, the optional +and rarely used `terminate/3`. + +=== Other handlers + +The `init/2` callback can also be used to inform Cowboy +that this is a different kind of handler and that Cowboy +should switch to it. To do this you simply need to return +the module name of the handler type you want to switch to. + +Cowboy comes with three handler types you can switch to: +xref:rest_handlers[cowboy_rest], xref:ws_handlers[cowboy_websocket] +and xref:loop_handlers[cowboy_loop]. In addition to those you +can define your own handler types. + +Switching is simple. Instead of returning `ok`, you simply +return the name of the handler type you want to use. The +following snippet switches to a Websocket handler: + +[source,erlang] +---- +init(Req, State) -> + {cowboy_websocket, Req, State}. +---- + +=== Cleaning up + +All handler types provide the optional `terminate/3` callback. + +[source,erlang] +---- +terminate(_Reason, _Req, _State) -> + ok. +---- + +This callback is strictly reserved for any required cleanup. +You cannot send a response from this function. There is no +other return value. + +This callback is optional because it is rarely necessary. +Cleanup should be done in separate processes directly (by +monitoring the handler process to detect when it exits). + +Cowboy does not reuse processes for different requests. The +process will terminate soon after this call returns. diff --git a/docs/en/cowboy/2.6/guide/handlers/index.html b/docs/en/cowboy/2.6/guide/handlers/index.html new file mode 100644 index 00000000..390eb32e --- /dev/null +++ b/docs/en/cowboy/2.6/guide/handlers/index.html @@ -0,0 +1,219 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Handlers</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Handlers</span></h1> + +<p>Handlers are Erlang modules that handle HTTP requests.</p> +<h2 id="_plain_http_handlers">Plain HTTP handlers</h2> +<p>The most basic handler in Cowboy implements the mandatory <code>init/2</code> callback, manipulates the request, optionally sends a response and then returns.</p> +<p>This callback receives the <a href="../req">Req object</a> and the initial state defined in the <a href="../routing">router configuration</a>.</p> +<p>A handler that does nothing would look like this:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>Despite sending no reply, a <code>204 No Content</code> response will be sent to the client, as Cowboy makes sure that a response is sent for every request.</p> +<p>We need to use the Req object to reply.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req0</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + <font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font> + }, <font color="#990000"><<</font><font color="#FF0000">"Hello World!"</font><font color="#990000">>></font>, <font color="#009900">Req0</font>), + {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>Cowboy will immediately send a response when <code>cowboy:reply/4</code> is called.</p> +<p>We then return a 3-tuple. <code>ok</code> means that the handler ran successfully. We also give the modified Req back to Cowboy.</p> +<p>The last value of the tuple is a state that will be used in every subsequent callbacks to this handler. Plain HTTP handlers only have one additional callback, the optional and rarely used <code>terminate/3</code>.</p> +<h2 id="_other_handlers">Other handlers</h2> +<p>The <code>init/2</code> callback can also be used to inform Cowboy that this is a different kind of handler and that Cowboy should switch to it. To do this you simply need to return the module name of the handler type you want to switch to.</p> +<p>Cowboy comes with three handler types you can switch to: <a href="../rest_handlers">cowboy_rest</a>, <a href="../ws_handlers">cowboy_websocket</a> and <a href="../loop_handlers">cowboy_loop</a>. In addition to those you can define your own handler types.</p> +<p>Switching is simple. Instead of returning <code>ok</code>, you simply return the name of the handler type you want to use. The following snippet switches to a Websocket handler:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">cowboy_websocket</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_cleaning_up">Cleaning up</h2> +<p>All handler types provide the optional <code>terminate/3</code> callback.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">terminate</font></b>(<font color="#009900">_Reason</font>, <font color="#009900">_Req</font>, <font color="#009900">_State</font>) <font color="#990000">-></font> + <font color="#FF6600">ok</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>This callback is strictly reserved for any required cleanup. You cannot send a response from this function. There is no other return value.</p> +<p>This callback is optional because it is rarely necessary. Cleanup should be done in separate processes directly (by monitoring the handler process to detect when it exits).</p> +<p>Cowboy does not reuse processes for different requests. The process will terminate soon after this call returns.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/constraints/"> + Constraints + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/loop_handlers/"> + Loop handlers + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/http_req_resp.png b/docs/en/cowboy/2.6/guide/http_req_resp.png Binary files differnew file mode 100644 index 00000000..41c17c8a --- /dev/null +++ b/docs/en/cowboy/2.6/guide/http_req_resp.png diff --git a/docs/en/cowboy/2.6/guide/http_req_resp.svg b/docs/en/cowboy/2.6/guide/http_req_resp.svg new file mode 100644 index 00000000..acedb152 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/http_req_resp.svg @@ -0,0 +1,543 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + xmlns:osb="http://www.openswatchbook.org/uri/2009/osb" + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="744.09448819" + height="1052.3622047" + id="svg2" + version="1.1" + inkscape:version="0.92.1 r" + sodipodi:docname="http_req_resp.svg" + inkscape:export-filename="/home/essen/Dropbox/Public/drawing.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <defs + id="defs4"> + <linearGradient + id="linearGradient5265"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5267" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.58823532;" + offset="1" + id="stop5269" /> + </linearGradient> + <linearGradient + id="linearGradient5251"> + <stop + style="stop-color:#69d2e7;stop-opacity:0.78431374;" + offset="0" + id="stop5253" /> + <stop + id="stop5263" + offset="0.5" + style="stop-color:#69d2e7;stop-opacity:1;" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.39215687;" + offset="1" + id="stop5255" /> + </linearGradient> + <linearGradient + id="linearGradient5233" + osb:paint="solid"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5235" /> + </linearGradient> + </defs> + <sodipodi:namedview + id="base" + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1.0" + inkscape:pageopacity="1" + inkscape:pageshadow="2" + inkscape:zoom="1.4142136" + inkscape:cx="172.08527" + inkscape:cy="762.31079" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="false" + inkscape:window-width="1920" + inkscape:window-height="1043" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="1" + inkscape:snap-global="true" + showguides="true"> + <inkscape:grid + type="xygrid" + id="grid5357" + empspacing="5" + visible="true" + enabled="true" + snapvisiblegridlinesonly="true" /> + </sodipodi:namedview> + <metadata + id="metadata7"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + <dc:title /> + </cc:Work> + </rdf:RDF> + </metadata> + <g + inkscape:label="Layer 1" + inkscape:groupmode="layer" + id="layer1"> + <g + transform="translate(193.54707,-32.134105)" + id="g5650-5-0"> + <path + inkscape:connector-curvature="0" + id="path5570-3-9" + d="m -57.78256,351.41962 v 52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-5-3" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="rotate(180,50.658226,375.46461)" + id="g5650-6-6"> + <path + inkscape:connector-curvature="0" + id="path5570-2-0" + d="m -57.78256,351.41962 v 52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9-6" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="translate(193.54707,-119.75468)" + id="g5650-5"> + <path + inkscape:connector-curvature="0" + id="path5570-3" + d="m -57.78256,351.41962 v 52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-5" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="rotate(180,50.658226,331.65432)" + id="g5650-6"> + <path + inkscape:connector-curvature="0" + id="path5570-2" + d="m -57.78256,351.41962 v 52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <rect + style="fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:2.44279909;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5367" + width="207.05719" + height="171.55719" + x="43.721401" + y="384.1973" + rx="11.072577" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <use + x="0" + y="0" + xlink:href="#g5650" + id="use5654" + transform="translate(205.03261,76.66371)" + width="744.09448" + height="1052.3622" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + id="use5660" + transform="translate(205.03261,-207.5)"> + <path + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m -57.78256,351.41962 0,52.3259" + id="path3051" + inkscape:connector-curvature="0" /> + <path + sodipodi:type="star" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="path3053" + sodipodi:sides="3" + sodipodi:cx="-222.73865" + sodipodi:cy="415.25897" + sodipodi:r1="14.849242" + sodipodi:r2="7.4246211" + sodipodi:arg1="1.5707963" + sodipodi:arg2="2.6179939" + inkscape:flatsided="true" + inkscape:rounded="0" + inkscape:randomized="0" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:transform-center-y="2.1823437" + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" /> + </g> + <use + x="0" + y="0" + xlink:href="#use5660" + id="use5662" + transform="translate(0,-86.562562)" + width="744.09448" + height="1052.3622" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + id="g5650"> + <path + inkscape:connector-curvature="0" + id="path5570" + d="m -57.78256,351.41962 0,52.3259" + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;opacity:0.8" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576" + style="fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0;opacity:0.8" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273" + width="104.5895" + height="36.392323" + x="-224.02068" + y="29.41218" + rx="15" /> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7" + width="104.5895" + height="36.392323" + x="-224.02068" + y="90.691978" + rx="15" /> + <rect + style="fill:#ffc48c;fill-opacity:1;fill-rule:nonzero;stroke:#d79c64;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-2" + width="104.5895" + height="36.392323" + x="-224.02068" + y="151.97169" + rx="15" /> + <rect + style="fill:#ff9f80;fill-opacity:1;fill-rule:nonzero;stroke:#d77758;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-22" + width="104.5895" + height="36.392323" + x="-224.02068" + y="213.25146" + rx="15" /> + <rect + style="fill:#f56991;fill-opacity:1;fill-rule:nonzero;stroke:#cd4169;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-8" + width="104.5895" + height="36.392323" + x="-224.02068" + y="274.53128" + rx="15" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="-58.692513" + y="114.39204" + id="text5371"><tspan + sodipodi:role="line" + id="tspan5373" + x="-58.692513" + y="114.39204" + style="font-size:16px;line-height:1.25;font-family:sans-serif">some text</tspan></text> + <g + id="g3850"> + <use + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + height="1052.3622" + width="744.09448" + transform="translate(318.97597,32.837526)" + id="use5359" + xlink:href="#rect5273-7" + y="0" + x="0" /> + <a + id="a3826"> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="146.77739" + y="145.67879" + id="text5371-7" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3" + x="146.77739" + y="145.67879" + style="font-size:16px;line-height:1.25;font-family:sans-serif">acceptor</tspan></text> + </a> + </g> + <g + id="g3860"> + <use + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + height="1052.3622" + width="744.09448" + transform="translate(1.630859e-6,86.777953)" + id="use5361" + xlink:href="#use5359" + y="0" + x="0" /> + <text + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + id="text5371-74" + y="232.91768" + x="147.26958" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + xml:space="preserve"><tspan + id="tspan3770" + style="font-size:16px;line-height:1.25;font-family:sans-serif" + y="232.91768" + x="147.26958" + sodipodi:role="line">protocol</tspan></text> + </g> + <g + id="g3904"> + <use + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + height="1052.3622" + width="744.09448" + transform="translate(0,197.08458)" + id="use5365" + xlink:href="#use5361" + y="0" + x="0" /> + <text + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + id="text5371-5" + y="431.0921" + x="146.53125" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + xml:space="preserve"><tspan + style="font-size:16px;line-height:1.25;font-family:sans-serif" + y="431.0921" + x="146.53125" + id="tspan5373-0" + sodipodi:role="line">router</tspan></text> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="-58.692513" + y="53.112247" + id="text5371-2"><tspan + sodipodi:role="line" + id="tspan5373-6" + x="-58.692513" + y="53.112247" + style="font-size:16px;line-height:1.25;font-family:sans-serif">some text</tspan></text> + <g + id="g3909"> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="use5363" + width="104.5895" + height="36.392323" + x="94.955292" + y="494.37244" + rx="15" /> + <text + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + id="text5371-2-3-0" + y="518.38519" + x="146.53125" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + xml:space="preserve"><tspan + style="font-size:16px;line-height:1.25;font-family:sans-serif" + y="518.38519" + x="146.53125" + id="tspan5373-6-7-3" + sodipodi:role="line">handler</tspan></text> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="-470.30792" + y="63.078125" + id="text5371-2-3-0-7" + transform="rotate(-90)" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7-3-9" + x="-470.30792" + y="63.078125" + style="font-size:16px;line-height:1.25;font-family:sans-serif">middlewares</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="-58.692513" + y="236.95154" + id="text5371-4"><tspan + sodipodi:role="line" + id="tspan5373-9" + x="-58.692513" + y="236.95154" + style="font-size:16px;line-height:1.25;font-family:sans-serif">some text</tspan></text> + <g + id="g3855"> + <use + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + height="1052.3622" + width="744.09448" + transform="translate(318.97592,-176.5)" + id="use5355" + xlink:href="#rect5273-22" + y="0" + x="0" /> + <text + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + id="text5371-4-0" + y="60.912468" + x="147.00391" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + xml:space="preserve"><tspan + style="font-size:16px;line-height:1.25;font-family:sans-serif" + y="60.912468" + x="147.00391" + id="tspan5373-9-2" + sodipodi:role="line">client</tspan></text> + </g> + <g + id="g3865"> + <rect + rx="15" + y="297.08545" + x="94.955299" + height="36.392323" + width="104.5895" + id="rect5273-3" + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" /> + <text + id="text5371-2-6" + y="320.78552" + x="147.50005" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + xml:space="preserve"><tspan + style="font-size:16px;line-height:1.25;font-family:sans-serif" + y="320.78552" + x="147.50005" + id="tspan5373-6-7" + sodipodi:role="line">stream</tspan></text> + </g> + </g> +</svg> diff --git a/docs/en/cowboy/2.6/guide/index.html b/docs/en/cowboy/2.6/guide/index.html new file mode 100644 index 00000000..1dd2f094 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/index.html @@ -0,0 +1,231 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Cowboy User Guide</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Cowboy User Guide</span></h1> + +<!-- REST: where should i handle bindings? init, probably. qs? in media type functions--> +<!-- REST: explain how a module per media type is good; module may be shared between client/server--> +<h2 id="_rationale">Rationale</h2> +<ul><li><a href="modern_web/">The modern Web</a> +</li> +<li><a href="erlang_web/">Erlang and the Web</a> +</li> +</ul> +<h2 id="_introduction">Introduction</h2> +<ul><li><a href="introduction/">Introduction</a> +</li> +<li><a href="getting_started/">Getting started</a> +</li> +<li><a href="flow_diagram/">Flow diagram</a> +</li> +</ul> +<h2 id="_configuration">Configuration</h2> +<ul><li><a href="listeners/">Listeners</a> +</li> +<li><a href="routing/">Routing</a> +</li> +<li><a href="constraints/">Constraints</a> +</li> +</ul> +<h2 id="_handlers">Handlers</h2> +<ul><li><a href="handlers/">Handlers</a> +</li> +<li><a href="loop_handlers/">Loop handlers</a> +</li> +<li><a href="static_files/">Static files</a> +</li> +</ul> +<h2 id="_request_and_response">Request and response</h2> +<ul><li><a href="req/">Request details</a> +</li> +<li><a href="req_body/">Reading the request body</a> +</li> +<li><a href="resp/">Sending a response</a> +</li> +<li><a href="cookies/">Using cookies</a> +</li> +<li><a href="multipart/">Multipart</a> +</li> +</ul> +<h2 id="_rest">REST</h2> +<ul><li><a href="rest_principles/">REST principles</a> +</li> +<li><a href="rest_handlers/">Handling REST requests</a> +</li> +<li><a href="rest_flowcharts/">REST flowcharts</a> +</li> +<li><a href="resource_design/">Designing a resource handler</a> +</li> +</ul> +<h2 id="_websocket">Websocket</h2> +<ul><li><a href="ws_protocol/">The Websocket protocol</a> +</li> +<li><a href="ws_handlers/">Websocket handlers</a> +</li> +</ul> +<h2 id="_advanced">Advanced</h2> +<ul><li><a href="streams/">Streams</a> +</li> +<li><a href="middlewares/">Middlewares</a> +</li> +</ul> +<h2 id="_additional_information">Additional information</h2> +<ul><li><a href="migrating_from_2.5/">Migrating from Cowboy 2.5 to 2.6</a> +</li> +<li><a href="migrating_from_2.4/">Migrating from Cowboy 2.4 to 2.5</a> +</li> +<li><a href="migrating_from_2.3/">Migrating from Cowboy 2.3 to 2.4</a> +</li> +<li><a href="migrating_from_2.2/">Migrating from Cowboy 2.2 to 2.3</a> +</li> +<li><a href="migrating_from_2.1/">Migrating from Cowboy 2.1 to 2.2</a> +</li> +<li><a href="migrating_from_2.0/">Migrating from Cowboy 2.0 to 2.1</a> +</li> +<li><a href="migrating_from_1.0/">Migrating from Cowboy 1.0 to 2.0</a> +</li> +<li><a href="specs/">HTTP and other specifications</a> +</li> +</ul> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/introduction.asciidoc b/docs/en/cowboy/2.6/guide/introduction.asciidoc new file mode 100644 index 00000000..1f9b52e4 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/introduction.asciidoc @@ -0,0 +1,75 @@ +[[introduction]] +== Introduction + +Cowboy is a small, fast and modern HTTP server for Erlang/OTP. + +Cowboy aims to provide a complete xref:modern_web[modern Web stack]. +This includes HTTP/1.1, HTTP/2, Websocket, Server-Sent Events and +Webmachine-based REST. + +Cowboy comes with functions for introspection and tracing, enabling +developers to know precisely what is happening at any time. Its modular +design also easily enable developers to add instrumentation. + +Cowboy is a high quality project. It has a small code base, is very +efficient (both in latency and memory use) and can easily be embedded +in another application. + +Cowboy is clean Erlang code. It includes hundreds of tests and its code +is fully compliant with the Dialyzer. It is also well documented and +features a Function Reference, a User Guide and numerous Tutorials. + +=== Prerequisites + +Beginner Erlang knowledge is recommended for reading this guide. + +Knowledge of the HTTP protocol is recommended but not required, as it +will be detailed throughout the guide. + +=== Supported platforms + +Cowboy is tested and supported on Linux, FreeBSD, Windows and OSX. + +Cowboy has been reported to work on other platforms, but we make no +guarantee that the experience will be safe and smooth. You are advised +to perform the necessary testing and security audits prior to deploying +on other platforms. + +Cowboy is developed for Erlang/OTP 19.0 and newer. + +=== License + +Cowboy uses the ISC License. + +---- +Copyright (c) 2011-2017, Loïc Hoguin <[email protected]> + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +---- + +=== Versioning + +Cowboy uses http://semver.org/[Semantic Versioning 2.0.0]. + +=== Conventions + +In the HTTP protocol, the method name is case sensitive. All standard +method names are uppercase. + +Header names are case insensitive. When using HTTP/1.1, Cowboy converts +all the request header names to lowercase. HTTP/2 requires clients to +send them as lowercase. Any other header name is expected to be provided +lowercased, including when querying information about the request or +when sending responses. + +The same applies to any other case insensitive value. diff --git a/docs/en/cowboy/2.6/guide/introduction/index.html b/docs/en/cowboy/2.6/guide/introduction/index.html new file mode 100644 index 00000000..dd4204e4 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/introduction/index.html @@ -0,0 +1,202 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Introduction</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Introduction</span></h1> + +<p>Cowboy is a small, fast and modern HTTP server for Erlang/OTP.</p> +<p>Cowboy aims to provide a complete <a href="../modern_web">modern Web stack</a>. This includes HTTP/1.1, HTTP/2, Websocket, Server-Sent Events and Webmachine-based REST.</p> +<p>Cowboy comes with functions for introspection and tracing, enabling developers to know precisely what is happening at any time. Its modular design also easily enable developers to add instrumentation.</p> +<p>Cowboy is a high quality project. It has a small code base, is very efficient (both in latency and memory use) and can easily be embedded in another application.</p> +<p>Cowboy is clean Erlang code. It includes hundreds of tests and its code is fully compliant with the Dialyzer. It is also well documented and features a Function Reference, a User Guide and numerous Tutorials.</p> +<h2 id="_prerequisites">Prerequisites</h2> +<p>Beginner Erlang knowledge is recommended for reading this guide.</p> +<p>Knowledge of the HTTP protocol is recommended but not required, as it will be detailed throughout the guide.</p> +<h2 id="_supported_platforms">Supported platforms</h2> +<p>Cowboy is tested and supported on Linux, FreeBSD, Windows and OSX.</p> +<p>Cowboy has been reported to work on other platforms, but we make no guarantee that the experience will be safe and smooth. You are advised to perform the necessary testing and security audits prior to deploying on other platforms.</p> +<p>Cowboy is developed for Erlang/OTP 19.0 and newer.</p> +<h2 id="_license">License</h2> +<p>Cowboy uses the ISC License.</p> +<div class="listingblock"><div class="content"><pre>Copyright (c) 2011-2017, Loïc Hoguin <[email protected]> + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> +<h2 id="_versioning">Versioning</h2> +<p>Cowboy uses <a href="http://semver.org/">Semantic Versioning 2.0.0</a>.</p> +<h2 id="_conventions">Conventions</h2> +<p>In the HTTP protocol, the method name is case sensitive. All standard method names are uppercase.</p> +<p>Header names are case insensitive. When using HTTP/1.1, Cowboy converts all the request header names to lowercase. HTTP/2 requires clients to send them as lowercase. Any other header name is expected to be provided lowercased, including when querying information about the request or when sending responses.</p> +<p>The same applies to any other case insensitive value.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/erlang_web/"> + Erlang and the Web + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/getting_started/"> + Getting started + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/listeners.asciidoc b/docs/en/cowboy/2.6/guide/listeners.asciidoc new file mode 100644 index 00000000..10ac4aad --- /dev/null +++ b/docs/en/cowboy/2.6/guide/listeners.asciidoc @@ -0,0 +1,115 @@ +[[listeners]] +== Listeners + +A listener is a set of processes that listens on a port for +new connections. Incoming connections get handled by Cowboy. +Depending on the connection handshake, one or another protocol +may be used. + +This chapter is specific to Cowboy. Please refer to the +https://ninenines.eu/docs/en/ranch/1.3/guide/listeners/[Ranch User Guide] +for more information about listeners. + +Cowboy provides two types of listeners: one listening for +clear TCP connections, and one listening for secure TLS +connections. Both of them support the HTTP/1.1 and HTTP/2 +protocols. + +=== Clear TCP listener + +The clear TCP listener will accept connections on the +given port. A typical HTTP server would listen on port 80. +Port 80 requires special permissions on most platforms +however so a common alternative is port 8080. + +The following snippet starts listening for connections +on port 8080: + +[source,erlang] +---- +start(_Type, _Args) -> + Dispatch = cowboy_router:compile([ + {'_', [{"/", hello_handler, []}]} + ]), + {ok, _} = cowboy:start_clear(my_http_listener, + [{port, 8080}], + #{env => #{dispatch => Dispatch}} + ), + hello_erlang_sup:start_link(). +---- + +The xref:getting_started[Getting Started] chapter uses a +clear TCP listener. + +Clients connecting to Cowboy on the clear listener port are +expected to use either HTTP/1.1 or HTTP/2. + +Cowboy supports both methods of initiating a clear +HTTP/2 connection: through the Upgrade mechanism +(https://tools.ietf.org/html/rfc7540#section-3.2[RFC 7540 3.2]) +or by sending the preface directly +(https://tools.ietf.org/html/rfc7540#section-3.4[RFC 7540 3.4]). + +Compatibility with HTTP/1.0 is provided by Cowboy's HTTP/1.1 +implementation. + +=== Secure TLS listener + +The secure TLS listener will accept connections on the +given port. A typical HTTPS server would listen on port 443. +Port 443 requires special permissions on most platforms +however so a common alternative is port 8443. + +// @todo Make a complete list of restrictions. + +The function provided by Cowboy will ensure that the TLS +options given are following the HTTP/2 RFC with regards +to security. For example some TLS extensions or ciphers +may be disabled. This also applies to HTTP/1.1 connections +on this listener. If this is not desirable, Ranch can be +used directly to setup a custom listener. + +[source,erlang] +---- +start(_Type, _Args) -> + Dispatch = cowboy_router:compile([ + {'_', [{"/", hello_handler, []}]} + ]), + {ok, _} = cowboy:start_tls(my_http_listener, + [ + {port, 8443}, + {certfile, "/path/to/certfile"}, + {keyfile, "/path/to/keyfile"} + ], + #{env => #{dispatch => Dispatch}} + ), + hello_erlang_sup:start_link(). +---- + +Clients connecting to Cowboy on the secure listener are +expected to use the ALPN TLS extension to indicate what +protocols they understand. Cowboy always prefers HTTP/2 +over HTTP/1.1 when both are supported. When neither are +supported by the client, or when the ALPN extension was +missing, Cowboy expects HTTP/1.1 to be used. + +Cowboy also advertises HTTP/2 support through the older +NPN TLS extension for compatibility. Note however that +this support will likely not be enabled by default when +Cowboy 2.0 gets released. + +Compatibility with HTTP/1.0 is provided by Cowboy's HTTP/1.1 +implementation. + +=== Protocol configuration + +The HTTP/1.1 and HTTP/2 protocols share the same semantics; +only their framing differs. The first is a text protocol and +the second a binary protocol. + +Cowboy doesn't separate the configuration for HTTP/1.1 and +HTTP/2. Everything goes into the same map. Many options are +shared. + +// @todo Describe good to know options for both protocols? +// Maybe do that in separate chapters? diff --git a/docs/en/cowboy/2.6/guide/listeners/index.html b/docs/en/cowboy/2.6/guide/listeners/index.html new file mode 100644 index 00000000..8b5b29d0 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/listeners/index.html @@ -0,0 +1,223 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Listeners</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Listeners</span></h1> + +<p>A listener is a set of processes that listens on a port for new connections. Incoming connections get handled by Cowboy. Depending on the connection handshake, one or another protocol may be used.</p> +<p>This chapter is specific to Cowboy. Please refer to the <a href="https://ninenines.eu/docs/en/ranch/1.3/guide/listeners/">Ranch User Guide</a> for more information about listeners.</p> +<p>Cowboy provides two types of listeners: one listening for clear TCP connections, and one listening for secure TLS connections. Both of them support the HTTP/1.1 and HTTP/2 protocols.</p> +<h2 id="_clear_tcp_listener">Clear TCP listener</h2> +<p>The clear TCP listener will accept connections on the given port. A typical HTTP server would listen on port 80. Port 80 requires special permissions on most platforms however so a common alternative is port 8080.</p> +<p>The following snippet starts listening for connections on port 8080:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">start</font></b>(<font color="#009900">_Type</font>, <font color="#009900">_Args</font>) <font color="#990000">-></font> + <font color="#009900">Dispatch</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_router:compile</font></b>([ + {<font color="#FF6600">'_'</font>, [{<font color="#FF0000">"/"</font>, <font color="#FF6600">hello_handler</font>, []}]} + ]), + {<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy:start_clear</font></b>(<font color="#FF6600">my_http_listener</font>, + [{<font color="#FF6600">port</font>, <font color="#993399">8080</font>}], + #{<font color="#0000FF">env</font> <font color="#990000">=></font> #{<font color="#0000FF">dispatch</font> <font color="#990000">=></font> <font color="#009900">Dispatch</font>}} + ), + <b><font color="#000000">hello_erlang_sup:start_link</font></b>()<font color="#990000">.</font></tt></pre> +</div></div> +<p>The <a href="../getting_started">Getting Started</a> chapter uses a clear TCP listener.</p> +<p>Clients connecting to Cowboy on the clear listener port are expected to use either HTTP/1.1 or HTTP/2.</p> +<p>Cowboy supports both methods of initiating a clear HTTP/2 connection: through the Upgrade mechanism (<a href="https://tools.ietf.org/html/rfc7540#section-3.2">RFC 7540 3.2</a>) or by sending the preface directly (<a href="https://tools.ietf.org/html/rfc7540#section-3.4">RFC 7540 3.4</a>).</p> +<p>Compatibility with HTTP/1.0 is provided by Cowboy's HTTP/1.1 implementation.</p> +<h2 id="_secure_tls_listener">Secure TLS listener</h2> +<p>The secure TLS listener will accept connections on the given port. A typical HTTPS server would listen on port 443. Port 443 requires special permissions on most platforms however so a common alternative is port 8443.</p> +<!-- @todo Make a complete list of restrictions.--> +<p>The function provided by Cowboy will ensure that the TLS options given are following the HTTP/2 RFC with regards to security. For example some TLS extensions or ciphers may be disabled. This also applies to HTTP/1.1 connections on this listener. If this is not desirable, Ranch can be used directly to setup a custom listener.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">start</font></b>(<font color="#009900">_Type</font>, <font color="#009900">_Args</font>) <font color="#990000">-></font> + <font color="#009900">Dispatch</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_router:compile</font></b>([ + {<font color="#FF6600">'_'</font>, [{<font color="#FF0000">"/"</font>, <font color="#FF6600">hello_handler</font>, []}]} + ]), + {<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy:start_tls</font></b>(<font color="#FF6600">my_http_listener</font>, + [ + {<font color="#FF6600">port</font>, <font color="#993399">8443</font>}, + {<font color="#FF6600">certfile</font>, <font color="#FF0000">"/path/to/certfile"</font>}, + {<font color="#FF6600">keyfile</font>, <font color="#FF0000">"/path/to/keyfile"</font>} + ], + #{<font color="#0000FF">env</font> <font color="#990000">=></font> #{<font color="#0000FF">dispatch</font> <font color="#990000">=></font> <font color="#009900">Dispatch</font>}} + ), + <b><font color="#000000">hello_erlang_sup:start_link</font></b>()<font color="#990000">.</font></tt></pre> +</div></div> +<p>Clients connecting to Cowboy on the secure listener are expected to use the ALPN TLS extension to indicate what protocols they understand. Cowboy always prefers HTTP/2 over HTTP/1.1 when both are supported. When neither are supported by the client, or when the ALPN extension was missing, Cowboy expects HTTP/1.1 to be used.</p> +<p>Cowboy also advertises HTTP/2 support through the older NPN TLS extension for compatibility. Note however that this support will likely not be enabled by default when Cowboy 2.0 gets released.</p> +<p>Compatibility with HTTP/1.0 is provided by Cowboy's HTTP/1.1 implementation.</p> +<h2 id="_protocol_configuration">Protocol configuration</h2> +<p>The HTTP/1.1 and HTTP/2 protocols share the same semantics; only their framing differs. The first is a text protocol and the second a binary protocol.</p> +<p>Cowboy doesn't separate the configuration for HTTP/1.1 and HTTP/2. Everything goes into the same map. Many options are shared.</p> +<!-- @todo Describe good to know options for both protocols?--> +<!-- Maybe do that in separate chapters?--> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/flow_diagram/"> + Flow diagram + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/routing/"> + Routing + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/loop_handlers.asciidoc b/docs/en/cowboy/2.6/guide/loop_handlers.asciidoc new file mode 100644 index 00000000..e5748548 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/loop_handlers.asciidoc @@ -0,0 +1,125 @@ +[[loop_handlers]] +== Loop handlers + +Loop handlers are a special kind of HTTP handlers used when the +response can not be sent right away. The handler enters instead +a receive loop waiting for the right message before it can send +a response. + +Loop handlers are used for requests where a response might not +be immediately available, but where you would like to keep the +connection open for a while in case the response arrives. The +most known example of such practice is known as long polling. + +Loop handlers can also be used for requests where a response is +partially available and you need to stream the response body +while the connection is open. The most known example of such +practice is server-sent events, but it also applies to any +response that takes a long time to send. + +While the same can be accomplished using plain HTTP handlers, +it is recommended to use loop handlers because they are well-tested +and allow using built-in features like hibernation and timeouts. + +Loop handlers essentially wait for one or more Erlang messages +and feed these messages to the `info/3` callback. It also features +the `init/2` and `terminate/3` callbacks which work the same as +for plain HTTP handlers. + +=== Initialization + +The `init/2` function must return a `cowboy_loop` tuple to enable +loop handler behavior. This tuple may optionally contain +the atom `hibernate` to make the process enter hibernation +until a message is received. + +This snippet enables the loop handler: + +[source,erlang] +---- +init(Req, State) -> + {cowboy_loop, Req, State}. +---- + +This also makes the process hibernate: + +[source,erlang] +---- +init(Req, State) -> + {cowboy_loop, Req, State, hibernate}. +---- + +=== Receive loop + +Once initialized, Cowboy will wait for messages to arrive +in the process' mailbox. When a message arrives, Cowboy +calls the `info/3` function with the message, the Req object +and the handler's state. + +The following snippet sends a reply when it receives a +`reply` message from another process, or waits for another +message otherwise. + +[source,erlang] +---- +info({reply, Body}, Req, State) -> + cowboy_req:reply(200, #{}, Body, Req), + {stop, Req, State}; +info(_Msg, Req, State) -> + {ok, Req, State, hibernate}. +---- + +Do note that the `reply` tuple here may be any message +and is simply an example. + +This callback may perform any necessary operation including +sending all or parts of a reply, and will subsequently +return a tuple indicating if more messages are to be expected. + +The callback may also choose to do nothing at all and just +skip the message received. + +If a reply is sent, then the `stop` tuple should be returned. +This will instruct Cowboy to end the request. + +Otherwise an `ok` tuple should be returned. + +=== Streaming loop + +Another common case well suited for loop handlers is +streaming data received in the form of Erlang messages. +This can be done by initiating a chunked reply in the +`init/2` callback and then using `cowboy_req:chunk/2` +every time a message is received. + +The following snippet does exactly that. As you can see +a chunk is sent every time an `event` message is received, +and the loop is stopped by sending an `eof` message. + +[source,erlang] +---- +init(Req, State) -> + Req2 = cowboy_req:stream_reply(200, Req), + {cowboy_loop, Req2, State}. + +info(eof, Req, State) -> + {stop, Req, State}; +info({event, Data}, Req, State) -> + cowboy_req:stream_body(Data, nofin, Req), + {ok, Req, State}; +info(_Msg, Req, State) -> + {ok, Req, State}. +---- + +=== Cleaning up + +Please refer to the xref:handlers[Handlers chapter] +for general instructions about cleaning up. + +=== Hibernate + +To save memory, you may hibernate the process in between +messages received. This is done by returning the atom +`hibernate` as part of the `loop` tuple callbacks normally +return. Just add the atom at the end and Cowboy will hibernate +accordingly. diff --git a/docs/en/cowboy/2.6/guide/loop_handlers/index.html b/docs/en/cowboy/2.6/guide/loop_handlers/index.html new file mode 100644 index 00000000..bb616f2e --- /dev/null +++ b/docs/en/cowboy/2.6/guide/loop_handlers/index.html @@ -0,0 +1,233 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Loop handlers</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Loop handlers</span></h1> + +<p>Loop handlers are a special kind of HTTP handlers used when the response can not be sent right away. The handler enters instead a receive loop waiting for the right message before it can send a response.</p> +<p>Loop handlers are used for requests where a response might not be immediately available, but where you would like to keep the connection open for a while in case the response arrives. The most known example of such practice is known as long polling.</p> +<p>Loop handlers can also be used for requests where a response is partially available and you need to stream the response body while the connection is open. The most known example of such practice is server-sent events, but it also applies to any response that takes a long time to send.</p> +<p>While the same can be accomplished using plain HTTP handlers, it is recommended to use loop handlers because they are well-tested and allow using built-in features like hibernation and timeouts.</p> +<p>Loop handlers essentially wait for one or more Erlang messages and feed these messages to the <code>info/3</code> callback. It also features the <code>init/2</code> and <code>terminate/3</code> callbacks which work the same as for plain HTTP handlers.</p> +<h2 id="_initialization">Initialization</h2> +<p>The <code>init/2</code> function must return a <code>cowboy_loop</code> tuple to enable loop handler behavior. This tuple may optionally contain the atom <code>hibernate</code> to make the process enter hibernation until a message is received.</p> +<p>This snippet enables the loop handler:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">cowboy_loop</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>This also makes the process hibernate:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">cowboy_loop</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>, <font color="#FF6600">hibernate</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_receive_loop">Receive loop</h2> +<p>Once initialized, Cowboy will wait for messages to arrive in the process' mailbox. When a message arrives, Cowboy calls the <code>info/3</code> function with the message, the Req object and the handler's state.</p> +<p>The following snippet sends a reply when it receives a <code>reply</code> message from another process, or waits for another message otherwise.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">info</font></b>({<font color="#FF6600">reply</font>, <font color="#009900">Body</font>}, <font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, #{}, <font color="#009900">Body</font>, <font color="#009900">Req</font>), + {<font color="#FF6600">stop</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}; +<b><font color="#000000">info</font></b>(<font color="#009900">_Msg</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>, <font color="#FF6600">hibernate</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>Do note that the <code>reply</code> tuple here may be any message and is simply an example.</p> +<p>This callback may perform any necessary operation including sending all or parts of a reply, and will subsequently return a tuple indicating if more messages are to be expected.</p> +<p>The callback may also choose to do nothing at all and just skip the message received.</p> +<p>If a reply is sent, then the <code>stop</code> tuple should be returned. This will instruct Cowboy to end the request.</p> +<p>Otherwise an <code>ok</code> tuple should be returned.</p> +<h2 id="_streaming_loop">Streaming loop</h2> +<p>Another common case well suited for loop handlers is streaming data received in the form of Erlang messages. This can be done by initiating a chunked reply in the <code>init/2</code> callback and then using <code>cowboy_req:chunk/2</code> every time a message is received.</p> +<p>The following snippet does exactly that. As you can see a chunk is sent every time an <code>event</code> message is received, and the loop is stopped by sending an <code>eof</code> message.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + <font color="#009900">Req2</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:stream_reply</font></b>(<font color="#993399">200</font>, <font color="#009900">Req</font>), + {<font color="#FF6600">cowboy_loop</font>, <font color="#009900">Req2</font>, <font color="#009900">State</font>}<font color="#990000">.</font> + +<b><font color="#000000">info</font></b>(<font color="#FF6600">eof</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">stop</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}; +<b><font color="#000000">info</font></b>({<font color="#FF6600">event</font>, <font color="#009900">Data</font>}, <font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + <b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#009900">Data</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>), + {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}; +<b><font color="#000000">info</font></b>(<font color="#009900">_Msg</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_cleaning_up">Cleaning up</h2> +<p>Please refer to the <a href="../handlers">Handlers chapter</a> for general instructions about cleaning up.</p> +<h2 id="_hibernate">Hibernate</h2> +<p>To save memory, you may hibernate the process in between messages received. This is done by returning the atom <code>hibernate</code> as part of the <code>loop</code> tuple callbacks normally return. Just add the atom at the end and Cowboy will hibernate accordingly.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/handlers/"> + Handlers + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/static_files/"> + Static files + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/middlewares.asciidoc b/docs/en/cowboy/2.6/guide/middlewares.asciidoc new file mode 100644 index 00000000..e6be30dd --- /dev/null +++ b/docs/en/cowboy/2.6/guide/middlewares.asciidoc @@ -0,0 +1,69 @@ +[[middlewares]] +== Middlewares + +Cowboy delegates the request processing to middleware components. +By default, two middlewares are defined, for the routing and handling +of the request, as is detailed in most of this guide. + +Middlewares give you complete control over how requests are to be +processed. You can add your own middlewares to the mix or completely +change the chain of middlewares as needed. + +Cowboy will execute all middlewares in the given order, unless one +of them decides to stop processing. + +=== Usage + +Middlewares only need to implement a single callback: `execute/2`. +It is defined in the `cowboy_middleware` behavior. + +This callback has two arguments. The first is the `Req` object. +The second is the environment. + +Middlewares can return one of three different values: + +* `{ok, Req, Env}` to continue the request processing +* `{suspend, Module, Function, Args}` to hibernate +* `{stop, Req}` to stop processing and move on to the next request + +Of note is that when hibernating, processing will resume on the given +MFA, discarding all previous stacktrace. Make sure you keep the `Req` +and `Env` in the arguments of this MFA for later use. + +If an error happens during middleware processing, Cowboy will not try +to send an error back to the socket, the process will just crash. It +is up to the middleware to make sure that a reply is sent if something +goes wrong. + +=== Configuration + +The middleware environment is defined as the `env` protocol option. +In the previous chapters we saw it briefly when we needed to pass +the routing information. It is a list of tuples with the first +element being an atom and the second any Erlang term. + +Two values in the environment are reserved: + +* `listener` contains the name of the listener +* `result` contains the result of the processing + +The `listener` value is always defined. The `result` value can be +set by any middleware. If set to anything other than `ok`, Cowboy +will not process any subsequent requests on this connection. + +The middlewares that come with Cowboy may define or require other +environment values to perform. + +You can update the environment by calling the `cowboy:set_env/3` +convenience function, adding or replacing a value in the environment. + +=== Routing middleware + +The routing middleware requires the `dispatch` value. If routing +succeeds, it will put the handler name and options in the `handler` +and `handler_opts` values of the environment, respectively. + +=== Handler middleware + +The handler middleware requires the `handler` and `handler_opts` +values. It puts the result of the request handling into `result`. diff --git a/docs/en/cowboy/2.6/guide/middlewares/index.html b/docs/en/cowboy/2.6/guide/middlewares/index.html new file mode 100644 index 00000000..1f6588da --- /dev/null +++ b/docs/en/cowboy/2.6/guide/middlewares/index.html @@ -0,0 +1,200 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Middlewares</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Middlewares</span></h1> + +<p>Cowboy delegates the request processing to middleware components. By default, two middlewares are defined, for the routing and handling of the request, as is detailed in most of this guide.</p> +<p>Middlewares give you complete control over how requests are to be processed. You can add your own middlewares to the mix or completely change the chain of middlewares as needed.</p> +<p>Cowboy will execute all middlewares in the given order, unless one of them decides to stop processing.</p> +<h2 id="_usage">Usage</h2> +<p>Middlewares only need to implement a single callback: <code>execute/2</code>. It is defined in the <code>cowboy_middleware</code> behavior.</p> +<p>This callback has two arguments. The first is the <code>Req</code> object. The second is the environment.</p> +<p>Middlewares can return one of three different values:</p> +<ul><li><code>{ok, Req, Env}</code> to continue the request processing +</li> +<li><code>{suspend, Module, Function, Args}</code> to hibernate +</li> +<li><code>{stop, Req}</code> to stop processing and move on to the next request +</li> +</ul> +<p>Of note is that when hibernating, processing will resume on the given MFA, discarding all previous stacktrace. Make sure you keep the <code>Req</code> and <code>Env</code> in the arguments of this MFA for later use.</p> +<p>If an error happens during middleware processing, Cowboy will not try to send an error back to the socket, the process will just crash. It is up to the middleware to make sure that a reply is sent if something goes wrong.</p> +<h2 id="_configuration">Configuration</h2> +<p>The middleware environment is defined as the <code>env</code> protocol option. In the previous chapters we saw it briefly when we needed to pass the routing information. It is a list of tuples with the first element being an atom and the second any Erlang term.</p> +<p>Two values in the environment are reserved:</p> +<ul><li><code>listener</code> contains the name of the listener +</li> +<li><code>result</code> contains the result of the processing +</li> +</ul> +<p>The <code>listener</code> value is always defined. The <code>result</code> value can be set by any middleware. If set to anything other than <code>ok</code>, Cowboy will not process any subsequent requests on this connection.</p> +<p>The middlewares that come with Cowboy may define or require other environment values to perform.</p> +<p>You can update the environment by calling the <code>cowboy:set_env/3</code> convenience function, adding or replacing a value in the environment.</p> +<h2 id="_routing_middleware">Routing middleware</h2> +<p>The routing middleware requires the <code>dispatch</code> value. If routing succeeds, it will put the handler name and options in the <code>handler</code> and <code>handler_opts</code> values of the environment, respectively.</p> +<h2 id="_handler_middleware">Handler middleware</h2> +<p>The handler middleware requires the <code>handler</code> and <code>handler_opts</code> values. It puts the result of the request handling into <code>result</code>.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/streams/"> + Streams + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.5/"> + Migrating from Cowboy 2.5 to 2.6 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/migrating_from_1.0.asciidoc b/docs/en/cowboy/2.6/guide/migrating_from_1.0.asciidoc new file mode 100644 index 00000000..4f4ea5bf --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_1.0.asciidoc @@ -0,0 +1,214 @@ +[appendix] +== Migrating from Cowboy 1.0 to 2.0 + +A lot has changed between Cowboy 1.0 and 2.0. The `cowboy_req` +interface in particular has seen a massive revamp. Hooks are +gone, their functionality can now be achieved via stream +handlers. + +The documentation has seen great work, in particular the +manual. Each module and each function now has its own dedicated +manual page with full details and examples. + +=== Compatibility + +Compatibility with Erlang/OTP R16, 17 and 18 has been dropped. +Erlang/OTP 19.0 or above is required. It is non-trivial to +make Cowboy 2.0 work with older Erlang/OTP versions. + +Cowboy 2.0 is not compatible with Cowlib versions older than +2.0. It should be compatible with Ranch 1.0 or above, however +it has not been tested with Ranch versions older than 1.4. + +Cowboy 2.0 is tested on Arch Linux, Ubuntu, FreeBSD, Windows +and OSX. It is tested with every point release (latest patch +release) and also with HiPE on the most recent release. + +Cowboy 2.0 now comes with Erlang.mk templates. + +=== Features added + +* The HTTP/2 protocol is now supported. + +* Cowboy no longer uses only one process per connection. + It now uses one process per connection plus one process + per request by default. This is necessary for HTTP/2. + There might be a slight drop in performance for HTTP/1.1 + connections due to this change. + +* Cowboy internals have largely been reworked in order to + support HTTP/2. This opened the way to stream handlers, + which are a chain of modules that are called whenever + something happens relating to a request/response. + +* The `cowboy_stream_h` stream handler has been added. + It provides most of Cowboy's default behavior. + +* The `cowboy_compress_h` stream handler has been added. + It compresses responses when possible. It's worth noting + that it compresses in more cases than Cowboy 1.0 ever did. + +* Because of the many changes in the internals of Cowboy, + many options have been added or modified. Of note is that + the Websocket options are now given per handler rather + than for the entire listener. + +* Websocket permessage-deflate compression is now supported + via the `compress` option. + +* Static file handlers will now correctly find files found + in '.ez' archives. + +* Constraints have been generalized and are now used not only + in the router but also in some `cowboy_req` functions. Their + interface has also been modified to allow for reverse + operations and formatting of errors. + +=== Features removed + +* SPDY support has been removed. Use HTTP/2 instead. + +* Hooks have been removed. Use xref:streams[stream handlers] instead. + +* The undocumented `waiting_stream` hack has been removed. + It allowed disabling chunked transfer-encoding for HTTP/1.1. + It has no equivalent in Cowboy 2.0. Open a ticket if necessary. + +* Sub protocols still exist, but their interface has largely changed + and they are no longer documented for the time being. + +=== Changed behaviors + +* The handler behaviors have been renamed and are now `cowboy_handler`, + `cowboy_loop`, `cowboy_rest` and `cowboy_websocket`. + +* Plain HTTP, loop, REST and Websocket handlers have had their + init and terminate callbacks unified. They now all use the + `init/2` and `terminate/3` callbacks. The latter is now optional. + The terminate reason has now been documented for all handlers. + +* The tuple returned to switch to a different handler type has + changed. It now takes the form `{Module, Req, State}` or + `{Module, Req, State, Opts}`, where `Opts` is a map of options + to configure the handler. The timeout and hibernate options + must now be specified using this map, where applicable. + +* All behaviors that used to accept `halt` or `shutdown` tuples + as a return value no longer do so. The return value is now + a `stop` tuple, consistent across Cowboy. + +* Middlewares can no longer return an `error` tuple. They have + to send the response and return a `stop` tuple instead. + +* The `known_content_type` REST handler callback has been removed + as it was found unnecessary. + +* Websocket handlers have both the normal `init/2` and + an optional `websocket_init/1` function. The reason for + that exception is that the `websocket_*` callbacks execute + in a separate process from the `init/2` callback, and it + was therefore not obvious how timers or monitors should + be setup properly. They are effectively initializing the + handler before and after the HTTP/1.1 upgrade. + +* Websocket handlers can now send frames directly from + `websocket_init/1`. The frames will be sent immediately + after the handshake. + +* Websocket handler callbacks no longer receive the Req + argument. The `init/2` callback still receives it and + can be used to extract relevant information. The `terminate/3` + callback, if implemented, may still receive the Req + (see next bullet point). + +* Websocket handlers have a new `req_filter` option that + can be used to customize how much information should be + discarded from the Req object after the handshake. Note + that the Req object is only available in `terminate/3` + past that point. + +* Websocket handlers have their timeout default changed + from infinity to 60 seconds. + +=== New functions + +* The `cowboy_req:scheme/1` function has been added. + +* The `cowboy_req:uri/1,2` function has been added, replacing the + less powerful functions `cowboy_req:url/1` and `cowboy_req:host_url/1`. + +* The functions `cowboy_req:match_qs/2` and `cowboy_req:match_cookies/2` + allow matching query string and cookies against constraints. + +* The function `cowboy_req:set_resp_cookie/3` has been added to + complement `cowboy_req:set_resp_cookie/4`. + +* The functions `cowboy_req:resp_header/2,3` and `cowboy_req:resp_headers/1` + have been added. They can be used to retrieve response headers + that were previously set. + +* The function `cowboy_req:set_resp_headers/2` has been added. It + allows setting many response headers at once. + +* The functions `cowboy_req:push/3,4` can be used to push resources + for protocols that support it (by default only HTTP/2). + +=== Changed functions + +* The `cowboy:start_http/4` function was renamed to `cowboy:start_clear/3`. + +* The `cowboy:start_https/4` function was renamed to `cowboy:start_tls/3`. + +* Most, if not all, functions in the `cowboy_req` module have been modified. + Please consult the changelog of each individual functions. The changes + are mainly about simplifying and clarifying the interface. The Req is no + longer returned when not necessary, maps are used wherever possible, + and some functions have been renamed. + +* The position of the `Opts` argument for `cowboy_req:set_resp_cookie/4` + has changed to improve consistency. It is now the last argument. + +=== Removed functions + +* The functions `cowboy_req:url/1` and `cowboy_req:host_url/1` have been + removed in favor of the new function `cowboy_req:uri/1,2`. + +* The functions `cowboy_req:meta/2,3` and `cowboy_req:set_meta/3` have + been removed. The Req object is now a public map, therefore they became + unnecessary. + +* The functions `cowboy_req:set_resp_body_fun/2,3` have been removed. + For sending files, the function `cowboy_req:set_resp_body/2` can now + take a sendfile tuple. + +* Remove many undocumented functions from `cowboy_req`, including the + functions `cowboy_req:get/2` and `cowboy_req:set/3`. + +=== Other changes + +* The correct percent-decoding algorithm is now used for path elements + during routing. It will no longer decode `+` characters. + +* The router will now properly handle path segments `.` and `..`. + +* Routing behavior has changed for URIs containing latin1 characters. + They are no longer allowed. URIs are expected to be in UTF-8 once + they are percent-decoded. + +* Clients that send multiple headers of the same name + will have the values of those headers concatenated into a + comma-separated list. This is of special importance in the + case of the content-type header, as previously only the + first value was used in the `content_types_accepted/2` step + in REST handlers. + +* Etag comparison in REST handlers has been fixed. Some requests may + now fail when they succeeded in the past. + +* The `If-*-Since` headers are now ignored in REST handlers if + the corresponding `If*-Match` header exist. The former is + largely a backward compatible header and this shouldn't create + any issue. The new behavior follows the current RFCs more closely. + +* The static file handler has been improved to handle more special + characters on systems that accept them. diff --git a/docs/en/cowboy/2.6/guide/migrating_from_1.0/index.html b/docs/en/cowboy/2.6/guide/migrating_from_1.0/index.html new file mode 100644 index 00000000..3c5b39a5 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_1.0/index.html @@ -0,0 +1,282 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Migrating from Cowboy 1.0 to 2.0</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Migrating from Cowboy 1.0 to 2.0</span></h1> + +<p>A lot has changed between Cowboy 1.0 and 2.0. The <code>cowboy_req</code> interface in particular has seen a massive revamp. Hooks are gone, their functionality can now be achieved via stream handlers.</p> +<p>The documentation has seen great work, in particular the manual. Each module and each function now has its own dedicated manual page with full details and examples.</p> +<h2 id="_compatibility">Compatibility</h2> +<p>Compatibility with Erlang/OTP R16, 17 and 18 has been dropped. Erlang/OTP 19.0 or above is required. It is non-trivial to make Cowboy 2.0 work with older Erlang/OTP versions.</p> +<p>Cowboy 2.0 is not compatible with Cowlib versions older than 2.0. It should be compatible with Ranch 1.0 or above, however it has not been tested with Ranch versions older than 1.4.</p> +<p>Cowboy 2.0 is tested on Arch Linux, Ubuntu, FreeBSD, Windows and OSX. It is tested with every point release (latest patch release) and also with HiPE on the most recent release.</p> +<p>Cowboy 2.0 now comes with Erlang.mk templates.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>The HTTP/2 protocol is now supported. +</li> +<li>Cowboy no longer uses only one process per connection. It now uses one process per connection plus one process per request by default. This is necessary for HTTP/2. There might be a slight drop in performance for HTTP/1.1 connections due to this change. +</li> +<li>Cowboy internals have largely been reworked in order to support HTTP/2. This opened the way to stream handlers, which are a chain of modules that are called whenever something happens relating to a request/response. +</li> +<li>The <code>cowboy_stream_h</code> stream handler has been added. It provides most of Cowboy's default behavior. +</li> +<li>The <code>cowboy_compress_h</code> stream handler has been added. It compresses responses when possible. It's worth noting that it compresses in more cases than Cowboy 1.0 ever did. +</li> +<li>Because of the many changes in the internals of Cowboy, many options have been added or modified. Of note is that the Websocket options are now given per handler rather than for the entire listener. +</li> +<li>Websocket permessage-deflate compression is now supported via the <code>compress</code> option. +</li> +<li>Static file handlers will now correctly find files found in <em>.ez</em> archives. +</li> +<li>Constraints have been generalized and are now used not only in the router but also in some <code>cowboy_req</code> functions. Their interface has also been modified to allow for reverse operations and formatting of errors. +</li> +</ul> +<h2 id="_features_removed">Features removed</h2> +<ul><li>SPDY support has been removed. Use HTTP/2 instead. +</li> +<li>Hooks have been removed. Use <a href="../streams">stream handlers</a> instead. +</li> +<li>The undocumented <code>waiting_stream</code> hack has been removed. It allowed disabling chunked transfer-encoding for HTTP/1.1. It has no equivalent in Cowboy 2.0. Open a ticket if necessary. +</li> +<li>Sub protocols still exist, but their interface has largely changed and they are no longer documented for the time being. +</li> +</ul> +<h2 id="_changed_behaviors">Changed behaviors</h2> +<ul><li>The handler behaviors have been renamed and are now <code>cowboy_handler</code>, <code>cowboy_loop</code>, <code>cowboy_rest</code> and <code>cowboy_websocket</code>. +</li> +<li>Plain HTTP, loop, REST and Websocket handlers have had their init and terminate callbacks unified. They now all use the <code>init/2</code> and <code>terminate/3</code> callbacks. The latter is now optional. The terminate reason has now been documented for all handlers. +</li> +<li>The tuple returned to switch to a different handler type has changed. It now takes the form <code>{Module, Req, State}</code> or <code>{Module, Req, State, Opts}</code>, where <code>Opts</code> is a map of options to configure the handler. The timeout and hibernate options must now be specified using this map, where applicable. +</li> +<li>All behaviors that used to accept <code>halt</code> or <code>shutdown</code> tuples as a return value no longer do so. The return value is now a <code>stop</code> tuple, consistent across Cowboy. +</li> +<li>Middlewares can no longer return an <code>error</code> tuple. They have to send the response and return a <code>stop</code> tuple instead. +</li> +<li>The <code>known_content_type</code> REST handler callback has been removed as it was found unnecessary. +</li> +<li>Websocket handlers have both the normal <code>init/2</code> and an optional <code>websocket_init/1</code> function. The reason for that exception is that the <code>websocket_*</code> callbacks execute in a separate process from the <code>init/2</code> callback, and it was therefore not obvious how timers or monitors should be setup properly. They are effectively initializing the handler before and after the HTTP/1.1 upgrade. +</li> +<li>Websocket handlers can now send frames directly from <code>websocket_init/1</code>. The frames will be sent immediately after the handshake. +</li> +<li>Websocket handler callbacks no longer receive the Req argument. The <code>init/2</code> callback still receives it and can be used to extract relevant information. The <code>terminate/3</code> callback, if implemented, may still receive the Req (see next bullet point). +</li> +<li>Websocket handlers have a new <code>req_filter</code> option that can be used to customize how much information should be discarded from the Req object after the handshake. Note that the Req object is only available in <code>terminate/3</code> past that point. +</li> +<li>Websocket handlers have their timeout default changed from infinity to 60 seconds. +</li> +</ul> +<h2 id="_new_functions">New functions</h2> +<ul><li>The <code>cowboy_req:scheme/1</code> function has been added. +</li> +<li>The <code>cowboy_req:uri/1,2</code> function has been added, replacing the less powerful functions <code>cowboy_req:url/1</code> and <code>cowboy_req:host_url/1</code>. +</li> +<li>The functions <code>cowboy_req:match_qs/2</code> and <code>cowboy_req:match_cookies/2</code> allow matching query string and cookies against constraints. +</li> +<li>The function <code>cowboy_req:set_resp_cookie/3</code> has been added to complement <code>cowboy_req:set_resp_cookie/4</code>. +</li> +<li>The functions <code>cowboy_req:resp_header/2,3</code> and <code>cowboy_req:resp_headers/1</code> have been added. They can be used to retrieve response headers that were previously set. +</li> +<li>The function <code>cowboy_req:set_resp_headers/2</code> has been added. It allows setting many response headers at once. +</li> +<li>The functions <code>cowboy_req:push/3,4</code> can be used to push resources for protocols that support it (by default only HTTP/2). +</li> +</ul> +<h2 id="_changed_functions">Changed functions</h2> +<ul><li>The <code>cowboy:start_http/4</code> function was renamed to <code>cowboy:start_clear/3</code>. +</li> +<li>The <code>cowboy:start_https/4</code> function was renamed to <code>cowboy:start_tls/3</code>. +</li> +<li>Most, if not all, functions in the <code>cowboy_req</code> module have been modified. Please consult the changelog of each individual functions. The changes are mainly about simplifying and clarifying the interface. The Req is no longer returned when not necessary, maps are used wherever possible, and some functions have been renamed. +</li> +<li>The position of the <code>Opts</code> argument for <code>cowboy_req:set_resp_cookie/4</code> has changed to improve consistency. It is now the last argument. +</li> +</ul> +<h2 id="_removed_functions">Removed functions</h2> +<ul><li>The functions <code>cowboy_req:url/1</code> and <code>cowboy_req:host_url/1</code> have been removed in favor of the new function <code>cowboy_req:uri/1,2</code>. +</li> +<li>The functions <code>cowboy_req:meta/2,3</code> and <code>cowboy_req:set_meta/3</code> have been removed. The Req object is now a public map, therefore they became unnecessary. +</li> +<li>The functions <code>cowboy_req:set_resp_body_fun/2,3</code> have been removed. For sending files, the function <code>cowboy_req:set_resp_body/2</code> can now take a sendfile tuple. +</li> +<li>Remove many undocumented functions from <code>cowboy_req</code>, including the functions <code>cowboy_req:get/2</code> and <code>cowboy_req:set/3</code>. +</li> +</ul> +<h2 id="_other_changes">Other changes</h2> +<ul><li>The correct percent-decoding algorithm is now used for path elements during routing. It will no longer decode <code>+</code> characters. +</li> +<li>The router will now properly handle path segments <code>.</code> and <code>..</code>. +</li> +<li>Routing behavior has changed for URIs containing latin1 characters. They are no longer allowed. URIs are expected to be in UTF-8 once they are percent-decoded. +</li> +<li>Clients that send multiple headers of the same name will have the values of those headers concatenated into a comma-separated list. This is of special importance in the case of the content-type header, as previously only the first value was used in the <code>content_types_accepted/2</code> step in REST handlers. +</li> +<li>Etag comparison in REST handlers has been fixed. Some requests may now fail when they succeeded in the past. +</li> +<li>The <code>If-*-Since</code> headers are now ignored in REST handlers if the corresponding <code>If*-Match</code> header exist. The former is largely a backward compatible header and this shouldn't create any issue. The new behavior follows the current RFCs more closely. +</li> +<li>The static file handler has been improved to handle more special characters on systems that accept them. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.0/"> + Migrating from Cowboy 2.0 to 2.1 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/specs/"> + HTTP and other specifications + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.0.asciidoc b/docs/en/cowboy/2.6/guide/migrating_from_2.0.asciidoc new file mode 100644 index 00000000..c76430c2 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.0.asciidoc @@ -0,0 +1,107 @@ +[appendix] +== Migrating from Cowboy 2.0 to 2.1 + +Cowboy 2.1 focused on adding features that were temporarily +removed in Cowboy 2.0. A number of bugs found in the 2.0 +release were also fixed. + +=== Features added + +* It is now possible to obtain the client TLS certificate + and the local IP/port for the connection from the Req object. + +* Informational responses (1XX responses) can now be sent. + They must be sent before initiating the final response. + +* The `expect: 100-continue` header is now handled + automatically. The 100 response will be sent on the + first `cowboy_req:read_body/2,3,4` call. This only applies + when using the default `cowboy_stream_h` stream handler. + +=== Experimental features added + +Experimental features are previews of features that will be +added in a future release. They are not documented and their +interface may change at any time. You are welcome to try them +and provide feedback. + +* The `cowboy_metrics_h` stream handler can be used to + extract metrics out of Cowboy. It must be used first in + the list of stream handlers, and will record all events + related to requests, responses and spawned processes. + When the stream terminates it will pass this information + to a user-defined callback. + +* The `cowboy_tracer_h` stream handler can be used to setup + automatic tracing of specific requests. You can conditionally + enable tracing based on a function, header, path or any other + element from the request and the trace will apply to the + entire connection and any processes created by it. This is + meant to be used for debugging both in tests and production. + +=== Changed behaviors + +* The `cowboy_rest` handler now implements a mechanism for + switching to a different type of handler from any callback + where `stop` is also allowed. Switch by returning + `{switch_handler, Module}` or `{switch_handler, Module, Opts}`. + This is especially useful for switching to `cowboy_loop` + for streaming the request or response body. + +* REST callbacks that do not allow `stop` as a return value + are now explicitly listed in the documentation. + +=== New functions + +* The function `cowboy_req:sock/1` returns the IP/port + of the local socket. + +* The function `cowboy_req:cert/1` returns the client + TLS certificate or `undefined` if it isn't available. + +* The function `cowboy_req:inform/2,3` sends an + informational response. + +=== Bugs fixed + +* Ensure HTTP/2 connections are not closed prematurely + when the user code does not read the request body. + +* Ensure HTTP/1.1 streams are not terminated too early. + Their behavior is now consistent with the HTTP/2 code + where the stream handler is only terminated when the + `stop` command is returned. + +* Sending zero-sized data from stream handlers or from + `cowboy_req:stream_body/3` could lead to issues with + HTTP/1.1. This has been fixed. + +* The final chunk sent by Cowboy when it terminates a + chunked body after the handler process exits was not + passed through stream handlers, which could lead to + issues when `cowboy_compress_h` was being used. This + is now corrected. + +* The stream handler state was discarded in some cases + where Cowboy had to send a response or response data + automatically when ending a stream. This has now + been corrected. + +* The stream handler callback `terminate/3` will now be + called when switching to another protocol using the + command `switch_protocol`. This doesn't apply when + doing upgrades to HTTP/2 as those occur before the + stream is initialized. + +* Cowlib has been updated to 2.0.1 to fix an issue with + Websocket compression when using Erlang/OTP 20.1. Note + that at the time of writing all 20.1 versions (from + 20.1 to 20.1.4) have issues when compression is enabled. + It is expected to work properly from 20.1.5 onward. In + the meantime it is recommended to run the plain 20.1 + release and disable Websocket compression, or use a + release before 20.1. + +* Cowboy will no longer crash when the `cowboy_clock` + process is not running. This can happen when Cowboy + is being restarted during upgrades, for example. diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.0/index.html b/docs/en/cowboy/2.6/guide/migrating_from_2.0/index.html new file mode 100644 index 00000000..4780b70f --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.0/index.html @@ -0,0 +1,217 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Migrating from Cowboy 2.0 to 2.1</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Migrating from Cowboy 2.0 to 2.1</span></h1> + +<p>Cowboy 2.1 focused on adding features that were temporarily removed in Cowboy 2.0. A number of bugs found in the 2.0 release were also fixed.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>It is now possible to obtain the client TLS certificate and the local IP/port for the connection from the Req object. +</li> +<li>Informational responses (1XX responses) can now be sent. They must be sent before initiating the final response. +</li> +<li>The <code>expect: 100-continue</code> header is now handled automatically. The 100 response will be sent on the first <code>cowboy_req:read_body/2,3,4</code> call. This only applies when using the default <code>cowboy_stream_h</code> stream handler. +</li> +</ul> +<h2 id="_experimental_features_added">Experimental features added</h2> +<p>Experimental features are previews of features that will be added in a future release. They are not documented and their interface may change at any time. You are welcome to try them and provide feedback.</p> +<ul><li>The <code>cowboy_metrics_h</code> stream handler can be used to extract metrics out of Cowboy. It must be used first in the list of stream handlers, and will record all events related to requests, responses and spawned processes. When the stream terminates it will pass this information to a user-defined callback. +</li> +<li>The <code>cowboy_tracer_h</code> stream handler can be used to setup automatic tracing of specific requests. You can conditionally enable tracing based on a function, header, path or any other element from the request and the trace will apply to the entire connection and any processes created by it. This is meant to be used for debugging both in tests and production. +</li> +</ul> +<h2 id="_changed_behaviors">Changed behaviors</h2> +<ul><li>The <code>cowboy_rest</code> handler now implements a mechanism for switching to a different type of handler from any callback where <code>stop</code> is also allowed. Switch by returning <code>{switch_handler, Module}</code> or <code>{switch_handler, Module, Opts}</code>. This is especially useful for switching to <code>cowboy_loop</code> for streaming the request or response body. +</li> +<li>REST callbacks that do not allow <code>stop</code> as a return value are now explicitly listed in the documentation. +</li> +</ul> +<h2 id="_new_functions">New functions</h2> +<ul><li>The function <code>cowboy_req:sock/1</code> returns the IP/port of the local socket. +</li> +<li>The function <code>cowboy_req:cert/1</code> returns the client TLS certificate or <code>undefined</code> if it isn't available. +</li> +<li>The function <code>cowboy_req:inform/2,3</code> sends an informational response. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>Ensure HTTP/2 connections are not closed prematurely when the user code does not read the request body. +</li> +<li>Ensure HTTP/1.1 streams are not terminated too early. Their behavior is now consistent with the HTTP/2 code where the stream handler is only terminated when the <code>stop</code> command is returned. +</li> +<li>Sending zero-sized data from stream handlers or from <code>cowboy_req:stream_body/3</code> could lead to issues with HTTP/1.1. This has been fixed. +</li> +<li>The final chunk sent by Cowboy when it terminates a chunked body after the handler process exits was not passed through stream handlers, which could lead to issues when <code>cowboy_compress_h</code> was being used. This is now corrected. +</li> +<li>The stream handler state was discarded in some cases where Cowboy had to send a response or response data automatically when ending a stream. This has now been corrected. +</li> +<li>The stream handler callback <code>terminate/3</code> will now be called when switching to another protocol using the command <code>switch_protocol</code>. This doesn't apply when doing upgrades to HTTP/2 as those occur before the stream is initialized. +</li> +<li>Cowlib has been updated to 2.0.1 to fix an issue with Websocket compression when using Erlang/OTP 20.1. Note that at the time of writing all 20.1 versions (from 20.1 to 20.1.4) have issues when compression is enabled. It is expected to work properly from 20.1.5 onward. In the meantime it is recommended to run the plain 20.1 release and disable Websocket compression, or use a release before 20.1. +</li> +<li>Cowboy will no longer crash when the <code>cowboy_clock</code> process is not running. This can happen when Cowboy is being restarted during upgrades, for example. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.1/"> + Migrating from Cowboy 2.1 to 2.2 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_1.0/"> + Migrating from Cowboy 1.0 to 2.0 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.1.asciidoc b/docs/en/cowboy/2.6/guide/migrating_from_2.1.asciidoc new file mode 100644 index 00000000..3c0681ff --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.1.asciidoc @@ -0,0 +1,107 @@ +[appendix] +== Migrating from Cowboy 2.1 to 2.2 + +Cowboy 2.2 focused on adding features required for writing +gRPC servers and on completing test suites for the core +HTTP RFCs, fixing many bugs along the way. + +=== Features added + +* Add support for sending trailers at the end of response bodies. + Trailers are additional header fields that may be sent after the + body to add more information to the response. Their usage is + required in gRPC servers. They are optional and may be discarded + in other scenarios (for example if the request goes through an + HTTP/1.0 proxy, as HTTP/1.0 does not support trailers). + +* The `max_skip_body_length` option was added to `cowboy_http`. + It controls how much of a request body Cowboy is willing to skip + when the handler did not touch it. If the remaining body size is + too large Cowboy instead closes the connection. It defaults to 1MB. + +* The CONNECT and TRACE methods are now rejected as they are + currently not implemented and must be handled differently than + other methods. They will be implemented in a future release. + +=== New functions + +* The function `stream_trailers/2` has been added. It terminates + a stream and adds trailer fields at the end of the response. A + corresponding stream handler command `{trailers, Trailers}` + has also been added. + +=== Bugs fixed + +* Test suites for the core HTTP RFCs RFC7230, RFC7231 and RFC7540 + have been completed. Many of the bugs listed here were fixed as + a result of this work. + +* Many HTTP/2 edge cases when clients are misbehaving have been + corrected. This includes many cases where the request is malformed + (for example when a pseudo-header is present twice). + +* When the HTTP/2 SETTINGS_INITIAL_WINDOW_SIZE value changes, + Cowboy now properly updates the flow control windows. + +* HTTP/2 could mistakenly log stray messages that actually were + expected. This is no longer the case. + +* We no longer send a GOAWAY frame when the HTTP/2 preface is invalid. + +* Some values in the Req object of pushed requests were in the + wrong type. They are now the expected binary instead of iolist. + +* A response body was sometimes sent in response to HEAD requests + when using HTTP/2. The body is now ignored. + +* The `max_headers` option for `cowboy_http` was not always respected + depending on the contents of the buffer. The limit is now strict. + +* When an early error occurred on the HTTP/1.1 request line, the + partial Req given to stream handlers was missing the `ref` and + `peer` information. This has been corrected. + +* Absolute URIs with a userinfo component, or without an authority + component, are now properly rejected for HTTP/1.0 and HTTP/1.1. + +* Whitespace is no longer allowed in header lines before the colon. + +* 408 responses to HTTP/1.1 requests now properly include a + connection: close header indicating that we are going to + close the connection. This header will also be sent for + other early errors resulting in the closing of the connection. + +* When both the transfer-encoding and content-length headers are + sent in an HTTP/1.1 request, the transfer-encoding now takes + precedence over the content-length header and the latter is + removed from the Req object. + +* A 400 response is now returned when the transfer-encoding + header is invalid or contains any transfer-coding other + than chunked. + +* Invalid chunk sizes are now rejected immediately. + +* Chunk extensions are now limited to 129 characters. They are + not used in practice and are still ignored by Cowboy. The limit + is not configurable. + +* The final chunk was mistakenly sent in responses to HEAD + requests. This is now corrected. + +* `OPTIONS *` requests were broken in Cowboy 2.0. They are now + working again. Both the routing and `cowboy_req:uri/1,2` have + been corrected. + +* 204 responses no longer include a content-length header. + +* A packet could be lost when switching to Websocket or any + other protocol via the `switch_protocol` command. This is + now fixed. + +* A 426 response will now be sent when a handler requires + the client to upgrade to Websocket and the request did not + include the required headers. + +* Both experimental stream handlers `cowboy_metrics_h` and + `cowboy_tracer_h` received a number of fixes and improvements. diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.1/index.html b/docs/en/cowboy/2.6/guide/migrating_from_2.1/index.html new file mode 100644 index 00000000..40e3b801 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.1/index.html @@ -0,0 +1,228 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Migrating from Cowboy 2.1 to 2.2</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Migrating from Cowboy 2.1 to 2.2</span></h1> + +<p>Cowboy 2.2 focused on adding features required for writing gRPC servers and on completing test suites for the core HTTP RFCs, fixing many bugs along the way.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Add support for sending trailers at the end of response bodies. Trailers are additional header fields that may be sent after the body to add more information to the response. Their usage is required in gRPC servers. They are optional and may be discarded in other scenarios (for example if the request goes through an HTTP/1.0 proxy, as HTTP/1.0 does not support trailers). +</li> +<li>The <code>max_skip_body_length</code> option was added to <code>cowboy_http</code>. It controls how much of a request body Cowboy is willing to skip when the handler did not touch it. If the remaining body size is too large Cowboy instead closes the connection. It defaults to 1MB. +</li> +<li>The CONNECT and TRACE methods are now rejected as they are currently not implemented and must be handled differently than other methods. They will be implemented in a future release. +</li> +</ul> +<h2 id="_new_functions">New functions</h2> +<ul><li>The function <code>stream_trailers/2</code> has been added. It terminates a stream and adds trailer fields at the end of the response. A corresponding stream handler command <code>{trailers, Trailers}</code> has also been added. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>Test suites for the core HTTP RFCs RFC7230, RFC7231 and RFC7540 have been completed. Many of the bugs listed here were fixed as a result of this work. +</li> +<li>Many HTTP/2 edge cases when clients are misbehaving have been corrected. This includes many cases where the request is malformed (for example when a pseudo-header is present twice). +</li> +<li>When the HTTP/2 SETTINGS_INITIAL_WINDOW_SIZE value changes, Cowboy now properly updates the flow control windows. +</li> +<li>HTTP/2 could mistakenly log stray messages that actually were expected. This is no longer the case. +</li> +<li>We no longer send a GOAWAY frame when the HTTP/2 preface is invalid. +</li> +<li>Some values in the Req object of pushed requests were in the wrong type. They are now the expected binary instead of iolist. +</li> +<li>A response body was sometimes sent in response to HEAD requests when using HTTP/2. The body is now ignored. +</li> +<li>The <code>max_headers</code> option for <code>cowboy_http</code> was not always respected depending on the contents of the buffer. The limit is now strict. +</li> +<li>When an early error occurred on the HTTP/1.1 request line, the partial Req given to stream handlers was missing the <code>ref</code> and <code>peer</code> information. This has been corrected. +</li> +<li>Absolute URIs with a userinfo component, or without an authority component, are now properly rejected for HTTP/1.0 and HTTP/1.1. +</li> +<li>Whitespace is no longer allowed in header lines before the colon. +</li> +<li>408 responses to HTTP/1.1 requests now properly include a connection: close header indicating that we are going to close the connection. This header will also be sent for other early errors resulting in the closing of the connection. +</li> +<li>When both the transfer-encoding and content-length headers are sent in an HTTP/1.1 request, the transfer-encoding now takes precedence over the content-length header and the latter is removed from the Req object. +</li> +<li>A 400 response is now returned when the transfer-encoding header is invalid or contains any transfer-coding other than chunked. +</li> +<li>Invalid chunk sizes are now rejected immediately. +</li> +<li>Chunk extensions are now limited to 129 characters. They are not used in practice and are still ignored by Cowboy. The limit is not configurable. +</li> +<li>The final chunk was mistakenly sent in responses to HEAD requests. This is now corrected. +</li> +<li><code>OPTIONS *</code> requests were broken in Cowboy 2.0. They are now working again. Both the routing and <code>cowboy_req:uri/1,2</code> have been corrected. +</li> +<li>204 responses no longer include a content-length header. +</li> +<li>A packet could be lost when switching to Websocket or any other protocol via the <code>switch_protocol</code> command. This is now fixed. +</li> +<li>A 426 response will now be sent when a handler requires the client to upgrade to Websocket and the request did not include the required headers. +</li> +<li>Both experimental stream handlers <code>cowboy_metrics_h</code> and <code>cowboy_tracer_h</code> received a number of fixes and improvements. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.2/"> + Migrating from Cowboy 2.2 to 2.3 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.0/"> + Migrating from Cowboy 2.0 to 2.1 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.2.asciidoc b/docs/en/cowboy/2.6/guide/migrating_from_2.2.asciidoc new file mode 100644 index 00000000..dacf790e --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.2.asciidoc @@ -0,0 +1,56 @@ +[appendix] +== Migrating from Cowboy 2.2 to 2.3 + +Cowboy 2.3 focused on making the Cowboy processes behave +properly according to OTP principles. This version is a +very good milestone toward that goal and most of everything +should now work. Release upgrades and a few details will +be improved in future versions. + +=== Features added + +* Add support for all functions from the module `sys`. Note + that Cowboy currently does not implement the `sys` debugging + mechanisms as tracing is recommended instead. + +* Add a `max_frame_size` option for Websocket handlers + to close the connection when the client attempts to + send a frame that's too large. It currently defaults + to `infinity` to avoid breaking existing code but will + be changed in a future version. + +* Update Cowlib to 2.2.1. + +* Add support for the 308 status code and a test suite + for RFC7538 where it is defined. + +=== Bugs fixed + +* Ensure timeout options accept the value `infinity` as + documented. + +* Properly reject HTTP/2 requests with an invalid content-length + header instead of simply crashing. + +* When switching from HTTP/1.1 to Websocket or user protocols + all the messages in the mailbox were flushed. Only messages + specific to `cowboy_http` should now be flushed. + +* Parsing of the x-forwarded-for header has been corrected. + It now supports IPv6 addresses both with and without port. + +* Websocket subprotocol tokens are now parsed in a case + insensitive manner, according to the spec. + +* Cookies without values are now allowed. For example `Cookie: foo`. + +* Colons are now allowed within path segments in routes provided + to `cowboy_router:compile/1` as long as they are not the first + character of the path segment. + +* The `cowboy_req:delete_resp_header/2` function will no longer + crash when no response header was set before calling it. + +* A miscount of the output HTTP/2 flow control window has been + fixed. It prevented sending the response body fully to some + clients. The issue only affected response bodies sent as iolists. diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.2/index.html b/docs/en/cowboy/2.6/guide/migrating_from_2.2/index.html new file mode 100644 index 00000000..1825c7a6 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.2/index.html @@ -0,0 +1,200 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Migrating from Cowboy 2.2 to 2.3</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Migrating from Cowboy 2.2 to 2.3</span></h1> + +<p>Cowboy 2.3 focused on making the Cowboy processes behave properly according to OTP principles. This version is a very good milestone toward that goal and most of everything should now work. Release upgrades and a few details will be improved in future versions.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Add support for all functions from the module <code>sys</code>. Note that Cowboy currently does not implement the <code>sys</code> debugging mechanisms as tracing is recommended instead. +</li> +<li>Add a <code>max_frame_size</code> option for Websocket handlers to close the connection when the client attempts to send a frame that's too large. It currently defaults to <code>infinity</code> to avoid breaking existing code but will be changed in a future version. +</li> +<li>Update Cowlib to 2.2.1. +</li> +<li>Add support for the 308 status code and a test suite for RFC7538 where it is defined. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>Ensure timeout options accept the value <code>infinity</code> as documented. +</li> +<li>Properly reject HTTP/2 requests with an invalid content-length header instead of simply crashing. +</li> +<li>When switching from HTTP/1.1 to Websocket or user protocols all the messages in the mailbox were flushed. Only messages specific to <code>cowboy_http</code> should now be flushed. +</li> +<li>Parsing of the x-forwarded-for header has been corrected. It now supports IPv6 addresses both with and without port. +</li> +<li>Websocket subprotocol tokens are now parsed in a case insensitive manner, according to the spec. +</li> +<li>Cookies without values are now allowed. For example <code>Cookie: foo</code>. +</li> +<li>Colons are now allowed within path segments in routes provided to <code>cowboy_router:compile/1</code> as long as they are not the first character of the path segment. +</li> +<li>The <code>cowboy_req:delete_resp_header/2</code> function will no longer crash when no response header was set before calling it. +</li> +<li>A miscount of the output HTTP/2 flow control window has been fixed. It prevented sending the response body fully to some clients. The issue only affected response bodies sent as iolists. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.3/"> + Migrating from Cowboy 2.3 to 2.4 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.1/"> + Migrating from Cowboy 2.1 to 2.2 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.3.asciidoc b/docs/en/cowboy/2.6/guide/migrating_from_2.3.asciidoc new file mode 100644 index 00000000..6a604f97 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.3.asciidoc @@ -0,0 +1,66 @@ +[appendix] +== Migrating from Cowboy 2.3 to 2.4 + +Cowboy 2.4 focused on improving the HTTP/2 implementation. +All existing tests from RFC7540 and the h2spec test suite +now all pass. Numerous options have been added to control +SETTINGS and related behavior. In addition experimental +support for Websocket over HTTP/2 was added. + +=== Features added + +* Add experimental support for Websocket over HTTP/2. + You can use the `enable_connect_protocol` option to + enable. It implements the following draft: + https://tools.ietf.org/html/draft-ietf-httpbis-h2-websockets-01 + +* Add options `max_decode_table_size` and + `max_encode_table_size` to restrict the size of the + HPACK compression dictionary. + +* Add option `max_concurrent_streams` to restrict the + number of HTTP/2 streams that can be opened concurrently. + +* Add options `initial_connection_window_size` and + `initial_stream_window_size` to restrict the size of + the HTTP/2 request body buffers for the whole connection + and per stream, respectively. + +* Add options `max_frame_size_received` and + `max_frame_size_sent` to restrict the size of + HTTP/2 frames. + +* Add option `settings_timeout` to reject clients that + did not send a SETTINGS ack. Note that this currently + may only occur at the beginning of the connection. + +* Update Ranch to 1.5.0 + +* Update Cowlib to 2.3.0 + +=== Bugs fixed + +* Fix the END_STREAM flag for informational responses + when using HTTP/2. + +* Receive and ignore HTTP/2 request trailers if any + for HTTP/2 requests. Request trailer information will + be propagated to the user code in a future release. + +* Reject WINDOW_UPDATE frames that are sent after the + client sent an RST_STREAM. Note that Cowboy will not + keep state information about terminated streams + forever and so the behavior might differ depending + on when the stream was reset. + +* Reject streams that depend on themselves. Note that + Cowboy currently does not implement HTTP/2's priority + mechanisms so this issue was harmless. + +* Reject HTTP/2 requests where the body size is different + than the content-length value. Note that due to how Cowboy + works some requests might go through regardless, for + example when the user code does not read the request body. + +* Fix all existing test failures from RFC7540. This was + mostly incorrect test cases or intermittent failures. diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.3/index.html b/docs/en/cowboy/2.6/guide/migrating_from_2.3/index.html new file mode 100644 index 00000000..e451e31e --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.3/index.html @@ -0,0 +1,202 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Migrating from Cowboy 2.3 to 2.4</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Migrating from Cowboy 2.3 to 2.4</span></h1> + +<p>Cowboy 2.4 focused on improving the HTTP/2 implementation. All existing tests from RFC7540 and the h2spec test suite now all pass. Numerous options have been added to control SETTINGS and related behavior. In addition experimental support for Websocket over HTTP/2 was added.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Add experimental support for Websocket over HTTP/2. You can use the <code>enable_connect_protocol</code> option to enable. It implements the following draft: <a href="https://tools.ietf.org/html/draft-ietf-httpbis-h2-websockets-01">https://tools.ietf.org/html/draft-ietf-httpbis-h2-websockets-01</a> +</li> +<li>Add options <code>max_decode_table_size</code> and <code>max_encode_table_size</code> to restrict the size of the HPACK compression dictionary. +</li> +<li>Add option <code>max_concurrent_streams</code> to restrict the number of HTTP/2 streams that can be opened concurrently. +</li> +<li>Add options <code>initial_connection_window_size</code> and <code>initial_stream_window_size</code> to restrict the size of the HTTP/2 request body buffers for the whole connection and per stream, respectively. +</li> +<li>Add options <code>max_frame_size_received</code> and <code>max_frame_size_sent</code> to restrict the size of HTTP/2 frames. +</li> +<li>Add option <code>settings_timeout</code> to reject clients that did not send a SETTINGS ack. Note that this currently may only occur at the beginning of the connection. +</li> +<li>Update Ranch to 1.5.0 +</li> +<li>Update Cowlib to 2.3.0 +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>Fix the END_STREAM flag for informational responses when using HTTP/2. +</li> +<li>Receive and ignore HTTP/2 request trailers if any for HTTP/2 requests. Request trailer information will be propagated to the user code in a future release. +</li> +<li>Reject WINDOW_UPDATE frames that are sent after the client sent an RST_STREAM. Note that Cowboy will not keep state information about terminated streams forever and so the behavior might differ depending on when the stream was reset. +</li> +<li>Reject streams that depend on themselves. Note that Cowboy currently does not implement HTTP/2's priority mechanisms so this issue was harmless. +</li> +<li>Reject HTTP/2 requests where the body size is different than the content-length value. Note that due to how Cowboy works some requests might go through regardless, for example when the user code does not read the request body. +</li> +<li>Fix all existing test failures from RFC7540. This was mostly incorrect test cases or intermittent failures. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.4/"> + Migrating from Cowboy 2.4 to 2.5 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.2/"> + Migrating from Cowboy 2.2 to 2.3 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.4.asciidoc b/docs/en/cowboy/2.6/guide/migrating_from_2.4.asciidoc new file mode 100644 index 00000000..3cdeaa54 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.4.asciidoc @@ -0,0 +1,109 @@ +[appendix] +== Migrating from Cowboy 2.4 to 2.5 + +Cowboy 2.5 focused on making the test suites pass. A +variety of new features, fixes and improvements have +also been worked on. + +=== Features added + +* Add option `linger_timeout` to control how long + Cowboy will wait before closing the socket when + shutting down the connection. This helps avoid + the TCP reset problem HTTP/1.1 suffers from. The + default is now 1000 ms. + +* It is now possible to stream a response body + without using chunked transfer-encoding when the + protocol is HTTP/1.1. To enable this behavior, + simply pass the content-length header with the + expected size when initiating the streamed response. + +* Update Ranch to 1.6.2 + +* Update Cowlib to 2.6.0 + +=== Experimental features added + +* Websocket handlers now feature a commands-based interface. + The return value from the callbacks can now take the form + `{Commands, State}` where `Commands` can be frames to be + sent or commands yet to be introduced. New commands will + be available only through this new interface. + +* Add the `{active, boolean()}` Websocket handler command. + It allows disabling reading from the socket when `false` + is returned. `true` reenables reading from the socket. + +* Add the protocol option `logger` that allows configuring + which logger module will be used. The logger module must + follow the interface of the new `logger` module in Erlang/OTP 21, + or be set to `error_logger` to keep the old behavior. A + similar transport option exists in Ranch 1.6; both options + are necessary to override Cowboy's default behavior completely. + +* Add the `{log, Level, Format, Args}` stream handler command. + Making it a command rather than a direct call will simplify + silencing particular log messages. + +=== New functions + +* The function `cowboy_req:stream_events/3` streams one or more + text/event-stream events, encoding them automatically. + +* The functions `cowboy_req:read_and_match_urlencoded_body/2,3` + can be used to read, parse and match application/x-www-form-urlencoded + request bodies, in a similar way to `cowboy_req:match_qs/2`. + +=== Bugs fixed + +* Fix Erlang/OTP 21 warnings. + +* Ensure that the port number is always defined in the + Req object. When it is not provided in the request, + the default port number for the protocol being used + will be set. + +* Ensure stream handlers can run after `cowboy_stream_h`. + +* Honor the SETTINGS_ENABLE_PUSH HTTP/2 setting: don't + send PUSH frames to clients that disabled it. + +* Fix HTTP/2 `settings_timeout` option when the value + is set to `infinity`. + +* HTTP/1.1 responses will no longer include a trailer header + when the request had no te header. + +* HTTP/1.1 204 responses no longer send the transfer-encoding + header when `cowboy_req:stream_reply/2,3` is used to send + a response. + +* Improve HTTP/1.1 keepalive handling to avoid processing + requests that follow the final request that will receive + a response. + +* Improve the validation of HTTP/1.1 absolute-form requests. + +* When the `switch_protocol` is used after a response was + sent, Cowboy will no longer attempt to send the 101 informational + response for the protocol upgrade. This caused a crash of the + connection previously. + +* Errors that occur when a callback returned by + `content_types_provided` does not exist have been improved. + +* Prevent annoying error logs when using sendfile in + Erlang/OTP 20 and lower. + +* Add missing frame types to `websocket_handle`. + +* A test suite has been added for RFC8297 to ensure that + 103 informational responses can be sent. + +* Numerous test cases have been fixed, improved or removed in order + to make the test suites pass. Most of the failures were caused + by broken tests. + +* Some misguiding or incorrect statements in the documentation + have been removed or clarified. diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.4/index.html b/docs/en/cowboy/2.6/guide/migrating_from_2.4/index.html new file mode 100644 index 00000000..e1ebec10 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.4/index.html @@ -0,0 +1,230 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Migrating from Cowboy 2.4 to 2.5</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Migrating from Cowboy 2.4 to 2.5</span></h1> + +<p>Cowboy 2.5 focused on making the test suites pass. A variety of new features, fixes and improvements have also been worked on.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Add option <code>linger_timeout</code> to control how long Cowboy will wait before closing the socket when shutting down the connection. This helps avoid the TCP reset problem HTTP/1.1 suffers from. The default is now 1000 ms. +</li> +<li>It is now possible to stream a response body without using chunked transfer-encoding when the protocol is HTTP/1.1. To enable this behavior, simply pass the content-length header with the expected size when initiating the streamed response. +</li> +<li>Update Ranch to 1.6.2 +</li> +<li>Update Cowlib to 2.6.0 +</li> +</ul> +<h2 id="_experimental_features_added">Experimental features added</h2> +<ul><li>Websocket handlers now feature a commands-based interface. The return value from the callbacks can now take the form <code>{Commands, State}</code> where <code>Commands</code> can be frames to be sent or commands yet to be introduced. New commands will be available only through this new interface. +</li> +<li>Add the <code>{active, boolean()}</code> Websocket handler command. It allows disabling reading from the socket when <code>false</code> is returned. <code>true</code> reenables reading from the socket. +</li> +<li>Add the protocol option <code>logger</code> that allows configuring which logger module will be used. The logger module must follow the interface of the new <code>logger</code> module in Erlang/OTP 21, or be set to <code>error_logger</code> to keep the old behavior. A similar transport option exists in Ranch 1.6; both options are necessary to override Cowboy's default behavior completely. +</li> +<li>Add the <code>{log, Level, Format, Args}</code> stream handler command. Making it a command rather than a direct call will simplify silencing particular log messages. +</li> +</ul> +<h2 id="_new_functions">New functions</h2> +<ul><li>The function <code>cowboy_req:stream_events/3</code> streams one or more text/event-stream events, encoding them automatically. +</li> +<li>The functions <code>cowboy_req:read_and_match_urlencoded_body/2,3</code> can be used to read, parse and match application/x-www-form-urlencoded request bodies, in a similar way to <code>cowboy_req:match_qs/2</code>. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>Fix Erlang/OTP 21 warnings. +</li> +<li>Ensure that the port number is always defined in the Req object. When it is not provided in the request, the default port number for the protocol being used will be set. +</li> +<li>Ensure stream handlers can run after <code>cowboy_stream_h</code>. +</li> +<li>Honor the SETTINGS_ENABLE_PUSH HTTP/2 setting: don't send PUSH frames to clients that disabled it. +</li> +<li>Fix HTTP/2 <code>settings_timeout</code> option when the value is set to <code>infinity</code>. +</li> +<li>HTTP/1.1 responses will no longer include a trailer header when the request had no te header. +</li> +<li>HTTP/1.1 204 responses no longer send the transfer-encoding header when <code>cowboy_req:stream_reply/2,3</code> is used to send a response. +</li> +<li>Improve HTTP/1.1 keepalive handling to avoid processing requests that follow the final request that will receive a response. +</li> +<li>Improve the validation of HTTP/1.1 absolute-form requests. +</li> +<li>When the <code>switch_protocol</code> is used after a response was sent, Cowboy will no longer attempt to send the 101 informational response for the protocol upgrade. This caused a crash of the connection previously. +</li> +<li>Errors that occur when a callback returned by <code>content_types_provided</code> does not exist have been improved. +</li> +<li>Prevent annoying error logs when using sendfile in Erlang/OTP 20 and lower. +</li> +<li>Add missing frame types to <code>websocket_handle</code>. +</li> +<li>A test suite has been added for RFC8297 to ensure that 103 informational responses can be sent. +</li> +<li>Numerous test cases have been fixed, improved or removed in order to make the test suites pass. Most of the failures were caused by broken tests. +</li> +<li>Some misguiding or incorrect statements in the documentation have been removed or clarified. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.5/"> + Migrating from Cowboy 2.5 to 2.6 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.3/"> + Migrating from Cowboy 2.3 to 2.4 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.5.asciidoc b/docs/en/cowboy/2.6/guide/migrating_from_2.5.asciidoc new file mode 100644 index 00000000..b91b617f --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.5.asciidoc @@ -0,0 +1,148 @@ +[appendix] +== Migrating from Cowboy 2.5 to 2.6 + +Cowboy 2.6 greatly refactored the HTTP/2 code, a large +part of which was moved to Cowlib and is now used by +both the Cowboy server and the Gun client. + +A large number of tickets were also closed which +resulted in many bugs fixed and many features and +options added, although some of them are still +experimental. + +=== Features added + +* Add support for the PROXY protocol header. + It can be enabled via the `proxy_header` option. + The proxy information can then be found under + the `proxy_info` key in the Req object. + +* Allow using sendfile tuples in `cowboy_req:stream_body/3` + and in the data command in stream handlers. The only + caveat is that when using `cowboy_compress_h` the + sendfile tuples may have to be converted to in-memory + data in order to compress them. This is the case for + gzip compression. + +* The stream handlers `cowboy_stream_h` and + `cowboy_compress_h` are now documented. + +* Add the `chunked` option to allow disabling chunked + transfer-encoding for HTTP/1.1 connections. + +* Add the `http10_keepalive` option to allow disabling + keep-alive for HTTP/1.0 connections. + +* Add the `idle_timeout` option for HTTP/2. + +* Add the `sendfile` option to both HTTP/1.1 and HTTP/2. + It allows disabling the sendfile syscall entirely for + all connections. It is recommended to disable sendfile + when using VirtualBox shared folders. + +* Add the `rate_limited/2` callback to REST handlers. + +* Add the `deflate_opts` option to Websocket handlers that + allows configuring deflate options for the + permessage-deflate extension. + +* Add the `charset` option to `cowboy_static`. + +* Add support for the SameSite cookie attribute. + +* Update Ranch to 1.7.0 + +* Update Cowlib to 2.7.0 + +=== Experimental features added + +* Add support for range requests (RFC7233) in REST handlers. + This adds two new callbacks: `ranges_accepted/2` and + `range_satisfiable/2` along with the user-specified + `ProvideRangeCallback/2`. + +* Add automatic handling of range requests to REST handlers + that return the callback `auto` from `ranges_accepted/2`. + Cowboy will call the configured `ProvideCallback` and + then split the ouput automatically for the ranged response. + +* Enable range requests support in `cowboy_static`. + +* Add the `{deflate, boolean()}` Websocket handler + command to disable permessage-deflate compression + temporarily. + +* Add the `compress_threshold` option which allows + configuring how much data must be present in a + response body to compress it. This only applies + to non-streamed bodies at this time. + +* Add the `compress_buffering` option which allows + controlling whether some buffering may be done + when streaming a response body. Change the default + behavior to not buffer to make sure it works by + default in all scenarios. + +* Add the `{set_options, map()}` command to stream + handlers and Websocket handlers. This can be used + to update options on a per-request basis. Allow + overriding the `idle_timeout` option for both + HTTP/1.1 and Websocket, the `cowboy_compress_h` + options for HTTP/1.1 and HTTP/2 and the `chunked` + option for HTTP/1.1. + +=== Bugs fixed + +* Do not send a content-length automatically with + 304 responses. This status code allows a content-length + that corresponds to what would have been sent for a 200 + response, but is never followed by a body. + +* HTTP/2 streams are now terminated once the body + has been sent fully, instead of immediately once + the stop command is returned (by default when the + request process exits). Metrics will therefore + more accurately represent when a stream ended. + +* Terminate connection processes gracefully when the + parent process exists or when sys:terminate/2,3 + is called. + +* Automatically ignore the boundary parameter of multipart + media types when using REST handlers. This is a special + parameter that may change with all requests and cannot + be predicted. + +* Fix parsing of the accept header when it contains charset + parameters. They are case insensitive and will now be + lowercased, like for accept-charset and content-type. + +* Handle the charset parameter using `charsets_provided` + when it is present in the accept header when using + REST handlers. + +* Don't select charsets when the q-value is 0 in REST + handlers. + +* Handle accept-charset headers that include a wildcard + in REST handlers. + +* Only send a charset header when the content-type + negotiated is of type text in REST handlers. + +* Remove the default charset iso-8859-1 from REST + handlers when no other is provided. This has been + removed from the HTTP specifications for a long time. + +* Many cases where a content-type header was sent + unnecessarily in the REST handlers response have + been fixed. + +* Handle error_response commands in `cowboy_metrics_h`. + +* A number of types and function specifications were + fixed or improved. Dialyzer is now run against both + the code and tests to help uncover issues. + +* An undefined `cowboy_router` behavior has been + documented. diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.5/index.html b/docs/en/cowboy/2.6/guide/migrating_from_2.5/index.html new file mode 100644 index 00000000..b301b745 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.5/index.html @@ -0,0 +1,245 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Migrating from Cowboy 2.5 to 2.6</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Migrating from Cowboy 2.5 to 2.6</span></h1> + +<p>Cowboy 2.6 greatly refactored the HTTP/2 code, a large part of which was moved to Cowlib and is now used by both the Cowboy server and the Gun client.</p> +<p>A large number of tickets were also closed which resulted in many bugs fixed and many features and options added, although some of them are still experimental.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Add support for the PROXY protocol header. It can be enabled via the <code>proxy_header</code> option. The proxy information can then be found under the <code>proxy_info</code> key in the Req object. +</li> +<li>Allow using sendfile tuples in <code>cowboy_req:stream_body/3</code> and in the data command in stream handlers. The only caveat is that when using <code>cowboy_compress_h</code> the sendfile tuples may have to be converted to in-memory data in order to compress them. This is the case for gzip compression. +</li> +<li>The stream handlers <code>cowboy_stream_h</code> and <code>cowboy_compress_h</code> are now documented. +</li> +<li>Add the <code>chunked</code> option to allow disabling chunked transfer-encoding for HTTP/1.1 connections. +</li> +<li>Add the <code>http10_keepalive</code> option to allow disabling keep-alive for HTTP/1.0 connections. +</li> +<li>Add the <code>idle_timeout</code> option for HTTP/2. +</li> +<li>Add the <code>sendfile</code> option to both HTTP/1.1 and HTTP/2. It allows disabling the sendfile syscall entirely for all connections. It is recommended to disable sendfile when using VirtualBox shared folders. +</li> +<li>Add the <code>rate_limited/2</code> callback to REST handlers. +</li> +<li>Add the <code>deflate_opts</code> option to Websocket handlers that allows configuring deflate options for the permessage-deflate extension. +</li> +<li>Add the <code>charset</code> option to <code>cowboy_static</code>. +</li> +<li>Add support for the SameSite cookie attribute. +</li> +<li>Update Ranch to 1.7.0 +</li> +<li>Update Cowlib to 2.7.0 +</li> +</ul> +<h2 id="_experimental_features_added">Experimental features added</h2> +<ul><li>Add support for range requests (RFC7233) in REST handlers. This adds two new callbacks: <code>ranges_accepted/2</code> and <code>range_satisfiable/2</code> along with the user-specified <code>ProvideRangeCallback/2</code>. +</li> +<li>Add automatic handling of range requests to REST handlers that return the callback <code>auto</code> from <code>ranges_accepted/2</code>. Cowboy will call the configured <code>ProvideCallback</code> and then split the ouput automatically for the ranged response. +</li> +<li>Enable range requests support in <code>cowboy_static</code>. +</li> +<li>Add the <code>{deflate, boolean()}</code> Websocket handler command to disable permessage-deflate compression temporarily. +</li> +<li>Add the <code>compress_threshold</code> option which allows configuring how much data must be present in a response body to compress it. This only applies to non-streamed bodies at this time. +</li> +<li>Add the <code>compress_buffering</code> option which allows controlling whether some buffering may be done when streaming a response body. Change the default behavior to not buffer to make sure it works by default in all scenarios. +</li> +<li>Add the <code>{set_options, map()}</code> command to stream handlers and Websocket handlers. This can be used to update options on a per-request basis. Allow overriding the <code>idle_timeout</code> option for both HTTP/1.1 and Websocket, the <code>cowboy_compress_h</code> options for HTTP/1.1 and HTTP/2 and the <code>chunked</code> option for HTTP/1.1. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>Do not send a content-length automatically with 304 responses. This status code allows a content-length that corresponds to what would have been sent for a 200 response, but is never followed by a body. +</li> +<li>HTTP/2 streams are now terminated once the body has been sent fully, instead of immediately once the stop command is returned (by default when the request process exits). Metrics will therefore more accurately represent when a stream ended. +</li> +<li>Terminate connection processes gracefully when the parent process exists or when sys:terminate/2,3 is called. +</li> +<li>Automatically ignore the boundary parameter of multipart media types when using REST handlers. This is a special parameter that may change with all requests and cannot be predicted. +</li> +<li>Fix parsing of the accept header when it contains charset parameters. They are case insensitive and will now be lowercased, like for accept-charset and content-type. +</li> +<li>Handle the charset parameter using <code>charsets_provided</code> when it is present in the accept header when using REST handlers. +</li> +<li>Don't select charsets when the q-value is 0 in REST handlers. +</li> +<li>Handle accept-charset headers that include a wildcard in REST handlers. +</li> +<li>Only send a charset header when the content-type negotiated is of type text in REST handlers. +</li> +<li>Remove the default charset iso-8859-1 from REST handlers when no other is provided. This has been removed from the HTTP specifications for a long time. +</li> +<li>Many cases where a content-type header was sent unnecessarily in the REST handlers response have been fixed. +</li> +<li>Handle error_response commands in <code>cowboy_metrics_h</code>. +</li> +<li>A number of types and function specifications were fixed or improved. Dialyzer is now run against both the code and tests to help uncover issues. +</li> +<li>An undefined <code>cowboy_router</code> behavior has been documented. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/middlewares/"> + Middlewares + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.4/"> + Migrating from Cowboy 2.4 to 2.5 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/modern_web.asciidoc b/docs/en/cowboy/2.6/guide/modern_web.asciidoc new file mode 100644 index 00000000..48525732 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/modern_web.asciidoc @@ -0,0 +1,122 @@ +[[modern_web]] +== The modern Web + +Cowboy is a server for the modern Web. This chapter explains +what it means and details all the standards involved. + +Cowboy supports all the standards listed in this document. + +=== HTTP/2 + +HTTP/2 is the most efficient protocol for consuming Web +services. It enables clients to keep a connection open +for long periods of time; to send requests concurrently; +to reduce the size of requests through HTTP headers +compression; and more. The protocol is binary, greatly +reducing the resources needed to parse it. + +HTTP/2 also enables the server to push messages to the +client. This can be used for various purposes, including +the sending of related resources before the client requests +them, in an effort to reduce latency. This can also be used +to enable bidirectional communication. + +Cowboy provides transparent support for HTTP/2. Clients +that know it can use it; others fall back to HTTP/1.1 +automatically. + +HTTP/2 is compatible with the HTTP/1.1 semantics. + +HTTP/2 is defined by RFC 7540 and RFC 7541. + +=== HTTP/1.1 + +HTTP/1.1 is the previous version of the HTTP protocol. +The protocol itself is text-based and suffers from numerous +issues and limitations. In particular it is not possible +to execute requests concurrently (though pipelining is +sometimes possible), and it's also sometimes difficult +to detect that a client disconnected. + +HTTP/1.1 does provide very good semantics for interacting +with Web services. It defines the standard methods, headers +and status codes used by HTTP/1.1 and HTTP/2 clients and +servers. + +HTTP/1.1 also defines compatibility with an older version +of the protocol, HTTP/1.0, which was never really standardized +across implementations. + +The core of HTTP/1.1 is defined by RFC 7230, RFC 7231, +RFC 7232, RFC 7233, RFC 7234 and RFC 7235. Numerous RFCs +and other specifications exist defining additional HTTP +methods, status codes, headers or semantics. + +=== Websocket + +xref:ws_protocol[Websocket] is a protocol built on top of HTTP/1.1 +that provides a two-ways communication channel between the client and +the server. Communication is asynchronous and can occur concurrently. + +It consists of a Javascript object allowing setting up a +Websocket connection to the server, and a binary based +protocol for sending data to the server or the client. + +Websocket connections can transfer either UTF-8 encoded text +data or binary data. The protocol also includes support for +implementing a ping/pong mechanism, allowing the server and +the client to have more confidence that the connection is still +alive. + +A Websocket connection can be used to transfer any kind of data, +small or big, text or binary. Because of this Websocket is +sometimes used for communication between systems. + +Websocket messages have no semantics on their own. Websocket +is closer to TCP in that aspect, and requires you to design +and implement your own protocol on top of it; or adapt an +existing protocol to Websocket. + +Cowboy provides an interface known as xref:ws_handlers[Websocket handlers] +that gives complete control over a Websocket connection. + +The Websocket protocol is defined by RFC 6455. + +=== Long-lived requests + +Cowboy provides an interface that can be used to support +long-polling or to stream large amounts of data reliably, +including using Server-Sent Events. + +Long-polling is a mechanism in which the client performs +a request which may not be immediately answered by the +server. It allows clients to request resources that may +not currently exist, but are expected to be created soon, +and which will be returned as soon as they are. + +Long-polling is essentially a hack, but it is widely used +to overcome limitations on older clients and servers. + +Server-Sent Events is a small protocol defined as a media +type, `text/event-stream`, along with a new HTTP header, +`Last-Event-ID`. It is defined in the EventSource W3C +specification. + +Cowboy provides an interface known as xref:loop_handlers[loop handlers] +that facilitates the implementation of long-polling or stream +mechanisms. It works regardless of the underlying protocol. + +=== REST + +xref:rest_principles[REST, or REpresentational State Transfer], +is a style of architecture for loosely connected distributed +systems. It can easily be implemented on top of HTTP. + +REST is essentially a set of constraints to be followed. +Many of these constraints are purely architectural and +solved by simply using HTTP. Some constraints must be +explicitly followed by the developer. + +Cowboy provides an interface known as xref:rest_handlers[REST handlers] +that simplifies the implementation of a REST API on top of +the HTTP protocol. diff --git a/docs/en/cowboy/2.6/guide/modern_web/index.html b/docs/en/cowboy/2.6/guide/modern_web/index.html new file mode 100644 index 00000000..2595013e --- /dev/null +++ b/docs/en/cowboy/2.6/guide/modern_web/index.html @@ -0,0 +1,196 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: The modern Web</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>The modern Web</span></h1> + +<p>Cowboy is a server for the modern Web. This chapter explains what it means and details all the standards involved.</p> +<p>Cowboy supports all the standards listed in this document.</p> +<h2 id="_http_2">HTTP/2</h2> +<p>HTTP/2 is the most efficient protocol for consuming Web services. It enables clients to keep a connection open for long periods of time; to send requests concurrently; to reduce the size of requests through HTTP headers compression; and more. The protocol is binary, greatly reducing the resources needed to parse it.</p> +<p>HTTP/2 also enables the server to push messages to the client. This can be used for various purposes, including the sending of related resources before the client requests them, in an effort to reduce latency. This can also be used to enable bidirectional communication.</p> +<p>Cowboy provides transparent support for HTTP/2. Clients that know it can use it; others fall back to HTTP/1.1 automatically.</p> +<p>HTTP/2 is compatible with the HTTP/1.1 semantics.</p> +<p>HTTP/2 is defined by RFC 7540 and RFC 7541.</p> +<h2 id="_http_1_1">HTTP/1.1</h2> +<p>HTTP/1.1 is the previous version of the HTTP protocol. The protocol itself is text-based and suffers from numerous issues and limitations. In particular it is not possible to execute requests concurrently (though pipelining is sometimes possible), and it's also sometimes difficult to detect that a client disconnected.</p> +<p>HTTP/1.1 does provide very good semantics for interacting with Web services. It defines the standard methods, headers and status codes used by HTTP/1.1 and HTTP/2 clients and servers.</p> +<p>HTTP/1.1 also defines compatibility with an older version of the protocol, HTTP/1.0, which was never really standardized across implementations.</p> +<p>The core of HTTP/1.1 is defined by RFC 7230, RFC 7231, RFC 7232, RFC 7233, RFC 7234 and RFC 7235. Numerous RFCs and other specifications exist defining additional HTTP methods, status codes, headers or semantics.</p> +<h2 id="_websocket">Websocket</h2> +<p><a href="../ws_protocol">Websocket</a> is a protocol built on top of HTTP/1.1 that provides a two-ways communication channel between the client and the server. Communication is asynchronous and can occur concurrently.</p> +<p>It consists of a Javascript object allowing setting up a Websocket connection to the server, and a binary based protocol for sending data to the server or the client.</p> +<p>Websocket connections can transfer either UTF-8 encoded text data or binary data. The protocol also includes support for implementing a ping/pong mechanism, allowing the server and the client to have more confidence that the connection is still alive.</p> +<p>A Websocket connection can be used to transfer any kind of data, small or big, text or binary. Because of this Websocket is sometimes used for communication between systems.</p> +<p>Websocket messages have no semantics on their own. Websocket is closer to TCP in that aspect, and requires you to design and implement your own protocol on top of it; or adapt an existing protocol to Websocket.</p> +<p>Cowboy provides an interface known as <a href="../ws_handlers">Websocket handlers</a> that gives complete control over a Websocket connection.</p> +<p>The Websocket protocol is defined by RFC 6455.</p> +<h2 id="_long_lived_requests">Long-lived requests</h2> +<p>Cowboy provides an interface that can be used to support long-polling or to stream large amounts of data reliably, including using Server-Sent Events.</p> +<p>Long-polling is a mechanism in which the client performs a request which may not be immediately answered by the server. It allows clients to request resources that may not currently exist, but are expected to be created soon, and which will be returned as soon as they are.</p> +<p>Long-polling is essentially a hack, but it is widely used to overcome limitations on older clients and servers.</p> +<p>Server-Sent Events is a small protocol defined as a media type, <code>text/event-stream</code>, along with a new HTTP header, <code>Last-Event-ID</code>. It is defined in the EventSource W3C specification.</p> +<p>Cowboy provides an interface known as <a href="../loop_handlers">loop handlers</a> that facilitates the implementation of long-polling or stream mechanisms. It works regardless of the underlying protocol.</p> +<h2 id="_rest">REST</h2> +<p><a href="../rest_principles">REST, or REpresentational State Transfer</a>, is a style of architecture for loosely connected distributed systems. It can easily be implemented on top of HTTP.</p> +<p>REST is essentially a set of constraints to be followed. Many of these constraints are purely architectural and solved by simply using HTTP. Some constraints must be explicitly followed by the developer.</p> +<p>Cowboy provides an interface known as <a href="../rest_handlers">REST handlers</a> that simplifies the implementation of a REST API on top of the HTTP protocol.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/erlang_web/"> + Erlang and the Web + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/multipart.asciidoc b/docs/en/cowboy/2.6/guide/multipart.asciidoc new file mode 100644 index 00000000..0825244c --- /dev/null +++ b/docs/en/cowboy/2.6/guide/multipart.asciidoc @@ -0,0 +1,169 @@ +[[multipart]] +== Multipart requests + +Multipart originates from MIME, an Internet standard that +extends the format of emails. + +A multipart message is a list of parts. A part contains +headers and a body. The body of the parts may be +of any media type, and contain text or binary data. +It is possible for parts to contain a multipart media +type. + +In the context of HTTP, multipart is most often used +with the `multipart/form-data` media type. It is what +browsers use to upload files through HTML forms. + +The `multipart/byteranges` is also common. It is the +media type used to send arbitrary bytes from a resource, +enabling clients to resume downloads. + +=== Form-data + +In the normal case, when a form is submitted, the +browser will use the `application/x-www-form-urlencoded` +content-type. This type is just a list of keys and +values and is therefore not fit for uploading files. + +That's where the `multipart/form-data` content-type +comes in. When the form is configured to use this +content-type, the browser will create a multipart +message where each part corresponds to a field on +the form. For files, it also adds some metadata in +the part headers, like the file name. + +A form with a text input, a file input and a select +choice box will result in a multipart message with +three parts, one for each field. + +The browser does its best to determine the media type +of the files it sends this way, but you should not +rely on it for determining the contents of the file. +Proper investigation of the contents is recommended. + +=== Checking for multipart messages + +The content-type header indicates the presence of +a multipart message: + +[source,erlang] +---- +{<<"multipart">>, <<"form-data">>, _} + = cowboy_req:parse_header(<<"content-type">>, Req). +---- + +=== Reading a multipart message + +Cowboy provides two sets of functions for reading +request bodies as multipart messages. + +The `cowboy_req:read_part/1,2` functions return the +next part's headers, if any. + +The `cowboy_req:read_part_body/1,2` functions return +the current part's body. For large bodies you may +need to call the function multiple times. + +To read a multipart message you need to iterate over +all its parts: + +[source,erlang] +---- +multipart(Req0) -> + case cowboy_req:read_part(Req0) of + {ok, _Headers, Req1} -> + {ok, _Body, Req} = cowboy_req:read_part_body(Req1), + multipart(Req); + {done, Req} -> + Req + end. +---- + +When part bodies are too large, Cowboy will return +a `more` tuple, and allow you to loop until the part +body has been fully read. + +The function `cow_multipart:form_data/1` can be used +to quickly obtain information about a part from a +`multipart/form-data` message. The function returns +a `data` or a `file` tuple depending on whether this +is a normal field or a file being uploaded. + +The following snippet will use this function and +use different strategies depending on whether the +part is a file: + +[source,erlang] +---- +multipart(Req0) -> + case cowboy_req:read_part(Req0) of + {ok, Headers, Req1} -> + Req = case cow_multipart:form_data(Headers) of + {data, _FieldName} -> + {ok, _Body, Req2} = cowboy_req:read_part_body(Req1), + Req2; + {file, _FieldName, _Filename, _CType} -> + stream_file(Req1) + end, + multipart(Req); + {done, Req} -> + Req + end. + +stream_file(Req0) -> + case cowboy_req:read_part_body(Req0) of + {ok, _LastBodyChunk, Req} -> + Req; + {more, _BodyChunk, Req} -> + stream_file(Req) + end. +---- + +Both the part header and body reading functions can take +options that will be given to the request body reading +functions. By default, `cowboy_req:read_part/1` reads +up to 64KB for up to 5 seconds. `cowboy_req:read_part_body/1` +has the same defaults as `cowboy_req:read_body/1`. + +To change the defaults for part headers: + +[source,erlang] +cowboy_req:read_part(Req, #{length => 128000}). + +And for part bodies: + +[source,erlang] +cowboy_req:read_part_body(Req, #{length => 1000000, period => 7000}). + +=== Skipping unwanted parts + +Part bodies do not have to be read. Cowboy will automatically +skip it when you request the next part's body. + +The following snippet reads all part headers and skips +all bodies: + +[source,erlang] +---- +multipart(Req0) -> + case cowboy_req:read_part(Req0) of + {ok, _Headers, Req} -> + multipart(Req); + {done, Req} -> + Req + end. +---- + +Similarly, if you start reading the body and it ends up +being too big, you can simply continue with the next part. +Cowboy will automatically skip what remains. + +While Cowboy can skip part bodies automatically, the read +rate is not configurable. Depending on your application +you may want to skip manually, in particular if you observe +poor performance while skipping. + +You do not have to read all parts either. You can stop +reading as soon as you find the data you need. + +// @todo Cover the building of multipart messages. diff --git a/docs/en/cowboy/2.6/guide/multipart/index.html b/docs/en/cowboy/2.6/guide/multipart/index.html new file mode 100644 index 00000000..7767a379 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/multipart/index.html @@ -0,0 +1,269 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Multipart requests</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Multipart requests</span></h1> + +<p>Multipart originates from MIME, an Internet standard that extends the format of emails.</p> +<p>A multipart message is a list of parts. A part contains headers and a body. The body of the parts may be of any media type, and contain text or binary data. It is possible for parts to contain a multipart media type.</p> +<p>In the context of HTTP, multipart is most often used with the <code>multipart/form-data</code> media type. It is what browsers use to upload files through HTML forms.</p> +<p>The <code>multipart/byteranges</code> is also common. It is the media type used to send arbitrary bytes from a resource, enabling clients to resume downloads.</p> +<h2 id="_form_data">Form-data</h2> +<p>In the normal case, when a form is submitted, the browser will use the <code>application/x-www-form-urlencoded</code> content-type. This type is just a list of keys and values and is therefore not fit for uploading files.</p> +<p>That's where the <code>multipart/form-data</code> content-type comes in. When the form is configured to use this content-type, the browser will create a multipart message where each part corresponds to a field on the form. For files, it also adds some metadata in the part headers, like the file name.</p> +<p>A form with a text input, a file input and a select choice box will result in a multipart message with three parts, one for each field.</p> +<p>The browser does its best to determine the media type of the files it sends this way, but you should not rely on it for determining the contents of the file. Proper investigation of the contents is recommended.</p> +<h2 id="_checking_for_multipart_messages">Checking for multipart messages</h2> +<p>The content-type header indicates the presence of a multipart message:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#990000"><<</font><font color="#FF0000">"multipart"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"form-data"</font><font color="#990000">>></font>, <font color="#990000">_</font>} + <font color="#990000">=</font> <b><font color="#000000">cowboy_req:parse_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_reading_a_multipart_message">Reading a multipart message</h2> +<p>Cowboy provides two sets of functions for reading request bodies as multipart messages.</p> +<p>The <code>cowboy_req:read_part/1,2</code> functions return the next part's headers, if any.</p> +<p>The <code>cowboy_req:read_part_body/1,2</code> functions return the current part's body. For large bodies you may need to call the function multiple times.</p> +<p>To read a multipart message you need to iterate over all its parts:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">multipart</font></b>(<font color="#009900">Req0</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">cowboy_req:read_part</font></b>(<font color="#009900">Req0</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">ok</font>, <font color="#009900">_Headers</font>, <font color="#009900">Req1</font>} <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">_Body</font>, <font color="#009900">Req</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:read_part_body</font></b>(<font color="#009900">Req1</font>), + <b><font color="#000000">multipart</font></b>(<font color="#009900">Req</font>); + {<font color="#FF6600">done</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> + <font color="#009900">Req</font> + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>When part bodies are too large, Cowboy will return a <code>more</code> tuple, and allow you to loop until the part body has been fully read.</p> +<p>The function <code>cow_multipart:form_data/1</code> can be used to quickly obtain information about a part from a <code>multipart/form-data</code> message. The function returns a <code>data</code> or a <code>file</code> tuple depending on whether this is a normal field or a file being uploaded.</p> +<p>The following snippet will use this function and use different strategies depending on whether the part is a file:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">multipart</font></b>(<font color="#009900">Req0</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">cowboy_req:read_part</font></b>(<font color="#009900">Req0</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">ok</font>, <font color="#009900">Headers</font>, <font color="#009900">Req1</font>} <font color="#990000">-></font> + <font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#0000FF">case</font></b> <b><font color="#000000">cow_multipart:form_data</font></b>(<font color="#009900">Headers</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">data</font>, <font color="#009900">_FieldName</font>} <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">_Body</font>, <font color="#009900">Req2</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:read_part_body</font></b>(<font color="#009900">Req1</font>), + <font color="#009900">Req2</font>; + {<font color="#FF6600">file</font>, <font color="#009900">_FieldName</font>, <font color="#009900">_Filename</font>, <font color="#009900">_CType</font>} <font color="#990000">-></font> + <b><font color="#000000">stream_file</font></b>(<font color="#009900">Req1</font>) + <b><font color="#0000FF">end</font></b>, + <b><font color="#000000">multipart</font></b>(<font color="#009900">Req</font>); + {<font color="#FF6600">done</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> + <font color="#009900">Req</font> + <b><font color="#0000FF">end</font></b><font color="#990000">.</font> + +<b><font color="#000000">stream_file</font></b>(<font color="#009900">Req0</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">cowboy_req:read_part_body</font></b>(<font color="#009900">Req0</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">ok</font>, <font color="#009900">_LastBodyChunk</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> + <font color="#009900">Req</font>; + {<font color="#FF6600">more</font>, <font color="#009900">_BodyChunk</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> + <b><font color="#000000">stream_file</font></b>(<font color="#009900">Req</font>) + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>Both the part header and body reading functions can take options that will be given to the request body reading functions. By default, <code>cowboy_req:read_part/1</code> reads up to 64KB for up to 5 seconds. <code>cowboy_req:read_part_body/1</code> has the same defaults as <code>cowboy_req:read_body/1</code>.</p> +<p>To change the defaults for part headers:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cowboy_req:read_part</font></b>(<font color="#009900">Req</font>, #{<b><font color="#000080">length</font></b> <font color="#990000">=></font> <font color="#993399">128000</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<p>And for part bodies:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cowboy_req:read_part_body</font></b>(<font color="#009900">Req</font>, #{<b><font color="#000080">length</font></b> <font color="#990000">=></font> <font color="#993399">1000000</font>, <font color="#0000FF">period</font> <font color="#990000">=></font> <font color="#993399">7000</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_skipping_unwanted_parts">Skipping unwanted parts</h2> +<p>Part bodies do not have to be read. Cowboy will automatically skip it when you request the next part's body.</p> +<p>The following snippet reads all part headers and skips all bodies:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">multipart</font></b>(<font color="#009900">Req0</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">cowboy_req:read_part</font></b>(<font color="#009900">Req0</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">ok</font>, <font color="#009900">_Headers</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> + <b><font color="#000000">multipart</font></b>(<font color="#009900">Req</font>); + {<font color="#FF6600">done</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> + <font color="#009900">Req</font> + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>Similarly, if you start reading the body and it ends up being too big, you can simply continue with the next part. Cowboy will automatically skip what remains.</p> +<p>While Cowboy can skip part bodies automatically, the read rate is not configurable. Depending on your application you may want to skip manually, in particular if you observe poor performance while skipping.</p> +<p>You do not have to read all parts either. You can stop reading as soon as you find the data you need.</p> +<!-- @todo Cover the building of multipart messages.--> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/cookies/"> + Using cookies + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/rest_principles/"> + REST principles + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/req.asciidoc b/docs/en/cowboy/2.6/guide/req.asciidoc new file mode 100644 index 00000000..9d04ce05 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/req.asciidoc @@ -0,0 +1,365 @@ +[[req]] +== The Req object + +The Req object is a variable used for obtaining information +about a request, read its body or send a response. + +It is not really an object in the object-oriented sense. +It is a simple map that can be directly accessed or +used when calling functions from the `cowboy_req` module. + +The Req object is the subject of a few different chapters. +In this chapter we will learn about the Req object and +look at how to retrieve information about the request. + +=== Direct access + +The Req map contains a number of fields which are documented +and can be accessed directly. They are the fields that have +a direct mapping to HTTP: the request `method`; the HTTP +`version` used; the effective URI components `scheme`, +`host`, `port`, `path` and `qs`; the request `headers`; +the connection `peer` address and port; and the TLS +certificate `cert` when applicable. + +Note that the `version` field can be used to determine +whether a connection is using HTTP/2. + +To access a field, you can simply match in the function +head. The following example sends a simple "Hello world!" +response when the `method` is GET, and a 405 error +otherwise. + +[source,erlang] +---- +init(Req0=#{method := <<"GET">>}, State) -> + Req = cowboy_req:reply(200, #{ + <<"content-type">> => <<"text/plain">> + }, <<"Hello world!">>, Req0), + {ok, Req, State}; +init(Req0, State) -> + Req = cowboy_req:reply(405, #{ + <<"allow">> => <<"GET">> + }, Req0), + {ok, Req, State}. +---- + +Any other field is internal and should not be accessed. +They may change in future releases, including maintenance +releases, without notice. + +Modifying the Req object, while allowed, is not recommended +unless strictly necessary. If adding new fields, make sure +to namespace the field names so that no conflict can occur +with future Cowboy updates or third party projects. + +=== Introduction to the cowboy_req interface + +// @todo Link to cowboy_req manual + +Functions in the `cowboy_req` module provide access to +the request information but also various operations that +are common when dealing with HTTP requests. + +All the functions that begin with a verb indicate an action. +Other functions simply return the corresponding value +(sometimes that value does need to be built, but the +cost of the operation is equivalent to retrieving a value). + +Some of the `cowboy_req` functions return an updated Req +object. They are the read, reply, set and delete functions. +While ignoring the returned Req will not cause incorrect +behavior for some of them, it is highly recommended to +always keep and use the last returned Req object. The +manual for `cowboy_req` details these functions and what +modifications are done to the Req object. + +Some of the calls to `cowboy_req` have side effects. This +is the case of the read and reply functions. Cowboy reads +the request body or replies immediately when the function +is called. + +All functions will crash if something goes wrong. There +is usually no need to catch these errors, Cowboy will +send the appropriate 4xx or 5xx response depending on +where the crash occurred. + +=== Request method + +The request method can be retrieved directly: + +[source, erlang] +#{method := Method} = Req. + +Or using a function: + +[source,erlang] +Method = cowboy_req:method(Req). + +The method is a case sensitive binary string. Standard +methods include GET, HEAD, OPTIONS, PATCH, POST, PUT +or DELETE. + +=== HTTP version + +The HTTP version is informational. It does not indicate that +the client implements the protocol well or fully. + +There is typically no need to change behavior based on the +HTTP version: Cowboy already does it for you. + +It can be useful in some cases, though. For example, one may +want to redirect HTTP/1.1 clients to use Websocket, while HTTP/2 +clients keep using HTTP/2. + +The HTTP version can be retrieved directly: + +[source,erlang] +#{version := Version} = Req. + +Or using a function: + +[source,erlang] +Version = cowboy_req:version(Req). + +Cowboy defines the `'HTTP/1.0'`, `'HTTP/1.1'` and `'HTTP/2'` +versions. Custom protocols can define their own values as +atoms. + +=== Effective request URI + +The scheme, host, port, path and query string components +of the effective request URI can all be retrieved directly: + +[source,erlang] +---- +#{ + scheme := Scheme, + host := Host, + port := Port, + path := Path, + qs := Qs +} = Req. +---- + +Or using the related functions: + +[source,erlang] +Scheme = cowboy_req:scheme(Req), +Host = cowboy_req:host(Req), +Port = cowboy_req:port(Req), +Path = cowboy_req:path(Req). +Qs = cowboy_req:qs(Req). + +The scheme and host are lowercased case insensitive binary +strings. The port is an integer representing the port number. +The path and query string are case sensitive binary strings. + +Cowboy defines only the `<<"http">>` and `<<"https">>` schemes. +They are chosen so that the scheme will only be `<<"https">>` +for requests on secure HTTP/1.1 or HTTP/2 connections. +// @todo Is that tested well? + +The effective request URI itself can be reconstructed with +the `cowboy_req:uri/1,2` function. By default, an absolute +URI is returned: + +[source,erlang] +%% scheme://host[:port]/path[?qs] +URI = cowboy_req:uri(Req). + +Options are available to either disable or replace some +or all of the components. Various URIs or URI formats can +be generated this way, including the origin form: + +[source,erlang] +%% /path[?qs] +URI = cowboy_req:uri(Req, #{host => undefined}). + +The protocol relative form: + +[source,erlang] +%% //host[:port]/path[?qs] +URI = cowboy_req:uri(Req, #{scheme => undefined}). + +The absolute URI without a query string: + +[source,erlang] +URI = cowboy_req:uri(Req, #{qs => undefined}). + +A different host: + +[source,erlang] +URI = cowboy_req:uri(Req, #{host => <<"example.org">>}). + +And any other combination. + +=== Bindings + +Bindings are the host and path components that you chose +to extract when defining the routes of your application. +They are only available after the routing. + +Cowboy provides functions to retrieve one or all bindings. + +To retrieve a single value: + +[source,erlang] +Value = cowboy_req:binding(userid, Req). + +When attempting to retrieve a value that was not bound, +`undefined` will be returned. A different default value +can be provided: + +[source,erlang] +Value = cowboy_req:binding(userid, Req, 42). + +To retrieve everything that was bound: + +[source,erlang] +Bindings = cowboy_req:bindings(Req). + +They are returned as a map, with keys being atoms. + +The Cowboy router also allows you to capture many host +or path segments at once using the `...` qualifier. + +To retrieve the segments captured from the host name: + +[source,erlang] +HostInfo = cowboy_req:host_info(Req). + +And the path segments: + +[source,erlang] +PathInfo = cowboy_req:path_info(Req). + +Cowboy will return `undefined` if `...` was not used +in the route. + +=== Query parameters + +Cowboy provides two functions to access query parameters. +You can use the first to get the entire list of parameters. + +[source,erlang] +QsVals = cowboy_req:parse_qs(Req), +{_, Lang} = lists:keyfind(<<"lang">>, 1, QsVals). + +Cowboy will only parse the query string, and not do any +transformation. This function may therefore return duplicates, +or parameter names without an associated value. The order of +the list returned is undefined. + +When a query string is `key=1&key=2`, the list returned will +contain two parameters of name `key`. + +The same is true when trying to use the PHP-style suffix `[]`. +When a query string is `key[]=1&key[]=2`, the list returned will +contain two parameters of name `key[]`. + +When a query string is simply `key`, Cowboy will return the +list `[{<<"key">>, true}]`, using `true` to indicate that the +parameter `key` was defined, but with no value. + +The second function Cowboy provides allows you to match out +only the parameters you are interested in, and at the same +time do any post processing you require using xref:constraints[constraints]. +This function returns a map. + +[source,erlang] +#{id := ID, lang := Lang} = cowboy_req:match_qs([id, lang], Req). + +Constraints can be applied automatically. The following +snippet will crash when the `id` parameter is not an integer, +or when the `lang` parameter is empty. At the same time, the +value for `id` will be converted to an integer term: + +[source,erlang] +QsMap = cowboy_req:match_qs([{id, int}, {lang, nonempty}], Req). + +A default value may also be provided. The default will be used +if the `lang` key is not found. It will not be used if +the key is found but has an empty value. + +[source,erlang] +#{lang := Lang} = cowboy_req:match_qs([{lang, [], <<"en-US">>}], Req). + +If no default is provided and the value is missing, the +query string is deemed invalid and the process will crash. + +When the query string is `key=1&key=2`, the value for `key` +will be the list `[1, 2]`. Parameter names do not need to +include the PHP-style suffix. Constraints may be used to +ensure that only one value was passed through. + +=== Headers + +Header values can be retrieved either as a binary string +or parsed into a more meaningful representation. + +The get the raw value: + +[source,erlang] +HeaderVal = cowboy_req:header(<<"content-type">>, Req). + +Cowboy expects all header names to be provided as lowercase +binary strings. This is true for both requests and responses, +regardless of the underlying protocol. + +When the header is missing from the request, `undefined` +will be returned. A different default can be provided: + +[source,erlang] +HeaderVal = cowboy_req:header(<<"content-type">>, Req, <<"text/plain">>). + +All headers can be retrieved at once, either directly: + +[source,erlang] +#{headers := AllHeaders} = Req. + +Or using a function: + +[source,erlang] +AllHeaders = cowboy_req:headers(Req). + +Cowboy provides equivalent functions to parse individual +headers. There is no function to parse all headers at once. + +To parse a specific header: + +[source,erlang] +ParsedVal = cowboy_req:parse_header(<<"content-type">>, Req). + +An exception will be thrown if it doesn't know how to parse the +given header, or if the value is invalid. The list of known headers +and default values can be found in the manual. + +When the header is missing, `undefined` is returned. You can +change the default value. Note that it should be the parsed value +directly: + +[source,erlang] +---- +ParsedVal = cowboy_req:parse_header(<<"content-type">>, Req, + {<<"text">>, <<"plain">>, []}). +---- + +=== Peer + +The peer address and port number for the connection can be +retrieved either directly or using a function. + +To retrieve the peer directly: + +[source,erlang] +#{peer := {IP, Port}} = Req. + +And using a function: + +[source,erlang] +{IP, Port} = cowboy_req:peer(Req). + +Note that the peer corresponds to the remote end of the +connection to the server, which may or may not be the +client itself. It may also be a proxy or a gateway. diff --git a/docs/en/cowboy/2.6/guide/req/index.html b/docs/en/cowboy/2.6/guide/req/index.html new file mode 100644 index 00000000..23ca7386 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/req/index.html @@ -0,0 +1,444 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: The Req object</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>The Req object</span></h1> + +<p>The Req object is a variable used for obtaining information about a request, read its body or send a response.</p> +<p>It is not really an object in the object-oriented sense. It is a simple map that can be directly accessed or used when calling functions from the <code>cowboy_req</code> module.</p> +<p>The Req object is the subject of a few different chapters. In this chapter we will learn about the Req object and look at how to retrieve information about the request.</p> +<h2 id="_direct_access">Direct access</h2> +<p>The Req map contains a number of fields which are documented and can be accessed directly. They are the fields that have a direct mapping to HTTP: the request <code>method</code>; the HTTP <code>version</code> used; the effective URI components <code>scheme</code>, <code>host</code>, <code>port</code>, <code>path</code> and <code>qs</code>; the request <code>headers</code>; the connection <code>peer</code> address and port; and the TLS certificate <code>cert</code> when applicable.</p> +<p>Note that the <code>version</code> field can be used to determine whether a connection is using HTTP/2.</p> +<p>To access a field, you can simply match in the function head. The following example sends a simple "Hello world!" response when the <code>method</code> is GET, and a 405 error otherwise.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req0</font><font color="#990000">=</font>#{<font color="#FF6600">method</font> <font color="#990000">:=</font> <font color="#990000"><<</font><font color="#FF0000">"GET"</font><font color="#990000">>></font>}, <font color="#009900">State</font>) <font color="#990000">-></font> + <font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font> + }, <font color="#990000"><<</font><font color="#FF0000">"Hello world!"</font><font color="#990000">>></font>, <font color="#009900">Req0</font>), + {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}; +<b><font color="#000000">init</font></b>(<font color="#009900">Req0</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + <font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">405</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"allow"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"GET"</font><font color="#990000">>></font> + }, <font color="#009900">Req0</font>), + {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>Any other field is internal and should not be accessed. They may change in future releases, including maintenance releases, without notice.</p> +<p>Modifying the Req object, while allowed, is not recommended unless strictly necessary. If adding new fields, make sure to namespace the field names so that no conflict can occur with future Cowboy updates or third party projects.</p> +<h2 id="_introduction_to_the_cowboy_req_interface">Introduction to the cowboy_req interface</h2> +<!-- @todo Link to cowboy_req manual--> +<p>Functions in the <code>cowboy_req</code> module provide access to the request information but also various operations that are common when dealing with HTTP requests.</p> +<p>All the functions that begin with a verb indicate an action. Other functions simply return the corresponding value (sometimes that value does need to be built, but the cost of the operation is equivalent to retrieving a value).</p> +<p>Some of the <code>cowboy_req</code> functions return an updated Req object. They are the read, reply, set and delete functions. While ignoring the returned Req will not cause incorrect behavior for some of them, it is highly recommended to always keep and use the last returned Req object. The manual for <code>cowboy_req</code> details these functions and what modifications are done to the Req object.</p> +<p>Some of the calls to <code>cowboy_req</code> have side effects. This is the case of the read and reply functions. Cowboy reads the request body or replies immediately when the function is called.</p> +<p>All functions will crash if something goes wrong. There is usually no need to catch these errors, Cowboy will send the appropriate 4xx or 5xx response depending on where the crash occurred.</p> +<h2 id="_request_method">Request method</h2> +<p>The request method can be retrieved directly:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">method</font> <font color="#990000">:=</font> <font color="#009900">Method</font>} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>Or using a function:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Method</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:method</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The method is a case sensitive binary string. Standard methods include GET, HEAD, OPTIONS, PATCH, POST, PUT or DELETE.</p> +<h2 id="_http_version">HTTP version</h2> +<p>The HTTP version is informational. It does not indicate that the client implements the protocol well or fully.</p> +<p>There is typically no need to change behavior based on the HTTP version: Cowboy already does it for you.</p> +<p>It can be useful in some cases, though. For example, one may want to redirect HTTP/1.1 clients to use Websocket, while HTTP/2 clients keep using HTTP/2.</p> +<p>The HTTP version can be retrieved directly:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">version</font> <font color="#990000">:=</font> <font color="#009900">Version</font>} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>Or using a function:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Version</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:version</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Cowboy defines the <code>'HTTP/1.0'</code>, <code>'HTTP/1.1'</code> and <code>'HTTP/2'</code> versions. Custom protocols can define their own values as atoms.</p> +<h2 id="_effective_request_uri">Effective request URI</h2> +<p>The scheme, host, port, path and query string components of the effective request URI can all be retrieved directly:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{ + <font color="#FF6600">scheme</font> <font color="#990000">:=</font> <font color="#009900">Scheme</font>, + <font color="#FF6600">host</font> <font color="#990000">:=</font> <font color="#009900">Host</font>, + <font color="#FF6600">port</font> <font color="#990000">:=</font> <font color="#009900">Port</font>, + <font color="#FF6600">path</font> <font color="#990000">:=</font> <font color="#009900">Path</font>, + <font color="#FF6600">qs</font> <font color="#990000">:=</font> <font color="#009900">Qs</font> +} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>Or using the related functions:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Scheme</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:scheme</font></b>(<font color="#009900">Req</font>), +<font color="#009900">Host</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:host</font></b>(<font color="#009900">Req</font>), +<font color="#009900">Port</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:port</font></b>(<font color="#009900">Req</font>), +<font color="#009900">Path</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:path</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font> +<font color="#009900">Qs</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:qs</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The scheme and host are lowercased case insensitive binary strings. The port is an integer representing the port number. The path and query string are case sensitive binary strings.</p> +<p>Cowboy defines only the <code><<"http">></code> and <code><<"https">></code> schemes. They are chosen so that the scheme will only be <code><<"https">></code> for requests on secure HTTP/1.1 or HTTP/2 connections.</p> +<!-- @todo Is that tested well?--> +<p>The effective request URI itself can be reconstructed with the <code>cowboy_req:uri/1,2</code> function. By default, an absolute URI is returned:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% </font></i><u><font color="#0000FF">scheme://host</font></u><i><font color="#9A1900">[:port]/path[?qs]</font></i> +<font color="#009900">URI</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Options are available to either disable or replace some or all of the components. Various URIs or URI formats can be generated this way, including the origin form:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% /path[?qs]</font></i> +<font color="#009900">URI</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>, #{<font color="#0000FF">host</font> <font color="#990000">=></font> <font color="#000080">undefined</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<p>The protocol relative form:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% //host[:port]/path[?qs]</font></i> +<font color="#009900">URI</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>, #{<font color="#0000FF">scheme</font> <font color="#990000">=></font> <font color="#000080">undefined</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<p>The absolute URI without a query string:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">URI</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>, #{<font color="#0000FF">qs</font> <font color="#990000">=></font> <font color="#000080">undefined</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<p>A different host:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">URI</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>, #{<font color="#0000FF">host</font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"example.org"</font><font color="#990000">>></font>})<font color="#990000">.</font></tt></pre> +</div></div> +<p>And any other combination.</p> +<h2 id="_bindings">Bindings</h2> +<p>Bindings are the host and path components that you chose to extract when defining the routes of your application. They are only available after the routing.</p> +<p>Cowboy provides functions to retrieve one or all bindings.</p> +<p>To retrieve a single value:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Value</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:binding</font></b>(<font color="#FF6600">userid</font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>When attempting to retrieve a value that was not bound, <code>undefined</code> will be returned. A different default value can be provided:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Value</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:binding</font></b>(<font color="#FF6600">userid</font>, <font color="#009900">Req</font>, <font color="#993399">42</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>To retrieve everything that was bound:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Bindings</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:bindings</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>They are returned as a map, with keys being atoms.</p> +<p>The Cowboy router also allows you to capture many host or path segments at once using the <code>...</code> qualifier.</p> +<p>To retrieve the segments captured from the host name:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">HostInfo</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:host_info</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>And the path segments:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PathInfo</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:path_info</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Cowboy will return <code>undefined</code> if <code>...</code> was not used in the route.</p> +<h2 id="_query_parameters">Query parameters</h2> +<p>Cowboy provides two functions to access query parameters. You can use the first to get the entire list of parameters.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">QsVals</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:parse_qs</font></b>(<font color="#009900">Req</font>), +{<font color="#990000">_</font>, <font color="#009900">Lang</font>} <font color="#990000">=</font> <b><font color="#000000">lists:keyfind</font></b>(<font color="#990000"><<</font><font color="#FF0000">"lang"</font><font color="#990000">>></font>, <font color="#993399">1</font>, <font color="#009900">QsVals</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Cowboy will only parse the query string, and not do any transformation. This function may therefore return duplicates, or parameter names without an associated value. The order of the list returned is undefined.</p> +<p>When a query string is <code>key=1&key=2</code>, the list returned will contain two parameters of name <code>key</code>.</p> +<p>The same is true when trying to use the PHP-style suffix <code>[]</code>. When a query string is <code>key[]=1&key[]=2</code>, the list returned will contain two parameters of name <code>key[]</code>.</p> +<p>When a query string is simply <code>key</code>, Cowboy will return the list <code>[{<<"key">>, true}]</code>, using <code>true</code> to indicate that the parameter <code>key</code> was defined, but with no value.</p> +<p>The second function Cowboy provides allows you to match out only the parameters you are interested in, and at the same time do any post processing you require using <a href="../constraints">constraints</a>. This function returns a map.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">id</font> <font color="#990000">:=</font> <font color="#009900">ID</font>, <font color="#FF6600">lang</font> <font color="#990000">:=</font> <font color="#009900">Lang</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:match_qs</font></b>([<font color="#FF6600">id</font>, <font color="#FF6600">lang</font>], <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Constraints can be applied automatically. The following snippet will crash when the <code>id</code> parameter is not an integer, or when the <code>lang</code> parameter is empty. At the same time, the value for <code>id</code> will be converted to an integer term:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">QsMap</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:match_qs</font></b>([{<font color="#FF6600">id</font>, <font color="#FF6600">int</font>}, {<font color="#FF6600">lang</font>, <font color="#FF6600">nonempty</font>}], <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>A default value may also be provided. The default will be used if the <code>lang</code> key is not found. It will not be used if the key is found but has an empty value.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">lang</font> <font color="#990000">:=</font> <font color="#009900">Lang</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:match_qs</font></b>([{<font color="#FF6600">lang</font>, [], <font color="#990000"><<</font><font color="#FF0000">"en-US"</font><font color="#990000">>></font>}], <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>If no default is provided and the value is missing, the query string is deemed invalid and the process will crash.</p> +<p>When the query string is <code>key=1&key=2</code>, the value for <code>key</code> will be the list <code>[1, 2]</code>. Parameter names do not need to include the PHP-style suffix. Constraints may be used to ensure that only one value was passed through.</p> +<h2 id="_headers">Headers</h2> +<p>Header values can be retrieved either as a binary string or parsed into a more meaningful representation.</p> +<p>The get the raw value:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">HeaderVal</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Cowboy expects all header names to be provided as lowercase binary strings. This is true for both requests and responses, regardless of the underlying protocol.</p> +<p>When the header is missing from the request, <code>undefined</code> will be returned. A different default can be provided:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">HeaderVal</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#009900">Req</font>, <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>All headers can be retrieved at once, either directly:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">headers</font> <font color="#990000">:=</font> <font color="#009900">AllHeaders</font>} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>Or using a function:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">AllHeaders</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:headers</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Cowboy provides equivalent functions to parse individual headers. There is no function to parse all headers at once.</p> +<p>To parse a specific header:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">ParsedVal</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:parse_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>An exception will be thrown if it doesn't know how to parse the given header, or if the value is invalid. The list of known headers and default values can be found in the manual.</p> +<p>When the header is missing, <code>undefined</code> is returned. You can change the default value. Note that it should be the parsed value directly:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">ParsedVal</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:parse_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#009900">Req</font>, + {<font color="#990000"><<</font><font color="#FF0000">"text"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"plain"</font><font color="#990000">>></font>, []})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_peer">Peer</h2> +<p>The peer address and port number for the connection can be retrieved either directly or using a function.</p> +<p>To retrieve the peer directly:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">peer</font> <font color="#990000">:=</font> {<font color="#009900">IP</font>, <font color="#009900">Port</font>}} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>And using a function:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#009900">IP</font>, <font color="#009900">Port</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:peer</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Note that the peer corresponds to the remote end of the connection to the server, which may or may not be the client itself. It may also be a proxy or a gateway.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/static_files/"> + Static files + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/req_body/"> + Reading the request body + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/req_body.asciidoc b/docs/en/cowboy/2.6/guide/req_body.asciidoc new file mode 100644 index 00000000..4906811e --- /dev/null +++ b/docs/en/cowboy/2.6/guide/req_body.asciidoc @@ -0,0 +1,130 @@ +[[req_body]] +== Reading the request body + +The request body can be read using the Req object. + +Cowboy will not attempt to read the body until requested. +You need to call the body reading functions in order to +retrieve it. + +Cowboy will not cache the body, it is therefore only +possible to read it once. + +You are not required to read it, however. If a body is +present and was not read, Cowboy will either cancel or +skip its download, depending on the protocol. + +Cowboy provides functions for reading the body raw, +and read and parse form urlencoded or xref:multipart[multipart bodies]. +The latter is covered in its own chapter. + +=== Request body presence + +Not all requests come with a body. You can check for +the presence of a request body with this function: + +[source,erlang] +cowboy_req:has_body(Req). + +It returns `true` if there is a body; `false` otherwise. + +In practice, this function is rarely used. When the +method is `POST`, `PUT` or `PATCH`, the request body +is often required by the application, which should +just attempt to read it directly. + +=== Request body length + +You can obtain the length of the body: + +[source,erlang] +Length = cowboy_req:body_length(Req). + +Note that the length may not be known in advance. In +that case `undefined` will be returned. This can happen +with HTTP/1.1's chunked transfer-encoding, or HTTP/2 +when no content-length was provided. + +Cowboy will update the body length in the Req object +once the body has been read completely. A length will +always be returned when attempting to call this function +after reading the body completely. + +=== Reading the body + +You can read the entire body with one function call: + +[source,erlang] +{ok, Data, Req} = cowboy_req:read_body(Req0). + +Cowboy returns an `ok` tuple when the body has been +read fully. + +By default, Cowboy will attempt to read up to 8MB +of data, for up to 15 seconds. The call will return +once Cowboy has read at least 8MB of data, or at +the end of the 15 seconds period. + +These values can be customized. For example, to read +only up to 1MB for up to 5 seconds: + +[source,erlang] +---- +{ok, Data, Req} = cowboy_req:read_body(Req0, + #{length => 1000000, period => 5000}). +---- + +You may also disable the length limit: + +[source,erlang] +{ok, Data, Req} = cowboy_req:read_body(Req0, #{length => infinity}). + +This makes the function wait 15 seconds and return with +whatever arrived during that period. This is not +recommended for public facing applications. + +These two options can effectively be used to control +the rate of transmission of the request body. + +=== Streaming the body + +When the body is too large, the first call will return +a `more` tuple instead of `ok`. You can call the +function again to read more of the body, reading +it one chunk at a time. + +[source,erlang] +---- +read_body_to_console(Req0) -> + case cowboy_req:read_body(Req0) of + {ok, Data, Req} -> + io:format("~s", [Data]), + Req; + {more, Data, Req} -> + io:format("~s", [Data]), + read_body_to_console(Req) + end. +---- + +The `length` and `period` options can also be used. +They need to be passed for every call. + +=== Reading a form urlencoded body + +Cowboy provides a convenient function for reading and +parsing bodies sent as application/x-www-form-urlencoded. + +[source,erlang] +{ok, KeyValues, Req} = cowboy_req:read_urlencoded_body(Req0). + +This function returns a list of key/values, exactly like +the function `cowboy_req:parse_qs/1`. + +The defaults for this function are different. Cowboy will +read for up to 64KB and up to 5 seconds. They can be modified: + +[source,erlang] +---- +{ok, KeyValues, Req} = cowboy_req:read_urlencoded_body(Req0, + #{length => 4096, period => 3000}). +---- diff --git a/docs/en/cowboy/2.6/guide/req_body/index.html b/docs/en/cowboy/2.6/guide/req_body/index.html new file mode 100644 index 00000000..583691ad --- /dev/null +++ b/docs/en/cowboy/2.6/guide/req_body/index.html @@ -0,0 +1,255 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Reading the request body</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Reading the request body</span></h1> + +<p>The request body can be read using the Req object.</p> +<p>Cowboy will not attempt to read the body until requested. You need to call the body reading functions in order to retrieve it.</p> +<p>Cowboy will not cache the body, it is therefore only possible to read it once.</p> +<p>You are not required to read it, however. If a body is present and was not read, Cowboy will either cancel or skip its download, depending on the protocol.</p> +<p>Cowboy provides functions for reading the body raw, and read and parse form urlencoded or <a href="../multipart">multipart bodies</a>. The latter is covered in its own chapter.</p> +<h2 id="_request_body_presence">Request body presence</h2> +<p>Not all requests come with a body. You can check for the presence of a request body with this function:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cowboy_req:has_body</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>It returns <code>true</code> if there is a body; <code>false</code> otherwise.</p> +<p>In practice, this function is rarely used. When the method is <code>POST</code>, <code>PUT</code> or <code>PATCH</code>, the request body is often required by the application, which should just attempt to read it directly.</p> +<h2 id="_request_body_length">Request body length</h2> +<p>You can obtain the length of the body:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Length</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:body_length</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Note that the length may not be known in advance. In that case <code>undefined</code> will be returned. This can happen with HTTP/1.1's chunked transfer-encoding, or HTTP/2 when no content-length was provided.</p> +<p>Cowboy will update the body length in the Req object once the body has been read completely. A length will always be returned when attempting to call this function after reading the body completely.</p> +<h2 id="_reading_the_body">Reading the body</h2> +<p>You can read the entire body with one function call:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">Data</font>, <font color="#009900">Req</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:read_body</font></b>(<font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Cowboy returns an <code>ok</code> tuple when the body has been read fully.</p> +<p>By default, Cowboy will attempt to read up to 8MB of data, for up to 15 seconds. The call will return once Cowboy has read at least 8MB of data, or at the end of the 15 seconds period.</p> +<p>These values can be customized. For example, to read only up to 1MB for up to 5 seconds:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">Data</font>, <font color="#009900">Req</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:read_body</font></b>(<font color="#009900">Req0</font>, + #{<b><font color="#000080">length</font></b> <font color="#990000">=></font> <font color="#993399">1000000</font>, <font color="#0000FF">period</font> <font color="#990000">=></font> <font color="#993399">5000</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<p>You may also disable the length limit:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">Data</font>, <font color="#009900">Req</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:read_body</font></b>(<font color="#009900">Req0</font>, #{<b><font color="#000080">length</font></b> <font color="#990000">=></font> <font color="#FF6600">infinity</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<p>This makes the function wait 15 seconds and return with whatever arrived during that period. This is not recommended for public facing applications.</p> +<p>These two options can effectively be used to control the rate of transmission of the request body.</p> +<h2 id="_streaming_the_body">Streaming the body</h2> +<p>When the body is too large, the first call will return a <code>more</code> tuple instead of <code>ok</code>. You can call the function again to read more of the body, reading it one chunk at a time.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">read_body_to_console</font></b>(<font color="#009900">Req0</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">cowboy_req:read_body</font></b>(<font color="#009900">Req0</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">ok</font>, <font color="#009900">Data</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> + <b><font color="#000000">io:format</font></b>(<font color="#FF0000">"~s"</font>, [<font color="#009900">Data</font>]), + <font color="#009900">Req</font>; + {<font color="#FF6600">more</font>, <font color="#009900">Data</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> + <b><font color="#000000">io:format</font></b>(<font color="#FF0000">"~s"</font>, [<font color="#009900">Data</font>]), + <b><font color="#000000">read_body_to_console</font></b>(<font color="#009900">Req</font>) + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>The <code>length</code> and <code>period</code> options can also be used. They need to be passed for every call.</p> +<h2 id="_reading_a_form_urlencoded_body">Reading a form urlencoded body</h2> +<p>Cowboy provides a convenient function for reading and parsing bodies sent as application/x-www-form-urlencoded.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">KeyValues</font>, <font color="#009900">Req</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:read_urlencoded_body</font></b>(<font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>This function returns a list of key/values, exactly like the function <code>cowboy_req:parse_qs/1</code>.</p> +<p>The defaults for this function are different. Cowboy will read for up to 64KB and up to 5 seconds. They can be modified:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">KeyValues</font>, <font color="#009900">Req</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:read_urlencoded_body</font></b>(<font color="#009900">Req0</font>, + #{<b><font color="#000080">length</font></b> <font color="#990000">=></font> <font color="#993399">4096</font>, <font color="#0000FF">period</font> <font color="#990000">=></font> <font color="#993399">3000</font>})<font color="#990000">.</font></tt></pre> +</div></div> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/req/"> + The Req object + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/resp/"> + Sending a response + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/resource_design.asciidoc b/docs/en/cowboy/2.6/guide/resource_design.asciidoc new file mode 100644 index 00000000..954d87d5 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/resource_design.asciidoc @@ -0,0 +1,226 @@ +[[resource_design]] +== Designing a resource handler + +This chapter aims to provide you with a list of questions +you must answer in order to write a good resource handler. +It is meant to be usable as a step by step guide. + +=== The service + +Can the service become unavailable, and when it does, can +we detect it? For example, database connectivity problems +may be detected early. We may also have planned outages +of all or parts of the system. Implement the +`service_available` callback. + +What HTTP methods does the service implement? Do we need +more than the standard OPTIONS, HEAD, GET, PUT, POST, +PATCH and DELETE? Are we not using one of those at all? +Implement the `known_methods` callback. + +=== Type of resource handler + +Am I writing a handler for a collection of resources, +or for a single resource? + +The semantics for each of these are quite different. +You should not mix collection and single resource in +the same handler. + +=== Collection handler + +Skip this section if you are not doing a collection. + +Is the collection hardcoded or dynamic? For example, +if you use the route `/users` for the collection of +users then the collection is hardcoded; if you use +`/forums/:category` for the collection of threads +then it isn't. When the collection is hardcoded you +can safely assume the resource always exists. + +What methods should I implement? + +OPTIONS is used to get some information about the +collection. It is recommended to allow it even if you +do not implement it, as Cowboy has a default +implementation built-in. + +HEAD and GET are used to retrieve the collection. +If you allow GET, also allow HEAD as there's no extra +work required to make it work. + +POST is used to create a new resource inside the +collection. Creating a resource by using POST on +the collection is useful when resources may be +created before knowing their URI, usually because +parts of it are generated dynamically. A common +case is some kind of auto incremented integer +identifier. + +The next methods are more rarely allowed. + +PUT is used to create a new collection (when +the collection isn't hardcoded), or replace +the entire collection. + +DELETE is used to delete the entire collection. + +PATCH is used to modify the collection using +instructions given in the request body. A PATCH +operation is atomic. The PATCH operation may +be used for such things as reordering; adding, +modifying or deleting parts of the collection. + +=== Single resource handler + +Skip this section if you are doing a collection. + +What methods should I implement? + +OPTIONS is used to get some information about the +resource. It is recommended to allow it even if you +do not implement it, as Cowboy has a default +implementation built-in. + +HEAD and GET are used to retrieve the resource. +If you allow GET, also allow HEAD as there's no extra +work required to make it work. + +POST is used to update the resource. + +PUT is used to create a new resource (when it doesn't +already exist) or replace the resource. + +DELETE is used to delete the resource. + +PATCH is used to modify the resource using +instructions given in the request body. A PATCH +operation is atomic. The PATCH operation may +be used for adding, removing or modifying specific +values in the resource. + +=== The resource + +Following the above discussion, implement the +`allowed_methods` callback. + +Does the resource always exist? If it may not, implement +the `resource_exists` callback. + +Do I need to authenticate the client before they can +access the resource? What authentication mechanisms +should I provide? This may include form-based, token-based +(in the URL or a cookie), HTTP basic, HTTP digest, +SSL certificate or any other form of authentication. +Implement the `is_authorized` callback. + +Do I need fine-grained access control? How do I determine +that they are authorized access? Handle that in your +`is_authorized` callback. + +Can access to a resource be forbidden regardless of access +being authorized? A simple example of that is censorship +of a resource. Implement the `forbidden` callback. + +Can access be rate-limited for authenticated users? Use the +`rate_limited` callback. + +Are there any constraints on the length of the resource URI? +For example, the URI may be used as a key in storage and may +have a limit in length. Implement `uri_too_long`. + +=== Representations + +What media types do I provide? If text based, what charsets +are provided? What languages do I provide? + +Implement the mandatory `content_types_provided`. Prefix +the callbacks with `to_` for clarity. For example, `to_html` +or `to_text`. For resources that don't implement methods +GET or HEAD, you must still accept at least one media type, +but you can leave the callback as `undefined` since it will +never be called. + +Implement the `languages_provided` or `charsets_provided` +callbacks if applicable. + +Is there any other header that may make the representation +of the resource vary? Implement the `variances` callback. + +Depending on your choices for caching content, you may +want to implement one or more of the `generate_etag`, +`last_modified` and `expires` callbacks. + +Do I want the user or user agent to actively choose a +representation available? Send a list of available +representations in the response body and implement +the `multiple_choices` callback. + +=== Redirections + +Do I need to keep track of what resources were deleted? +For example, you may have a mechanism where moving a +resource leaves a redirect link to its new location. +Implement the `previously_existed` callback. + +Was the resource moved, and is the move temporary? If +it is explicitly temporary, for example due to maintenance, +implement the `moved_temporarily` callback. Otherwise, +implement the `moved_permanently` callback. + +=== The request + +Do you need to read the query string? Individual headers? +Implement `malformed_request` and do all the parsing and +validation in this function. Note that the body should not +be read at this point. + +May there be a request body? Will I know its size? +What's the maximum size of the request body I'm willing +to accept? Implement `valid_entity_length`. + +Finally, take a look at the sections corresponding to the +methods you are implementing. + +=== OPTIONS method + +Cowboy by default will send back a list of allowed methods. +Do I need to add more information to the response? Implement +the `options` method. + +=== GET and HEAD methods + +If you implement the methods GET and/or HEAD, you must +implement one `ProvideResource` callback for each +content-type returned by the `content_types_provided` +callback. + +=== PUT, POST and PATCH methods + +If you implement the methods PUT, POST and/or PATCH, +you must implement the `content_types_accepted` callback, +and one `AcceptCallback` callback for each content-type +it returns. Prefix the `AcceptCallback` callback names +with `from_` for clarity. For example, `from_html` or +`from_json`. + +Do we want to allow the POST method to create individual +resources directly through their URI (like PUT)? Implement +the `allow_missing_post` callback. It is recommended to +explicitly use PUT in these cases instead. + +May there be conflicts when using PUT to create or replace +a resource? Do we want to make sure that two updates around +the same time are not cancelling one another? Implement the +`is_conflict` callback. + +=== DELETE methods + +If you implement the method DELETE, you must implement +the `delete_resource` callback. + +When `delete_resource` returns, is the resource completely +removed from the server, including from any caching service? +If not, and/or if the deletion is asynchronous and we have +no way of knowing it has been completed yet, implement the +`delete_completed` callback. diff --git a/docs/en/cowboy/2.6/guide/resource_design/index.html b/docs/en/cowboy/2.6/guide/resource_design/index.html new file mode 100644 index 00000000..32617be4 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/resource_design/index.html @@ -0,0 +1,229 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Designing a resource handler</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Designing a resource handler</span></h1> + +<p>This chapter aims to provide you with a list of questions you must answer in order to write a good resource handler. It is meant to be usable as a step by step guide.</p> +<h2 id="_the_service">The service</h2> +<p>Can the service become unavailable, and when it does, can we detect it? For example, database connectivity problems may be detected early. We may also have planned outages of all or parts of the system. Implement the <code>service_available</code> callback.</p> +<p>What HTTP methods does the service implement? Do we need more than the standard OPTIONS, HEAD, GET, PUT, POST, PATCH and DELETE? Are we not using one of those at all? Implement the <code>known_methods</code> callback.</p> +<h2 id="_type_of_resource_handler">Type of resource handler</h2> +<p>Am I writing a handler for a collection of resources, or for a single resource?</p> +<p>The semantics for each of these are quite different. You should not mix collection and single resource in the same handler.</p> +<h2 id="_collection_handler">Collection handler</h2> +<p>Skip this section if you are not doing a collection.</p> +<p>Is the collection hardcoded or dynamic? For example, if you use the route <code>/users</code> for the collection of users then the collection is hardcoded; if you use <code>/forums/:category</code> for the collection of threads then it isn't. When the collection is hardcoded you can safely assume the resource always exists.</p> +<p>What methods should I implement?</p> +<p>OPTIONS is used to get some information about the collection. It is recommended to allow it even if you do not implement it, as Cowboy has a default implementation built-in.</p> +<p>HEAD and GET are used to retrieve the collection. If you allow GET, also allow HEAD as there's no extra work required to make it work.</p> +<p>POST is used to create a new resource inside the collection. Creating a resource by using POST on the collection is useful when resources may be created before knowing their URI, usually because parts of it are generated dynamically. A common case is some kind of auto incremented integer identifier.</p> +<p>The next methods are more rarely allowed.</p> +<p>PUT is used to create a new collection (when the collection isn't hardcoded), or replace the entire collection.</p> +<p>DELETE is used to delete the entire collection.</p> +<p>PATCH is used to modify the collection using instructions given in the request body. A PATCH operation is atomic. The PATCH operation may be used for such things as reordering; adding, modifying or deleting parts of the collection.</p> +<h2 id="_single_resource_handler">Single resource handler</h2> +<p>Skip this section if you are doing a collection.</p> +<p>What methods should I implement?</p> +<p>OPTIONS is used to get some information about the resource. It is recommended to allow it even if you do not implement it, as Cowboy has a default implementation built-in.</p> +<p>HEAD and GET are used to retrieve the resource. If you allow GET, also allow HEAD as there's no extra work required to make it work.</p> +<p>POST is used to update the resource.</p> +<p>PUT is used to create a new resource (when it doesn't already exist) or replace the resource.</p> +<p>DELETE is used to delete the resource.</p> +<p>PATCH is used to modify the resource using instructions given in the request body. A PATCH operation is atomic. The PATCH operation may be used for adding, removing or modifying specific values in the resource.</p> +<h2 id="_the_resource">The resource</h2> +<p>Following the above discussion, implement the <code>allowed_methods</code> callback.</p> +<p>Does the resource always exist? If it may not, implement the <code>resource_exists</code> callback.</p> +<p>Do I need to authenticate the client before they can access the resource? What authentication mechanisms should I provide? This may include form-based, token-based (in the URL or a cookie), HTTP basic, HTTP digest, SSL certificate or any other form of authentication. Implement the <code>is_authorized</code> callback.</p> +<p>Do I need fine-grained access control? How do I determine that they are authorized access? Handle that in your <code>is_authorized</code> callback.</p> +<p>Can access to a resource be forbidden regardless of access being authorized? A simple example of that is censorship of a resource. Implement the <code>forbidden</code> callback.</p> +<p>Can access be rate-limited for authenticated users? Use the <code>rate_limited</code> callback.</p> +<p>Are there any constraints on the length of the resource URI? For example, the URI may be used as a key in storage and may have a limit in length. Implement <code>uri_too_long</code>.</p> +<h2 id="_representations">Representations</h2> +<p>What media types do I provide? If text based, what charsets are provided? What languages do I provide?</p> +<p>Implement the mandatory <code>content_types_provided</code>. Prefix the callbacks with <code>to_</code> for clarity. For example, <code>to_html</code> or <code>to_text</code>. For resources that don't implement methods GET or HEAD, you must still accept at least one media type, but you can leave the callback as <code>undefined</code> since it will never be called.</p> +<p>Implement the <code>languages_provided</code> or <code>charsets_provided</code> callbacks if applicable.</p> +<p>Is there any other header that may make the representation of the resource vary? Implement the <code>variances</code> callback.</p> +<p>Depending on your choices for caching content, you may want to implement one or more of the <code>generate_etag</code>, <code>last_modified</code> and <code>expires</code> callbacks.</p> +<p>Do I want the user or user agent to actively choose a representation available? Send a list of available representations in the response body and implement the <code>multiple_choices</code> callback.</p> +<h2 id="_redirections">Redirections</h2> +<p>Do I need to keep track of what resources were deleted? For example, you may have a mechanism where moving a resource leaves a redirect link to its new location. Implement the <code>previously_existed</code> callback.</p> +<p>Was the resource moved, and is the move temporary? If it is explicitly temporary, for example due to maintenance, implement the <code>moved_temporarily</code> callback. Otherwise, implement the <code>moved_permanently</code> callback.</p> +<h2 id="_the_request">The request</h2> +<p>Do you need to read the query string? Individual headers? Implement <code>malformed_request</code> and do all the parsing and validation in this function. Note that the body should not be read at this point.</p> +<p>May there be a request body? Will I know its size? What's the maximum size of the request body I'm willing to accept? Implement <code>valid_entity_length</code>.</p> +<p>Finally, take a look at the sections corresponding to the methods you are implementing.</p> +<h2 id="_options_method">OPTIONS method</h2> +<p>Cowboy by default will send back a list of allowed methods. Do I need to add more information to the response? Implement the <code>options</code> method.</p> +<h2 id="_get_and_head_methods">GET and HEAD methods</h2> +<p>If you implement the methods GET and/or HEAD, you must implement one <code>ProvideResource</code> callback for each content-type returned by the <code>content_types_provided</code> callback.</p> +<h2 id="_put__post_and_patch_methods">PUT, POST and PATCH methods</h2> +<p>If you implement the methods PUT, POST and/or PATCH, you must implement the <code>content_types_accepted</code> callback, and one <code>AcceptCallback</code> callback for each content-type it returns. Prefix the <code>AcceptCallback</code> callback names with <code>from_</code> for clarity. For example, <code>from_html</code> or <code>from_json</code>.</p> +<p>Do we want to allow the POST method to create individual resources directly through their URI (like PUT)? Implement the <code>allow_missing_post</code> callback. It is recommended to explicitly use PUT in these cases instead.</p> +<p>May there be conflicts when using PUT to create or replace a resource? Do we want to make sure that two updates around the same time are not cancelling one another? Implement the <code>is_conflict</code> callback.</p> +<h2 id="_delete_methods">DELETE methods</h2> +<p>If you implement the method DELETE, you must implement the <code>delete_resource</code> callback.</p> +<p>When <code>delete_resource</code> returns, is the resource completely removed from the server, including from any caching service? If not, and/or if the deletion is asynchronous and we have no way of knowing it has been completed yet, implement the <code>delete_completed</code> callback.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/rest_flowcharts/"> + REST flowcharts + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/ws_protocol/"> + The Websocket protocol + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/resp.asciidoc b/docs/en/cowboy/2.6/guide/resp.asciidoc new file mode 100644 index 00000000..1664aefc --- /dev/null +++ b/docs/en/cowboy/2.6/guide/resp.asciidoc @@ -0,0 +1,368 @@ +[[resp]] +== Sending a response + +The response must be sent using the Req object. + +Cowboy provides two different ways of sending responses: +either directly or by streaming the body. Response headers +and body may be set in advance. The response is sent as +soon as one of the reply or stream reply function is +called. + +Cowboy also provides a simplified interface for sending +files. It can also send only specific parts of a file. + +While only one response is allowed for every request, +HTTP/2 introduced a mechanism that allows the server +to push additional resources related to the response. +This chapter also describes how this feature works in +Cowboy. + +=== Reply + +Cowboy provides three functions for sending the entire reply, +depending on whether you need to set headers and body. In all +cases, Cowboy will add any headers required by the protocol +(for example the date header will always be sent). + +When you need to set only the status code, +use `cowboy_req:reply/2`: + +[source,erlang] +Req = cowboy_req:reply(200, Req0). + +When you need to set response headers at the same time, +use `cowboy_req:reply/3`: + +[source,erlang] +---- +Req = cowboy_req:reply(303, #{ + <<"location">> => <<"https://ninenines.eu">> +}, Req0). +---- + +Note that the header name must always be a lowercase +binary. + +When you also need to set the response body, +use `cowboy_req:reply/4`: + +[source,erlang] +---- +Req = cowboy_req:reply(200, #{ + <<"content-type">> => <<"text/plain">> +}, "Hello world!", Req0). +---- + +You should always set the content-type header when the +response has a body. There is however no need to set +the content-length header; Cowboy does it automatically. + +The response body and the header values must be either +a binary or an iolist. An iolist is a list containing +binaries, characters, strings or other iolists. This +allows you to build a response from different parts +without having to do any concatenation: + +[source,erlang] +---- +Title = "Hello world!", +Body = <<"Hats off!">>, +Req = cowboy_req:reply(200, #{ + <<"content-type">> => <<"text/html">> +}, ["<html><head><title>", Title, "</title></head>", + "<body><p>", Body, "</p></body></html>"], Req0). +---- + +This method of building responses is more efficient than +concatenating. Behind the scenes, each element of the list +is simply a pointer, and those pointers are used directly +when writing to the socket. + +=== Stream reply + +Cowboy provides two functions for initiating a response, +and an additional function for streaming the response body. +Cowboy will add any required headers to the response. + +// @todo For HTTP/1.1 Cowboy should probably not use chunked transfer-encoding if the content-length is set. + +When you need to set only the status code, +use `cowboy_req:stream_reply/2`: + +[source,erlang] +---- +Req = cowboy_req:stream_reply(200, Req0), + +cowboy_req:stream_body("Hello...", nofin, Req), +cowboy_req:stream_body("chunked...", nofin, Req), +cowboy_req:stream_body("world!!", fin, Req). +---- + +The second argument to `cowboy_req:stream_body/3` indicates +whether this data terminates the body. Use `fin` for the +final flag, and `nofin` otherwise. + +This snippet does not set a content-type header. This is +not recommended. All responses with a body should have +a content-type. The header can be set beforehand, or +using the `cowboy_req:stream_reply/3`: + +[source,erlang] +---- +Req = cowboy_req:stream_reply(200, #{ + <<"content-type">> => <<"text/html">> +}, Req0), + +cowboy_req:stream_body("<html><head>Hello world!</head>", nofin, Req), +cowboy_req:stream_body("<body><p>Hats off!</p></body></html>", fin, Req). +---- + +HTTP provides a few different ways to stream response bodies. +Cowboy will select the most appropriate one based on the HTTP +version and the request and response headers. + +While not required by any means, it is recommended that you +set the content-length header in the response if you know it +in advance. This will ensure that the best response method +is selected and help clients understand when the response +is fully received. + +Cowboy also provides a function to send response trailers. +Response trailers are semantically equivalent to the headers +you send in the response, only they are sent at the end. +This is especially useful to attach information to the +response that could not be generated until the response +body was fully generated. + +Trailer fields must be listed in the trailer header. Any +field not listed might be dropped by the client or an intermediary. + +[source,erlang] +---- +Req = cowboy_req:stream_reply(200, #{ + <<"content-type">> => <<"text/html">>, + <<"trailer">> => <<"expires, content-md5">> +}, Req0), + +cowboy_req:stream_body("<html><head>Hello world!</head>", nofin, Req), +cowboy_req:stream_body("<body><p>Hats off!</p></body></html>", nofin, Req), + +cowboy_req:stream_trailers(#{ + <<"expires">> => <<"Sun, 10 Dec 2017 19:13:47 GMT">>, + <<"content-md5">> => <<"c6081d20ff41a42ce17048ed1c0345e2">> +}, Req). +---- + +The stream ends with trailers. It is no longer possible to +send data after sending trailers. You cannot send trailers +after setting the `fin` flag when streaming the body. + +=== Preset response headers + +Cowboy provides functions to set response headers without +immediately sending them. They are stored in the Req object +and sent as part of the response when a reply function is +called. + +To set response headers: + +[source,erlang] +Req = cowboy_req:set_resp_header(<<"allow">>, "GET", Req0). + +Header names must be a lowercase binary. + +Do not use this function for setting cookies. Refer to +the xref:cookies[Cookies] chapter for more information. + +To check if a response header has already been set: + +[source,erlang] +cowboy_req:has_resp_header(<<"allow">>, Req). + +It returns `true` if the header was set, `false` otherwise. + +To delete a response header that was set previously: + +[source,erlang] +Req = cowboy_req:delete_resp_header(<<"allow">>, Req0). + +=== Overriding headers + +As Cowboy provides different ways of setting response +headers and body, clashes may occur, so it's important +to understand what happens when a header is set twice. + +Headers come from five different origins: + +* Protocol-specific headers (for example HTTP/1.1's connection header) +* Other required headers (for example the date header) +* Preset headers +* Headers given to the reply function +* Set-cookie headers + +Cowboy does not allow overriding protocol-specific headers. + +Set-cookie headers will always be appended at the end of +the list of headers before sending the response. + +Headers given to the reply function will always override +preset headers and required headers. If a header is found +in two or three of these, then the one in the reply function +is picked and the others are dropped. + +Similarly, preset headers will always override required +headers. + +To illustrate, look at the following snippet. Cowboy by +default sends the server header with the value "Cowboy". +We can override it: + +[source,erlang] +---- +Req = cowboy_req:reply(200, #{ + <<"server">> => <<"yaws">> +}, Req0). +---- + +=== Preset response body + +Cowboy provides functions to set the response body without +immediately sending it. It is stored in the Req object and +sent when the reply function is called. + +To set the response body: + +[source,erlang] +Req = cowboy_req:set_resp_body("Hello world!", Req0). + +// @todo Yeah we probably should add that function that +// also sets the content-type at the same time... + +To check if a response body has already been set: + +[source,erlang] +cowboy_req:has_resp_body(Req). + +It returns `true` if the body was set and is non-empty, +`false` otherwise. + +// @todo We probably should also have a function that +// properly removes the response body, including any +// content-* headers. + +The preset response body is only sent if the reply function +used is `cowboy_req:reply/2` or `cowboy_req:reply/3`. + +=== Sending files + +Cowboy provides a shortcut for sending files. When +using `cowboy_req:reply/4`, or when presetting the +response header, you can give a `sendfile` tuple to +Cowboy: + +[source,erlang] +{sendfile, Offset, Length, Filename} + +Depending on the values for `Offset` or `Length`, the +entire file may be sent, or just a part of it. + +The length is required even for sending the entire file. +Cowboy sends it in the content-length header. + +To send a file while replying: + +[source,erlang] +---- +Req = cowboy_req:reply(200, #{ + <<"content-type">> => "image/png" +}, {sendfile, 0, 12345, "path/to/logo.png"}, Req0). +---- + +// @todo An example of presetting a file would be useful, +// but let's wait for the function that can set the +// content-type at the same time. + +// @todo What about streaming many files? For example +// it should be possible to build a tar file on the fly +// while still using sendfile. Another example could be +// proper support for multipart byte ranges. Yet another +// example would be automatic concatenation of CSS or JS +// files. + +=== Informational responses + +Cowboy allows you to send informational responses. + +Informational responses are responses that have a status +code between 100 and 199. Any number can be sent before +the proper response. Sending an informational response +does not change the behavior of the proper response, and +clients are expected to ignore any informational response +they do not understand. + +The following snippet sends a 103 informational response +with some headers that are expected to be in the final +response. + +[source,erlang] +---- +Req = cowboy_req:inform(103, #{ + <<"link">> => <<"</style.css>; rel=preload; as=style, </script.js>; rel=preload; as=script">> +}, Req0). +---- + +=== Push + +The HTTP/2 protocol introduced the ability to push resources +related to the one sent in the response. Cowboy provides two +functions for that purpose: `cowboy_req:push/3,4`. + +Push is only available for HTTP/2. Cowboy will automatically +ignore push requests if the protocol doesn't support it. + +The push function must be called before any of the reply +functions. Doing otherwise will result in a crash. + +To push a resource, you need to provide the same information +as a client performing a request would. This includes the +HTTP method, the URI and any necessary request headers. + +Cowboy by default only requires you to give the path to +the resource and the request headers. The rest of the URI +is taken from the current request (excluding the query +string, set to empty) and the method is GET by default. + +The following snippet pushes a CSS file that is linked to +in the response: + +[source,erlang] +---- +cowboy_req:push("/static/style.css", #{ + <<"accept">> => <<"text/css">> +}, Req0), +Req = cowboy_req:reply(200, #{ + <<"content-type">> => <<"text/html">> +}, ["<html><head><title>My web page</title>", + "<link rel='stylesheet' type='text/css' href='/static/style.css'>", + "<body><p>Welcome to Erlang!</p></body></html>"], Req0). +---- + +To override the method, scheme, host, port or query string, +simply pass in a fourth argument. The following snippet +uses a different host name: + +[source,erlang] +---- +cowboy_req:push("/static/style.css", #{ + <<"accept">> => <<"text/css">> +}, #{host => <<"cdn.example.org">>}, Req), +---- + +Pushed resources don't have to be files. As long as the push +request is cacheable, safe and does not include a body, the +resource can be pushed. + +Under the hood, Cowboy handles pushed requests the same as +normal requests: a different process is created which will +ultimately send a response to the client. diff --git a/docs/en/cowboy/2.6/guide/resp/index.html b/docs/en/cowboy/2.6/guide/resp/index.html new file mode 100644 index 00000000..50fce753 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/resp/index.html @@ -0,0 +1,411 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Sending a response</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Sending a response</span></h1> + +<p>The response must be sent using the Req object.</p> +<p>Cowboy provides two different ways of sending responses: either directly or by streaming the body. Response headers and body may be set in advance. The response is sent as soon as one of the reply or stream reply function is called.</p> +<p>Cowboy also provides a simplified interface for sending files. It can also send only specific parts of a file.</p> +<p>While only one response is allowed for every request, HTTP/2 introduced a mechanism that allows the server to push additional resources related to the response. This chapter also describes how this feature works in Cowboy.</p> +<h2 id="_reply">Reply</h2> +<p>Cowboy provides three functions for sending the entire reply, depending on whether you need to set headers and body. In all cases, Cowboy will add any headers required by the protocol (for example the date header will always be sent).</p> +<p>When you need to set only the status code, use <code>cowboy_req:reply/2</code>:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>When you need to set response headers at the same time, use <code>cowboy_req:reply/3</code>:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">303</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"location"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"https://ninenines.eu"</font><font color="#990000">>></font> +}, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Note that the header name must always be a lowercase binary.</p> +<p>When you also need to set the response body, use <code>cowboy_req:reply/4</code>:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font> +}, <font color="#FF0000">"Hello world!"</font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>You should always set the content-type header when the response has a body. There is however no need to set the content-length header; Cowboy does it automatically.</p> +<p>The response body and the header values must be either a binary or an iolist. An iolist is a list containing binaries, characters, strings or other iolists. This allows you to build a response from different parts without having to do any concatenation:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Title</font> <font color="#990000">=</font> <font color="#FF0000">"Hello world!"</font>, +<font color="#009900">Body</font> <font color="#990000">=</font> <font color="#990000"><<</font><font color="#FF0000">"Hats off!"</font><font color="#990000">>></font>, +<font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/html"</font><font color="#990000">>></font> +}, [<font color="#FF0000">"<html><head><title>"</font>, <font color="#009900">Title</font>, <font color="#FF0000">"</title></head>"</font>, + <font color="#FF0000">"<body><p>"</font>, <font color="#009900">Body</font>, <font color="#FF0000">"</p></body></html>"</font>], <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>This method of building responses is more efficient than concatenating. Behind the scenes, each element of the list is simply a pointer, and those pointers are used directly when writing to the socket.</p> +<h2 id="_stream_reply">Stream reply</h2> +<p>Cowboy provides two functions for initiating a response, and an additional function for streaming the response body. Cowboy will add any required headers to the response.</p> +<!-- @todo For HTTP/1.1 Cowboy should probably not use chunked transfer-encoding if the content-length is set.--> +<p>When you need to set only the status code, use <code>cowboy_req:stream_reply/2</code>:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:stream_reply</font></b>(<font color="#993399">200</font>, <font color="#009900">Req0</font>), + +<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#FF0000">"Hello..."</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>), +<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#FF0000">"chunked..."</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>), +<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#FF0000">"world!!"</font>, <font color="#FF6600">fin</font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The second argument to <code>cowboy_req:stream_body/3</code> indicates whether this data terminates the body. Use <code>fin</code> for the final flag, and <code>nofin</code> otherwise.</p> +<p>This snippet does not set a content-type header. This is not recommended. All responses with a body should have a content-type. The header can be set beforehand, or using the <code>cowboy_req:stream_reply/3</code>:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:stream_reply</font></b>(<font color="#993399">200</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/html"</font><font color="#990000">>></font> +}, <font color="#009900">Req0</font>), + +<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#FF0000">"<html><head>Hello world!</head>"</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>), +<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#FF0000">"<body><p>Hats off!</p></body></html>"</font>, <font color="#FF6600">fin</font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>HTTP provides a few different ways to stream response bodies. Cowboy will select the most appropriate one based on the HTTP version and the request and response headers.</p> +<p>While not required by any means, it is recommended that you set the content-length header in the response if you know it in advance. This will ensure that the best response method is selected and help clients understand when the response is fully received.</p> +<p>Cowboy also provides a function to send response trailers. Response trailers are semantically equivalent to the headers you send in the response, only they are sent at the end. This is especially useful to attach information to the response that could not be generated until the response body was fully generated.</p> +<p>Trailer fields must be listed in the trailer header. Any field not listed might be dropped by the client or an intermediary.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:stream_reply</font></b>(<font color="#993399">200</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/html"</font><font color="#990000">>></font>, + <font color="#990000"><<</font><font color="#FF0000">"trailer"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"expires, content-md5"</font><font color="#990000">>></font> +}, <font color="#009900">Req0</font>), + +<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#FF0000">"<html><head>Hello world!</head>"</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>), +<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#FF0000">"<body><p>Hats off!</p></body></html>"</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>), + +<b><font color="#000000">cowboy_req:stream_trailers</font></b>(#{ + <font color="#990000"><<</font><font color="#FF0000">"expires"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"Sun, 10 Dec 2017 19:13:47 GMT"</font><font color="#990000">>></font>, + <font color="#990000"><<</font><font color="#FF0000">"content-md5"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"c6081d20ff41a42ce17048ed1c0345e2"</font><font color="#990000">>></font> +}, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The stream ends with trailers. It is no longer possible to send data after sending trailers. You cannot send trailers after setting the <code>fin</code> flag when streaming the body.</p> +<h2 id="_preset_response_headers">Preset response headers</h2> +<p>Cowboy provides functions to set response headers without immediately sending them. They are stored in the Req object and sent as part of the response when a reply function is called.</p> +<p>To set response headers:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"allow"</font><font color="#990000">>></font>, <font color="#FF0000">"GET"</font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Header names must be a lowercase binary.</p> +<p>Do not use this function for setting cookies. Refer to the <a href="../cookies">Cookies</a> chapter for more information.</p> +<p>To check if a response header has already been set:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cowboy_req:has_resp_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"allow"</font><font color="#990000">>></font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>It returns <code>true</code> if the header was set, <code>false</code> otherwise.</p> +<p>To delete a response header that was set previously:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:delete_resp_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"allow"</font><font color="#990000">>></font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_overriding_headers">Overriding headers</h2> +<p>As Cowboy provides different ways of setting response headers and body, clashes may occur, so it's important to understand what happens when a header is set twice.</p> +<p>Headers come from five different origins:</p> +<ul><li>Protocol-specific headers (for example HTTP/1.1's connection header) +</li> +<li>Other required headers (for example the date header) +</li> +<li>Preset headers +</li> +<li>Headers given to the reply function +</li> +<li>Set-cookie headers +</li> +</ul> +<p>Cowboy does not allow overriding protocol-specific headers.</p> +<p>Set-cookie headers will always be appended at the end of the list of headers before sending the response.</p> +<p>Headers given to the reply function will always override preset headers and required headers. If a header is found in two or three of these, then the one in the reply function is picked and the others are dropped.</p> +<p>Similarly, preset headers will always override required headers.</p> +<p>To illustrate, look at the following snippet. Cowboy by default sends the server header with the value "Cowboy". We can override it:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"server"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"yaws"</font><font color="#990000">>></font> +}, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_preset_response_body">Preset response body</h2> +<p>Cowboy provides functions to set the response body without immediately sending it. It is stored in the Req object and sent when the reply function is called.</p> +<p>To set the response body:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_body</font></b>(<font color="#FF0000">"Hello world!"</font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<!-- @todo Yeah we probably should add that function that--> +<!-- also sets the content-type at the same time...--> +<p>To check if a response body has already been set:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cowboy_req:has_resp_body</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>It returns <code>true</code> if the body was set and is non-empty, <code>false</code> otherwise.</p> +<!-- @todo We probably should also have a function that--> +<!-- properly removes the response body, including any--> +<!-- content-* headers.--> +<p>The preset response body is only sent if the reply function used is <code>cowboy_req:reply/2</code> or <code>cowboy_req:reply/3</code>.</p> +<h2 id="_sending_files">Sending files</h2> +<p>Cowboy provides a shortcut for sending files. When using <code>cowboy_req:reply/4</code>, or when presetting the response header, you can give a <code>sendfile</code> tuple to Cowboy:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">sendfile</font>, <font color="#009900">Offset</font>, <font color="#009900">Length</font>, <font color="#009900">Filename</font>}</tt></pre> +</div></div> +<p>Depending on the values for <code>Offset</code> or <code>Length</code>, the entire file may be sent, or just a part of it.</p> +<p>The length is required even for sending the entire file. Cowboy sends it in the content-length header.</p> +<p>To send a file while replying:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#FF0000">"image/png"</font> +}, {<font color="#FF6600">sendfile</font>, <font color="#993399">0</font>, <font color="#993399">12345</font>, <font color="#FF0000">"path/to/logo.png"</font>}, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<!-- @todo An example of presetting a file would be useful,--> +<!-- but let's wait for the function that can set the--> +<!-- content-type at the same time.--> +<!-- @todo What about streaming many files? For example--> +<!-- it should be possible to build a tar file on the fly--> +<!-- while still using sendfile. Another example could be--> +<!-- proper support for multipart byte ranges. Yet another--> +<!-- example would be automatic concatenation of CSS or JS--> +<!-- files.--> +<h2 id="_informational_responses">Informational responses</h2> +<p>Cowboy allows you to send informational responses.</p> +<p>Informational responses are responses that have a status code between 100 and 199. Any number can be sent before the proper response. Sending an informational response does not change the behavior of the proper response, and clients are expected to ignore any informational response they do not understand.</p> +<p>The following snippet sends a 103 informational response with some headers that are expected to be in the final response.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:inform</font></b>(<font color="#993399">103</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"link"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"</style.css>; rel=preload; as=style, </script.js>; rel=preload; as=script"</font><font color="#990000">>></font> +}, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_push">Push</h2> +<p>The HTTP/2 protocol introduced the ability to push resources related to the one sent in the response. Cowboy provides two functions for that purpose: <code>cowboy_req:push/3,4</code>.</p> +<p>Push is only available for HTTP/2. Cowboy will automatically ignore push requests if the protocol doesn't support it.</p> +<p>The push function must be called before any of the reply functions. Doing otherwise will result in a crash.</p> +<p>To push a resource, you need to provide the same information as a client performing a request would. This includes the HTTP method, the URI and any necessary request headers.</p> +<p>Cowboy by default only requires you to give the path to the resource and the request headers. The rest of the URI is taken from the current request (excluding the query string, set to empty) and the method is GET by default.</p> +<p>The following snippet pushes a CSS file that is linked to in the response:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cowboy_req:push</font></b>(<font color="#FF0000">"/static/style.css"</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/css"</font><font color="#990000">>></font> +}, <font color="#009900">Req0</font>), +<font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/html"</font><font color="#990000">>></font> +}, [<font color="#FF0000">"<html><head><title>My web page</title>"</font>, + <font color="#FF0000">"<link rel='stylesheet' type='text/css' href='/static/style.css'>"</font>, + <font color="#FF0000">"<body><p>Welcome to Erlang!</p></body></html>"</font>], <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>To override the method, scheme, host, port or query string, simply pass in a fourth argument. The following snippet uses a different host name:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cowboy_req:push</font></b>(<font color="#FF0000">"/static/style.css"</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/css"</font><font color="#990000">>></font> +}, #{<font color="#0000FF">host</font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"cdn.example.org"</font><font color="#990000">>></font>}, <font color="#009900">Req</font>),</tt></pre> +</div></div> +<p>Pushed resources don't have to be files. As long as the push request is cacheable, safe and does not include a body, the resource can be pushed.</p> +<p>Under the hood, Cowboy handles pushed requests the same as normal requests: a different process is created which will ultimately send a response to the client.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/req_body/"> + Reading the request body + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/cookies/"> + Using cookies + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/rest_cond.png b/docs/en/cowboy/2.6/guide/rest_cond.png Binary files differnew file mode 100644 index 00000000..64cda347 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_cond.png diff --git a/docs/en/cowboy/2.6/guide/rest_cond.svg b/docs/en/cowboy/2.6/guide/rest_cond.svg new file mode 100644 index 00000000..542ae17d --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_cond.svg @@ -0,0 +1,1656 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + xmlns:osb="http://www.openswatchbook.org/uri/2009/osb" + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="744.09448819" + height="1052.3622047" + id="svg2" + version="1.1" + inkscape:version="0.48.4 r9939" + sodipodi:docname="rest_cond.svg" + inkscape:export-filename="/home/essen/Dropbox/Public/drawing.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <defs + id="defs4"> + <linearGradient + id="linearGradient5265"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5267" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.58823532;" + offset="1" + id="stop5269" /> + </linearGradient> + <linearGradient + id="linearGradient5251"> + <stop + style="stop-color:#69d2e7;stop-opacity:0.78431374;" + offset="0" + id="stop5253" /> + <stop + id="stop5263" + offset="0.5" + style="stop-color:#69d2e7;stop-opacity:1;" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.39215687;" + offset="1" + id="stop5255" /> + </linearGradient> + <linearGradient + id="linearGradient5233" + osb:paint="solid"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5235" /> + </linearGradient> + </defs> + <sodipodi:namedview + id="base" + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1.0" + inkscape:pageopacity="1" + inkscape:pageshadow="2" + inkscape:zoom="2.0000001" + inkscape:cx="351.17815" + inkscape:cy="292.20555" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="false" + inkscape:window-width="2560" + inkscape:window-height="1402" + inkscape:window-x="0" + inkscape:window-y="38" + inkscape:window-maximized="1" + inkscape:snap-global="true" + showguides="true"> + <inkscape:grid + type="xygrid" + id="grid5357" + empspacing="5" + visible="true" + enabled="true" + snapvisiblegridlinesonly="true" /> + </sodipodi:namedview> + <metadata + id="metadata7"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + <dc:title /> + </cc:Work> + </rdf:RDF> + </metadata> + <g + inkscape:label="Layer 1" + inkscape:groupmode="layer" + id="layer1"> + <path + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:connector-curvature="0" + id="use5777" + d="m -360.31658,371.70113 203.00246,0.045" + style="fill:none;stroke:#6d8e41;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:1.99999999, 3.99999998;stroke-dashoffset:0" /> + <g + transform="translate(303.92143,-296.03137)" + id="g5650-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-9" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-0" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(303.92143,-212.00698)" + id="g5650-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-7" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-09" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(303.92143,-129.04326)" + id="g5650-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-5" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-1" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(303.92143,-44.866334)" + id="g5650-94" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-71" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-5" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(303.92143,38.329623)" + id="g5650-93" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-3" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-4" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(303.92143,122.59665)" + id="g5650-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-93" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-04" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(303.92143,206.62103)" + id="g5650-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-78" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,-276.88574,248.85545)" + id="g5650-2-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <g + transform="matrix(0,-1,1,0,72.326854,331.8341)" + id="g5650-2-04" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-2-9" + d="m -57.78256,274.83062 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-0" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-28" + width="210.17955" + height="35.209244" + x="141.04909" + y="204.49196" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-5" + width="210.17955" + height="35.209244" + x="141.04909" + y="288.06644" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8" + width="210.17955" + height="35.209244" + x="141.04909" + y="371.6409" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-4" + width="210.17955" + height="35.209244" + x="141.04909" + y="455.21542" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + transform="matrix(0,-1,1,0,72.019862,498.61197)" + id="g5650-2-04-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-2-9-6" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-0-7" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-87" + width="210.17955" + height="35.209244" + x="141.04909" + y="538.78992" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + transform="translate(303.92156,289.38374)" + id="g5650-6-2" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-78-4" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9-2" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,-273.77202,830.73267)" + id="g5650-2-0-4-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-9" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-3" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <g + transform="matrix(0,-1,1,0,-276.00956,743.77999)" + id="g5650-2-0-4-9-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 100.30195,432.97597 c 0,0 -104.1879007,-96.82159 -227.75958,-12.49311" + id="path20172-9-6-0" + inkscape:connector-curvature="0" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,146.48523,357.79168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-5-7" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-41" + width="210.17955" + height="35.209244" + x="140.98338" + y="622.36444" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1" + width="210.17955" + height="35.209244" + x="141.04909" + y="120.91741" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + id="g5650" + transform="translate(0,-0.47597102)"> + <path + inkscape:connector-curvature="0" + id="path5570" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273" + width="104.5895" + height="36.392323" + x="-224.02068" + y="29.41218" + rx="15" /> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7" + width="104.5895" + height="36.392323" + x="-224.02068" + y="90.691978" + rx="15" /> + <rect + style="fill:#ffc48c;fill-opacity:1;fill-rule:nonzero;stroke:#d79c64;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-2" + width="104.5895" + height="36.392323" + x="-224.02068" + y="151.97169" + rx="15" /> + <rect + style="fill:#ff9f80;fill-opacity:1;fill-rule:nonzero;stroke:#d77758;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-22" + width="104.5895" + height="36.392323" + x="-224.02068" + y="213.25146" + rx="15" /> + <rect + style="fill:#f56991;fill-opacity:1;fill-rule:nonzero;stroke:#cd4169;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-8" + width="104.5895" + height="36.392323" + x="-224.02068" + y="274.53128" + rx="15" /> + <use + x="0" + y="0" + xlink:href="#rect5273-22" + id="use5355" + transform="translate(417.86479,-176.50006)" + width="744.09448" + height="1052.3622" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-58.692513" + y="114.39204" + id="text5371" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan5373" + x="-58.692513" + y="114.39204">some text</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-58.692513" + y="53.112247" + id="text5371-2" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan5373-6" + x="-58.692513" + y="53.112247">some text</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="246.18575" + y="311.63589" + id="text5371-2-3" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7" + x="246.18575" + y="311.63589">has if-unmodified-since?</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="245.60762" + y="478.78488" + id="text5371-2-3-0" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7-3" + x="245.60762" + y="478.78488">has if-none-match?</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-58.692513" + y="236.95154" + id="text5371-4" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan5373-9" + x="-58.692513" + y="236.95154">some text</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="246.15059" + y="55.939754" + id="text5371-4-0" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + x="246.15059" + y="55.939754" + id="tspan17171">...</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="246.11153" + y="560.125" + id="text5371-2-9" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-8" + x="246.11153" + y="560.125">generate_etag</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="246.64278" + y="645.9339" + id="text5371-2-7" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-2" + x="246.64278" + y="645.9339">has if-modified-since?</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="246.13106" + y="144.48688" + id="text5371-2-95" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-80" + x="246.13106" + y="144.48688">has if-match?</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="245.80684" + y="225.82706" + id="text5371-2-32" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-27" + x="245.80684" + y="225.82706">generate_etag</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="246.05293" + y="393.43692" + id="text5371-2-74" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18" + x="246.05293" + y="393.43692">last_modified</tspan></text> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-2" + width="210.17955" + height="35.209244" + x="-489.75586" + y="33.4944" + rx="15" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="262.26562" + y="185.95248" + id="text5371-2-391" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63" + x="262.26562" + y="185.95248">true</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="262.26562" + y="269.61978" + id="text5371-2-954" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-808" + x="262.26562" + y="269.61978">match*</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="262.26562" + y="353.28702" + id="text5371-2-4" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-11" + x="262.26562" + y="353.28702">true</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="262.26562" + y="436.95425" + id="text5371-2-92" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-4" + x="262.26562" + y="436.95425">not modified*</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="262.26562" + y="520.62152" + id="text5371-2-739" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-0" + x="262.26562" + y="520.62152">true</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="261.24219" + y="604.14661" + id="text5371-2-8" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3" + x="261.24219" + y="604.14661">no match*</tspan></text> + <g + transform="matrix(0,-1,1,0,-513.31414,353.05561)" + id="g5650-2"> + <path + inkscape:connector-curvature="0" + id="path5570-2" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="66.515488" + y="227.88033" + id="text5371-4-6" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-0" + x="66.515488" + y="227.88033">false</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="66.097519" + y="385.50708" + id="text5371-4-2" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-01" + x="66.097519" + y="385.50708">false, or</tspan><tspan + sodipodi:role="line" + x="66.097519" + y="405.50708" + id="tspan21678">invalid</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="413.26172" + y="414.19577" + id="text5371-4-3" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-62" + x="413.26172" + y="414.19577">modified*</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="66.515488" + y="563.13391" + id="text5371-4-4" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2" + x="66.515488" + y="563.13391">false</tspan></text> + <g + transform="matrix(-1,0,0,-1,541.38289,824.55574)" + id="g5650-2-2"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1" + width="218.52127" + height="34.993004" + x="489.90482" + y="372.18814" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="599.20062" + y="394.09869" + id="text5371-43" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3" + x="599.20062" + y="394.09869">412 precondition failed</tspan></text> + <rect + style="fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:2.44279909;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5367" + width="207.05719" + height="171.55719" + x="-373.52859" + y="458.58362" + rx="11.072577" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-544.69421" + y="-354.17184" + id="text5371-2-3-0-7" + sodipodi:linespacing="125%" + transform="matrix(0,-1,1,0,0,0)" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7-3-9" + x="-544.69421" + y="-354.17184">middlewares</tspan></text> + <g + transform="matrix(0,-1,1,0,-508.93096,565.23553)" + id="g5650-2-0-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <g + transform="matrix(0,-1,1,0,-276.88574,416.17722)" + id="g5650-2-0-4-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-6" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-5" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <g + transform="matrix(0,-1,1,0,-276.88574,583.49898)" + id="g5650-2-0-4-5" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-0" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-6" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <g + transform="matrix(0.70472302,-0.70948254,0.70948254,0.70472302,241.97558,40.02582)" + id="g5650-2-1-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-2-2-8" + d="m -64.113139,212.68162 6.332851,190.92097" + style="opacity:0.80000000000000004;fill:none;stroke:#9b3b1c;stroke-width:1.99999999;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-9-3" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="511.01306" + y="-49.514503" + id="text5371-4-5-9" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" + transform="matrix(0.72036037,0.69359998,-0.69359998,0.72036037,0,0)"><tspan + sodipodi:role="line" + id="tspan5373-9-09-1" + x="511.01306" + y="-49.514503">no match*</tspan></text> + <g + transform="translate(303.92156,371.88426)" + id="g5650-6-2-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-78-4-2" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9-2-0" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-41-0" + width="210.17955" + height="35.209244" + x="140.98338" + y="705.93896" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="246.11142" + y="729.50842" + id="text5371-2-7-9" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-2-1" + x="246.11142" + y="729.50842">date is in the future?</tspan></text> + <g + transform="translate(303.92156,455.39272)" + id="g5650-6-2-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-78-4-6" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9-2-2" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,72.385532,749.33549)" + id="g5650-2-04-1-2" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-2-9-6-9" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-0-7-5" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-2-6" + width="210.17955" + height="35.209244" + x="140.98338" + y="789.51343" + rx="15" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="246.04581" + y="811.30945" + id="text5371-2-7-9-0" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-2-1-1" + x="246.04581" + y="811.30945">last_modified</tspan></text> + <g + id="g5650-39" + transform="translate(656.94774,376.09516)"> + <path + inkscape:connector-curvature="0" + id="path5570-0" + d="m -57.78256,195.3221 0,204.64594" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,159.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-124" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-7" + width="218.52127" + height="34.993004" + x="489.90482" + y="957.01166" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="599.28265" + y="980.47302" + id="text5371-43-0" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-6" + x="599.28265" + y="980.47302">304 not modified</tspan></text> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-2-6-4" + width="210.17955" + height="35.209244" + x="140.98338" + y="873.08795" + rx="15" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="246.08487" + y="891.68475" + id="text5371-2-7-9-0-3" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-2-1-1-0" + x="246.08487" + y="891.68475">...</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="66.097519" + y="720.76068" + id="text5371-4-2-5" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-01-9" + x="66.097519" + y="720.76068">false, or</tspan><tspan + sodipodi:role="line" + x="66.097519" + y="740.76068" + id="tspan21678-9">invalid</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="412.95471" + y="580.78271" + id="text5371-4-3-9" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-62-9" + x="412.95471" + y="580.78271">match*</tspan></text> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3.05435514;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-41-0-7" + width="218.20164" + height="35.154888" + x="490.06448" + y="538.81708" + rx="15.572517" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="599.00122" + y="562.35938" + id="text5371-2-7-9-04" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-2-1-6" + x="599.00122" + y="562.35938">method is GET/HEAD?</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="621.08008" + y="607.0827" + id="text5371-2-739-3" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-0-0" + x="621.08008" + y="607.0827">true</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="640.17383" + y="518.34009" + id="text5371-4-4-9" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6" + x="640.17383" + y="518.34009">false</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="157.927" + y="770.83472" + id="text5371-4-4-4" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-4" + x="157.927" + y="770.83472">true</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="262.32812" + y="771.29565" + id="text5371-2-739-5" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-0-1" + x="262.32812" + y="771.29565">false</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="262.26562" + y="687.26025" + id="text5371-2-739-56" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-0-8" + x="262.26562" + y="687.26025">true</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="261.24219" + y="854.87012" + id="text5371-2-739-5-6" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-0-1-3" + x="261.24219" + y="854.87012">modified*</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="417.07037" + y="834.64905" + id="text5371-4-3-9-9" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-62-9-4" + x="417.07037" + y="834.64905">not modified*</tspan></text> + <g + transform="translate(656.94774,455.40497)" + id="g5650-6-2-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-78-4-1" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9-2-09" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-28-5" + width="210.17955" + height="35.209244" + x="490.03729" + y="789.51343" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="595.41223" + y="810.84851" + id="text5371-2-32-1" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-27-8" + x="595.41223" + y="810.84851">generate_etag</tspan></text> + <g + transform="translate(656.94774,539.41312)" + id="g5650-6-2-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-78-4-7" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9-2-5" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-28-5-0" + width="210.17955" + height="35.209244" + x="490.03729" + y="873.08795" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="595.41223" + y="894.42303" + id="text5371-2-32-1-2" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-27-8-6" + x="595.41223" + y="894.42303">expires</tspan></text> + </g> +</svg> diff --git a/docs/en/cowboy/2.6/guide/rest_conneg.png b/docs/en/cowboy/2.6/guide/rest_conneg.png Binary files differnew file mode 100644 index 00000000..65ecdcf3 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_conneg.png diff --git a/docs/en/cowboy/2.6/guide/rest_conneg.svg b/docs/en/cowboy/2.6/guide/rest_conneg.svg new file mode 100644 index 00000000..247567a0 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_conneg.svg @@ -0,0 +1,1135 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + xmlns:osb="http://www.openswatchbook.org/uri/2009/osb" + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="744.09448819" + height="1052.3622047" + id="svg2" + version="1.1" + inkscape:version="0.48.4 r9939" + sodipodi:docname="rest_conneg.svg" + inkscape:export-filename="/home/essen/Dropbox/Public/drawing.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <defs + id="defs4"> + <linearGradient + id="linearGradient5265"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5267" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.58823532;" + offset="1" + id="stop5269" /> + </linearGradient> + <linearGradient + id="linearGradient5251"> + <stop + style="stop-color:#69d2e7;stop-opacity:0.78431374;" + offset="0" + id="stop5253" /> + <stop + id="stop5263" + offset="0.5" + style="stop-color:#69d2e7;stop-opacity:1;" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.39215687;" + offset="1" + id="stop5255" /> + </linearGradient> + <linearGradient + id="linearGradient5233" + osb:paint="solid"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5235" /> + </linearGradient> + </defs> + <sodipodi:namedview + id="base" + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1.0" + inkscape:pageopacity="1" + inkscape:pageshadow="2" + inkscape:zoom="1.4142136" + inkscape:cx="222.80947" + inkscape:cy="634.56615" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="false" + inkscape:window-width="2560" + inkscape:window-height="1402" + inkscape:window-x="0" + inkscape:window-y="38" + inkscape:window-maximized="1" + inkscape:snap-global="true" + showguides="true"> + <inkscape:grid + type="xygrid" + id="grid5357" + empspacing="5" + visible="true" + enabled="true" + snapvisiblegridlinesonly="true" /> + </sodipodi:namedview> + <metadata + id="metadata7"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + <dc:title></dc:title> + </cc:Work> + </rdf:RDF> + </metadata> + <g + inkscape:label="Layer 1" + inkscape:groupmode="layer" + id="layer1"> + <path + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:connector-curvature="0" + id="use5777" + d="m -360.31658,371.70113 203.00246,0.045" + style="fill:none;stroke:#6d8e41;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:1.99999999, 3.99999998;stroke-dashoffset:0" /> + <g + transform="translate(303.92143,-296.03137)" + id="g5650-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-9" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-0" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(303.92143,-212.00698)" + id="g5650-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-7" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-09" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(303.92143,-129.04326)" + id="g5650-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-5" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-1" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(303.92143,-44.866334)" + id="g5650-94" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-71" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-5" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(303.92143,38.329623)" + id="g5650-93" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-3" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-4" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(303.92143,122.59665)" + id="g5650-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-93" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-04" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(303.92143,206.62103)" + id="g5650-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-78" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,-276.88574,248.85545)" + id="g5650-2-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <g + transform="matrix(0,-1,1,0,72.326854,331.8341)" + id="g5650-2-04" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-2-9" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-0" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-28" + width="210.17955" + height="35.209244" + x="141.04909" + y="204.67757" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-5" + width="210.17955" + height="35.209244" + x="141.04909" + y="288.40311" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8" + width="210.17955" + height="35.209244" + x="141.04909" + y="372.01199" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-4" + width="210.17955" + height="35.209244" + x="141.04909" + y="455.67929" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-87" + width="210.17955" + height="35.209244" + x="141.04909" + y="539.34656" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + transform="translate(303.92156,289.38374)" + id="g5650-6-2" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-78-4" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9-2" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-41" + width="210.17955" + height="35.209244" + x="141.04909" + y="623.01385" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1" + width="210.17955" + height="35.209244" + x="141.04909" + y="121.0042" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + id="g5650" + transform="translate(0,-0.47597102)"> + <path + inkscape:connector-curvature="0" + id="path5570" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273" + width="104.5895" + height="36.392323" + x="-224.02068" + y="29.41218" + rx="15" /> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7" + width="104.5895" + height="36.392323" + x="-224.02068" + y="90.691978" + rx="15" /> + <rect + style="fill:#ffc48c;fill-opacity:1;fill-rule:nonzero;stroke:#d79c64;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-2" + width="104.5895" + height="36.392323" + x="-224.02068" + y="151.97169" + rx="15" /> + <rect + style="fill:#ff9f80;fill-opacity:1;fill-rule:nonzero;stroke:#d77758;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-22" + width="104.5895" + height="36.392323" + x="-224.02068" + y="213.25146" + rx="15" /> + <rect + style="fill:#f56991;fill-opacity:1;fill-rule:nonzero;stroke:#cd4169;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-8" + width="104.5895" + height="36.392323" + x="-224.02068" + y="274.53128" + rx="15" /> + <use + x="0" + y="0" + xlink:href="#rect5273-22" + id="use5355" + transform="translate(417.86479,-176.50006)" + width="744.09448" + height="1052.3622" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-58.692513" + y="114.39204" + id="text5371" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan5373" + x="-58.692513" + y="114.39204">some text</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-58.692513" + y="53.112247" + id="text5371-2" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan5373-6" + x="-58.692513" + y="53.112247">some text</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="246.18575" + y="310.19913" + id="text5371-2-3" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7" + x="246.18575" + y="310.19913">has accept-language?</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="245.60762" + y="477.47531" + id="text5371-2-3-0" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7-3" + x="245.60762" + y="477.47531">has accept-charset?</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-58.692513" + y="236.95154" + id="text5371-4" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan5373-9" + x="-58.692513" + y="236.95154">some text</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="245.00391" + y="60.912468" + id="text5371-4-0" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + x="245.00391" + y="60.912468" + id="tspan17171">start</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="246.11153" + y="561.14258" + id="text5371-2-9" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-8" + x="246.11153" + y="561.14258">charsets_provided</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="246.64278" + y="646.58331" + id="text5371-2-7" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-2" + x="246.64278" + y="646.58331">variances</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="246.13106" + y="142.80627" + id="text5371-2-95" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-80" + x="246.13106" + y="142.80627">has accept?</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="245.80684" + y="226.4736" + id="text5371-2-32" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-27" + x="245.80684" + y="226.4736">content_types_provided</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="246.05293" + y="393.80801" + id="text5371-2-74" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18" + x="246.05293" + y="393.80801">languages_provided</tspan></text> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-2" + width="210.17955" + height="35.209244" + x="-489.75586" + y="33.4944" + rx="15" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="262.26562" + y="185.95248" + id="text5371-2-391" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63" + x="262.26562" + y="185.95248">true</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="262.26562" + y="269.61978" + id="text5371-2-954" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-808" + x="262.26562" + y="269.61978">provided*</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="262.26562" + y="353.28702" + id="text5371-2-4" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-11" + x="262.26562" + y="353.28702">true</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="262.26562" + y="436.95425" + id="text5371-2-92" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-4" + x="262.26562" + y="436.95425">provided*</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="262.26562" + y="520.62152" + id="text5371-2-739" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-0" + x="262.26562" + y="520.62152">true</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="262.26562" + y="604.28876" + id="text5371-2-8" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3" + x="262.26562" + y="604.28876">provided*</tspan></text> + <g + transform="matrix(0,-1,1,0,-513.31414,353.05561)" + id="g5650-2"> + <path + inkscape:connector-curvature="0" + id="path5570-2" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="76.761719" + y="227.88033" + id="text5371-4-6" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-0" + x="76.761719" + y="227.88033">false</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="76.761719" + y="395.20209" + id="text5371-4-2" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-01" + x="76.761719" + y="395.20209">false</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="413.26172" + y="374.19577" + id="text5371-4-3" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-62" + x="413.26172" + y="374.19577">not provided*</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="76.761719" + y="562.52386" + id="text5371-4-4" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2" + x="76.761719" + y="562.52386">false</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-8.8034744" + y="663.24762" + id="text5371-4-5" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" + transform="matrix(0.7410941,-0.67140117,0.67140117,0.7410941,0,0)"><tspan + sodipodi:role="line" + id="tspan5373-9-09" + x="-8.8034744" + y="663.24762">not provided*</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1" + width="218.52127" + height="34.993004" + x="489.90482" + y="372.18814" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + transform="matrix(-0.65781496,-0.75317958,0.75317958,-0.65781496,150.24236,637.46542)" + id="g5650-2-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-2-2" + d="m -59.488319,210.57681 1.65844,193.00059" + style="opacity:0.80000000000000004;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-9" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="599.20062" + y="394.09869" + id="text5371-43" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3" + x="599.20062" + y="394.09869">406 not acceptable</tspan></text> + <rect + style="fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:2.44279909;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5367" + width="207.05719" + height="171.55719" + x="-373.52859" + y="458.58362" + rx="11.072577" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-544.69421" + y="-354.17184" + id="text5371-2-3-0-7" + sodipodi:linespacing="125%" + transform="matrix(0,-1,1,0,0,0)" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7-3-9" + x="-544.69421" + y="-354.17184">middlewares</tspan></text> + <g + transform="matrix(0,-1,1,0,-508.93096,565.23553)" + id="g5650-2-0-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <g + transform="matrix(0,-1,1,0,-276.88574,416.17722)" + id="g5650-2-0-4-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-6" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-5" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <g + transform="matrix(0,-1,1,0,-276.88574,583.49898)" + id="g5650-2-0-4-5" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-0" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-6" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <g + transform="matrix(0.70472302,-0.70948254,0.70948254,0.70472302,241.97558,40.02582)" + id="g5650-2-1-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-2-2-8" + d="m -64.113139,212.68162 6.332851,190.92097" + style="opacity:0.80000000000000004;fill:none;stroke:#9b3b1c;stroke-width:1.99999999;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-9-3" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="509.41452" + y="-106.16136" + id="text5371-4-5-9" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" + transform="matrix(0.69480867,0.71919462,-0.71919462,0.69480867,0,0)"><tspan + sodipodi:role="line" + id="tspan5373-9-09-1" + x="509.41452" + y="-106.16136">not provided*</tspan></text> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-41-0" + width="210.17955" + height="35.209244" + x="141.049" + y="706.68097" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="246.15048" + y="725.27777" + id="text5371-2-7-9" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-2-1" + x="246.15048" + y="725.27777">...</tspan></text> + </g> +</svg> diff --git a/docs/en/cowboy/2.6/guide/rest_delete.png b/docs/en/cowboy/2.6/guide/rest_delete.png Binary files differnew file mode 100644 index 00000000..56a861c0 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_delete.png diff --git a/docs/en/cowboy/2.6/guide/rest_delete.svg b/docs/en/cowboy/2.6/guide/rest_delete.svg new file mode 100644 index 00000000..2f5513cd --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_delete.svg @@ -0,0 +1,1718 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + xmlns:osb="http://www.openswatchbook.org/uri/2009/osb" + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="744.09448819" + height="1052.3622047" + id="svg2" + version="1.1" + inkscape:version="0.48.4 r9939" + sodipodi:docname="rest_delete.svg" + inkscape:export-filename="/home/essen/Dropbox/Public/drawing.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <defs + id="defs4"> + <linearGradient + id="linearGradient5265"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5267" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.58823532;" + offset="1" + id="stop5269" /> + </linearGradient> + <linearGradient + id="linearGradient5251"> + <stop + style="stop-color:#69d2e7;stop-opacity:0.78431374;" + offset="0" + id="stop5253" /> + <stop + id="stop5263" + offset="0.5" + style="stop-color:#69d2e7;stop-opacity:1;" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.39215687;" + offset="1" + id="stop5255" /> + </linearGradient> + <linearGradient + id="linearGradient5233" + osb:paint="solid"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5235" /> + </linearGradient> + </defs> + <sodipodi:namedview + id="base" + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1.0" + inkscape:pageopacity="1" + inkscape:pageshadow="2" + inkscape:zoom="1.4142136" + inkscape:cx="187.51922" + inkscape:cy="446.38557" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="false" + inkscape:window-width="2560" + inkscape:window-height="1402" + inkscape:window-x="0" + inkscape:window-y="38" + inkscape:window-maximized="1" + inkscape:snap-global="true" + showguides="true"> + <inkscape:grid + type="xygrid" + id="grid5357" + empspacing="5" + visible="true" + enabled="true" + snapvisiblegridlinesonly="true" /> + </sodipodi:namedview> + <metadata + id="metadata7"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + <dc:title></dc:title> + </cc:Work> + </rdf:RDF> + </metadata> + <g + inkscape:label="Layer 1" + inkscape:groupmode="layer" + id="layer1"> + <path + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:connector-curvature="0" + id="use5777" + d="m -360.31658,371.70113 203.00246,0.045" + style="fill:none;stroke:#6d8e41;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:1.99999999, 3.99999998;stroke-dashoffset:0" /> + <g + transform="translate(416.63925,-305.0045)" + id="g5650-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-9" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-0" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(270.88515,270.15614)" + id="g5650-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-93" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-04" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(270.88515,435.68973)" + id="g5650-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-78" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(270.88515,-141.93971)" + id="g5650-0-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-5-3" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-1-1" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(270.88515,-59.713866)" + id="g5650-0-6-5" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-5-7-7" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-1-3-8" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,-307.35528,398.54403)" + id="g5650-2-0-4-8-8-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-5-6-2" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-2-8-3" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-28" + width="210.17955" + height="35.209244" + x="108.01281" + y="275.4668" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + transform="translate(270.88515,105.33602)" + id="g5650-2-2-7"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-3" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-9" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,-310.05718,566.15049)" + id="g5650-2-0-4-3-8-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-8-9-8" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58-6-7" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-5" + width="210.17955" + height="35.209244" + x="108.01281" + y="440.50873" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + transform="matrix(0,-1,1,0,-308.28941,729.66893)" + id="g5650-2-0-4-8-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-5-6" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-2-8" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-4" + width="210.17955" + height="35.209244" + x="108.01281" + y="605.5506" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + transform="matrix(0,-1,1,0,-313.39862,891.55835)" + id="g5650-2-0-4-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-5" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-2" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-87" + width="210.17955" + height="35.209244" + x="108.01281" + y="770.83313" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + transform="matrix(0.70710678,-0.70710678,0.70710678,0.70710678,261.76354,-143.71473)" + id="g5650-2-2-8"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-4" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-3" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1" + width="210.17955" + height="35.209244" + x="253.76691" + y="112.69559" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + id="g5650" + transform="translate(0,-0.47597102)"> + <path + inkscape:connector-curvature="0" + id="path5570" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273" + width="104.5895" + height="36.392323" + x="-224.02068" + y="29.41218" + rx="15" /> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7" + width="104.5895" + height="36.392323" + x="-224.02068" + y="90.691978" + rx="15" /> + <rect + style="fill:#ffc48c;fill-opacity:1;fill-rule:nonzero;stroke:#d79c64;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-2" + width="104.5895" + height="36.392323" + x="-224.02068" + y="151.97169" + rx="15" /> + <rect + style="fill:#ff9f80;fill-opacity:1;fill-rule:nonzero;stroke:#d77758;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-22" + width="104.5895" + height="36.392323" + x="-224.02068" + y="213.25146" + rx="15" /> + <rect + style="fill:#f56991;fill-opacity:1;fill-rule:nonzero;stroke:#cd4169;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-8" + width="104.5895" + height="36.392323" + x="-224.02068" + y="274.53128" + rx="15" /> + <use + x="0" + y="0" + xlink:href="#rect5273-22" + id="use5355" + transform="translate(530.58261,-183.7816)" + width="744.09448" + height="1052.3622" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-58.692513" + y="114.39204" + id="text5371" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan5373" + x="-58.692513" + y="114.39204">some text</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-58.692513" + y="53.112247" + id="text5371-2" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan5373-6" + x="-58.692513" + y="53.112247">some text</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="213.38774" + y="462.30475" + id="text5371-2-3" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7" + x="213.38774" + y="462.30475">delete_completed</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="212.93852" + y="627.56927" + id="text5371-2-3-0" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7-3" + x="212.93852" + y="627.56927">has response body?</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-58.692513" + y="236.95154" + id="text5371-4" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan5373-9" + x="-58.692513" + y="236.95154">some text</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="359.14185" + y="50.482433" + id="text5371-4-0" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + x="359.14185" + y="50.482433" + id="tspan17171">conneg</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="212.77055" + y="792.62915" + id="text5371-2-9" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-8" + x="212.77055" + y="792.62915">multiple_choices</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="358.52466" + y="134.49161" + id="text5371-2-95" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-80" + x="358.52466" + y="134.49161">resource_exists</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="213.08696" + y="297.26282" + id="text5371-2-32" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-27" + x="213.08696" + y="297.26282">delete_resource</tspan></text> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-2" + width="210.17955" + height="35.209244" + x="-489.75586" + y="33.4944" + rx="15" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="251.83722" + y="175.92931" + id="text5371-2-391" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63" + x="251.83722" + y="175.92931">true</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="159.54012" + y="835.54285" + id="text5371-2-8" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3" + x="159.54012" + y="835.54285">false</tspan></text> + <g + transform="matrix(0,-1,1,0,-513.31414,353.05561)" + id="g5650-2"> + <path + inkscape:connector-curvature="0" + id="path5570-2" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="447.26678" + y="176.39024" + id="text5371-4-6" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-0" + x="447.26678" + y="176.39024">false</tspan></text> + <g + transform="translate(563.72619,-141.76777)" + id="g5650-2-2"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:2.44279909;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5367" + width="207.05719" + height="171.55719" + x="-373.52859" + y="458.58362" + rx="11.072577" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-544.69421" + y="-354.17184" + id="text5371-2-3-0-7" + sodipodi:linespacing="125%" + transform="matrix(0,-1,1,0,0,0)" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7-3-9" + x="-544.69421" + y="-354.17184">middlewares</tspan></text> + <g + transform="matrix(0,-1,1,0,-508.93096,565.23553)" + id="g5650-2-0-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="47.338913" + y="876.22211" + id="text5371-4-3-9" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-62-9" + x="47.338913" + y="876.22211">true</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="545.12921" + y="257.43518" + id="text5371-4-4-9" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6" + x="545.12921" + y="257.43518">true</tspan></text> + <g + transform="matrix(0.70710678,0.70710678,-0.70710678,0.70710678,547.47379,-62.310424)" + id="g5650-9-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-7-6" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-09-5" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <use + x="0" + y="0" + xlink:href="#rect5273-22" + id="use5355-0" + transform="translate(384.82851,-20.897068)" + width="744.09448" + height="1052.3622" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="213.38774" + y="216.5154" + id="text5371-4-0-8" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + x="213.38774" + y="216.5154" + id="tspan17171-6">cond</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-1" + width="218.52127" + height="34.993004" + x="99.803589" + y="935.6217" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="208.84938" + y="957.53229" + id="text5371-43-5" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-62" + x="208.84938" + y="957.53229">300 multiple choices</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-8" + width="218.52127" + height="34.993004" + x="99.803589" + y="853.22168" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="208.31422" + y="876.54242" + id="text5371-43-3" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-1" + x="208.31422" + y="876.54242">200 OK</tspan></text> + <g + transform="matrix(0,-1,-1,0,1028.2004,317.70407)" + id="g5650-2-0-4-3-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-8-9" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58-6" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-28-4" + width="210.17955" + height="35.209244" + x="400.85385" + y="192.94594" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="505.77957" + y="216.51541" + id="text5371-2-32-6" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-27-8" + x="505.77957" + y="216.51541">has if-match?</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="651.74426" + y="299.27689" + id="text5371-2-391-5" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63-7" + x="651.74426" + y="299.27689">false</tspan></text> + <g + transform="translate(563.72619,22.800669)" + id="g5650-0-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-5-7" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-1-3" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,-1,0,1027.6701,482.30508)" + id="g5650-2-0-4-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-8" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-28-7" + width="210.17955" + height="35.209244" + x="400.85385" + y="357.98779" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="505.94363" + y="379.78381" + id="text5371-2-32-8" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-27-1" + x="505.94363" + y="379.78381">previously_existed</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-5" + width="218.52127" + height="34.993004" + x="396.68301" + y="440.37622" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="506.2796" + y="463.83755" + id="text5371-43-2" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-9" + x="506.2796" + y="463.83755">404 not found</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="528.75421" + y="422.69736" + id="text5371-2-8-9" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3-4" + x="528.75421" + y="422.69736">false</tspan></text> + <g + transform="translate(563.72619,187.85116)" + id="g5650-2-2-17"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-0" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-45" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,-1,0,1027.4933,646.81763)" + id="g5650-2-0-4-3-8-0-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-8-9-31-8" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58-6-3-6" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9" + width="210.17955" + height="35.209244" + x="400.85385" + y="523.02966" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="505.45535" + y="544.82568" + id="text5371-2-74-0" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2" + x="505.45535" + y="544.82568">moved_permanently</tspan></text> + <g + transform="matrix(0,-1,-1,0,347.00351,567.35686)" + id="g5650-2-0-4-3-8-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-8-9-3" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58-6-1" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1" + width="218.52127" + height="34.993004" + x="396.68301" + y="275.81555" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="506.2796" + y="297.7261" + id="text5371-43" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3" + x="506.2796" + y="297.7261">412 precondition failed</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="668.11926" + y="463.37662" + id="text5371-4-3-9-8" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-62-9-9" + x="668.11926" + y="463.37662">true</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="549.12921" + y="587.59863" + id="text5371-4-4-9-3" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-2" + x="549.12921" + y="587.59863">true*</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="651.74426" + y="628.87946" + id="text5371-2-391-5-5-1" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63-7-9-9" + x="651.74426" + y="628.87946">false</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-5-9" + width="218.52127" + height="34.993004" + x="396.68301" + y="605.41809" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="505.57257" + y="627.32867" + id="text5371-43-2-9" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-9-7" + x="505.57257" + y="627.32867">301 moved permanently</tspan></text> + <g + transform="translate(563.72619,353.12604)" + id="g5650-2-2-65"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-5" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-5" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,-1,0,1032.2004,811.50699)" + id="g5650-2-0-4-3-8-0-3-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-8-9-31-8-1" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58-6-3-6-3" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9-1" + width="210.17955" + height="35.209244" + x="400.85385" + y="687.83093" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="505.45535" + y="709.62695" + id="text5371-2-74-0-7" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2-8" + x="505.45535" + y="709.62695">moved_temporarily</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="549.12921" + y="752.64056" + id="text5371-4-4-9-3-2" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-2-6" + x="549.12921" + y="752.64056">true*</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="651.74426" + y="794.16199" + id="text5371-2-391-5-5-1-0" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63-7-9-9-2" + x="651.74426" + y="794.16199">false</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-5-9-2" + width="218.52127" + height="34.993004" + x="396.68301" + y="770.70062" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="505.57257" + y="792.61121" + id="text5371-43-2-9-7" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-9-7-8" + x="505.57257" + y="792.61121">307 moved temporarily</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-5-9-2-4" + width="218.52127" + height="34.993004" + x="396.68301" + y="853.22168" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="505.97882" + y="874.99164" + id="text5371-43-2-9-7-3" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-9-7-8-7" + x="505.97882" + y="874.99164">410 gone</tspan></text> + <g + transform="translate(31.619614,4.2328831)" + id="g5650-2-2-6"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-6" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-1" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="178.57137" + y="505.21829" + id="text5371-4-6-0" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-0-9" + x="178.57137" + y="505.21829">false</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-8-7" + width="218.52127" + height="34.993004" + x="99.803589" + y="522.89716" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="209.20485" + y="544.80774" + id="text5371-43-3-1" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-1-5" + x="209.20485" + y="544.80774">202 accepted</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-8-5" + width="218.52127" + height="34.993004" + x="99.803589" + y="687.69843" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="208.6736" + y="711.01917" + id="text5371-43-3-9" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-1-8" + x="208.6736" + y="711.01917">204 no content</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="47.338913" + y="711.15979" + id="text5371-4-6-0-4" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-0-9-4" + x="47.338913" + y="711.15979">true</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="30.901413" + y="545.89758" + id="text5371-2-391-6" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63-9" + x="30.901413" + y="545.89758">true</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-8-7-1" + width="218.52127" + height="34.993004" + x="99.803589" + y="357.85529" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="208.45485" + y="381.31662" + id="text5371-43-3-1-2" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-1-5-9" + x="208.45485" + y="381.31662">500 internal server error</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="159.54012" + y="340.17645" + id="text5371-2-8-9-0" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3-4-4" + x="159.54012" + y="340.17645">false</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="47.338913" + y="380.85568" + id="text5371-4-4-9-2" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-1" + x="47.338913" + y="380.85568">true</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="159.54012" + y="670.13989" + id="text5371-2-391-6-3" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63-9-1" + x="159.54012" + y="670.13989">false</tspan></text> + </g> +</svg> diff --git a/docs/en/cowboy/2.6/guide/rest_flowcharts.asciidoc b/docs/en/cowboy/2.6/guide/rest_flowcharts.asciidoc new file mode 100644 index 00000000..b5697825 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_flowcharts.asciidoc @@ -0,0 +1,248 @@ +[[rest_flowcharts]] +== REST flowcharts + +This chapter will explain the REST handler state machine through +a number of different diagrams. + +There are four main paths that requests may follow. One for the +method OPTIONS; one for the methods GET and HEAD; one for the +methods PUT, POST and PATCH; and one for the method DELETE. + +All paths start with the "Start" diagram, and all paths excluding +the OPTIONS path go through the "Content negotiation" diagram +and optionally the "Conditional requests" diagram if the resource +exists. + +The red squares refer to another diagram. The light green squares +indicate a response. Other squares may be either a callback or a +question answered by Cowboy itself. Green arrows tend to indicate +the default behavior if the callback is undefined. + +=== Start + +All requests start from here. + +image::rest_start.png[REST starting flowchart] + +A series of callbacks are called in succession to perform +a general checkup of the service, the request line and +request headers. + +The request body, if any, is not expected to have been +received for any of these steps. It is only processed +at the end of the "PUT, POST and PATCH methods" diagram, +when all conditions have been met. + +The `known_methods` and `allowed_methods` callbacks +return a list of methods. Cowboy then checks if the request +method is in the list, and stops otherwise. + +The `is_authorized` callback may be used to check that +access to the resource is authorized. Authentication +may also be performed as needed. When authorization is +denied, the return value from the callback must include +a challenge applicable to the requested resource, which +will be sent back to the client in the www-authenticate +header. + +This diagram is immediately followed by either the +"OPTIONS method" diagram when the request method is +OPTIONS, or the "Content negotiation" diagram otherwise. + +=== OPTIONS method + +This diagram only applies to OPTIONS requests. + +image::rest_options.png[REST OPTIONS method flowchart] + +The `options` callback may be used to add information +about the resource, such as media types or languages +provided; allowed methods; any extra information. A +response body may also be set, although clients should +not be expected to read it. + +If the `options` callback is not defined, Cowboy will +send a response containing the list of allowed methods +by default. + +=== Content negotiation + +This diagram applies to all request methods other than +OPTIONS. It is executed right after the "Start" diagram +is completed. + +image::rest_conneg.png[REST content negotiation flowchart] + +The purpose of these steps is to determine an appropriate +representation to be sent back to the client. + +The request may contain any of the accept header; the +accept-language header; or the accept-charset header. +When present, Cowboy will parse the headers and then +call the corresponding callback to obtain the list +of provided content-type, language or charset for this +resource. It then automatically select the best match +based on the request. + +If a callback is not defined, Cowboy will select the +content-type, language or charset that the client +prefers. + +The `content_types_provided` also returns the name of +a callback for every content-type it accepts. This +callback will only be called at the end of the +"GET and HEAD methods" diagram, when all conditions +have been met. + +The selected content-type, language and charset are +saved as meta values in the Req object. You *should* +use the appropriate representation if you set a +response body manually (alongside an error code, +for example). + +This diagram is immediately followed by +the "GET and HEAD methods" diagram, +the "PUT, POST and PATCH methods" diagram, +or the "DELETE method" diagram, depending on the +method. + +=== GET and HEAD methods + +This diagram only applies to GET and HEAD requests. + +For a description of the `cond` step, please see +the "Conditional requests" diagram. + +image::rest_get_head.png[REST GET/HEAD methods flowchart] + +When the resource exists, and the conditional steps +succeed, the resource can be retrieved. + +Cowboy prepares the response by first retrieving +metadata about the representation, then by calling +the `ProvideResource` callback. This is the callback +you defined for each content-types you returned from +`content_types_provided`. This callback returns the body +that will be sent back to the client, or a fun if the +body must be streamed. + +When the resource does not exist, Cowboy will figure out +whether the resource existed previously, and if so whether +it was moved elsewhere in order to redirect the client to +the new URI. + +The `moved_permanently` and `moved_temporarily` callbacks +must return the new location of the resource if it was in +fact moved. + +=== PUT, POST and PATCH methods + +This diagram only applies to PUT, POST and PATCH requests. + +For a description of the `cond` step, please see +the "Conditional requests" diagram. + +image::rest_put_post_patch.png[REST PUT/POST/PATCH methods flowchart] + +When the resource exists, first the conditional steps +are executed. When that succeeds, and the method is PUT, +Cowboy will call the `is_conflict` callback. This function +can be used to prevent potential race conditions, by locking +the resource for example. + +Then all three methods reach the `content_types_accepted` +step that we will describe in a few paragraphs. + +When the resource does not exist, and the method is PUT, +Cowboy will check for conflicts and then move on to the +`content_types_accepted` step. For other methods, Cowboy +will figure out whether the resource existed previously, +and if so whether it was moved elsewhere. If the resource +is truly non-existent, the method is POST and the call +for `allow_missing_post` returns `true`, then Cowboy will +move on to the `content_types_accepted` step. Otherwise +the request processing ends there. + +The `moved_permanently` and `moved_temporarily` callbacks +must return the new location of the resource if it was in +fact moved. + +The `content_types_accepted` returns a list of +content-types it accepts, but also the name of a callback +for each of them. Cowboy will select the appropriate +callback for processing the request body and call it. + +This callback may return one of three different return +values. + +If an error occurred while processing the request body, +it must return `false` and Cowboy will send an +appropriate error response. + +If the method is POST, then you may return `true` with +an URI of where the resource has been created. This is +especially useful for writing handlers for collections. + +Otherwise, return `true` to indicate success. Cowboy +will select the appropriate response to be sent depending +on whether a resource has been created, rather than +modified, and on the availability of a location header +or a body in the response. + +=== DELETE method + +This diagram only applies to DELETE requests. + +For a description of the `cond` step, please see +the "Conditional requests" diagram. + +image::rest_delete.png[REST DELETE method flowchart] + +When the resource exists, and the conditional steps +succeed, the resource can be deleted. + +Deleting the resource is a two steps process. First +the callback `delete_resource` is executed. Use this +callback to delete the resource. + +Because the resource may be cached, you must also +delete all cached representations of this resource +in the system. This operation may take a while though, +so you may return before it finished. + +Cowboy will then call the `delete_completed` callback. +If you know that the resource has been completely +deleted from your system, including from caches, then +you can return `true`. If any doubts persist, return +`false`. Cowboy will assume `true` by default. + +To finish, Cowboy checks if you set a response body, +and depending on that, sends the appropriate response. + +When the resource does not exist, Cowboy will figure out +whether the resource existed previously, and if so whether +it was moved elsewhere in order to redirect the client to +the new URI. + +The `moved_permanently` and `moved_temporarily` callbacks +must return the new location of the resource if it was in +fact moved. + +=== Conditional requests + +This diagram applies to all request methods other than +OPTIONS. It is executed right after the `resource_exists` +callback, when the resource exists. + +image::rest_cond.png[REST conditional requests flowchart] + +A request becomes conditional when it includes either of +the if-match header; the if-unmodified-since header; the +if-none-match header; or the if-modified-since header. + +If the condition fails, the request ends immediately +without any retrieval or modification of the resource. + +The `generate_etag` and `last_modified` are called as +needed. Cowboy will only call them once and then cache +the results for subsequent use. diff --git a/docs/en/cowboy/2.6/guide/rest_flowcharts/index.html b/docs/en/cowboy/2.6/guide/rest_flowcharts/index.html new file mode 100644 index 00000000..6e855fc5 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_flowcharts/index.html @@ -0,0 +1,226 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: REST flowcharts</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>REST flowcharts</span></h1> + +<p>This chapter will explain the REST handler state machine through a number of different diagrams.</p> +<p>There are four main paths that requests may follow. One for the method OPTIONS; one for the methods GET and HEAD; one for the methods PUT, POST and PATCH; and one for the method DELETE.</p> +<p>All paths start with the "Start" diagram, and all paths excluding the OPTIONS path go through the "Content negotiation" diagram and optionally the "Conditional requests" diagram if the resource exists.</p> +<p>The red squares refer to another diagram. The light green squares indicate a response. Other squares may be either a callback or a question answered by Cowboy itself. Green arrows tend to indicate the default behavior if the callback is undefined.</p> +<h2 id="_start">Start</h2> +<p>All requests start from here.</p> +<img src="../rest_start.png" alt="REST starting flowchart"/><p>A series of callbacks are called in succession to perform a general checkup of the service, the request line and request headers.</p> +<p>The request body, if any, is not expected to have been received for any of these steps. It is only processed at the end of the "PUT, POST and PATCH methods" diagram, when all conditions have been met.</p> +<p>The <code>known_methods</code> and <code>allowed_methods</code> callbacks return a list of methods. Cowboy then checks if the request method is in the list, and stops otherwise.</p> +<p>The <code>is_authorized</code> callback may be used to check that access to the resource is authorized. Authentication may also be performed as needed. When authorization is denied, the return value from the callback must include a challenge applicable to the requested resource, which will be sent back to the client in the www-authenticate header.</p> +<p>This diagram is immediately followed by either the "OPTIONS method" diagram when the request method is OPTIONS, or the "Content negotiation" diagram otherwise.</p> +<h2 id="_options_method">OPTIONS method</h2> +<p>This diagram only applies to OPTIONS requests.</p> +<img src="../rest_options.png" alt="REST OPTIONS method flowchart"/><p>The <code>options</code> callback may be used to add information about the resource, such as media types or languages provided; allowed methods; any extra information. A response body may also be set, although clients should not be expected to read it.</p> +<p>If the <code>options</code> callback is not defined, Cowboy will send a response containing the list of allowed methods by default.</p> +<h2 id="_content_negotiation">Content negotiation</h2> +<p>This diagram applies to all request methods other than OPTIONS. It is executed right after the "Start" diagram is completed.</p> +<img src="../rest_conneg.png" alt="REST content negotiation flowchart"/><p>The purpose of these steps is to determine an appropriate representation to be sent back to the client.</p> +<p>The request may contain any of the accept header; the accept-language header; or the accept-charset header. When present, Cowboy will parse the headers and then call the corresponding callback to obtain the list of provided content-type, language or charset for this resource. It then automatically select the best match based on the request.</p> +<p>If a callback is not defined, Cowboy will select the content-type, language or charset that the client prefers.</p> +<p>The <code>content_types_provided</code> also returns the name of a callback for every content-type it accepts. This callback will only be called at the end of the "GET and HEAD methods" diagram, when all conditions have been met.</p> +<p>The selected content-type, language and charset are saved as meta values in the Req object. You <strong>should</strong> use the appropriate representation if you set a response body manually (alongside an error code, for example).</p> +<p>This diagram is immediately followed by the "GET and HEAD methods" diagram, the "PUT, POST and PATCH methods" diagram, or the "DELETE method" diagram, depending on the method.</p> +<h2 id="_get_and_head_methods">GET and HEAD methods</h2> +<p>This diagram only applies to GET and HEAD requests.</p> +<p>For a description of the <code>cond</code> step, please see the "Conditional requests" diagram.</p> +<img src="../rest_get_head.png" alt="REST GET/HEAD methods flowchart"/><p>When the resource exists, and the conditional steps succeed, the resource can be retrieved.</p> +<p>Cowboy prepares the response by first retrieving metadata about the representation, then by calling the <code>ProvideResource</code> callback. This is the callback you defined for each content-types you returned from <code>content_types_provided</code>. This callback returns the body that will be sent back to the client, or a fun if the body must be streamed.</p> +<p>When the resource does not exist, Cowboy will figure out whether the resource existed previously, and if so whether it was moved elsewhere in order to redirect the client to the new URI.</p> +<p>The <code>moved_permanently</code> and <code>moved_temporarily</code> callbacks must return the new location of the resource if it was in fact moved.</p> +<h2 id="_put__post_and_patch_methods">PUT, POST and PATCH methods</h2> +<p>This diagram only applies to PUT, POST and PATCH requests.</p> +<p>For a description of the <code>cond</code> step, please see the "Conditional requests" diagram.</p> +<img src="../rest_put_post_patch.png" alt="REST PUT/POST/PATCH methods flowchart"/><p>When the resource exists, first the conditional steps are executed. When that succeeds, and the method is PUT, Cowboy will call the <code>is_conflict</code> callback. This function can be used to prevent potential race conditions, by locking the resource for example.</p> +<p>Then all three methods reach the <code>content_types_accepted</code> step that we will describe in a few paragraphs.</p> +<p>When the resource does not exist, and the method is PUT, Cowboy will check for conflicts and then move on to the <code>content_types_accepted</code> step. For other methods, Cowboy will figure out whether the resource existed previously, and if so whether it was moved elsewhere. If the resource is truly non-existent, the method is POST and the call for <code>allow_missing_post</code> returns <code>true</code>, then Cowboy will move on to the <code>content_types_accepted</code> step. Otherwise the request processing ends there.</p> +<p>The <code>moved_permanently</code> and <code>moved_temporarily</code> callbacks must return the new location of the resource if it was in fact moved.</p> +<p>The <code>content_types_accepted</code> returns a list of content-types it accepts, but also the name of a callback for each of them. Cowboy will select the appropriate callback for processing the request body and call it.</p> +<p>This callback may return one of three different return values.</p> +<p>If an error occurred while processing the request body, it must return <code>false</code> and Cowboy will send an appropriate error response.</p> +<p>If the method is POST, then you may return <code>true</code> with an URI of where the resource has been created. This is especially useful for writing handlers for collections.</p> +<p>Otherwise, return <code>true</code> to indicate success. Cowboy will select the appropriate response to be sent depending on whether a resource has been created, rather than modified, and on the availability of a location header or a body in the response.</p> +<h2 id="_delete_method">DELETE method</h2> +<p>This diagram only applies to DELETE requests.</p> +<p>For a description of the <code>cond</code> step, please see the "Conditional requests" diagram.</p> +<img src="../rest_delete.png" alt="REST DELETE method flowchart"/><p>When the resource exists, and the conditional steps succeed, the resource can be deleted.</p> +<p>Deleting the resource is a two steps process. First the callback <code>delete_resource</code> is executed. Use this callback to delete the resource.</p> +<p>Because the resource may be cached, you must also delete all cached representations of this resource in the system. This operation may take a while though, so you may return before it finished.</p> +<p>Cowboy will then call the <code>delete_completed</code> callback. If you know that the resource has been completely deleted from your system, including from caches, then you can return <code>true</code>. If any doubts persist, return <code>false</code>. Cowboy will assume <code>true</code> by default.</p> +<p>To finish, Cowboy checks if you set a response body, and depending on that, sends the appropriate response.</p> +<p>When the resource does not exist, Cowboy will figure out whether the resource existed previously, and if so whether it was moved elsewhere in order to redirect the client to the new URI.</p> +<p>The <code>moved_permanently</code> and <code>moved_temporarily</code> callbacks must return the new location of the resource if it was in fact moved.</p> +<h2 id="_conditional_requests">Conditional requests</h2> +<p>This diagram applies to all request methods other than OPTIONS. It is executed right after the <code>resource_exists</code> callback, when the resource exists.</p> +<img src="../rest_cond.png" alt="REST conditional requests flowchart"/><p>A request becomes conditional when it includes either of the if-match header; the if-unmodified-since header; the if-none-match header; or the if-modified-since header.</p> +<p>If the condition fails, the request ends immediately without any retrieval or modification of the resource.</p> +<p>The <code>generate_etag</code> and <code>last_modified</code> are called as needed. Cowboy will only call them once and then cache the results for subsequent use.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/rest_handlers/"> + REST handlers + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/resource_design/"> + Designing a resource handler + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/rest_get_head.png b/docs/en/cowboy/2.6/guide/rest_get_head.png Binary files differnew file mode 100644 index 00000000..211ab603 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_get_head.png diff --git a/docs/en/cowboy/2.6/guide/rest_get_head.svg b/docs/en/cowboy/2.6/guide/rest_get_head.svg new file mode 100644 index 00000000..92030cf3 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_get_head.svg @@ -0,0 +1,1523 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + xmlns:osb="http://www.openswatchbook.org/uri/2009/osb" + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="744.09448819" + height="1052.3622047" + id="svg2" + version="1.1" + inkscape:version="0.92.1 r" + sodipodi:docname="rest_get_head.svg" + inkscape:export-filename="/home/essen/Dropbox/Public/drawing.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <defs + id="defs4"> + <linearGradient + id="linearGradient5265"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5267" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.58823532;" + offset="1" + id="stop5269" /> + </linearGradient> + <linearGradient + id="linearGradient5251"> + <stop + style="stop-color:#69d2e7;stop-opacity:0.78431374;" + offset="0" + id="stop5253" /> + <stop + id="stop5263" + offset="0.5" + style="stop-color:#69d2e7;stop-opacity:1;" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.39215687;" + offset="1" + id="stop5255" /> + </linearGradient> + <linearGradient + id="linearGradient5233" + osb:paint="solid"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5235" /> + </linearGradient> + </defs> + <sodipodi:namedview + id="base" + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1.0" + inkscape:pageopacity="1" + inkscape:pageshadow="2" + inkscape:zoom="1.4142136" + inkscape:cx="353.51266" + inkscape:cy="522.73683" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="false" + inkscape:window-width="1920" + inkscape:window-height="1043" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="1" + inkscape:snap-global="true" + showguides="true"> + <inkscape:grid + type="xygrid" + id="grid5357" + empspacing="5" + visible="true" + enabled="true" + snapvisiblegridlinesonly="true" /> + </sodipodi:namedview> + <metadata + id="metadata7"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + <dc:title /> + </cc:Work> + </rdf:RDF> + </metadata> + <g + inkscape:label="Layer 1" + inkscape:groupmode="layer" + id="layer1"> + <path + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:connector-curvature="0" + id="use5777" + d="m -360.31658,371.70113 203.00246,0.045" + style="fill:none;stroke:#6d8e41;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:1.99999999, 3.99999998;stroke-dashoffset:0" /> + <g + transform="translate(416.63925,-305.0045)" + id="g5650-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-9" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-0" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(270.88515,-59.451492)" + id="g5650-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-5" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-1" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(270.88515,22.975441)" + id="g5650-94" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-71" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-5" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(270.88515,105.29639)" + id="g5650-93" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-3" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-4" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(270.88515,187.81342)" + id="g5650-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-93" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-04" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(270.88515,270.7128)" + id="g5650-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-78" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(270.88515,-141.93971)" + id="g5650-0-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-5-3" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-1-1" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-28" + width="210.17955" + height="35.209244" + x="108.01281" + y="275.4668" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-5" + width="210.17955" + height="35.209244" + x="108.01281" + y="357.98779" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8" + width="210.17955" + height="35.209244" + x="108.01281" + y="440.50873" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-4" + width="210.17955" + height="35.209244" + x="108.01281" + y="523.02966" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + transform="matrix(0,-1,1,0,-314.06239,730.23773)" + id="g5650-2-0-4-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-5" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-2" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-87" + width="210.17955" + height="35.209244" + x="108.01281" + y="605.5506" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + transform="matrix(0.70710678,-0.70710678,0.70710678,0.70710678,261.76354,-143.71473)" + id="g5650-2-2-8"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-4" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-3" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1" + width="210.17955" + height="35.209244" + x="253.76691" + y="112.69559" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + id="g5650" + transform="translate(0,-0.47597102)"> + <path + inkscape:connector-curvature="0" + id="path5570" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273" + width="104.5895" + height="36.392323" + x="-224.02068" + y="29.41218" + rx="15" /> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7" + width="104.5895" + height="36.392323" + x="-224.02068" + y="90.691978" + rx="15" /> + <rect + style="fill:#ffc48c;fill-opacity:1;fill-rule:nonzero;stroke:#d79c64;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-2" + width="104.5895" + height="36.392323" + x="-224.02068" + y="151.97169" + rx="15" /> + <rect + style="fill:#ff9f80;fill-opacity:1;fill-rule:nonzero;stroke:#d77758;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-22" + width="104.5895" + height="36.392323" + x="-224.02068" + y="213.25146" + rx="15" /> + <rect + style="fill:#f56991;fill-opacity:1;fill-rule:nonzero;stroke:#cd4169;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-8" + width="104.5895" + height="36.392323" + x="-224.02068" + y="274.53128" + rx="15" /> + <use + x="0" + y="0" + xlink:href="#rect5273-22" + id="use5355" + transform="translate(530.58261,-183.7816)" + width="744.09448" + height="1052.3622" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="-58.692513" + y="114.39204" + id="text5371"><tspan + sodipodi:role="line" + id="tspan5373" + x="-58.692513" + y="114.39204" + style="font-size:16px;line-height:1.25;font-family:sans-serif">some text</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="-58.692513" + y="53.112247" + id="text5371-2"><tspan + sodipodi:role="line" + id="tspan5373-6" + x="-58.692513" + y="53.112247" + style="font-size:16px;line-height:1.25;font-family:sans-serif">some text</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="213.07524" + y="379.78381" + id="text5371-2-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7" + x="213.07524" + y="379.78381" + style="font-size:16px;line-height:1.25;font-family:sans-serif">last_modified</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="212.74321" + y="546.59912" + id="text5371-2-3-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7-3" + x="212.74321" + y="546.59912" + style="font-size:16px;line-height:1.25;font-family:sans-serif">ProvideCallback</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="-58.692513" + y="236.95154" + id="text5371-4"><tspan + sodipodi:role="line" + id="tspan5373-9" + x="-58.692513" + y="236.95154" + style="font-size:16px;line-height:1.25;font-family:sans-serif">some text</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="359.14185" + y="50.482433" + id="text5371-4-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + x="359.14185" + y="50.482433" + id="tspan17171" + style="font-size:16px;line-height:1.25;font-family:sans-serif">conneg</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="212.77055" + y="627.34662" + id="text5371-2-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-8" + x="212.77055" + y="627.34662" + style="font-size:16px;line-height:1.25;font-family:sans-serif">multiple_choices</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="358.52466" + y="134.49161" + id="text5371-2-95" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-80" + x="358.52466" + y="134.49161" + style="font-size:16px;line-height:1.25;font-family:sans-serif">resource_exists</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="213.38774" + y="296.80188" + id="text5371-2-32" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-27" + x="213.38774" + y="296.80188" + style="font-size:16px;line-height:1.25;font-family:sans-serif">generate_etag</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="213.05571" + y="462.5274" + id="text5371-2-74" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18" + x="213.05571" + y="462.5274" + style="font-size:16px;line-height:1.25;font-family:sans-serif">expires</tspan></text> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-2" + width="210.17955" + height="35.209244" + x="-489.75586" + y="33.4944" + rx="15" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="251.83722" + y="175.92931" + id="text5371-2-391" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63" + x="251.83722" + y="175.92931" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="161.54012" + y="670.38055" + id="text5371-2-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3" + x="161.54012" + y="670.38055" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <g + transform="matrix(0,-1,1,0,-513.31414,353.05561)" + id="g5650-2"> + <path + inkscape:connector-curvature="0" + id="path5570-2" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="447.26678" + y="176.39024" + id="text5371-4-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-0" + x="447.26678" + y="176.39024" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <g + transform="translate(563.72619,-141.76777)" + id="g5650-2-2"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:2.44279909;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5367" + width="207.05719" + height="171.55719" + x="-373.52859" + y="458.58362" + rx="11.072577" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="-544.69421" + y="-354.17184" + id="text5371-2-3-0-7" + transform="rotate(-90)" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7-3-9" + x="-544.69421" + y="-354.17184" + style="font-size:16px;line-height:1.25;font-family:sans-serif">middlewares</tspan></text> + <g + transform="matrix(0,-1,1,0,-508.93096,565.23553)" + id="g5650-2-0-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="46.409981" + y="711.18011" + id="text5371-4-3-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-62-9" + x="46.409981" + y="711.18011" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="545.12921" + y="257.43518" + id="text5371-4-4-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6" + x="545.12921" + y="257.43518" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <g + transform="matrix(0.70710678,0.70710678,-0.70710678,0.70710678,547.47379,-62.310424)" + id="g5650-9-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-7-6" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-09-5" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <use + x="0" + y="0" + xlink:href="#rect5273-22" + id="use5355-0" + transform="translate(384.82851,-20.897068)" + width="744.09448" + height="1052.3622" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="213.38774" + y="216.5154" + id="text5371-4-0-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + x="213.38774" + y="216.5154" + id="tspan17171-6" + style="font-size:16px;line-height:1.25;font-family:sans-serif">cond</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-1" + width="218.52127" + height="34.993004" + x="103.84195" + y="770.70062" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="212.88774" + y="792.61121" + id="text5371-43-5" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-62" + x="212.88774" + y="792.61121" + style="font-size:16px;line-height:1.25;font-family:sans-serif">300 multiple choices</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-8" + width="218.52127" + height="34.993004" + x="103.84195" + y="688.17969" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="212.35258" + y="711.50043" + id="text5371-43-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-1" + x="212.35258" + y="711.50043" + style="font-size:16px;line-height:1.25;font-family:sans-serif">200 OK</tspan></text> + <g + transform="matrix(0,-1,-1,0,1028.2004,317.70407)" + id="g5650-2-0-4-3-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-8-9" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58-6" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-28-4" + width="210.17955" + height="35.209244" + x="400.85385" + y="192.94594" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="505.77957" + y="216.51541" + id="text5371-2-32-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-27-8" + x="505.77957" + y="216.51541" + style="font-size:16px;line-height:1.25;font-family:sans-serif">has if-match?</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="651.74426" + y="299.27689" + id="text5371-2-391-5" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63-7" + x="651.74426" + y="299.27689" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <g + transform="translate(563.72619,22.800669)" + id="g5650-0-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-5-7" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-1-3" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,-1,0,1027.6701,482.30508)" + id="g5650-2-0-4-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-8" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-28-7" + width="210.17955" + height="35.209244" + x="400.85385" + y="357.98779" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="505.94363" + y="379.78381" + id="text5371-2-32-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-27-1" + x="505.94363" + y="379.78381" + style="font-size:16px;line-height:1.25;font-family:sans-serif">previously_existed</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-5" + width="218.52127" + height="34.993004" + x="396.68301" + y="440.37622" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="506.2796" + y="463.83755" + id="text5371-43-2" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-9" + x="506.2796" + y="463.83755" + style="font-size:16px;line-height:1.25;font-family:sans-serif">404 not found</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="528.75421" + y="422.69736" + id="text5371-2-8-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3-4" + x="528.75421" + y="422.69736" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <g + transform="translate(563.72619,187.85116)" + id="g5650-2-2-17"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-0" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-45" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,-1,0,1027.4933,646.81763)" + id="g5650-2-0-4-3-8-0-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-8-9-31-8" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58-6-3-6" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9" + width="210.17955" + height="35.209244" + x="400.85385" + y="523.02966" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="505.45535" + y="544.82568" + id="text5371-2-74-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2" + x="505.45535" + y="544.82568" + style="font-size:16px;line-height:1.25;font-family:sans-serif">moved_permanently</tspan></text> + <g + transform="matrix(0,-1,-1,0,347.00351,567.35686)" + id="g5650-2-0-4-3-8-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-8-9-3" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58-6-1" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1" + width="218.52127" + height="34.993004" + x="396.68301" + y="275.81555" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="506.2796" + y="297.7261" + id="text5371-43" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3" + x="506.2796" + y="297.7261" + style="font-size:16px;line-height:1.25;font-family:sans-serif">412 precondition failed</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="668.11926" + y="463.37662" + id="text5371-4-3-9-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-62-9-9" + x="668.11926" + y="463.37662" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="549.12921" + y="587.59863" + id="text5371-4-4-9-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-2" + x="549.12921" + y="587.59863" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true*</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="651.74426" + y="628.87946" + id="text5371-2-391-5-5-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63-7-9-9" + x="651.74426" + y="628.87946" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-5-9" + width="218.52127" + height="34.993004" + x="396.68301" + y="605.41809" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="505.57257" + y="627.32867" + id="text5371-43-2-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-9-7" + x="505.57257" + y="627.32867" + style="font-size:16px;line-height:1.25;font-family:sans-serif">301 moved permanently</tspan></text> + <g + transform="translate(563.72619,353.12604)" + id="g5650-2-2-65"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-5" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-5" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,-1,0,1032.2004,811.50699)" + id="g5650-2-0-4-3-8-0-3-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-8-9-31-8-1" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58-6-3-6-3" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9-1" + width="210.17955" + height="35.209244" + x="400.85385" + y="687.83093" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="505.45535" + y="709.62695" + id="text5371-2-74-0-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2-8" + x="505.45535" + y="709.62695" + style="font-size:16px;line-height:1.25;font-family:sans-serif">moved_temporarily</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="549.12921" + y="752.64056" + id="text5371-4-4-9-3-2" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-2-6" + x="549.12921" + y="752.64056" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true*</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="651.74426" + y="794.16199" + id="text5371-2-391-5-5-1-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63-7-9-9-2" + x="651.74426" + y="794.16199" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-5-9-2" + width="218.52127" + height="34.993004" + x="396.68301" + y="770.70062" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="505.57257" + y="792.61121" + id="text5371-43-2-9-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-9-7-8" + x="505.57257" + y="792.61121" + style="font-size:16px;line-height:1.25;font-family:sans-serif">307 moved temporarily</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-5-9-2-4" + width="218.52127" + height="34.993004" + x="396.68301" + y="853.22168" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="505.97882" + y="874.99164" + id="text5371-43-2-9-7-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-9-7-8-7" + x="505.97882" + y="874.99164" + style="font-size:16px;line-height:1.25;font-family:sans-serif">410 gone</tspan></text> + <g + transform="translate(31.619614,4.2328831)" + id="g5650-2-2-6"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-6" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-1" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + </g> +</svg> diff --git a/docs/en/cowboy/2.6/guide/rest_handlers.asciidoc b/docs/en/cowboy/2.6/guide/rest_handlers.asciidoc new file mode 100644 index 00000000..baf8e6a2 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_handlers.asciidoc @@ -0,0 +1,139 @@ +[[rest_handlers]] +== REST handlers + +REST is implemented in Cowboy as a sub protocol. The request +is handled as a state machine with many optional callbacks +describing the resource and modifying the machine's behavior. + +The REST handler is the recommended way to handle HTTP requests. + +=== Initialization + +First, the `init/2` callback is called. This callback is common +to all handlers. To use REST for the current request, this function +must return a `cowboy_rest` tuple. + +[source,erlang] +---- +init(Req, State) -> + {cowboy_rest, Req, State}. +---- + +Cowboy will then switch to the REST protocol and start executing +the state machine. + +After reaching the end of the flowchart, the `terminate/3` callback +will be called if it is defined. + +=== Methods + +The REST component has code for handling the following HTTP methods: +HEAD, GET, POST, PATCH, PUT, DELETE and OPTIONS. + +Other methods can be accepted, however they have no specific callback +defined for them at this time. + +=== Callbacks + +All callbacks are optional. Some may become mandatory depending +on what other defined callbacks return. The various flowcharts +in the next chapter should be a useful to determine which callbacks +you need. + +All callbacks take two arguments, the Req object and the State, +and return a three-element tuple of the form `{Value, Req, State}`. + +Nearly all callbacks can also return `{stop, Req, State}` to +stop execution of the request, and +`{{switch_handler, Module}, Req, State}` or +`{{switch_handler, Module, Opts}, Req, State}` to switch to +a different handler type. The exceptions are `expires` +`generate_etag`, `last_modified` and `variances`. + +The following table summarizes the callbacks and their default values. +If the callback isn't defined, then the default value will be used. +Please look at the flowcharts to find out the result of each return +value. + +In the following table, "skip" means the callback is entirely skipped +if it is undefined, moving directly to the next step. Similarly, +"none" means there is no default value for this callback. + +[cols="<,^",options="header"] +|=== +| Callback name | Default value +| allowed_methods | `[<<"GET">>, <<"HEAD">>, <<"OPTIONS">>]` +| allow_missing_post | `true` +| charsets_provided | skip +| content_types_accepted | none +// @todo Space required for the time being: https://github.com/spf13/hugo/issues/2398 +| content_types_provided | `[{{ <<"text">>, <<"html">>, '*'}, to_html}]` +| delete_completed | `true` +| delete_resource | `false` +| expires | `undefined` +| forbidden | `false` +| generate_etag | `undefined` +| is_authorized | `true` +| is_conflict | `false` +| known_methods | `[<<"GET">>, <<"HEAD">>, <<"POST">>, <<"PUT">>, <<"PATCH">>, <<"DELETE">>, <<"OPTIONS">>]` +| languages_provided | skip +| last_modified | `undefined` +| malformed_request | `false` +| moved_permanently | `false` +| moved_temporarily | `false` +| multiple_choices | `false` +| options | `ok` +| previously_existed | `false` +| rate_limited | `false` +| resource_exists | `true` +| service_available | `true` +| uri_too_long | `false` +| valid_content_headers | `true` +| valid_entity_length | `true` +| variances | `[]` +|=== + +As you can see, Cowboy tries to move on with the request whenever +possible by using well thought out default values. + +In addition to these, there can be any number of user-defined +callbacks that are specified through `content_types_accepted/2` +and `content_types_provided/2`. They can take any name, however +it is recommended to use a separate prefix for the callbacks of +each function. For example, `from_html` and `to_html` indicate +in the first case that we're accepting a resource given as HTML, +and in the second case that we send one as HTML. + +=== Meta data + +Cowboy will set informative values to the Req object at various +points of the execution. You can retrieve them by matching the +Req object directly. The values are defined in the following table: + +[cols="<,<",options="header"] +|=== +| Key | Details +| media_type | The content-type negotiated for the response entity. +| language | The language negotiated for the response entity. +| charset | The charset negotiated for the response entity. +|=== + +They can be used to send a proper body with the response to a +request that used a method other than HEAD or GET. + +=== Response headers + +Cowboy will set response headers automatically over the execution +of the REST code. They are listed in the following table. + +[cols="<,<",options="header"] +|=== +| Header name | Details +| content-language | Language used in the response body +| content-type | Media type and charset of the response body +| etag | Etag of the resource +| expires | Expiration date of the resource +| last-modified | Last modification date for the resource +| location | Relative or absolute URI to the requested resource +| vary | List of headers that may change the representation of the resource +|=== diff --git a/docs/en/cowboy/2.6/guide/rest_handlers/index.html b/docs/en/cowboy/2.6/guide/rest_handlers/index.html new file mode 100644 index 00000000..1a528bc8 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_handlers/index.html @@ -0,0 +1,327 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: REST handlers</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>REST handlers</span></h1> + +<p>REST is implemented in Cowboy as a sub protocol. The request is handled as a state machine with many optional callbacks describing the resource and modifying the machine's behavior.</p> +<p>The REST handler is the recommended way to handle HTTP requests.</p> +<h2 id="_initialization">Initialization</h2> +<p>First, the <code>init/2</code> callback is called. This callback is common to all handlers. To use REST for the current request, this function must return a <code>cowboy_rest</code> tuple.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">cowboy_rest</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>Cowboy will then switch to the REST protocol and start executing the state machine.</p> +<p>After reaching the end of the flowchart, the <code>terminate/3</code> callback will be called if it is defined.</p> +<h2 id="_methods">Methods</h2> +<p>The REST component has code for handling the following HTTP methods: HEAD, GET, POST, PATCH, PUT, DELETE and OPTIONS.</p> +<p>Other methods can be accepted, however they have no specific callback defined for them at this time.</p> +<h2 id="_callbacks">Callbacks</h2> +<p>All callbacks are optional. Some may become mandatory depending on what other defined callbacks return. The various flowcharts in the next chapter should be a useful to determine which callbacks you need.</p> +<p>All callbacks take two arguments, the Req object and the State, and return a three-element tuple of the form <code>{Value, Req, State}</code>.</p> +<p>Nearly all callbacks can also return <code>{stop, Req, State}</code> to stop execution of the request, and <code>{{switch_handler, Module}, Req, State}</code> or <code>{{switch_handler, Module, Opts}, Req, State}</code> to switch to a different handler type. The exceptions are <code>expires</code> <code>generate_etag</code>, <code>last_modified</code> and <code>variances</code>.</p> +<p>The following table summarizes the callbacks and their default values. If the callback isn't defined, then the default value will be used. Please look at the flowcharts to find out the result of each return value.</p> +<p>In the following table, "skip" means the callback is entirely skipped if it is undefined, moving directly to the next step. Similarly, "none" means there is no default value for this callback.</p> +<table rules="all" width="100%" frame="border" + cellspacing="0" cellpadding="4"> +<thead><tr><th>Callback name</th> +<th>Default value</th> +</tr></thead><tbody><tr><td>allowed_methods</td> +<td><code>[<<"GET">>, <<"HEAD">>, <<"OPTIONS">>]</code></td> +</tr> +<tr><td>allow_missing_post</td> +<td><code>true</code></td> +</tr> +<tr><td>charsets_provided</td> +<td>skip</td> +</tr> +<tr><td>content_types_accepted</td> +<td>none</td> +</tr> +<tr><td>content_types_provided</td> +<td><code>[{{ <<"text">>, <<"html">>, '*'}, to_html}]</code></td> +</tr> +<tr><td>delete_completed</td> +<td><code>true</code></td> +</tr> +<tr><td>delete_resource</td> +<td><code>false</code></td> +</tr> +<tr><td>expires</td> +<td><code>undefined</code></td> +</tr> +<tr><td>forbidden</td> +<td><code>false</code></td> +</tr> +<tr><td>generate_etag</td> +<td><code>undefined</code></td> +</tr> +<tr><td>is_authorized</td> +<td><code>true</code></td> +</tr> +<tr><td>is_conflict</td> +<td><code>false</code></td> +</tr> +<tr><td>known_methods</td> +<td><code>[<<"GET">>, <<"HEAD">>, <<"POST">>, <<"PUT">>, <<"PATCH">>, <<"DELETE">>, <<"OPTIONS">>]</code></td> +</tr> +<tr><td>languages_provided</td> +<td>skip</td> +</tr> +<tr><td>last_modified</td> +<td><code>undefined</code></td> +</tr> +<tr><td>malformed_request</td> +<td><code>false</code></td> +</tr> +<tr><td>moved_permanently</td> +<td><code>false</code></td> +</tr> +<tr><td>moved_temporarily</td> +<td><code>false</code></td> +</tr> +<tr><td>multiple_choices</td> +<td><code>false</code></td> +</tr> +<tr><td>options</td> +<td><code>ok</code></td> +</tr> +<tr><td>previously_existed</td> +<td><code>false</code></td> +</tr> +<tr><td>rate_limited</td> +<td><code>false</code></td> +</tr> +<tr><td>resource_exists</td> +<td><code>true</code></td> +</tr> +<tr><td>service_available</td> +<td><code>true</code></td> +</tr> +<tr><td>uri_too_long</td> +<td><code>false</code></td> +</tr> +<tr><td>valid_content_headers</td> +<td><code>true</code></td> +</tr> +<tr><td>valid_entity_length</td> +<td><code>true</code></td> +</tr> +<tr><td>variances</td> +<td><code>[]</code></td> +</tr> +</tbody></table> +<p>As you can see, Cowboy tries to move on with the request whenever possible by using well thought out default values.</p> +<p>In addition to these, there can be any number of user-defined callbacks that are specified through <code>content_types_accepted/2</code> and <code>content_types_provided/2</code>. They can take any name, however it is recommended to use a separate prefix for the callbacks of each function. For example, <code>from_html</code> and <code>to_html</code> indicate in the first case that we're accepting a resource given as HTML, and in the second case that we send one as HTML.</p> +<h2 id="_meta_data">Meta data</h2> +<p>Cowboy will set informative values to the Req object at various points of the execution. You can retrieve them by matching the Req object directly. The values are defined in the following table:</p> +<table rules="all" width="100%" frame="border" + cellspacing="0" cellpadding="4"> +<thead><tr><th>Key</th> +<th>Details</th> +</tr></thead><tbody><tr><td>media_type</td> +<td>The content-type negotiated for the response entity.</td> +</tr> +<tr><td>language</td> +<td>The language negotiated for the response entity.</td> +</tr> +<tr><td>charset</td> +<td>The charset negotiated for the response entity.</td> +</tr> +</tbody></table> +<p>They can be used to send a proper body with the response to a request that used a method other than HEAD or GET.</p> +<h2 id="_response_headers">Response headers</h2> +<p>Cowboy will set response headers automatically over the execution of the REST code. They are listed in the following table.</p> +<table rules="all" width="100%" frame="border" + cellspacing="0" cellpadding="4"> +<thead><tr><th>Header name</th> +<th>Details</th> +</tr></thead><tbody><tr><td>content-language</td> +<td>Language used in the response body</td> +</tr> +<tr><td>content-type</td> +<td>Media type and charset of the response body</td> +</tr> +<tr><td>etag</td> +<td>Etag of the resource</td> +</tr> +<tr><td>expires</td> +<td>Expiration date of the resource</td> +</tr> +<tr><td>last-modified</td> +<td>Last modification date for the resource</td> +</tr> +<tr><td>location</td> +<td>Relative or absolute URI to the requested resource</td> +</tr> +<tr><td>vary</td> +<td>List of headers that may change the representation of the resource</td> +</tr> +</tbody></table> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/rest_principles/"> + REST principles + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/rest_flowcharts/"> + REST flowcharts + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/rest_options.png b/docs/en/cowboy/2.6/guide/rest_options.png Binary files differnew file mode 100644 index 00000000..90fd6f06 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_options.png diff --git a/docs/en/cowboy/2.6/guide/rest_options.svg b/docs/en/cowboy/2.6/guide/rest_options.svg new file mode 100644 index 00000000..496c050c --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_options.svg @@ -0,0 +1,387 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + xmlns:osb="http://www.openswatchbook.org/uri/2009/osb" + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="744.09448819" + height="1052.3622047" + id="svg2" + version="1.1" + inkscape:version="0.48.4 r9939" + sodipodi:docname="rest_options.svg" + inkscape:export-filename="/home/essen/Dropbox/Public/drawing.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <defs + id="defs4"> + <linearGradient + id="linearGradient5265"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5267" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.58823532;" + offset="1" + id="stop5269" /> + </linearGradient> + <linearGradient + id="linearGradient5251"> + <stop + style="stop-color:#69d2e7;stop-opacity:0.78431374;" + offset="0" + id="stop5253" /> + <stop + id="stop5263" + offset="0.5" + style="stop-color:#69d2e7;stop-opacity:1;" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.39215687;" + offset="1" + id="stop5255" /> + </linearGradient> + <linearGradient + id="linearGradient5233" + osb:paint="solid"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5235" /> + </linearGradient> + </defs> + <sodipodi:namedview + id="base" + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1.0" + inkscape:pageopacity="1" + inkscape:pageshadow="2" + inkscape:zoom="1.0000001" + inkscape:cx="166.77748" + inkscape:cy="548.36436" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="false" + inkscape:window-width="2560" + inkscape:window-height="1402" + inkscape:window-x="0" + inkscape:window-y="38" + inkscape:window-maximized="1" + inkscape:snap-global="true" + showguides="true"> + <inkscape:grid + type="xygrid" + id="grid5357" + empspacing="5" + visible="true" + enabled="true" + snapvisiblegridlinesonly="true" /> + </sodipodi:namedview> + <metadata + id="metadata7"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + <dc:title /> + </cc:Work> + </rdf:RDF> + </metadata> + <g + inkscape:label="Layer 1" + inkscape:groupmode="layer" + id="layer1"> + <path + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:connector-curvature="0" + id="use5777" + d="m -360.31658,371.70113 203.00246,0.045" + style="fill:none;stroke:#6d8e41;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:1.99999999, 3.99999998;stroke-dashoffset:0" /> + <g + transform="translate(205.92143,-296.03137)" + id="g5650-7"> + <path + inkscape:connector-curvature="0" + id="path5570-9" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-0" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(205.92143,-212.00698)" + id="g5650-9"> + <path + inkscape:connector-curvature="0" + id="path5570-7" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-09" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-28" + width="210.17955" + height="35.209244" + x="43.049091" + y="204.67757" + rx="15" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1" + width="210.17955" + height="35.209244" + x="43.049091" + y="121.0042" + rx="15" /> + <g + id="g5650" + transform="translate(0,-0.47597102)"> + <path + inkscape:connector-curvature="0" + id="path5570" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273" + width="104.5895" + height="36.392323" + x="-224.02068" + y="29.41218" + rx="15" /> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7" + width="104.5895" + height="36.392323" + x="-224.02068" + y="90.691978" + rx="15" /> + <rect + style="fill:#ffc48c;fill-opacity:1;fill-rule:nonzero;stroke:#d79c64;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-2" + width="104.5895" + height="36.392323" + x="-224.02068" + y="151.97169" + rx="15" /> + <rect + style="fill:#ff9f80;fill-opacity:1;fill-rule:nonzero;stroke:#d77758;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-22" + width="104.5895" + height="36.392323" + x="-224.02068" + y="213.25146" + rx="15" /> + <rect + style="fill:#f56991;fill-opacity:1;fill-rule:nonzero;stroke:#cd4169;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-8" + width="104.5895" + height="36.392323" + x="-224.02068" + y="274.53128" + rx="15" /> + <use + x="0" + y="0" + xlink:href="#rect5273-22" + id="use5355" + transform="translate(319.86479,-176.50006)" + width="744.09448" + height="1052.3622" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-58.692513" + y="114.39204" + id="text5371" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan5373" + x="-58.692513" + y="114.39204">some text</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-58.692513" + y="53.112247" + id="text5371-2" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan5373-6" + x="-58.692513" + y="53.112247">some text</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-58.692513" + y="236.95154" + id="text5371-4" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan5373-9" + x="-58.692513" + y="236.95154">some text</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="147.00391" + y="60.912468" + id="text5371-4-0" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + x="147.00391" + y="60.912468" + id="tspan17171">start</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="148.13106" + y="142.80627" + id="text5371-2-95" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan5373-6-80" + x="148.13106" + y="142.80627">options</tspan></text> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="147.80684" + y="226.4736" + id="text5371-2-32" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan5373-6-27" + x="147.80684" + y="226.4736">200 OK</tspan></text> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-2" + width="210.17955" + height="35.209244" + x="-489.75586" + y="33.4944" + rx="15" /> + <g + transform="matrix(0,-1,1,0,-513.31414,353.05561)" + id="g5650-2"> + <path + inkscape:connector-curvature="0" + id="path5570-2" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:2.44279909;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5367" + width="207.05719" + height="171.55719" + x="-373.52859" + y="458.58362" + rx="11.072577" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-size:16px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans" + x="-544.69421" + y="-354.17184" + id="text5371-2-3-0-7" + sodipodi:linespacing="125%" + transform="matrix(0,-1,1,0,0,0)" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7-3-9" + x="-544.69421" + y="-354.17184">middlewares</tspan></text> + </g> +</svg> diff --git a/docs/en/cowboy/2.6/guide/rest_principles.asciidoc b/docs/en/cowboy/2.6/guide/rest_principles.asciidoc new file mode 100644 index 00000000..66939cb7 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_principles.asciidoc @@ -0,0 +1,160 @@ +[[rest_principles]] +== REST principles + +This chapter will attempt to define the concepts behind REST +and explain what makes a service RESTful. + +REST is often confused with performing a distinct operation +depending on the HTTP method, while using more than the GET +and POST methods. That's highly misguided at best. + +We will first attempt to define REST and will look at what +it means in the context of HTTP and the Web. +For a more in-depth explanation of REST, you can read +http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm[Roy T. Fielding's dissertation] +as it does a great job explaining where it comes from and +what it achieves. + +=== REST architecture + +REST is a *client-server* architecture. The client and the server +both have a different set of concerns. The server stores and/or +manipulates information and makes it available to the user in +an efficient manner. The client takes that information and +displays it to the user and/or uses it to perform subsequent +requests for information. This separation of concerns allows both +the client and the server to evolve independently as it only +requires that the interface stays the same. + +REST is *stateless*. That means the communication between the +client and the server always contains all the information needed +to perform the request. There is no session state in the server, +it is kept entirely on the client's side. If access to a resource +requires authentication, then the client needs to authenticate +itself with every request. + +REST is *cacheable*. The client, the server and any intermediary +components can all cache resources in order to improve performance. + +REST provides a *uniform interface* between components. This +simplifies the architecture, as all components follow the same +rules to speak to one another. It also makes it easier to understand +the interactions between the different components of the system. +A number of constraints are required to achieve this. They are +covered in the rest of the chapter. + +REST is a *layered system*. Individual components cannot see +beyond the immediate layer with which they are interacting. This +means that a client connecting to an intermediate component, like +a proxy, has no knowledge of what lies beyond. This allows +components to be independent and thus easily replaceable or +extendable. + +REST optionally provides *code on demand*. Code may be downloaded +to extend client functionality. This is optional however because +the client may not be able to download or run this code, and so +a REST component cannot rely on it being executed. + +=== Resources and resource identifiers + +A resource is an abstract concept. In a REST system, any information +that can be named may be a resource. This includes documents, images, +a collection of resources and any other information. Any information +that can be the target of an hypertext link can be a resource. + +A resource is a conceptual mapping to a set of entities. The set of +entities evolves over time; a resource doesn't. For example, a resource +can map to "users who have logged in this past month" and another +to "all users". At some point in time they may map to the same set of +entities, because all users logged in this past month. But they are +still different resources. Similarly, if nobody logged in recently, +then the first resource may map to the empty set. This resource exists +regardless of the information it maps to. + +Resources are identified by uniform resource identifiers, also known +as URIs. Sometimes internationalized resource identifiers, or IRIs, +may also be used, but these can be directly translated into a URI. + +In practice we will identify two kinds of resources. Individual +resources map to a set of one element, for example "user Joe". +Collection of resources map to a set of 0 to N elements, +for example "all users". + +=== Resource representations + +The representation of a resource is a sequence of bytes associated +with metadata. + +The metadata comes as a list of key-value pairs, where the name +corresponds to a standard that defines the value's structure and +semantics. With HTTP, the metadata comes in the form of request +or response headers. The headers' structure and semantics are well +defined in the HTTP standard. Metadata includes representation +metadata, resource metadata and control data. + +The representation metadata gives information about the +representation, such as its media type, the date of last +modification, or even a checksum. + +Resource metadata could be link to related resources or +information about additional representations of the resource. + +Control data allows parameterizing the request or response. +For example, we may only want the representation returned if +it is more recent than the one we have in cache. Similarly, +we may want to instruct the client about how it should cache +the representation. This isn't restricted to caching. We may, +for example, want to store a new representation of a resource +only if it wasn't modified since we first retrieved it. + +The data format of a representation is also known as the media +type. Some media types are intended for direct rendering to the +user, while others are intended for automated processing. The +media type is a key component of the REST architecture. + +=== Self-descriptive messages + +Messages must be self-descriptive. That means that the data +format of a representation must always come with its media +type (and similarly requesting a resource involves choosing +the media type of the representation returned). If you are +sending HTML, then you must say it is HTML by sending the +media type with the representation. In HTTP this is done +using the content-type header. + +The media type is often an IANA registered media type, like +`text/html` or `image/png`, but does not need to be. Exactly +two things are important for respecting this constraint: that +the media type is well specified, and that the sender and +recipient agree about what the media type refers to. + +This means that you can create your own media types, like +`application/x-mine`, and that as long as you write the +specifications for it and that both endpoints agree about +it then the constraint is respected. + +=== Hypermedia as the engine of application state + +The last constraint is generally where services that claim +to be RESTful fail. Interactions with a server must be +entirely driven by hypermedia. The client does not need +any prior knowledge of the service in order to use it, +other than an entry point and of course basic understanding +of the media type of the representations, at the very least +enough to find and identify hyperlinks and link relations. + +To give a simple example, if your service only works with +the `application/json` media type then this constraint +cannot be respected (as there are no concept of links in +JSON) and thus your service isn't RESTful. This is the case +for the majority of self-proclaimed REST services. + +On the other hand if you create a JSON based media type +that has a concept of links and link relations, then +your service might be RESTful. + +Respecting this constraint means that the entirety of the +service becomes self-discoverable, not only the resources +in it, but also the operations you can perform on it. This +makes clients very thin as there is no need to implement +anything specific to the service to operate on it. diff --git a/docs/en/cowboy/2.6/guide/rest_principles/index.html b/docs/en/cowboy/2.6/guide/rest_principles/index.html new file mode 100644 index 00000000..fdb8b353 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_principles/index.html @@ -0,0 +1,200 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: REST principles</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>REST principles</span></h1> + +<p>This chapter will attempt to define the concepts behind REST and explain what makes a service RESTful.</p> +<p>REST is often confused with performing a distinct operation depending on the HTTP method, while using more than the GET and POST methods. That's highly misguided at best.</p> +<p>We will first attempt to define REST and will look at what it means in the context of HTTP and the Web. For a more in-depth explanation of REST, you can read <a href="http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm">Roy T. Fielding's dissertation</a> as it does a great job explaining where it comes from and what it achieves.</p> +<h2 id="_rest_architecture">REST architecture</h2> +<p>REST is a <strong>client-server</strong> architecture. The client and the server both have a different set of concerns. The server stores and/or manipulates information and makes it available to the user in an efficient manner. The client takes that information and displays it to the user and/or uses it to perform subsequent requests for information. This separation of concerns allows both the client and the server to evolve independently as it only requires that the interface stays the same.</p> +<p>REST is <strong>stateless</strong>. That means the communication between the client and the server always contains all the information needed to perform the request. There is no session state in the server, it is kept entirely on the client's side. If access to a resource requires authentication, then the client needs to authenticate itself with every request.</p> +<p>REST is <strong>cacheable</strong>. The client, the server and any intermediary components can all cache resources in order to improve performance.</p> +<p>REST provides a <strong>uniform interface</strong> between components. This simplifies the architecture, as all components follow the same rules to speak to one another. It also makes it easier to understand the interactions between the different components of the system. A number of constraints are required to achieve this. They are covered in the rest of the chapter.</p> +<p>REST is a <strong>layered system</strong>. Individual components cannot see beyond the immediate layer with which they are interacting. This means that a client connecting to an intermediate component, like a proxy, has no knowledge of what lies beyond. This allows components to be independent and thus easily replaceable or extendable.</p> +<p>REST optionally provides <strong>code on demand</strong>. Code may be downloaded to extend client functionality. This is optional however because the client may not be able to download or run this code, and so a REST component cannot rely on it being executed.</p> +<h2 id="_resources_and_resource_identifiers">Resources and resource identifiers</h2> +<p>A resource is an abstract concept. In a REST system, any information that can be named may be a resource. This includes documents, images, a collection of resources and any other information. Any information that can be the target of an hypertext link can be a resource.</p> +<p>A resource is a conceptual mapping to a set of entities. The set of entities evolves over time; a resource doesn't. For example, a resource can map to "users who have logged in this past month" and another to "all users". At some point in time they may map to the same set of entities, because all users logged in this past month. But they are still different resources. Similarly, if nobody logged in recently, then the first resource may map to the empty set. This resource exists regardless of the information it maps to.</p> +<p>Resources are identified by uniform resource identifiers, also known as URIs. Sometimes internationalized resource identifiers, or IRIs, may also be used, but these can be directly translated into a URI.</p> +<p>In practice we will identify two kinds of resources. Individual resources map to a set of one element, for example "user Joe". Collection of resources map to a set of 0 to N elements, for example "all users".</p> +<h2 id="_resource_representations">Resource representations</h2> +<p>The representation of a resource is a sequence of bytes associated with metadata.</p> +<p>The metadata comes as a list of key-value pairs, where the name corresponds to a standard that defines the value's structure and semantics. With HTTP, the metadata comes in the form of request or response headers. The headers' structure and semantics are well defined in the HTTP standard. Metadata includes representation metadata, resource metadata and control data.</p> +<p>The representation metadata gives information about the representation, such as its media type, the date of last modification, or even a checksum.</p> +<p>Resource metadata could be link to related resources or information about additional representations of the resource.</p> +<p>Control data allows parameterizing the request or response. For example, we may only want the representation returned if it is more recent than the one we have in cache. Similarly, we may want to instruct the client about how it should cache the representation. This isn't restricted to caching. We may, for example, want to store a new representation of a resource only if it wasn't modified since we first retrieved it.</p> +<p>The data format of a representation is also known as the media type. Some media types are intended for direct rendering to the user, while others are intended for automated processing. The media type is a key component of the REST architecture.</p> +<h2 id="_self_descriptive_messages">Self-descriptive messages</h2> +<p>Messages must be self-descriptive. That means that the data format of a representation must always come with its media type (and similarly requesting a resource involves choosing the media type of the representation returned). If you are sending HTML, then you must say it is HTML by sending the media type with the representation. In HTTP this is done using the content-type header.</p> +<p>The media type is often an IANA registered media type, like <code>text/html</code> or <code>image/png</code>, but does not need to be. Exactly two things are important for respecting this constraint: that the media type is well specified, and that the sender and recipient agree about what the media type refers to.</p> +<p>This means that you can create your own media types, like <code>application/x-mine</code>, and that as long as you write the specifications for it and that both endpoints agree about it then the constraint is respected.</p> +<h2 id="_hypermedia_as_the_engine_of_application_state">Hypermedia as the engine of application state</h2> +<p>The last constraint is generally where services that claim to be RESTful fail. Interactions with a server must be entirely driven by hypermedia. The client does not need any prior knowledge of the service in order to use it, other than an entry point and of course basic understanding of the media type of the representations, at the very least enough to find and identify hyperlinks and link relations.</p> +<p>To give a simple example, if your service only works with the <code>application/json</code> media type then this constraint cannot be respected (as there are no concept of links in JSON) and thus your service isn't RESTful. This is the case for the majority of self-proclaimed REST services.</p> +<p>On the other hand if you create a JSON based media type that has a concept of links and link relations, then your service might be RESTful.</p> +<p>Respecting this constraint means that the entirety of the service becomes self-discoverable, not only the resources in it, but also the operations you can perform on it. This makes clients very thin as there is no need to implement anything specific to the service to operate on it.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/multipart/"> + Multipart requests + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/rest_handlers/"> + REST handlers + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/rest_put_post_patch.png b/docs/en/cowboy/2.6/guide/rest_put_post_patch.png Binary files differnew file mode 100644 index 00000000..176650e9 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_put_post_patch.png diff --git a/docs/en/cowboy/2.6/guide/rest_put_post_patch.svg b/docs/en/cowboy/2.6/guide/rest_put_post_patch.svg new file mode 100644 index 00000000..06d55052 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_put_post_patch.svg @@ -0,0 +1,2856 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + xmlns:osb="http://www.openswatchbook.org/uri/2009/osb" + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="744.09448" + height="1052.3622" + id="svg2" + version="1.1" + inkscape:version="0.92.1 r" + sodipodi:docname="rest_put_post_patch.svg" + inkscape:export-filename="/home/essen/Dropbox/Public/drawing.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <defs + id="defs4"> + <linearGradient + id="linearGradient5265"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5267" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.58823532;" + offset="1" + id="stop5269" /> + </linearGradient> + <linearGradient + id="linearGradient5251"> + <stop + style="stop-color:#69d2e7;stop-opacity:0.78431374;" + offset="0" + id="stop5253" /> + <stop + id="stop5263" + offset="0.5" + style="stop-color:#69d2e7;stop-opacity:1;" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.39215687;" + offset="1" + id="stop5255" /> + </linearGradient> + <linearGradient + id="linearGradient5233" + osb:paint="solid"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5235" /> + </linearGradient> + </defs> + <sodipodi:namedview + id="base" + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1.0" + inkscape:pageopacity="1" + inkscape:pageshadow="2" + inkscape:zoom="0.70710678" + inkscape:cx="201.51415" + inkscape:cy="-214.71801" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="false" + inkscape:window-width="1920" + inkscape:window-height="1043" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="1" + inkscape:snap-global="true" + showguides="true"> + <inkscape:grid + type="xygrid" + id="grid5357" + empspacing="5" + visible="true" + enabled="true" + snapvisiblegridlinesonly="true" /> + </sodipodi:namedview> + <metadata + id="metadata7"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + <dc:title /> + </cc:Work> + </rdf:RDF> + </metadata> + <g + inkscape:label="Layer 1" + inkscape:groupmode="layer" + id="layer1" + transform="translate(0,1.5472441e-4)"> + <path + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:connector-curvature="0" + id="use5777" + d="m -360.31658,371.70113 203.00246,0.045" + style="fill:none;stroke:#6d8e41;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:1.99999999, 3.99999998;stroke-dashoffset:0" /> + <g + transform="translate(370.63925,-305.0045)" + id="g5650-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-9" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-0" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0.70710678,-0.70710678,0.70710678,0.70710678,215.76354,-143.71473)" + id="g5650-2-2-8"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-4" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-3" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1" + width="210.17955" + height="35.209244" + x="207.76691" + y="112.69559" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + id="g5650" + transform="translate(229.41793,93.569228)"> + <path + inkscape:connector-curvature="0" + id="path5570" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273" + width="104.5895" + height="36.392323" + x="-224.02068" + y="29.41218" + rx="15" /> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7" + width="104.5895" + height="36.392323" + x="-224.02068" + y="90.691978" + rx="15" /> + <rect + style="fill:#ffc48c;fill-opacity:1;fill-rule:nonzero;stroke:#d79c64;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-2" + width="104.5895" + height="36.392323" + x="-224.02068" + y="151.97169" + rx="15" /> + <rect + style="fill:#ff9f80;fill-opacity:1;fill-rule:nonzero;stroke:#d77758;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-22" + width="104.5895" + height="36.392323" + x="-224.02068" + y="213.25146" + rx="15" /> + <rect + style="fill:#f56991;fill-opacity:1;fill-rule:nonzero;stroke:#cd4169;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-8" + width="104.5895" + height="36.392323" + x="-224.02068" + y="274.53128" + rx="15" /> + <use + x="0" + y="0" + xlink:href="#rect5273-22" + id="use5355" + transform="translate(484.58261,-183.7816)" + width="744.09448" + height="1052.3622" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="-58.692513" + y="114.39204" + id="text5371"><tspan + sodipodi:role="line" + id="tspan5373" + x="-58.692513" + y="114.39204" + style="font-size:16px;line-height:1.25;font-family:sans-serif">some text</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="-58.692513" + y="53.112247" + id="text5371-2"><tspan + sodipodi:role="line" + id="tspan5373-6" + x="-58.692513" + y="53.112247" + style="font-size:16px;line-height:1.25;font-family:sans-serif">some text</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="-58.692513" + y="236.95154" + id="text5371-4"><tspan + sodipodi:role="line" + id="tspan5373-9" + x="-58.692513" + y="236.95154" + style="font-size:16px;line-height:1.25;font-family:sans-serif">some text</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="313.14185" + y="50.482433" + id="text5371-4-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + x="313.14185" + y="50.482433" + id="tspan17171" + style="font-size:16px;line-height:1.25;font-family:sans-serif">conneg</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="312.52466" + y="134.49161" + id="text5371-2-95" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-80" + x="312.52466" + y="134.49161" + style="font-size:16px;line-height:1.25;font-family:sans-serif">resource_exists</tspan></text> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-2" + width="210.17955" + height="35.209244" + x="-489.75586" + y="33.4944" + rx="15" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="205.83722" + y="175.92931" + id="text5371-2-391" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63" + x="205.83722" + y="175.92931" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <g + transform="matrix(0,-1,1,0,-586.85324,629.53436)" + id="g5650-2"> + <path + inkscape:connector-curvature="0" + id="path5570-2" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="401.26678" + y="176.39024" + id="text5371-4-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-0" + x="401.26678" + y="176.39024" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <g + transform="translate(517.41793,-144.94975)" + id="g5650-2-2"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:2.44279909;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5367" + width="207.05719" + height="171.55719" + x="-373.52859" + y="458.58362" + rx="11.072577" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="-544.69421" + y="-354.17184" + id="text5371-2-3-0-7" + transform="rotate(-90)" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7-3-9" + x="-544.69421" + y="-354.17184" + style="font-size:16px;line-height:1.25;font-family:sans-serif">middlewares</tspan></text> + <g + transform="matrix(0,-1,1,0,-508.93096,565.23553)" + id="g5650-2-0-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="496.12921" + y="255.81152" + id="text5371-4-4-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6" + x="496.12921" + y="255.81152" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <g + transform="matrix(0.70710678,0.70710678,-0.70710678,0.70710678,501.47379,-62.310424)" + id="g5650-9-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-7-6" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-09-5" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(-0.08419269,-0.81571201,-1.0857893,-0.07785618,667.56845,424.75412)" + id="g5650-2-0-4-3-8-9-2" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + id="g6634"> + <path + inkscape:connector-curvature="0" + id="path20172-9-8-9-3-7" + d="m 18.652036,463.77088 c 0,0 65.81835,-170.39134 345.869384,-106.32083" + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(-0.44664484,-0.38224114,-0.38224114,0.44664484,110.28192,145.11277)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58-6-1-5-3-0" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <g + transform="matrix(0,-1,1,0,-443.10758,753.30201)" + id="g5650-2-0-4-3-8-9-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:1.98598707;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 530.36552,568.78955 c 0,0 -275.73145,-235.65993 -602.761737,-30.40772" + id="path20172-9-8-9-3-1" + inkscape:connector-curvature="0" /> + <path + transform="matrix(0.29887498,0.50623478,-0.50623478,0.29887498,210.13685,523.56774)" + inkscape:transform-center-y="-0.81224338" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58-6-1-1" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="5.134315" /> + </g> + <use + x="0" + y="0" + xlink:href="#rect5273-22" + id="use5355-0" + transform="translate(343.36129,-20.897068)" + width="744.09448" + height="1052.3622" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="171.92052" + y="216.5154" + id="text5371-4-0-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + x="171.92052" + y="216.5154" + id="tspan17171-6" + style="font-size:16px;line-height:1.25;font-family:sans-serif">cond</tspan></text> + <g + transform="matrix(0,-1,-1,0,983.2611,313.28465)" + id="g5650-2-0-4-3-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-8-9" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58-6" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-28-4" + width="210.17955" + height="35.209244" + x="354.54559" + y="192.94588" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="459.47131" + y="216.51535" + id="text5371-2-32-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-27-8" + x="459.47131" + y="216.51535" + style="font-size:16px;line-height:1.25;font-family:sans-serif">has if-match?</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="609.12769" + y="296.02957" + id="text5371-2-391-5" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63-7" + x="609.12769" + y="296.02957" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <g + transform="translate(517.41793,13.785058)" + id="g5650-0-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-5-7" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-1-3" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-28-7" + width="210.17955" + height="35.209244" + x="354.54559" + y="351.97443" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="459.47131" + y="374.91498" + id="text5371-2-32-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-27-1" + x="459.47131" + y="374.91498" + style="font-size:16px;line-height:1.25;font-family:sans-serif">method is POST/PATCH?</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="479.69171" + y="414.84009" + id="text5371-2-8-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3-4" + x="479.69171" + y="414.84009" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <g + transform="translate(517.41793,490.80719)" + id="g5650-0-6-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-5-7-76" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-1-3-7" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0.34202014,-0.93969262,-0.93969262,-0.34202014,1086.6042,1290.1092)" + id="g5650-2-0-4-0-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 152.42141,615.5283 c 0,0 -73.650807,-184.33554 -245.781275,54.61093" + id="path20172-9-3-4" + inkscape:connector-curvature="0" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,178.4823,610.19901)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-0-2" + style="opacity:0.80000000000000004;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <g + transform="translate(517.41793,570.7504)" + id="g5650-2-2-2-7-5"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-62-7-7" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-9-5-8" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9" + width="210.17955" + height="35.209244" + x="354.54559" + y="908.57428" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + transform="matrix(0,1,-1,0,694.44282,904.44724)" + id="g5650-2-2-6-6"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-6-3" + d="m -57.78256,339.02801 0,65.70583" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-1-1" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9-59" + width="210.17955" + height="35.209244" + x="354.54559" + y="829.06006" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="459.47131" + y="852.62952" + id="text5371-2-74-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2" + x="459.47131" + y="852.62952" + style="font-size:16px;line-height:1.25;font-family:sans-serif">method is POST?</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1" + width="218.52127" + height="34.993004" + x="350.37473" + y="272.56824" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="459.97131" + y="294.47879" + id="text5371-43" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3" + x="459.97131" + y="294.47879" + style="font-size:16px;line-height:1.25;font-family:sans-serif">412 precondition failed</tspan></text> + <g + transform="translate(2.6196148,3.2328831)" + id="g5650-2-2-6"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-6" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-1" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,1,-1,0,694.2803,507.19416)" + id="g5650-0-6-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-5-7-7" + d="m -57.78256,340.48769 0,63.05283" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-1-3-1" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(517.41793,93.25206)" + id="g5650-2-2-2"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-62" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-9" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-28-7-6" + width="210.17955" + height="35.209244" + x="354.54559" + y="431.48868" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="459.63538" + y="453.2847" + id="text5371-2-32-8-5" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-27-1-2" + x="459.63538" + y="453.2847" + style="font-size:16px;line-height:1.25;font-family:sans-serif">previously_existed</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-5-5" + width="218.52127" + height="34.993004" + x="62.374733" + y="590.76849" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + transform="translate(229.41793,173.2314)" + id="g5650-2-2-2-7"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-62-7" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-9-5" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="171.97131" + y="614.22986" + id="text5371-43-2-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-9-74" + x="171.97131" + y="614.22986" + style="font-size:16px;line-height:1.25;font-family:sans-serif">404 not found</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="296.84631" + y="433.29703" + id="text5371-2-8-9-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3-4-8" + x="296.84631" + y="433.29703" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <g + transform="translate(516.00372,173.10383)" + id="g5650-2-2-17-8"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-0-3" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-45-2" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,-1,0,983.3517,631.45158)" + id="g5650-2-0-4-3-8-0-3-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-8-9-31-8-9" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58-6-3-6-5" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="500.12921" + y="574.2605" + id="text5371-4-4-9-3-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-2-8" + x="500.12921" + y="574.2605" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true*</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="607.7135" + y="610.86951" + id="text5371-2-391-5-5-1-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63-7-9-9-5" + x="607.7135" + y="610.86951" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-5-9-29" + width="218.52127" + height="34.993004" + x="350.37473" + y="590.76849" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="459.26428" + y="612.67908" + id="text5371-43-2-9-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-9-7-5" + x="459.26428" + y="612.67908" + style="font-size:16px;line-height:1.25;font-family:sans-serif">301 moved permanently</tspan></text> + <g + transform="translate(517.41793,332.05687)" + id="g5650-2-2-65-2"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-5-9" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-5-9" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,-1,0,982.4019,789.6002)" + id="g5650-2-0-4-3-8-0-3-7-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-8-9-31-8-1-6" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58-6-3-6-3-2" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9-1-4" + width="210.17955" + height="35.209244" + x="354.54559" + y="670.03149" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="459.14709" + y="691.82751" + id="text5371-2-74-0-7-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2-8-9" + x="459.14709" + y="691.82751" + style="font-size:16px;line-height:1.25;font-family:sans-serif">moved_temporarily</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="500.12921" + y="733.21747" + id="text5371-4-4-9-3-2-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-2-6-6" + x="500.12921" + y="733.21747" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true*</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="607.7135" + y="769.89801" + id="text5371-2-391-5-5-1-0-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63-7-9-9-2-8" + x="607.7135" + y="769.89801" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-5-9-2-1" + width="218.52127" + height="34.993004" + x="350.37473" + y="749.65387" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="459.26428" + y="771.56445" + id="text5371-43-2-9-7-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-9-7-8-9" + x="459.26428" + y="771.56445" + style="font-size:16px;line-height:1.25;font-family:sans-serif">307 moved temporarily</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-5-9-2-4-1" + width="218.52127" + height="34.993004" + x="495.25732" + y="1220.3925" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="604.32263" + y="1242.303" + id="text5371-43-2-9-7-3-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-9-7-8-7-5" + x="604.32263" + y="1242.303" + style="font-size:16px;line-height:1.25;font-family:sans-serif">400 bad request</tspan></text> + <g + transform="matrix(-0.34202014,-0.93969262,0.93969262,-0.34202014,-311.11659,1246.6148)" + id="g5650-2-0-4-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 251.64748,501.65559 c 0,0 -132.95279,-198.6035 -335.041098,15.43198" + id="path20172-9-3" + inkscape:connector-curvature="0" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,190.22636,455.7026)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-0" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="120.08566" + y="891.92566" + id="text5371-2-8-9-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3-4-5" + x="120.08566" + y="891.92566" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <g + transform="matrix(0,-1,-1,0,699.22962,550.33236)" + id="g5650-2-0-4-5" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-1" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-5" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9-1-3" + width="210.17955" + height="35.209244" + x="66.545593" + y="511.00293" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="167.39459" + y="532.79895" + id="text5371-2-74-0-7-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2-8-94" + x="167.39459" + y="532.79895" + style="font-size:16px;line-height:1.25;font-family:sans-serif">allow_missing_post</tspan></text> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9-5" + width="210.17955" + height="35.209244" + x="66.545593" + y="431.80698" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="175.2144" + y="455.37643" + id="text5371-2-74-0-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2-6" + x="175.2144" + y="455.37643" + style="font-size:16px;line-height:1.25;font-family:sans-serif">method is POST?</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="459.35022" + y="930.3703" + id="text5371-2-74-0-7-1-5" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2-8-94-5" + x="459.35022" + y="930.3703" + style="font-size:16px;line-height:1.25;font-family:sans-serif">allow_missing_post</tspan></text> + <g + transform="translate(229.41793,490.95885)" + id="g5650-0-6-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-5-7-2" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-1-3-14" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9-19" + width="210.17955" + height="35.209244" + x="66.545593" + y="829.06006" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="166.63885" + y="852.62952" + id="text5371-2-74-0-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2-7" + x="166.63885" + y="852.62952" + style="font-size:16px;line-height:1.25;font-family:sans-serif">method is PUT?</tspan></text> + <g + transform="translate(229.41793,571.07045)" + id="g5650-2-2-65-9"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-5-1" + d="m -57.78256,343.20394 0,61.59661" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-5-3" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(-0.34202014,-0.93969262,-0.93969262,0.34202014,702.18987,886.11239)" + id="g5650-2-0-4-05" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2.19573760000000018;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 96.51476,423.00572 c 0,0 -72.55269,-41.6703 -192.585744,26.04761" + id="path20172-9-9" + inkscape:connector-curvature="0" /> + <path + transform="matrix(0.20642765,0.55044303,-0.55044303,0.20642765,176.90073,487.11794)" + inkscape:transform-center-y="2.5699832" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-6" + style="opacity:0.80000000000000004;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="6.2547481" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9-1-8" + width="210.17955" + height="35.209244" + x="66.545593" + y="908.57428" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="166.24431" + y="930.3703" + id="text5371-2-74-0-7-15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2-8-2" + x="166.24431" + y="930.3703" + style="font-size:16px;line-height:1.25;font-family:sans-serif">is_conflict</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="136.52316" + y="971.55994" + id="text5371-4-4-9-3-2-08" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-2-6-0" + x="136.52316" + y="971.55994" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-5-9-2-7" + width="218.52127" + height="34.993004" + x="62.374733" + y="988.43671" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="171.44006" + y="1011.8981" + id="text5371-43-2-9-7-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-9-7-8-0" + x="171.44006" + y="1011.8981" + style="font-size:16px;line-height:1.25;font-family:sans-serif">409 conflict</tspan></text> + <g + transform="translate(370.63925,803.79161)" + id="g5650-93-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-3-0" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-4-9" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9-1-40" + width="210.17955" + height="35.209244" + x="207.76691" + y="1142.3002" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="313.14185" + y="1164.0962" + id="text5371-2-74-0-7-41" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2-8-3" + x="313.14185" + y="1164.0962" + style="font-size:16px;line-height:1.25;font-family:sans-serif">content_types_accepted</tspan></text> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-4-9" + width="210.17955" + height="35.209244" + x="207.76691" + y="1220.5249" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="313.21997" + y="1242.2975" + id="text5371-2-3-0-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7-3-1" + x="313.21997" + y="1242.2975" + style="font-size:16px;line-height:1.25;font-family:sans-serif">AcceptCallback</tspan></text> + <g + transform="translate(233.45629,961.91953)" + id="g5650-6-4-8-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-78-5-5-2" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9-6-6-6" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,-345.93614,1498.2457)" + id="g5650-2-0-4-8-9-6-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 169.94368,422.8286 c 0,0 -94.23585,-64.78987 -206.003937,-8.35999" + id="path20172-9-5-2-6-6" + inkscape:connector-curvature="0" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-2-8-7-6" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9-19-2" + width="210.17955" + height="35.209244" + x="70.583946" + y="1300.3734" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="175.50966" + y="1323.8022" + id="text5371-2-74-0-1-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2-7-4" + x="175.50966" + y="1323.8022" + style="font-size:16px;line-height:1.25;font-family:sans-serif">new resource?</tspan></text> + <g + transform="translate(517.41793,962.60627)" + id="g5650-6-4-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-78-5-5" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9-6-6" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,-1,0,985.5699,1417.4167)" + id="g5650-2-0-4-8-9-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-5-2-6" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-2-8-7" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9-19-2-1" + width="210.17955" + height="35.209244" + x="354.54559" + y="1300.3734" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="459.47131" + y="1323.8022" + id="text5371-2-74-0-1-3-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2-7-4-8" + x="459.47131" + y="1323.8022" + style="font-size:16px;line-height:1.25;font-family:sans-serif">new resource?</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-8-7" + width="218.52127" + height="34.993004" + x="350.37473" + y="1380.1163" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="459.776" + y="1403.5779" + id="text5371-43-3-2" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-1-9" + x="459.776" + y="1403.5779" + style="font-size:16px;line-height:1.25;font-family:sans-serif">201 created</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-8-7-4" + width="218.52127" + height="34.993004" + x="350.37473" + y="1459.7511" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="459.03381" + y="1483.2128" + id="text5371-43-3-2-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-1-9-2" + x="459.03381" + y="1483.2128" + style="font-size:16px;line-height:1.25;font-family:sans-serif">303 see other</tspan></text> + <g + transform="matrix(0,1,1,0,-67.245042,1455.155)" + id="g5650-2-2-6-6-7-9-1"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-6-3-8-5-9" + d="m -57.78256,339.02801 0,65.70583" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-1-1-7-6-3" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(233.45629,1121.5376)" + id="g5650-6-4-8-7-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-78-5-5-2-8" + d="m -57.78256,294.4515 0,109.76214" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9-6-6-6-7" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9-19-2-2" + width="210.17955" + height="35.209244" + x="70.583946" + y="1379.7678" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="175.50966" + y="1401.7865" + id="text5371-2-74-0-1-3-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2-7-4-9" + x="175.50966" + y="1401.7865" + style="font-size:16px;line-height:1.25;font-family:sans-serif">has resp location?</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-8-7-4-7" + width="218.52127" + height="34.993004" + x="62.374733" + y="1619.0205" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + transform="translate(233.45629,1201.4108)" + id="g5650-6-4-8-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-78-5-5-3" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9-6-6-3" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,1,1,0,-63.162935,1614.665)" + id="g5650-2-2-6-6-7-9"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-6-3-8-5" + d="m -57.78256,339.02801 0,65.70583" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-1-1-7-6" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9-19-2-2-4" + width="210.17955" + height="35.209244" + x="70.583946" + y="1539.2778" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="175.50966" + y="1561.2965" + id="text5371-2-74-0-1-3-7-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2-7-4-9-5" + x="175.50966" + y="1561.2965" + style="font-size:16px;line-height:1.25;font-family:sans-serif">has resp body?</tspan></text> + <g + transform="translate(517.41793,1201.395)" + id="g5650-6-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-78-5" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9-6" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,-1,0,987.64405,1658.4266)" + id="g5650-2-0-4-8-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-5-2" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-2-8" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-87-8" + width="210.17955" + height="35.209244" + x="354.54559" + y="1539.2778" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="459.30334" + y="1561.0739" + id="text5371-2-9-6" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-8-6" + x="459.30334" + y="1561.0739" + style="font-size:16px;line-height:1.25;font-family:sans-serif">multiple_choices</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="479.75421" + y="1602.6646" + id="text5371-2-8-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3-7" + x="479.75421" + y="1602.6646" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-1-0" + width="218.52127" + height="34.993004" + x="350.37473" + y="1698.6555" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="459.42053" + y="1720.566" + id="text5371-43-5-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-62-9" + x="459.42053" + y="1720.566" + style="font-size:16px;line-height:1.25;font-family:sans-serif">300 multiple choices</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-8-3" + width="218.52127" + height="34.993004" + x="350.37473" + y="1619.0208" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="458.88538" + y="1642.3412" + id="text5371-43-3-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-1-3" + x="458.88538" + y="1642.3412" + style="font-size:16px;line-height:1.25;font-family:sans-serif">200 OK</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="171.24475" + y="1642.3412" + id="text5371-43-3-2-6-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-1-9-2-0" + x="171.24475" + y="1642.3412" + style="font-size:16px;line-height:1.25;font-family:sans-serif">204 no content</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="479.69171" + y="891.92566" + id="text5371-2-8-9-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3-4-1" + x="479.69171" + y="891.92566" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <g + id="g5650-4-8" + transform="matrix(0.5,0.8660254,-0.8660254,0.5,204.7918,279.30499)"> + <path + inkscape:connector-curvature="0" + id="path5570-8-7" + d="m -58.01975,316.62647 0,86.23385" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,72.919441,161.77521)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-3-4" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="496.12921" + y="494.3544" + id="text5371-4-4-9-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-8" + x="496.12921" + y="494.3544" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8-9-1-3-4-8" + width="210.17955" + height="35.209244" + x="354.54559" + y="511.00293" + rx="15" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="459.14709" + y="532.79895" + id="text5371-2-74-0-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-18-2-9" + x="459.14709" + y="532.79895" + style="font-size:16px;line-height:1.25;font-family:sans-serif">moved_permanently</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1-8-7-9" + width="218.52127" + height="34.993004" + x="350.37473" + y="988.43671" + rx="12.372616" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="459.67053" + y="1010.2067" + id="text5371-43-3-2-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-3-1-9-5" + x="459.67053" + y="1010.2067" + style="font-size:16px;line-height:1.25;font-family:sans-serif">410 gone</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="260.04547" + y="494.97446" + id="text5371-4-4-9-1-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-8-2" + x="260.04547" + y="494.97446" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="120.08566" + y="494.51349" + id="text5371-2-8-9-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3-4-55" + x="120.08566" + y="494.51349" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="133.92941" + y="574.40112" + id="text5371-4-4-9-1-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-8-0" + x="133.92941" + y="574.40112" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="315.87756" + y="828.86047" + id="text5371-4-4-9-1-1-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-8-0-1" + x="315.87756" + y="828.86047" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="498.78546" + y="972.02087" + id="text5371-4-4-9-1-1-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-8-0-2" + x="498.78546" + y="972.02087" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="458.9295" + y="1217.7582" + id="text5371-4-4-9-1-1-9-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-8-0-1-2" + x="458.9295" + y="1217.7582" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <g + transform="matrix(0,1,1,0,77.85132,1295.6715)" + id="g5650-2-2-6-6-7"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-6-3-8" + d="m -57.78256,339.02801 0,65.70583" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-5-1-1-7" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="207.75119" + y="1283.5576" + id="text5371-2-391-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63-4" + x="207.75119" + y="1283.5576" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <g + transform="matrix(0.70710678,0.70710678,-0.70710678,0.70710678,501.47379,1045.323)" + id="g5650-9-9-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-7-6-1" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-09-5-4" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:end;letter-spacing:0px;word-spacing:0px;text-anchor:end;fill:#6d8e41;fill-opacity:1;stroke:none" + x="419.81369" + y="1283.0615" + id="text5371-2-391-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + x="419.81369" + y="1283.0615" + id="tspan5794" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true, URI*</tspan></text> + <g + transform="matrix(-0.70710678,0.70710678,0.70710678,0.70710678,124.04665,1045.323)" + id="g5650-9-9-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-7-6-8" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-09-5-45" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="479.69171" + y="1363.2994" + id="text5371-2-8-4-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3-7-5" + x="479.69171" + y="1363.2994" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="626.74475" + y="1403.5779" + id="text5371-4-4-9-1-1-9-1-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-8-0-1-2-0" + x="626.74475" + y="1403.5779" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="624.0885" + y="1642.0209" + id="text5371-4-4-9-1-1-9-1-0" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-8-0-1-2-3" + x="624.0885" + y="1642.0209" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="317.91525" + y="1538.8624" + id="text5371-4-4-9-1-1-9-1-2" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-8-0-1-2-1" + x="317.91525" + y="1538.8624" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="190.83659" + y="1602.2036" + id="text5371-2-8-4-3-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3-7-5-9" + x="190.83659" + y="1602.2036" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="190.83659" + y="1363.1792" + id="text5371-2-8-4-3-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3-7-5-0" + x="190.83659" + y="1363.1792" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="7.9966321" + y="1443.395" + id="text5371-4-4-9-1-1-9-1-4-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-8-0-1-2-0-6" + x="7.9966321" + y="1443.395" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="317.86548" + y="1379.0562" + id="text5371-4-4-9-1-1-9-1-2-2" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-8-0-1-2-1-5" + x="317.86548" + y="1379.0562" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="190.83659" + y="1482.6313" + id="text5371-2-8-4-3-8-7" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3-7-5-0-8" + x="190.83659" + y="1482.6313" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="85.095001" + y="891.92566" + id="text5371-4-4-9-1-4-2" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-2-6-8-2-9" + x="85.095001" + y="891.92566" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="232.21094" + y="971.55994" + id="text5371-2-391-5-5-1-0-7-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-63-7-9-9-2-8-8" + x="232.21094" + y="971.55994" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <g + transform="matrix(0,-1,1,0,-359.02432,626.75367)" + id="g5650-2-0-4-3-8-9-4" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <g + id="g6614"> + <g + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + id="g5650-2-0-4-3-8-9" + transform="matrix(0,-1,-1,0,347.00351,567.35686)"> + <path + inkscape:transform-center-x="-3.1059024" + sodipodi:type="star" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="path5576-12-1-7-58-6-1-4" + sodipodi:sides="3" + sodipodi:cx="-222.73865" + sodipodi:cy="415.25897" + sodipodi:r1="14.849242" + sodipodi:r2="7.4246211" + sodipodi:arg1="1.5707963" + sodipodi:arg2="2.6179939" + inkscape:flatsided="true" + inkscape:rounded="0" + inkscape:randomized="0" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:transform-center-y="6.2755376" + transform="matrix(0.10770811,0.57792634,-0.57792634,0.10770811,224.52461,390.64831)" /> + </g> + <path + transform="translate(0,-1.5472441e-4)" + inkscape:connector-curvature="0" + id="path6438" + d="M 72.831997,543.06854 C 17.500892,616.78442 35.178561,698.8088 35.178561,698.8088" + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;stroke-miterlimit:4;stroke-dasharray:none" /> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="536.26642" + y="972.02087" + id="text5371-2-8-9-1-5" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3-4-1-4" + x="536.26642" + y="972.02087" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <g + transform="matrix(0,-1,-1,0,347.71062,566.6496)" + id="g5650-2-0-4-3-8-9-2-8" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-8-9-3-7-4" + inkscape:connector-curvature="0" + transform="matrix(0,1,-1,0,248.85545,276.69312)" /> + <path + transform="matrix(0.38224114,0.44664484,-0.44664484,0.38224114,233.48523,355.54168)" + inkscape:transform-center-y="-1.0388082" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1-7-58-6-1-5-3" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" + inkscape:transform-center-x="4.5299474" /> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="322.92551" + y="375.54388" + id="text5371-4-6-1" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-9-0-8" + x="322.92551" + y="375.54388" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="66.001251" + y="574.40112" + id="text5371-2-8-9-0-3" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-3-4-55-3" + x="66.001251" + y="574.40112" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + </g> +</svg> diff --git a/docs/en/cowboy/2.6/guide/rest_start.png b/docs/en/cowboy/2.6/guide/rest_start.png Binary files differnew file mode 100644 index 00000000..4c230a02 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_start.png diff --git a/docs/en/cowboy/2.6/guide/rest_start.svg b/docs/en/cowboy/2.6/guide/rest_start.svg new file mode 100644 index 00000000..6f1dd871 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/rest_start.svg @@ -0,0 +1,1656 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + xmlns:osb="http://www.openswatchbook.org/uri/2009/osb" + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="744.09448819" + height="1052.3622047" + id="svg2" + version="1.1" + inkscape:version="0.92.2 2405546, 2018-03-11" + sodipodi:docname="rest_start.svg" + inkscape:export-filename="/home/essen/Dropbox/Public/drawing.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <defs + id="defs4"> + <linearGradient + id="linearGradient5265"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5267" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.58823532;" + offset="1" + id="stop5269" /> + </linearGradient> + <linearGradient + id="linearGradient5251"> + <stop + style="stop-color:#69d2e7;stop-opacity:0.78431374;" + offset="0" + id="stop5253" /> + <stop + id="stop5263" + offset="0.5" + style="stop-color:#69d2e7;stop-opacity:1;" /> + <stop + style="stop-color:#69d2e7;stop-opacity:0.39215687;" + offset="1" + id="stop5255" /> + </linearGradient> + <linearGradient + id="linearGradient5233" + osb:paint="solid"> + <stop + style="stop-color:#69d2e7;stop-opacity:1;" + offset="0" + id="stop5235" /> + </linearGradient> + </defs> + <sodipodi:namedview + id="base" + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1.0" + inkscape:pageopacity="1" + inkscape:pageshadow="2" + inkscape:zoom="1.0000001" + inkscape:cx="213.11305" + inkscape:cy="726.77495" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="false" + inkscape:window-width="1920" + inkscape:window-height="1043" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="1" + inkscape:snap-global="true" + showguides="true"> + <inkscape:grid + type="xygrid" + id="grid5357" + empspacing="5" + visible="true" + enabled="true" + snapvisiblegridlinesonly="true" /> + </sodipodi:namedview> + <metadata + id="metadata7"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + <dc:title /> + </cc:Work> + </rdf:RDF> + </metadata> + <g + inkscape:label="Layer 1" + inkscape:groupmode="layer" + id="layer1"> + <path + inkscape:export-ydpi="89.926643" + inkscape:export-xdpi="89.926643" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:connector-curvature="0" + id="use5777" + d="m -360.31658,371.70113 203.00246,0.045" + style="fill:none;stroke:#6d8e41;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:1.99999999, 3.99999998;stroke-dashoffset:0" /> + <g + transform="translate(205.92143,-296.03137)" + id="g5650-7" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-9" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-0" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(205.92143,-212.00698)" + id="g5650-9" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-7" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-09" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(205.92143,-129.04326)" + id="g5650-0" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-5" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-1" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(205.92143,-44.866334)" + id="g5650-94" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-71" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-5" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(205.92143,38.329623)" + id="g5650-93" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-3" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-4" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(205.92143,122.59665)" + id="g5650-3" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-93" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-04" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(205.92143,206.62103)" + id="g5650-6" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-78" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-9" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(205.92143,289.59516)" + id="g5650-34" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-30" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-3" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(205.92143,373.37691)" + id="g5650-5" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-90" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-6" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="translate(205.92143,457.4117)" + id="g5650-1" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-33" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-2" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,-25.673146,80.832304)" + id="g5650-2-0" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-2-5" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-1" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,-25.673146,164.49956)" + id="g5650-2-6" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-6" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,-25.673146,248.1668)" + id="g5650-2-4" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-2-0" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-7" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,-25.673146,331.8341)" + id="g5650-2-04" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-2-9" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-0" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,-25.673146,415.50138)" + id="g5650-2-8" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-2-50" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-2" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,-25.673146,499.16862)" + id="g5650-2-1" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-2-2" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-9" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,-25.673146,582.83589)" + id="g5650-2-3" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-2-10" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-60" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,-25.673146,666.50315)" + id="g5650-2-44" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-2-11" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-73" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,1,0,-25.673146,750.17041)" + id="g5650-2-12" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-2-6" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-04" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-28" + width="210.17955" + height="35.209244" + x="43.049091" + y="204.67757" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-5" + width="210.17955" + height="35.209244" + x="43.049091" + y="288.40311" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-8" + width="210.17955" + height="35.209244" + x="43.049091" + y="372.01199" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-4" + width="210.17955" + height="35.209244" + x="43.049091" + y="455.67929" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-87" + width="210.17955" + height="35.209244" + x="43.049091" + y="539.34656" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-41" + width="210.17955" + height="35.209244" + x="43.049091" + y="623.01385" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-7" + width="210.17955" + height="35.209244" + x="43.049091" + y="706.68115" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-20" + width="210.17955" + height="35.209244" + x="43.049091" + y="790.34839" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1" + width="210.17955" + height="35.209244" + x="43.049091" + y="121.0042" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <g + id="g5650" + transform="translate(0,-0.47597102)"> + <path + inkscape:connector-curvature="0" + id="path5570" + d="m -57.78256,351.41962 0,52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273" + width="104.5895" + height="36.392323" + x="-224.02068" + y="29.41218" + rx="15" /> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7" + width="104.5895" + height="36.392323" + x="-224.02068" + y="90.691978" + rx="15" /> + <rect + style="fill:#ffc48c;fill-opacity:1;fill-rule:nonzero;stroke:#d79c64;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-2" + width="104.5895" + height="36.392323" + x="-224.02068" + y="151.97169" + rx="15" /> + <rect + style="fill:#ff9f80;fill-opacity:1;fill-rule:nonzero;stroke:#d77758;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-22" + width="104.5895" + height="36.392323" + x="-224.02068" + y="213.25146" + rx="15" /> + <rect + style="fill:#f56991;fill-opacity:1;fill-rule:nonzero;stroke:#cd4169;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-8" + width="104.5895" + height="36.392323" + x="-224.02068" + y="274.53128" + rx="15" /> + <use + x="0" + y="0" + xlink:href="#rect5273-22" + id="use5355" + transform="translate(319.86479,-176.50006)" + width="744.09448" + height="1052.3622" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="-58.692513" + y="114.39204" + id="text5371"><tspan + sodipodi:role="line" + id="tspan5373" + x="-58.692513" + y="114.39204" + style="font-size:16px;line-height:1.25;font-family:sans-serif">some text</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="-58.692513" + y="53.112247" + id="text5371-2"><tspan + sodipodi:role="line" + id="tspan5373-6" + x="-58.692513" + y="53.112247" + style="font-size:16px;line-height:1.25;font-family:sans-serif">some text</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="148.18575" + y="310.19913" + id="text5371-2-3" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-7" + x="148.18575" + y="310.19913" + style="font-size:16px;line-height:1.25;font-family:sans-serif">uri_too_long</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="147.60762" + y="477.47531" + id="text5371-2-3-0" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-7-3" + x="147.60762" + y="477.47531" + style="font-size:16px;line-height:1.25;font-family:sans-serif">malformed_request</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="-58.692513" + y="236.95154" + id="text5371-4"><tspan + sodipodi:role="line" + id="tspan5373-9" + x="-58.692513" + y="236.95154" + style="font-size:16px;line-height:1.25;font-family:sans-serif">some text</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="147.00391" + y="60.912468" + id="text5371-4-0" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + x="147.00391" + y="60.912468" + id="tspan17171" + style="font-size:16px;line-height:1.25;font-family:sans-serif">init</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="148.11153" + y="561.14258" + id="text5371-2-9" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-8" + x="148.11153" + y="561.14258" + style="font-size:16px;line-height:1.25;font-family:sans-serif">is_authorized</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="148.64278" + y="646.58331" + id="text5371-2-7" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-2" + x="148.64278" + y="646.58331" + style="font-size:16px;line-height:1.25;font-family:sans-serif">forbidden</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="148.29512" + y="728.47717" + id="text5371-2-73" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-5" + x="148.29512" + y="728.47717" + style="font-size:16px;line-height:1.25;font-family:sans-serif">valid_content_headers</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="147.83809" + y="812.14441" + id="text5371-2-5" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-1" + x="147.83809" + y="812.14441" + style="font-size:16px;line-height:1.25;font-family:sans-serif">valid_entity_length</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="148.58809" + y="895.81165" + id="text5371-2-1" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-71" + x="148.58809" + y="895.81165" + style="font-size:16px;line-height:1.25;font-family:sans-serif">...</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="148.13106" + y="142.80627" + id="text5371-2-95" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-80" + x="148.13106" + y="142.80627" + style="font-size:16px;line-height:1.25;font-family:sans-serif">service_available</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="147.80684" + y="226.4736" + id="text5371-2-32" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-27" + x="147.80684" + y="226.4736" + style="font-size:16px;line-height:1.25;font-family:sans-serif">known_methods</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="148.05293" + y="393.80801" + id="text5371-2-74" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-18" + x="148.05293" + y="393.80801" + style="font-size:16px;line-height:1.25;font-family:sans-serif">allowed_methods</tspan></text> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-2" + width="210.17955" + height="35.209244" + x="-489.75586" + y="33.4944" + rx="15" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="164.26562" + y="185.95248" + id="text5371-2-391" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-63" + x="164.26562" + y="185.95248" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="164.26562" + y="269.61978" + id="text5371-2-954" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-808" + x="164.26562" + y="269.61978" + style="font-size:16px;line-height:1.25;font-family:sans-serif">known*</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="164.26562" + y="353.28702" + id="text5371-2-4" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-11" + x="164.26562" + y="353.28702" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="164.26562" + y="436.95425" + id="text5371-2-92" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-4" + x="164.26562" + y="436.95425" + style="font-size:16px;line-height:1.25;font-family:sans-serif">allowed*</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="164.26562" + y="520.62152" + id="text5371-2-739" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-0" + x="164.26562" + y="520.62152" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="164.26562" + y="604.28876" + id="text5371-2-8" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-3" + x="164.26562" + y="604.28876" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="164.26562" + y="687.95599" + id="text5371-2-0" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-01" + x="164.26562" + y="687.95599" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="164.26562" + y="771.62329" + id="text5371-2-2" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-33" + x="164.26562" + y="771.62329" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="164.26562" + y="855.29053" + id="text5371-2-21" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-9" + x="164.26562" + y="855.29053" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <g + transform="matrix(0,-1,1,0,-513.31414,353.05561)" + id="g5650-2"> + <path + inkscape:connector-curvature="0" + id="path5570-2" + d="m -57.78256,275.13761 0,129.13992" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + sodipodi:type="star" /> + </g> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="315.26172" + y="123.86062" + id="text5371-4-6" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-9-0" + x="315.26172" + y="123.86062" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="315.26172" + y="207.30568" + id="text5371-4-7" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-9-6" + x="315.26172" + y="207.30568" + style="font-size:16px;line-height:1.25;font-family:sans-serif">unknown*</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="315.26172" + y="290.75076" + id="text5371-4-2" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-9-01" + x="315.26172" + y="290.75076" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="315.26172" + y="374.19577" + id="text5371-4-3" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-9-62" + x="315.26172" + y="374.19577" + style="font-size:16px;line-height:1.25;font-family:sans-serif">unallowed*</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="315.26172" + y="457.64084" + id="text5371-4-4" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-9-2" + x="315.26172" + y="457.64084" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="315.26172" + y="541.08588" + id="text5371-4-5" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-9-09" + x="315.26172" + y="541.08588" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false*</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="315.26172" + y="624.53094" + id="text5371-4-61" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-9-69" + x="315.26172" + y="624.53094" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="315.26172" + y="707.97595" + id="text5371-4-58" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-9-5" + x="315.26172" + y="707.97595" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="315.26172" + y="791.42102" + id="text5371-4-54" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-9-012" + x="315.26172" + y="791.42102" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3" + width="264.92532" + height="34.728001" + x="392.03732" + y="121.24477" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="524.53516" + y="143.02283" + id="text5371-6" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + x="524.53516" + y="143.02283" + id="tspan18994" + style="font-size:16px;line-height:1.25;font-family:sans-serif">503 service unavailable</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-9" + width="264.92532" + height="34.728001" + x="392.03732" + y="204.93674" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-6" + width="264.92532" + height="34.728001" + x="392.03732" + y="288.62869" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-1" + width="264.92532" + height="34.728001" + x="392.03732" + y="372.32065" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-90" + width="264.92532" + height="34.728001" + x="392.03732" + y="456.01254" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-2" + width="264.92532" + height="34.728001" + x="392.03732" + y="539.70447" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-3" + width="264.92532" + height="34.728001" + x="392.03732" + y="623.39642" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-39" + width="264.92532" + height="34.728001" + x="392.03732" + y="707.08838" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-7-3-5" + width="264.92532" + height="34.728001" + x="392.03732" + y="790.78027" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="524.26172" + y="227.80464" + id="text5371-7" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-69" + x="524.26172" + y="227.80464" + style="font-size:16px;line-height:1.25;font-family:sans-serif">501 not implemented</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="524.26172" + y="311.49661" + id="text5371-9" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-5" + x="524.26172" + y="311.49661" + style="font-size:16px;line-height:1.25;font-family:sans-serif">414 request URI too long</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="524.26172" + y="395.18857" + id="text5371-43" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-3" + x="524.26172" + y="395.18857" + style="font-size:16px;line-height:1.25;font-family:sans-serif">405 method not allowed</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="524.26172" + y="478.88046" + id="text5371-3" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-67" + x="524.26172" + y="478.88046" + style="font-size:16px;line-height:1.25;font-family:sans-serif">400 bad request</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="524.26172" + y="562.57239" + id="text5371-1" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-53" + x="524.26172" + y="562.57239" + style="font-size:16px;line-height:1.25;font-family:sans-serif">401 unauthorized</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="524.26172" + y="646.26434" + id="text5371-27" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-64" + x="524.26172" + y="646.26434" + style="font-size:16px;line-height:1.25;font-family:sans-serif">403 forbidden</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="524.26172" + y="729.9563" + id="text5371-21" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-58" + x="524.26172" + y="729.9563" + style="font-size:16px;line-height:1.25;font-family:sans-serif">501 not implemented</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="524.26172" + y="813.64819" + id="text5371-5" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-60" + x="524.26172" + y="813.64819" + style="font-size:16px;line-height:1.25;font-family:sans-serif">413 request entity too large</tspan></text> + <rect + style="fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:2.44279909;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5367" + width="207.05719" + height="171.55719" + x="-373.52859" + y="458.58362" + rx="11.072577" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="-544.69421" + y="-354.17184" + id="text5371-2-3-0-7" + transform="rotate(-90)" + inkscape:export-filename="/home/essen/extend/cowboy/guide/http_req_resp.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"><tspan + sodipodi:role="line" + id="tspan5373-6-7-3-9" + x="-544.69421" + y="-354.17184" + style="font-size:16px;line-height:1.25;font-family:sans-serif">middlewares</tspan></text> + <g + transform="translate(205.92143,541.07893)" + id="g5650-1-3" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-33-6" + d="m -57.78256,351.41962 v 52.3259" + style="opacity:0.8;fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-2-7" + style="opacity:0.8;fill:#6d8e41;fill-opacity:1;fill-rule:nonzero;stroke:#6d8e41;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="rotate(-90,404.08225,429.75539)" + id="g5650-2-12-5" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> + <path + inkscape:connector-curvature="0" + id="path5570-2-6-3" + d="M -57.78256,275.13761 V 404.27753" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> + <path + transform="matrix(0.58787746,0,0,0.58787746,73.160466,163.35774)" + inkscape:transform-center-y="2.1823437" + d="m -222.73865,430.10821 -12.85982,-22.27386 25.71964,0 z" + inkscape:randomized="0" + inkscape:rounded="0" + inkscape:flatsided="true" + sodipodi:arg2="2.6179939" + sodipodi:arg1="1.5707963" + sodipodi:r2="7.4246211" + sodipodi:r1="14.849242" + sodipodi:cy="415.25897" + sodipodi:cx="-222.73865" + sodipodi:sides="3" + id="path5576-12-04-5" + style="opacity:0.8;fill:#9b3b1c;fill-opacity:1;fill-rule:nonzero;stroke:#9b3b1c;stroke-width:0;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" + id="rect5273-1-3" + width="210.17955" + height="35.209244" + x="43.049091" + y="874.01562" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <rect + style="fill:#d1f2a5;fill-opacity:1;fill-rule:nonzero;stroke:#a9ca7d;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-3-2" + width="210.17955" + height="35.209244" + x="43.049088" + y="957.68286" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="147.8381" + y="895.81165" + id="text5371-2-5-9" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-1-1" + x="147.8381" + y="895.81165" + style="font-size:16px;line-height:1.25;font-family:sans-serif">rate_limited</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#6d8e41;fill-opacity:1;stroke:none" + x="148.5881" + y="979.47888" + id="text5371-2-1-2" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-71-7" + x="148.5881" + y="979.47888" + style="font-size:16px;line-height:1.25;font-family:sans-serif">...</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="164.26562" + y="855.29053" + id="text5371-2-2-0" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-33-9" + x="164.26562" + y="855.29053" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="164.26562" + y="938.95776" + id="text5371-2-21-3" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-6-9-6" + x="164.26562" + y="938.95776" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="315.26172" + y="875.08826" + id="text5371-4-54-0" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-9-012-6" + x="315.26172" + y="875.08826" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true*</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-5-2" + width="264.92532" + height="34.728001" + x="392.03729" + y="874.44751" + rx="15" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" /> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#77823c;fill-opacity:1;stroke:none" + x="524.26172" + y="897.31543" + id="text5371-5-6" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"><tspan + sodipodi:role="line" + id="tspan5373-60-1" + x="524.26172" + y="897.31543" + style="font-size:16px;line-height:1.25;font-family:sans-serif">429 too many requests</tspan></text> + </g> +</svg> diff --git a/docs/en/cowboy/2.6/guide/routing.asciidoc b/docs/en/cowboy/2.6/guide/routing.asciidoc new file mode 100644 index 00000000..e5f8c33f --- /dev/null +++ b/docs/en/cowboy/2.6/guide/routing.asciidoc @@ -0,0 +1,230 @@ +[[routing]] +== Routing + +Cowboy does nothing by default. + +To make Cowboy useful, you need to map URIs to Erlang modules that will +handle the requests. This is called routing. + +When Cowboy receives a request, it tries to match the requested host and +path to the configured routes. When there's a match, the route's +associated handler is executed. + +Routes need to be compiled before they can be used by Cowboy. +The result of the compilation is the dispatch rules. + +=== Syntax + +The general structure for the routes is defined as follow. + +[source,erlang] +Routes = [Host1, Host2, ... HostN]. + +Each host contains matching rules for the host along with optional +constraints, and a list of routes for the path component. + +[source,erlang] +Host1 = {HostMatch, PathsList}. +Host2 = {HostMatch, Constraints, PathsList}. + +The list of routes for the path component is defined similar to the +list of hosts. + +[source,erlang] +PathsList = [Path1, Path2, ... PathN]. + +Finally, each path contains matching rules for the path along with +optional constraints, and gives us the handler module to be used +along with its initial state. + +[source,erlang] +Path1 = {PathMatch, Handler, InitialState}. +Path2 = {PathMatch, Constraints, Handler, InitialState}. + +Continue reading to learn more about the match syntax and the optional +constraints. + +=== Match syntax + +The match syntax is used to associate host names and paths with their +respective handlers. + +The match syntax is the same for host and path with a few subtleties. +Indeed, the segments separator is different, and the host is matched +starting from the last segment going to the first. All examples will +feature both host and path match rules and explain the differences +when encountered. + +Excluding special values that we will explain at the end of this section, +the simplest match value is a host or a path. It can be given as either +a `string()` or a `binary()`. + +[source,erlang] +---- +PathMatch1 = "/". +PathMatch2 = "/path/to/resource". + +HostMatch1 = "cowboy.example.org". +---- + +As you can see, all paths defined this way must start with a slash +character. Note that these two paths are identical as far as routing +is concerned. + +[source,erlang] +PathMatch2 = "/path/to/resource". +PathMatch3 = "/path/to/resource/". + +Hosts with and without a trailing dot are equivalent for routing. +Similarly, hosts with and without a leading dot are also equivalent. + +[source,erlang] +HostMatch1 = "cowboy.example.org". +HostMatch2 = "cowboy.example.org.". +HostMatch3 = ".cowboy.example.org". + +It is possible to extract segments of the host and path and to store +the values in the `Req` object for later use. We call these kind of +values bindings. + +The syntax for bindings is very simple. A segment that begins with +the `:` character means that what follows until the end of the segment +is the name of the binding in which the segment value will be stored. + +[source,erlang] +PathMatch = "/hats/:name/prices". +HostMatch = ":subdomain.example.org". + +If these two end up matching when routing, you will end up with two +bindings defined, `subdomain` and `name`, each containing the +segment value where they were defined. For example, the URL +`http://test.example.org/hats/wild_cowboy_legendary/prices` will +result in having the value `test` bound to the name `subdomain` +and the value `wild_cowboy_legendary` bound to the name `name`. +They can later be retrieved using `cowboy_req:binding/{2,3}`. The +binding name must be given as an atom. + +There is a special binding name you can use to mimic the underscore +variable in Erlang. Any match against the `_` binding will succeed +but the data will be discarded. This is especially useful for +matching against many domain names in one go. + +[source,erlang] +HostMatch = "ninenines.:_". + +Similarly, it is possible to have optional segments. Anything +between brackets is optional. + +[source,erlang] +PathMatch = "/hats/[page/:number]". +HostMatch = "[www.]ninenines.eu". + +You can also have imbricated optional segments. + +[source,erlang] +PathMatch = "/hats/[page/[:number]]". + +While Cowboy does not reject multiple brackets in a route, +the behavior may be undefined if the route is under-specified. +For example, this route requires constraints to determine what +is a chapter and what is a page, since they are both optional: + +[source,erlang] +PathMatch = "/book/[:chapter]/[:page]". + +You can retrieve the rest of the host or path using `[...]`. +In the case of hosts it will match anything before, in the case +of paths anything after the previously matched segments. It is +a special case of optional segments, in that it can have +zero, one or many segments. You can then find the segments using +`cowboy_req:host_info/1` and `cowboy_req:path_info/1` respectively. +They will be represented as a list of segments. + +[source,erlang] +PathMatch = "/hats/[...]". +HostMatch = "[...]ninenines.eu". + +If a binding appears twice in the routing rules, then the match +will succeed only if they share the same value. This copies the +Erlang pattern matching behavior. + +[source,erlang] +PathMatch = "/hats/:name/:name". + +This is also true when an optional segment is present. In this +case the two values must be identical only if the segment is +available. + +[source,erlang] +PathMatch = "/hats/:name/[:name]". + +If a binding is defined in both the host and path, then they must +also share the same value. + +[source,erlang] +PathMatch = "/:user/[...]". +HostMatch = ":user.github.com". + +Finally, there are two special match values that can be used. The +first is the atom `'_'` which will match any host or path. + +[source,erlang] +PathMatch = '_'. +HostMatch = '_'. + +The second is the special host match `"*"` which will match the +wildcard path, generally used alongside the `OPTIONS` method. + +[source,erlang] +HostMatch = "*". + +=== Constraints + +After the matching has completed, the resulting bindings can be tested +against a set of constraints. Constraints are only tested when the +binding is defined. They run in the order you defined them. The match +will succeed only if they all succeed. If the match fails, then Cowboy +tries the next route in the list. + +The format used for constraints is the same as match functions in +`cowboy_req`: they are provided as a list of fields which may have +one or more constraints. While the router accepts the same format, +it will skip fields with no constraints and will also ignore default +values, if any. + +Read more about xref:constraints[constraints]. + +=== Compilation + +The routes must be compiled before Cowboy can use them. The compilation +step normalizes the routes to simplify the code and speed up the +execution, but the routes are still looked up one by one in the end. +Faster compilation strategies could be to compile the routes directly +to Erlang code, but would require heavier dependencies. + +To compile routes, just call the appropriate function: + +[source,erlang] +---- +Dispatch = cowboy_router:compile([ + %% {HostMatch, list({PathMatch, Handler, InitialState})} + {'_', [{'_', my_handler, #{}}]} +]), +%% Name, NbAcceptors, TransOpts, ProtoOpts +cowboy:start_clear(my_http_listener, + [{port, 8080}], + #{env => #{dispatch => Dispatch}} +). +---- + +=== Live update + +You can use the `cowboy:set_env/3` function for updating the dispatch +list used by routing. This will apply to all new connections accepted +by the listener: + +[source,erlang] +Dispatch = cowboy_router:compile(Routes), +cowboy:set_env(my_http_listener, dispatch, Dispatch). + +Note that you need to compile the routes again before updating. diff --git a/docs/en/cowboy/2.6/guide/routing/index.html b/docs/en/cowboy/2.6/guide/routing/index.html new file mode 100644 index 00000000..57da48e0 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/routing/index.html @@ -0,0 +1,350 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Routing</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Routing</span></h1> + +<p>Cowboy does nothing by default.</p> +<p>To make Cowboy useful, you need to map URIs to Erlang modules that will handle the requests. This is called routing.</p> +<p>When Cowboy receives a request, it tries to match the requested host and path to the configured routes. When there's a match, the route's associated handler is executed.</p> +<p>Routes need to be compiled before they can be used by Cowboy. The result of the compilation is the dispatch rules.</p> +<h2 id="_syntax">Syntax</h2> +<p>The general structure for the routes is defined as follow.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Routes</font> <font color="#990000">=</font> [<font color="#009900">Host1</font>, <font color="#009900">Host2</font>, <font color="#990000">...</font> <font color="#009900">HostN</font>]<font color="#990000">.</font></tt></pre> +</div></div> +<p>Each host contains matching rules for the host along with optional constraints, and a list of routes for the path component.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Host1</font> <font color="#990000">=</font> {<font color="#009900">HostMatch</font>, <font color="#009900">PathsList</font>}<font color="#990000">.</font> +<font color="#009900">Host2</font> <font color="#990000">=</font> {<font color="#009900">HostMatch</font>, <font color="#009900">Constraints</font>, <font color="#009900">PathsList</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>The list of routes for the path component is defined similar to the list of hosts.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PathsList</font> <font color="#990000">=</font> [<font color="#009900">Path1</font>, <font color="#009900">Path2</font>, <font color="#990000">...</font> <font color="#009900">PathN</font>]<font color="#990000">.</font></tt></pre> +</div></div> +<p>Finally, each path contains matching rules for the path along with optional constraints, and gives us the handler module to be used along with its initial state.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Path1</font> <font color="#990000">=</font> {<font color="#009900">PathMatch</font>, <font color="#009900">Handler</font>, <font color="#009900">InitialState</font>}<font color="#990000">.</font> +<font color="#009900">Path2</font> <font color="#990000">=</font> {<font color="#009900">PathMatch</font>, <font color="#009900">Constraints</font>, <font color="#009900">Handler</font>, <font color="#009900">InitialState</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>Continue reading to learn more about the match syntax and the optional constraints.</p> +<h2 id="_match_syntax">Match syntax</h2> +<p>The match syntax is used to associate host names and paths with their respective handlers.</p> +<p>The match syntax is the same for host and path with a few subtleties. Indeed, the segments separator is different, and the host is matched starting from the last segment going to the first. All examples will feature both host and path match rules and explain the differences when encountered.</p> +<p>Excluding special values that we will explain at the end of this section, the simplest match value is a host or a path. It can be given as either a <code>string()</code> or a <code>binary()</code>.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PathMatch1</font> <font color="#990000">=</font> <font color="#FF0000">"/"</font><font color="#990000">.</font> +<font color="#009900">PathMatch2</font> <font color="#990000">=</font> <font color="#FF0000">"/path/to/resource"</font><font color="#990000">.</font> + +<font color="#009900">HostMatch1</font> <font color="#990000">=</font> <font color="#FF0000">"cowboy.example.org"</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>As you can see, all paths defined this way must start with a slash character. Note that these two paths are identical as far as routing is concerned.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PathMatch2</font> <font color="#990000">=</font> <font color="#FF0000">"/path/to/resource"</font><font color="#990000">.</font> +<font color="#009900">PathMatch3</font> <font color="#990000">=</font> <font color="#FF0000">"/path/to/resource/"</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>Hosts with and without a trailing dot are equivalent for routing. Similarly, hosts with and without a leading dot are also equivalent.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">HostMatch1</font> <font color="#990000">=</font> <font color="#FF0000">"cowboy.example.org"</font><font color="#990000">.</font> +<font color="#009900">HostMatch2</font> <font color="#990000">=</font> <font color="#FF0000">"cowboy.example.org."</font><font color="#990000">.</font> +<font color="#009900">HostMatch3</font> <font color="#990000">=</font> <font color="#FF0000">".cowboy.example.org"</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>It is possible to extract segments of the host and path and to store the values in the <code>Req</code> object for later use. We call these kind of values bindings.</p> +<p>The syntax for bindings is very simple. A segment that begins with the <code>:</code> character means that what follows until the end of the segment is the name of the binding in which the segment value will be stored.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PathMatch</font> <font color="#990000">=</font> <font color="#FF0000">"/hats/:name/prices"</font><font color="#990000">.</font> +<font color="#009900">HostMatch</font> <font color="#990000">=</font> <font color="#FF0000">":subdomain.example.org"</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>If these two end up matching when routing, you will end up with two bindings defined, <code>subdomain</code> and <code>name</code>, each containing the segment value where they were defined. For example, the URL <code>http://test.example.org/hats/wild_cowboy_legendary/prices</code> will result in having the value <code>test</code> bound to the name <code>subdomain</code> and the value <code>wild_cowboy_legendary</code> bound to the name <code>name</code>. They can later be retrieved using <code>cowboy_req:binding/{2,3}</code>. The binding name must be given as an atom.</p> +<p>There is a special binding name you can use to mimic the underscore variable in Erlang. Any match against the <code>_</code> binding will succeed but the data will be discarded. This is especially useful for matching against many domain names in one go.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">HostMatch</font> <font color="#990000">=</font> <font color="#FF0000">"ninenines.:_"</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>Similarly, it is possible to have optional segments. Anything between brackets is optional.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PathMatch</font> <font color="#990000">=</font> <font color="#FF0000">"/hats/[page/:number]"</font><font color="#990000">.</font> +<font color="#009900">HostMatch</font> <font color="#990000">=</font> <font color="#FF0000">"[www.]ninenines.eu"</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>You can also have imbricated optional segments.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PathMatch</font> <font color="#990000">=</font> <font color="#FF0000">"/hats/[page/[:number]]"</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>While Cowboy does not reject multiple brackets in a route, the behavior may be undefined if the route is under-specified. For example, this route requires constraints to determine what is a chapter and what is a page, since they are both optional:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PathMatch</font> <font color="#990000">=</font> <font color="#FF0000">"/book/[:chapter]/[:page]"</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>You can retrieve the rest of the host or path using <code>[...]</code>. In the case of hosts it will match anything before, in the case of paths anything after the previously matched segments. It is a special case of optional segments, in that it can have zero, one or many segments. You can then find the segments using <code>cowboy_req:host_info/1</code> and <code>cowboy_req:path_info/1</code> respectively. They will be represented as a list of segments.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PathMatch</font> <font color="#990000">=</font> <font color="#FF0000">"/hats/[...]"</font><font color="#990000">.</font> +<font color="#009900">HostMatch</font> <font color="#990000">=</font> <font color="#FF0000">"[...]ninenines.eu"</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>If a binding appears twice in the routing rules, then the match will succeed only if they share the same value. This copies the Erlang pattern matching behavior.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PathMatch</font> <font color="#990000">=</font> <font color="#FF0000">"/hats/:name/:name"</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>This is also true when an optional segment is present. In this case the two values must be identical only if the segment is available.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PathMatch</font> <font color="#990000">=</font> <font color="#FF0000">"/hats/:name/[:name]"</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>If a binding is defined in both the host and path, then they must also share the same value.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PathMatch</font> <font color="#990000">=</font> <font color="#FF0000">"/:user/[...]"</font><font color="#990000">.</font> +<font color="#009900">HostMatch</font> <font color="#990000">=</font> <font color="#FF0000">":user.github.com"</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>Finally, there are two special match values that can be used. The first is the atom <code>'_'</code> which will match any host or path.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PathMatch</font> <font color="#990000">=</font> <font color="#FF6600">'_'</font><font color="#990000">.</font> +<font color="#009900">HostMatch</font> <font color="#990000">=</font> <font color="#FF6600">'_'</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>The second is the special host match <code>"*"</code> which will match the wildcard path, generally used alongside the <code>OPTIONS</code> method.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">HostMatch</font> <font color="#990000">=</font> <font color="#FF0000">"*"</font><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_constraints">Constraints</h2> +<p>After the matching has completed, the resulting bindings can be tested against a set of constraints. Constraints are only tested when the binding is defined. They run in the order you defined them. The match will succeed only if they all succeed. If the match fails, then Cowboy tries the next route in the list.</p> +<p>The format used for constraints is the same as match functions in <code>cowboy_req</code>: they are provided as a list of fields which may have one or more constraints. While the router accepts the same format, it will skip fields with no constraints and will also ignore default values, if any.</p> +<p>Read more about <a href="../constraints">constraints</a>.</p> +<h2 id="_compilation">Compilation</h2> +<p>The routes must be compiled before Cowboy can use them. The compilation step normalizes the routes to simplify the code and speed up the execution, but the routes are still looked up one by one in the end. Faster compilation strategies could be to compile the routes directly to Erlang code, but would require heavier dependencies.</p> +<p>To compile routes, just call the appropriate function:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Dispatch</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_router:compile</font></b>([ + <i><font color="#9A1900">%% {HostMatch, list({PathMatch, Handler, InitialState})}</font></i> + {<font color="#FF6600">'_'</font>, [{<font color="#FF6600">'_'</font>, <font color="#FF6600">my_handler</font>, #{}}]} +]), +<i><font color="#9A1900">%% Name, NbAcceptors, TransOpts, ProtoOpts</font></i> +<b><font color="#000000">cowboy:start_clear</font></b>(<font color="#FF6600">my_http_listener</font>, + [{<font color="#FF6600">port</font>, <font color="#993399">8080</font>}], + #{<font color="#0000FF">env</font> <font color="#990000">=></font> #{<font color="#0000FF">dispatch</font> <font color="#990000">=></font> <font color="#009900">Dispatch</font>}} +)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_live_update">Live update</h2> +<p>You can use the <code>cowboy:set_env/3</code> function for updating the dispatch list used by routing. This will apply to all new connections accepted by the listener:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Dispatch</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_router:compile</font></b>(<font color="#009900">Routes</font>), +<b><font color="#000000">cowboy:set_env</font></b>(<font color="#FF6600">my_http_listener</font>, <font color="#FF6600">dispatch</font>, <font color="#009900">Dispatch</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Note that you need to compile the routes again before updating.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/listeners/"> + Listeners + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/constraints/"> + Constraints + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/specs.asciidoc b/docs/en/cowboy/2.6/guide/specs.asciidoc new file mode 100644 index 00000000..fa76793f --- /dev/null +++ b/docs/en/cowboy/2.6/guide/specs.asciidoc @@ -0,0 +1,198 @@ +[appendix] +== HTTP and other specifications + +This chapter intends to list all the specification documents +for or related to HTTP. + +=== HTTP + +==== IANA Registries + +* https://www.iana.org/assignments/http-methods/http-methods.xhtml[HTTP Method Registry] +* https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml[HTTP Status Code Registry] +* https://www.iana.org/assignments/message-headers/message-headers.xhtml[Message Headers] +* https://www.iana.org/assignments/http-parameters/http-parameters.xhtml[HTTP Parameters] +* https://www.iana.org/assignments/http-alt-svc-parameters/http-alt-svc-parameters.xhtml[HTTP Alt-Svc Parameter Registry] +* https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml[HTTP Authentication Scheme Registry] +* https://www.iana.org/assignments/http-cache-directives/http-cache-directives.xhtml[HTTP Cache Directive Registry] +* https://www.iana.org/assignments/http-dig-alg/http-dig-alg.xhtml[HTTP Digest Algorithm Values] +* https://www.iana.org/assignments/hoba-device-identifiers/hoba-device-identifiers.xhtml[HTTP Origin-Bound Authentication Device Identifier Types] +* https://www.iana.org/assignments/http-upgrade-tokens/http-upgrade-tokens.xhtml[HTTP Upgrade Token Registry] +* https://www.iana.org/assignments/http-warn-codes/http-warn-codes.xhtml[HTTP Warn Codes] +* https://www.iana.org/assignments/http2-parameters/http2-parameters.xhtml[HTTP/2 Parameters] +* https://www.ietf.org/assignments/websocket/websocket.xml[WebSocket Protocol Registries] + +==== Current + +* http://www.w3.org/TR/cors/[CORS]: Cross-Origin Resource Sharing +* http://www.w3.org/TR/CSP2/[CSP2]: Content Security Policy Level 2 +* http://www.w3.org/TR/tracking-dnt/[DNT]: Tracking Preference Expression (DNT) +* http://www.w3.org/TR/eventsource/[eventsource]: Server-Sent Events +* https://www.w3.org/TR/html4/interact/forms.html#h-17.13.4[Form content types]: Form content types +* https://www.w3.org/TR/preload/[Preload]: Preload +* https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt[PROXY]: The PROXY protocol +* http://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm[REST]: Fielding's Dissertation +* https://tools.ietf.org/html/rfc1945[RFC 1945]: HTTP/1.0 +* https://tools.ietf.org/html/rfc1951[RFC 1951]: DEFLATE Compressed Data Format Specification version 1.3 +* https://tools.ietf.org/html/rfc1952[RFC 1952]: GZIP file format specification version 4.3 +* https://tools.ietf.org/html/rfc2046#section-5.1[RFC 2046]: Multipart media type (in MIME Part Two: Media Types) +* https://tools.ietf.org/html/rfc2295[RFC 2295]: Transparent Content Negotiation in HTTP +* https://tools.ietf.org/html/rfc2296[RFC 2296]: HTTP Remote Variant Selection Algorithm: RVSA/1.0 +* https://tools.ietf.org/html/rfc2817[RFC 2817]: Upgrading to TLS Within HTTP/1.1 +* https://tools.ietf.org/html/rfc2818[RFC 2818]: HTTP Over TLS +* https://tools.ietf.org/html/rfc3230[RFC 3230]: Instance Digests in HTTP +* https://tools.ietf.org/html/rfc4559[RFC 4559]: SPNEGO-based Kerberos and NTLM HTTP Authentication in Microsoft Windows +* https://tools.ietf.org/html/rfc5789[RFC 5789]: PATCH Method for HTTP +* https://tools.ietf.org/html/rfc5843[RFC 5843]: Additional Hash Algorithms for HTTP Instance Digests +* https://tools.ietf.org/html/rfc5861[RFC 5861]: HTTP Cache-Control Extensions for Stale Content +* https://tools.ietf.org/html/rfc5988[RFC 5988]: Web Linking +* https://tools.ietf.org/html/rfc6265[RFC 6265]: HTTP State Management Mechanism +* https://tools.ietf.org/html/rfc6266[RFC 6266]: Use of the Content-Disposition Header Field +* https://tools.ietf.org/html/rfc6454[RFC 6454]: The Web Origin Concept +* https://tools.ietf.org/html/rfc6455[RFC 6455]: The WebSocket Protocol +* https://tools.ietf.org/html/rfc6585[RFC 6585]: Additional HTTP Status Codes +* https://tools.ietf.org/html/rfc6750[RFC 6750]: The OAuth 2.0 Authorization Framework: Bearer Token Usage +* https://tools.ietf.org/html/rfc6797[RFC 6797]: HTTP Strict Transport Security (HSTS) +* https://tools.ietf.org/html/rfc6903[RFC 6903]: Additional Link Relation Types +* https://tools.ietf.org/html/rfc7034[RFC 7034]: HTTP Header Field X-Frame-Options +* https://tools.ietf.org/html/rfc7089[RFC 7089]: Time-Based Access to Resource States: Memento +* https://tools.ietf.org/html/rfc7230[RFC 7230]: HTTP/1.1 Message Syntax and Routing +* https://tools.ietf.org/html/rfc7231[RFC 7231]: HTTP/1.1 Semantics and Content +* https://tools.ietf.org/html/rfc7232[RFC 7232]: HTTP/1.1 Conditional Requests +* https://tools.ietf.org/html/rfc7233[RFC 7233]: HTTP/1.1 Range Requests +* https://tools.ietf.org/html/rfc7234[RFC 7234]: HTTP/1.1 Caching +* https://tools.ietf.org/html/rfc7235[RFC 7235]: HTTP/1.1 Authentication +* https://tools.ietf.org/html/rfc7239[RFC 7239]: Forwarded HTTP Extension +* https://tools.ietf.org/html/rfc7240[RFC 7240]: Prefer Header for HTTP +* https://tools.ietf.org/html/rfc7469[RFC 7469]: Public Key Pinning Extension for HTTP +* https://tools.ietf.org/html/rfc7486[RFC 7486]: HTTP Origin-Bound Authentication (HOBA) +* https://tools.ietf.org/html/rfc7538[RFC 7538]: HTTP Status Code 308 (Permanent Redirect) +* https://tools.ietf.org/html/rfc7540[RFC 7540]: Hypertext Transfer Protocol Version 2 (HTTP/2) +* https://tools.ietf.org/html/rfc7541[RFC 7541]: HPACK: Header Compression for HTTP/2 +* https://tools.ietf.org/html/rfc7578[RFC 7578]: Returning Values from Forms: multipart/form-data +* https://tools.ietf.org/html/rfc7615[RFC 7615]: HTTP Authentication-Info and Proxy-Authentication-Info Response Header Fields +* https://tools.ietf.org/html/rfc7616[RFC 7616]: HTTP Digest Access Authentication +* https://tools.ietf.org/html/rfc7617[RFC 7617]: The 'Basic' HTTP Authentication Scheme +* https://tools.ietf.org/html/rfc7639[RFC 7639]: The ALPN HTTP Header Field +* https://tools.ietf.org/html/rfc7692[RFC 7692]: Compression Extensions for WebSocket +* https://tools.ietf.org/html/rfc7694[RFC 7694]: HTTP Client-Initiated Content-Encoding +* https://tools.ietf.org/html/rfc7725[RFC 7725]: An HTTP Status Code to Report Legal Obstacles +* https://tools.ietf.org/html/rfc7804[RFC 7804]: Salted Challenge Response HTTP Authentication Mechanism +* https://tools.ietf.org/html/rfc7838[RFC 7838]: HTTP Alternative Services +* https://tools.ietf.org/html/rfc7932[RFC 7932]: Brotli Compressed Data Format +* https://tools.ietf.org/html/rfc7936[RFC 7936]: Clarifying Registry Procedures for the WebSocket Subprotocol Name Registry +* https://tools.ietf.org/html/rfc8053[RFC 8053]: HTTP Authentication Extensions for Interactive Clients +* https://tools.ietf.org/html/rfc8164[RFC 8164]: Opportunistic Security for HTTP/2 +* https://tools.ietf.org/html/rfc8187[RFC 8187]: Indicating Character Encoding and Language for HTTP Header Field Parameters +* https://tools.ietf.org/html/rfc8188[RFC 8188]: Encrypted Content-Encoding for HTTP +* https://tools.ietf.org/html/rfc8246[RFC 8246]: HTTP Immutable Responses +* https://tools.ietf.org/html/rfc8297[RFC 8297]: An HTTP Status Code for Indicating Hints +* https://tools.ietf.org/html/rfc8336[RFC 8336]: The ORIGIN HTTP/2 Frame +* https://tools.ietf.org/html/rfc8441[RFC 8441]: Bootstrapping WebSockets with HTTP/2 +* https://tools.ietf.org/html/rfc8470[RFC 8470]: Using Early Data in HTTP +* https://tools.ietf.org/html/rfc8473[RFC 8473]: Token Binding over HTTP +* https://www.w3.org/TR/webmention/[Webmention]: Webmention + +==== Upcoming + +* https://www.w3.org/TR/clear-site-data/[Clear Site Data] +* https://www.w3.org/TR/csp-cookies/[Content Security Policy: Cookie Controls] +* https://www.w3.org/TR/csp-embedded-enforcement/[Content Security Policy: Embedded Enforcement] +* https://www.w3.org/TR/CSP3/[Content Security Policy Level 3] +* https://www.w3.org/TR/csp-pinning/[Content Security Policy Pinning] +* http://www.w3.org/TR/referrer-policy/[Referrer Policy] +* http://www.w3.org/TR/UISecurity/[User Interface Security Directives for Content Security Policy] + +==== Informative + +* http://www.w3.org/TR/webarch/[Architecture of the World Wide Web] +* https://tools.ietf.org/html/rfc2936[RFC 2936]: HTTP MIME Type Handler Detection +* https://tools.ietf.org/html/rfc2964[RFC 2964]: Use of HTTP State Management +* https://tools.ietf.org/html/rfc3143[RFC 3143]: Known HTTP Proxy/Caching Problems +* https://tools.ietf.org/html/rfc6202[RFC 6202]: Known Issues and Best Practices for the Use of Long Polling and Streaming in Bidirectional HTTP +* https://tools.ietf.org/html/rfc6838[RFC 6838]: Media Type Specifications and Registration Procedures +* https://tools.ietf.org/html/rfc7478[RFC 7478]: Web Real-Time Communication Use Cases and Requirements + +==== Related + +* http://www.w3.org/TR/app-uri/[app: URL Scheme] +* http://www.w3.org/TR/beacon/[Beacon] +* http://www.w3.org/TR/FileAPI/[File API] +* https://tools.ietf.org/html/rfc8030[Generic Event Delivery Using HTTP Push] +* http://www.w3.org/TR/capability-urls/[Good Practices for Capability URLs] +* https://html.spec.whatwg.org/multipage/[HTML Living Standard] +* https://developers.whatwg.org/[HTML Living Standard for Web developers] +* http://www.w3.org/TR/html401/[HTML4.01] +* http://www.w3.org/TR/html5/[HTML5] +* http://www.w3.org/TR/html51/[HTML5.1] +* https://www.w3.org/TR/html52/[HTML5.2] +* http://www.w3.org/TR/media-frags/[Media Fragments URI 1.0] +* https://tools.ietf.org/html/rfc6657[RFC 6657]: Update to MIME regarding "charset" Parameter Handling in Textual Media Types +* https://tools.ietf.org/html/rfc6690[RFC 6690]: Constrained RESTful Environments (CoRE) Link Format +* https://tools.ietf.org/html/rfc7807[RFC 7807]: Problem Details for HTTP APIs +* https://tools.ietf.org/html/rfc6906[RFC 6906]: The 'profile' Link Relation Type +* http://www.w3.org/TR/SRI/[Subresource Integrity] +* http://www.w3.org/TR/tracking-compliance/[Tracking Compliance and Scope] +* http://www.w3.org/TR/media-frags-reqs/[Use cases and requirements for Media Fragments] +* http://www.w3.org/TR/webrtc/[WebRTC 1.0: Real-time Communication Between Browsers] +* http://www.w3.org/TR/websockets/[Websocket API] +* http://www.w3.org/TR/XMLHttpRequest/[XMLHttpRequest Level 1] +* https://xhr.spec.whatwg.org/[XMLHttpRequest Living Standard] + +==== Seemingly obsolete + +* https://tools.ietf.org/html/rfc2227[RFC 2227]: Simple Hit-Metering and Usage-Limiting for HTTP +* https://tools.ietf.org/html/rfc2310[RFC 2310]: The Safe Response Header Field +* https://tools.ietf.org/html/rfc2324[RFC 2324]: Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0) +* https://tools.ietf.org/html/rfc2660[RFC 2660]: The Secure HyperText Transfer Protocol +* https://tools.ietf.org/html/rfc2774[RFC 2774]: An HTTP Extension Framework +* https://tools.ietf.org/html/rfc2965[RFC 2965]: HTTP State Management Mechanism (Cookie2) +* https://tools.ietf.org/html/rfc3229[RFC 3229]: Delta encoding in HTTP +* https://tools.ietf.org/html/rfc7168[RFC 7168]: The Hyper Text Coffee Pot Control Protocol for Tea Efflux Appliances (HTCPCP-TEA) +* http://dev.chromium.org/spdy/spdy-protocol[SPDY]: SPDY Protocol +* https://tools.ietf.org/html/draft-tyoshino-hybi-websocket-perframe-deflate-06[x-webkit-deflate-frame]: Deprecated Websocket compression + +=== URL + +* https://tools.ietf.org/html/rfc3986[RFC 3986]: URI Generic Syntax +* https://tools.ietf.org/html/rfc6570[RFC 6570]: URI Template +* https://tools.ietf.org/html/rfc6874[RFC 6874]: Representing IPv6 Zone Identifiers in Address Literals and URIs +* https://tools.ietf.org/html/rfc7320[RFC 7320]: URI Design and Ownership +* http://www.w3.org/TR/url-1/[URL] +* https://url.spec.whatwg.org/[URL Living Standard] + +=== WebDAV + +* https://tools.ietf.org/html/rfc3253[RFC 3253]: Versioning Extensions to WebDAV +* https://tools.ietf.org/html/rfc3648[RFC 3648]: WebDAV Ordered Collections Protocol +* https://tools.ietf.org/html/rfc3744[RFC 3744]: WebDAV Access Control Protocol +* https://tools.ietf.org/html/rfc4316[RFC 4316]: Datatypes for WebDAV Properties +* https://tools.ietf.org/html/rfc4331[RFC 4331]: Quota and Size Properties for DAV Collections +* https://tools.ietf.org/html/rfc4437[RFC 4437]: WebDAV Redirect Reference Resources +* https://tools.ietf.org/html/rfc4709[RFC 4709]: Mounting WebDAV Servers +* https://tools.ietf.org/html/rfc4791[RFC 4791]: Calendaring Extensions to WebDAV (CalDAV) +* https://tools.ietf.org/html/rfc4918[RFC 4918]: HTTP Extensions for WebDAV +* https://tools.ietf.org/html/rfc5323[RFC 5323]: WebDAV SEARCH +* https://tools.ietf.org/html/rfc5397[RFC 5397]: WebDAV Current Principal Extension +* https://tools.ietf.org/html/rfc5689[RFC 5689]: Extended MKCOL for WebDAV +* https://tools.ietf.org/html/rfc5842[RFC 5842]: Binding Extensions to WebDAV +* https://tools.ietf.org/html/rfc5995[RFC 5995]: Using POST to Add Members to WebDAV Collections +* https://tools.ietf.org/html/rfc6352[RFC 6352]: CardDAV: vCard Extensions to WebDAV +* https://tools.ietf.org/html/rfc6578[RFC 6578]: Collection Synchronization for WebDAV +* https://tools.ietf.org/html/rfc6638[RFC 6638]: Scheduling Extensions to CalDAV +* https://tools.ietf.org/html/rfc6764[RFC 6764]: Locating Services for Calendaring Extensions to WebDAV (CalDAV) and vCard Extensions to WebDAV (CardDAV) +* https://tools.ietf.org/html/rfc7809[RFC 7809]: Calendaring Extensions to WebDAV (CalDAV): Time Zones by Reference +* https://tools.ietf.org/html/rfc7953[RFC 7953]: Calendar Availability +* https://tools.ietf.org/html/rfc8144[RFC 8144]: Use of the Prefer Header Field in WebDAV + +=== CoAP + +* https://tools.ietf.org/html/rfc7252[RFC 7252]: The Constrained Application Protocol (CoAP) +* https://tools.ietf.org/html/rfc7390[RFC 7390]: Group Communication for CoAP +* https://tools.ietf.org/html/rfc7641[RFC 7641]: Observing Resources in CoAP +* https://tools.ietf.org/html/rfc7650[RFC 7650]: A CoAP Usage for REsource LOcation And Discovery (RELOAD) +* https://tools.ietf.org/html/rfc7959[RFC 7959]: Block-Wise Transfers in CoAP +* https://tools.ietf.org/html/rfc7967[RFC 7967]: CoAP Option for No Server Response +* https://tools.ietf.org/html/rfc8075[RFC 8075]: Guidelines for Mapping Implementations: HTTP to CoAP +* https://tools.ietf.org/html/rfc8132[RFC 8132]: PATCH and FETCH Methods for CoAP +* https://tools.ietf.org/html/rfc8323[RFC 8323]: CoAP over TCP, TLS, and WebSockets diff --git a/docs/en/cowboy/2.6/guide/specs/index.html b/docs/en/cowboy/2.6/guide/specs/index.html new file mode 100644 index 00000000..1504fa93 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/specs/index.html @@ -0,0 +1,513 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: HTTP and other specifications</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>HTTP and other specifications</span></h1> + +<p>This chapter intends to list all the specification documents for or related to HTTP.</p> +<h2 id="_http">HTTP</h2> +<h4 id="_iana_registries">IANA Registries</h4> +<ul><li><a href="https://www.iana.org/assignments/http-methods/http-methods.xhtml">HTTP Method Registry</a> +</li> +<li><a href="https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml">HTTP Status Code Registry</a> +</li> +<li><a href="https://www.iana.org/assignments/message-headers/message-headers.xhtml">Message Headers</a> +</li> +<li><a href="https://www.iana.org/assignments/http-parameters/http-parameters.xhtml">HTTP Parameters</a> +</li> +<li><a href="https://www.iana.org/assignments/http-alt-svc-parameters/http-alt-svc-parameters.xhtml">HTTP Alt-Svc Parameter Registry</a> +</li> +<li><a href="https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml">HTTP Authentication Scheme Registry</a> +</li> +<li><a href="https://www.iana.org/assignments/http-cache-directives/http-cache-directives.xhtml">HTTP Cache Directive Registry</a> +</li> +<li><a href="https://www.iana.org/assignments/http-dig-alg/http-dig-alg.xhtml">HTTP Digest Algorithm Values</a> +</li> +<li><a href="https://www.iana.org/assignments/hoba-device-identifiers/hoba-device-identifiers.xhtml">HTTP Origin-Bound Authentication Device Identifier Types</a> +</li> +<li><a href="https://www.iana.org/assignments/http-upgrade-tokens/http-upgrade-tokens.xhtml">HTTP Upgrade Token Registry</a> +</li> +<li><a href="https://www.iana.org/assignments/http-warn-codes/http-warn-codes.xhtml">HTTP Warn Codes</a> +</li> +<li><a href="https://www.iana.org/assignments/http2-parameters/http2-parameters.xhtml">HTTP/2 Parameters</a> +</li> +<li><a href="https://www.ietf.org/assignments/websocket/websocket.xml">WebSocket Protocol Registries</a> +</li> +</ul> +<h4 id="_current">Current</h4> +<ul><li><a href="http://www.w3.org/TR/cors/">CORS</a>: Cross-Origin Resource Sharing +</li> +<li><a href="http://www.w3.org/TR/CSP2/">CSP2</a>: Content Security Policy Level 2 +</li> +<li><a href="http://www.w3.org/TR/tracking-dnt/">DNT</a>: Tracking Preference Expression (DNT) +</li> +<li><a href="http://www.w3.org/TR/eventsource/">eventsource</a>: Server-Sent Events +</li> +<li><a href="https://www.w3.org/TR/html4/interact/forms.html#h-17.13.4">Form content types</a>: Form content types +</li> +<li><a href="https://www.w3.org/TR/preload/">Preload</a>: Preload +</li> +<li><a href="https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt">PROXY</a>: The PROXY protocol +</li> +<li><a href="http://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm">REST</a>: Fielding's Dissertation +</li> +<li><a href="https://tools.ietf.org/html/rfc1945">RFC 1945</a>: HTTP/1.0 +</li> +<li><a href="https://tools.ietf.org/html/rfc1951">RFC 1951</a>: DEFLATE Compressed Data Format Specification version 1.3 +</li> +<li><a href="https://tools.ietf.org/html/rfc1952">RFC 1952</a>: GZIP file format specification version 4.3 +</li> +<li><a href="https://tools.ietf.org/html/rfc2046#section-5.1">RFC 2046</a>: Multipart media type (in MIME Part Two: Media Types) +</li> +<li><a href="https://tools.ietf.org/html/rfc2295">RFC 2295</a>: Transparent Content Negotiation in HTTP +</li> +<li><a href="https://tools.ietf.org/html/rfc2296">RFC 2296</a>: HTTP Remote Variant Selection Algorithm: RVSA/1.0 +</li> +<li><a href="https://tools.ietf.org/html/rfc2817">RFC 2817</a>: Upgrading to TLS Within HTTP/1.1 +</li> +<li><a href="https://tools.ietf.org/html/rfc2818">RFC 2818</a>: HTTP Over TLS +</li> +<li><a href="https://tools.ietf.org/html/rfc3230">RFC 3230</a>: Instance Digests in HTTP +</li> +<li><a href="https://tools.ietf.org/html/rfc4559">RFC 4559</a>: SPNEGO-based Kerberos and NTLM HTTP Authentication in Microsoft Windows +</li> +<li><a href="https://tools.ietf.org/html/rfc5789">RFC 5789</a>: PATCH Method for HTTP +</li> +<li><a href="https://tools.ietf.org/html/rfc5843">RFC 5843</a>: Additional Hash Algorithms for HTTP Instance Digests +</li> +<li><a href="https://tools.ietf.org/html/rfc5861">RFC 5861</a>: HTTP Cache-Control Extensions for Stale Content +</li> +<li><a href="https://tools.ietf.org/html/rfc5988">RFC 5988</a>: Web Linking +</li> +<li><a href="https://tools.ietf.org/html/rfc6265">RFC 6265</a>: HTTP State Management Mechanism +</li> +<li><a href="https://tools.ietf.org/html/rfc6266">RFC 6266</a>: Use of the Content-Disposition Header Field +</li> +<li><a href="https://tools.ietf.org/html/rfc6454">RFC 6454</a>: The Web Origin Concept +</li> +<li><a href="https://tools.ietf.org/html/rfc6455">RFC 6455</a>: The WebSocket Protocol +</li> +<li><a href="https://tools.ietf.org/html/rfc6585">RFC 6585</a>: Additional HTTP Status Codes +</li> +<li><a href="https://tools.ietf.org/html/rfc6750">RFC 6750</a>: The OAuth 2.0 Authorization Framework: Bearer Token Usage +</li> +<li><a href="https://tools.ietf.org/html/rfc6797">RFC 6797</a>: HTTP Strict Transport Security (HSTS) +</li> +<li><a href="https://tools.ietf.org/html/rfc6903">RFC 6903</a>: Additional Link Relation Types +</li> +<li><a href="https://tools.ietf.org/html/rfc7034">RFC 7034</a>: HTTP Header Field X-Frame-Options +</li> +<li><a href="https://tools.ietf.org/html/rfc7089">RFC 7089</a>: Time-Based Access to Resource States: Memento +</li> +<li><a href="https://tools.ietf.org/html/rfc7230">RFC 7230</a>: HTTP/1.1 Message Syntax and Routing +</li> +<li><a href="https://tools.ietf.org/html/rfc7231">RFC 7231</a>: HTTP/1.1 Semantics and Content +</li> +<li><a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>: HTTP/1.1 Conditional Requests +</li> +<li><a href="https://tools.ietf.org/html/rfc7233">RFC 7233</a>: HTTP/1.1 Range Requests +</li> +<li><a href="https://tools.ietf.org/html/rfc7234">RFC 7234</a>: HTTP/1.1 Caching +</li> +<li><a href="https://tools.ietf.org/html/rfc7235">RFC 7235</a>: HTTP/1.1 Authentication +</li> +<li><a href="https://tools.ietf.org/html/rfc7239">RFC 7239</a>: Forwarded HTTP Extension +</li> +<li><a href="https://tools.ietf.org/html/rfc7240">RFC 7240</a>: Prefer Header for HTTP +</li> +<li><a href="https://tools.ietf.org/html/rfc7469">RFC 7469</a>: Public Key Pinning Extension for HTTP +</li> +<li><a href="https://tools.ietf.org/html/rfc7486">RFC 7486</a>: HTTP Origin-Bound Authentication (HOBA) +</li> +<li><a href="https://tools.ietf.org/html/rfc7538">RFC 7538</a>: HTTP Status Code 308 (Permanent Redirect) +</li> +<li><a href="https://tools.ietf.org/html/rfc7540">RFC 7540</a>: Hypertext Transfer Protocol Version 2 (HTTP/2) +</li> +<li><a href="https://tools.ietf.org/html/rfc7541">RFC 7541</a>: HPACK: Header Compression for HTTP/2 +</li> +<li><a href="https://tools.ietf.org/html/rfc7578">RFC 7578</a>: Returning Values from Forms: multipart/form-data +</li> +<li><a href="https://tools.ietf.org/html/rfc7615">RFC 7615</a>: HTTP Authentication-Info and Proxy-Authentication-Info Response Header Fields +</li> +<li><a href="https://tools.ietf.org/html/rfc7616">RFC 7616</a>: HTTP Digest Access Authentication +</li> +<li><a href="https://tools.ietf.org/html/rfc7617">RFC 7617</a>: The <em>Basic</em> HTTP Authentication Scheme +</li> +<li><a href="https://tools.ietf.org/html/rfc7639">RFC 7639</a>: The ALPN HTTP Header Field +</li> +<li><a href="https://tools.ietf.org/html/rfc7692">RFC 7692</a>: Compression Extensions for WebSocket +</li> +<li><a href="https://tools.ietf.org/html/rfc7694">RFC 7694</a>: HTTP Client-Initiated Content-Encoding +</li> +<li><a href="https://tools.ietf.org/html/rfc7725">RFC 7725</a>: An HTTP Status Code to Report Legal Obstacles +</li> +<li><a href="https://tools.ietf.org/html/rfc7804">RFC 7804</a>: Salted Challenge Response HTTP Authentication Mechanism +</li> +<li><a href="https://tools.ietf.org/html/rfc7838">RFC 7838</a>: HTTP Alternative Services +</li> +<li><a href="https://tools.ietf.org/html/rfc7932">RFC 7932</a>: Brotli Compressed Data Format +</li> +<li><a href="https://tools.ietf.org/html/rfc7936">RFC 7936</a>: Clarifying Registry Procedures for the WebSocket Subprotocol Name Registry +</li> +<li><a href="https://tools.ietf.org/html/rfc8053">RFC 8053</a>: HTTP Authentication Extensions for Interactive Clients +</li> +<li><a href="https://tools.ietf.org/html/rfc8164">RFC 8164</a>: Opportunistic Security for HTTP/2 +</li> +<li><a href="https://tools.ietf.org/html/rfc8187">RFC 8187</a>: Indicating Character Encoding and Language for HTTP Header Field Parameters +</li> +<li><a href="https://tools.ietf.org/html/rfc8188">RFC 8188</a>: Encrypted Content-Encoding for HTTP +</li> +<li><a href="https://tools.ietf.org/html/rfc8246">RFC 8246</a>: HTTP Immutable Responses +</li> +<li><a href="https://tools.ietf.org/html/rfc8297">RFC 8297</a>: An HTTP Status Code for Indicating Hints +</li> +<li><a href="https://tools.ietf.org/html/rfc8336">RFC 8336</a>: The ORIGIN HTTP/2 Frame +</li> +<li><a href="https://tools.ietf.org/html/rfc8441">RFC 8441</a>: Bootstrapping WebSockets with HTTP/2 +</li> +<li><a href="https://tools.ietf.org/html/rfc8470">RFC 8470</a>: Using Early Data in HTTP +</li> +<li><a href="https://tools.ietf.org/html/rfc8473">RFC 8473</a>: Token Binding over HTTP +</li> +<li><a href="https://www.w3.org/TR/webmention/">Webmention</a>: Webmention +</li> +</ul> +<h4 id="_upcoming">Upcoming</h4> +<ul><li><a href="https://www.w3.org/TR/clear-site-data/">Clear Site Data</a> +</li> +<li><a href="https://www.w3.org/TR/csp-cookies/">Content Security Policy: Cookie Controls</a> +</li> +<li><a href="https://www.w3.org/TR/csp-embedded-enforcement/">Content Security Policy: Embedded Enforcement</a> +</li> +<li><a href="https://www.w3.org/TR/CSP3/">Content Security Policy Level 3</a> +</li> +<li><a href="https://www.w3.org/TR/csp-pinning/">Content Security Policy Pinning</a> +</li> +<li><a href="http://www.w3.org/TR/referrer-policy/">Referrer Policy</a> +</li> +<li><a href="http://www.w3.org/TR/UISecurity/">User Interface Security Directives for Content Security Policy</a> +</li> +</ul> +<h4 id="_informative">Informative</h4> +<ul><li><a href="http://www.w3.org/TR/webarch/">Architecture of the World Wide Web</a> +</li> +<li><a href="https://tools.ietf.org/html/rfc2936">RFC 2936</a>: HTTP MIME Type Handler Detection +</li> +<li><a href="https://tools.ietf.org/html/rfc2964">RFC 2964</a>: Use of HTTP State Management +</li> +<li><a href="https://tools.ietf.org/html/rfc3143">RFC 3143</a>: Known HTTP Proxy/Caching Problems +</li> +<li><a href="https://tools.ietf.org/html/rfc6202">RFC 6202</a>: Known Issues and Best Practices for the Use of Long Polling and Streaming in Bidirectional HTTP +</li> +<li><a href="https://tools.ietf.org/html/rfc6838">RFC 6838</a>: Media Type Specifications and Registration Procedures +</li> +<li><a href="https://tools.ietf.org/html/rfc7478">RFC 7478</a>: Web Real-Time Communication Use Cases and Requirements +</li> +</ul> +<h4 id="_related">Related</h4> +<ul><li><a href="http://www.w3.org/TR/app-uri/">app: URL Scheme</a> +</li> +<li><a href="http://www.w3.org/TR/beacon/">Beacon</a> +</li> +<li><a href="http://www.w3.org/TR/FileAPI/">File API</a> +</li> +<li><a href="https://tools.ietf.org/html/rfc8030">Generic Event Delivery Using HTTP Push</a> +</li> +<li><a href="http://www.w3.org/TR/capability-urls/">Good Practices for Capability URLs</a> +</li> +<li><a href="https://html.spec.whatwg.org/multipage/">HTML Living Standard</a> +</li> +<li><a href="https://developers.whatwg.org/">HTML Living Standard for Web developers</a> +</li> +<li><a href="http://www.w3.org/TR/html401/">HTML4.01</a> +</li> +<li><a href="http://www.w3.org/TR/html5/">HTML5</a> +</li> +<li><a href="http://www.w3.org/TR/html51/">HTML5.1</a> +</li> +<li><a href="https://www.w3.org/TR/html52/">HTML5.2</a> +</li> +<li><a href="http://www.w3.org/TR/media-frags/">Media Fragments URI 1.0</a> +</li> +<li><a href="https://tools.ietf.org/html/rfc6657">RFC 6657</a>: Update to MIME regarding "charset" Parameter Handling in Textual Media Types +</li> +<li><a href="https://tools.ietf.org/html/rfc6690">RFC 6690</a>: Constrained RESTful Environments (CoRE) Link Format +</li> +<li><a href="https://tools.ietf.org/html/rfc7807">RFC 7807</a>: Problem Details for HTTP APIs +</li> +<li><a href="https://tools.ietf.org/html/rfc6906">RFC 6906</a>: The <em>profile</em> Link Relation Type +</li> +<li><a href="http://www.w3.org/TR/SRI/">Subresource Integrity</a> +</li> +<li><a href="http://www.w3.org/TR/tracking-compliance/">Tracking Compliance and Scope</a> +</li> +<li><a href="http://www.w3.org/TR/media-frags-reqs/">Use cases and requirements for Media Fragments</a> +</li> +<li><a href="http://www.w3.org/TR/webrtc/">WebRTC 1.0: Real-time Communication Between Browsers</a> +</li> +<li><a href="http://www.w3.org/TR/websockets/">Websocket API</a> +</li> +<li><a href="http://www.w3.org/TR/XMLHttpRequest/">XMLHttpRequest Level 1</a> +</li> +<li><a href="https://xhr.spec.whatwg.org/">XMLHttpRequest Living Standard</a> +</li> +</ul> +<h4 id="_seemingly_obsolete">Seemingly obsolete</h4> +<ul><li><a href="https://tools.ietf.org/html/rfc2227">RFC 2227</a>: Simple Hit-Metering and Usage-Limiting for HTTP +</li> +<li><a href="https://tools.ietf.org/html/rfc2310">RFC 2310</a>: The Safe Response Header Field +</li> +<li><a href="https://tools.ietf.org/html/rfc2324">RFC 2324</a>: Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0) +</li> +<li><a href="https://tools.ietf.org/html/rfc2660">RFC 2660</a>: The Secure HyperText Transfer Protocol +</li> +<li><a href="https://tools.ietf.org/html/rfc2774">RFC 2774</a>: An HTTP Extension Framework +</li> +<li><a href="https://tools.ietf.org/html/rfc2965">RFC 2965</a>: HTTP State Management Mechanism (Cookie2) +</li> +<li><a href="https://tools.ietf.org/html/rfc3229">RFC 3229</a>: Delta encoding in HTTP +</li> +<li><a href="https://tools.ietf.org/html/rfc7168">RFC 7168</a>: The Hyper Text Coffee Pot Control Protocol for Tea Efflux Appliances (HTCPCP-TEA) +</li> +<li><a href="http://dev.chromium.org/spdy/spdy-protocol">SPDY</a>: SPDY Protocol +</li> +<li><a href="https://tools.ietf.org/html/draft-tyoshino-hybi-websocket-perframe-deflate-06">x-webkit-deflate-frame</a>: Deprecated Websocket compression +</li> +</ul> +<h2 id="_url">URL</h2> +<ul><li><a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>: URI Generic Syntax +</li> +<li><a href="https://tools.ietf.org/html/rfc6570">RFC 6570</a>: URI Template +</li> +<li><a href="https://tools.ietf.org/html/rfc6874">RFC 6874</a>: Representing IPv6 Zone Identifiers in Address Literals and URIs +</li> +<li><a href="https://tools.ietf.org/html/rfc7320">RFC 7320</a>: URI Design and Ownership +</li> +<li><a href="http://www.w3.org/TR/url-1/">URL</a> +</li> +<li><a href="https://url.spec.whatwg.org/">URL Living Standard</a> +</li> +</ul> +<h2 id="_webdav">WebDAV</h2> +<ul><li><a href="https://tools.ietf.org/html/rfc3253">RFC 3253</a>: Versioning Extensions to WebDAV +</li> +<li><a href="https://tools.ietf.org/html/rfc3648">RFC 3648</a>: WebDAV Ordered Collections Protocol +</li> +<li><a href="https://tools.ietf.org/html/rfc3744">RFC 3744</a>: WebDAV Access Control Protocol +</li> +<li><a href="https://tools.ietf.org/html/rfc4316">RFC 4316</a>: Datatypes for WebDAV Properties +</li> +<li><a href="https://tools.ietf.org/html/rfc4331">RFC 4331</a>: Quota and Size Properties for DAV Collections +</li> +<li><a href="https://tools.ietf.org/html/rfc4437">RFC 4437</a>: WebDAV Redirect Reference Resources +</li> +<li><a href="https://tools.ietf.org/html/rfc4709">RFC 4709</a>: Mounting WebDAV Servers +</li> +<li><a href="https://tools.ietf.org/html/rfc4791">RFC 4791</a>: Calendaring Extensions to WebDAV (CalDAV) +</li> +<li><a href="https://tools.ietf.org/html/rfc4918">RFC 4918</a>: HTTP Extensions for WebDAV +</li> +<li><a href="https://tools.ietf.org/html/rfc5323">RFC 5323</a>: WebDAV SEARCH +</li> +<li><a href="https://tools.ietf.org/html/rfc5397">RFC 5397</a>: WebDAV Current Principal Extension +</li> +<li><a href="https://tools.ietf.org/html/rfc5689">RFC 5689</a>: Extended MKCOL for WebDAV +</li> +<li><a href="https://tools.ietf.org/html/rfc5842">RFC 5842</a>: Binding Extensions to WebDAV +</li> +<li><a href="https://tools.ietf.org/html/rfc5995">RFC 5995</a>: Using POST to Add Members to WebDAV Collections +</li> +<li><a href="https://tools.ietf.org/html/rfc6352">RFC 6352</a>: CardDAV: vCard Extensions to WebDAV +</li> +<li><a href="https://tools.ietf.org/html/rfc6578">RFC 6578</a>: Collection Synchronization for WebDAV +</li> +<li><a href="https://tools.ietf.org/html/rfc6638">RFC 6638</a>: Scheduling Extensions to CalDAV +</li> +<li><a href="https://tools.ietf.org/html/rfc6764">RFC 6764</a>: Locating Services for Calendaring Extensions to WebDAV (CalDAV) and vCard Extensions to WebDAV (CardDAV) +</li> +<li><a href="https://tools.ietf.org/html/rfc7809">RFC 7809</a>: Calendaring Extensions to WebDAV (CalDAV): Time Zones by Reference +</li> +<li><a href="https://tools.ietf.org/html/rfc7953">RFC 7953</a>: Calendar Availability +</li> +<li><a href="https://tools.ietf.org/html/rfc8144">RFC 8144</a>: Use of the Prefer Header Field in WebDAV +</li> +</ul> +<h2 id="_coap">CoAP</h2> +<ul><li><a href="https://tools.ietf.org/html/rfc7252">RFC 7252</a>: The Constrained Application Protocol (CoAP) +</li> +<li><a href="https://tools.ietf.org/html/rfc7390">RFC 7390</a>: Group Communication for CoAP +</li> +<li><a href="https://tools.ietf.org/html/rfc7641">RFC 7641</a>: Observing Resources in CoAP +</li> +<li><a href="https://tools.ietf.org/html/rfc7650">RFC 7650</a>: A CoAP Usage for REsource LOcation And Discovery (RELOAD) +</li> +<li><a href="https://tools.ietf.org/html/rfc7959">RFC 7959</a>: Block-Wise Transfers in CoAP +</li> +<li><a href="https://tools.ietf.org/html/rfc7967">RFC 7967</a>: CoAP Option for No Server Response +</li> +<li><a href="https://tools.ietf.org/html/rfc8075">RFC 8075</a>: Guidelines for Mapping Implementations: HTTP to CoAP +</li> +<li><a href="https://tools.ietf.org/html/rfc8132">RFC 8132</a>: PATCH and FETCH Methods for CoAP +</li> +<li><a href="https://tools.ietf.org/html/rfc8323">RFC 8323</a>: CoAP over TCP, TLS, and WebSockets +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_1.0/"> + Migrating from Cowboy 1.0 to 2.0 + </a> + + + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/static_files.asciidoc b/docs/en/cowboy/2.6/guide/static_files.asciidoc new file mode 100644 index 00000000..9d9b8cc2 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/static_files.asciidoc @@ -0,0 +1,163 @@ +[[static_files]] +== Static files + +Cowboy comes with a ready to use handler for serving static +files. It is provided as a convenience for serving files +during development. + +For systems in production, consider using one of the many +Content Distribution Network (CDN) available on the market, +as they are the best solution for serving files. + +The static handler can serve either one file or all files +from a given directory. The etag generation and mime types +can be configured. + +=== Serve one file + +You can use the static handler to serve one specific file +from an application's private directory. This is particularly +useful to serve an 'index.html' file when the client requests +the `/` path, for example. The path configured is relative +to the given application's private directory. + +The following rule will serve the file 'static/index.html' +from the application `my_app`'s priv directory whenever the +path `/` is accessed: + +[source,erlang] +{"/", cowboy_static, {priv_file, my_app, "static/index.html"}} + +You can also specify the absolute path to a file, or the +path to the file relative to the current directory: + +[source,erlang] +{"/", cowboy_static, {file, "/var/www/index.html"}} + +=== Serve all files from a directory + +You can also use the static handler to serve all files that +can be found in the configured directory. The handler will +use the `path_info` information to resolve the file location, +which means that your route must end with a `[...]` pattern +for it to work. All files are served, including the ones that +may be found in subfolders. + +You can specify the directory relative to an application's +private directory. + +The following rule will serve any file found in the application +`my_app`'s priv directory inside the `static/assets` folder +whenever the requested path begins with `/assets/`: + +[source,erlang] +{"/assets/[...]", cowboy_static, {priv_dir, my_app, "static/assets"}} + +You can also specify the absolute path to the directory or +set it relative to the current directory: + +[source,erlang] +{"/assets/[...]", cowboy_static, {dir, "/var/www/assets"}} + +=== Customize the mimetype detection + +By default, Cowboy will attempt to recognize the mimetype +of your static files by looking at the extension. + +You can override the function that figures out the mimetype +of the static files. It can be useful when Cowboy is missing +a mimetype you need to handle, or when you want to reduce +the list to make lookups faster. You can also give a +hard-coded mimetype that will be used unconditionally. + +Cowboy comes with two functions built-in. The default +function only handles common file types used when building +Web applications. The other function is an extensive list +of hundreds of mimetypes that should cover almost any need +you may have. You can of course create your own function. + +To use the default function, you should not have to configure +anything, as it is the default. If you insist, though, the +following will do the job: + +[source,erlang] +---- +{"/assets/[...]", cowboy_static, {priv_dir, my_app, "static/assets", + [{mimetypes, cow_mimetypes, web}]}} +---- + +As you can see, there is an optional field that may contain +a list of less used options, like mimetypes or etag. All option +types have this optional field. + +To use the function that will detect almost any mimetype, +the following configuration will do: + +[source,erlang] +---- +{"/assets/[...]", cowboy_static, {priv_dir, my_app, "static/assets", + [{mimetypes, cow_mimetypes, all}]}} +---- + +You probably noticed the pattern by now. The configuration +expects a module and a function name, so you can use any +of your own functions instead: + +[source,erlang] +---- +{"/assets/[...]", cowboy_static, {priv_dir, my_app, "static/assets", + [{mimetypes, Module, Function}]}} +---- + +The function that performs the mimetype detection receives +a single argument that is the path to the file on disk. It +is recommended to return the mimetype in tuple form, although +a binary string is also allowed (but will require extra +processing). If the function can't figure out the mimetype, +then it should return `{<<"application">>, <<"octet-stream">>, []}`. + +When the static handler fails to find the extension, +it will send the file as `application/octet-stream`. +A browser receiving such file will attempt to download it +directly to disk. + +Finally, the mimetype can be hard-coded for all files. +This is especially useful in combination with the `file` +and `priv_file` options as it avoids needless computation: + +[source,erlang] +---- +{"/", cowboy_static, {priv_file, my_app, "static/index.html", + [{mimetypes, {<<"text">>, <<"html">>, []}}]}} +---- + +=== Generate an etag + +By default, the static handler will generate an etag header +value based on the size and modified time. This solution +can not be applied to all systems though. It would perform +rather poorly over a cluster of nodes, for example, as the +file metadata will vary from server to server, giving a +different etag on each server. + +You can however change the way the etag is calculated: + +[source,erlang] +---- +{"/assets/[...]", cowboy_static, {priv_dir, my_app, "static/assets", + [{etag, Module, Function}]}} +---- + +This function will receive three arguments: the path to the +file on disk, the size of the file and the last modification +time. In a distributed setup, you would typically use the +file path to retrieve an etag value that is identical across +all your servers. + +You can also completely disable etag handling: + +[source,erlang] +---- +{"/assets/[...]", cowboy_static, {priv_dir, my_app, "static/assets", + [{etag, false}]}} +---- diff --git a/docs/en/cowboy/2.6/guide/static_files/index.html b/docs/en/cowboy/2.6/guide/static_files/index.html new file mode 100644 index 00000000..367e559b --- /dev/null +++ b/docs/en/cowboy/2.6/guide/static_files/index.html @@ -0,0 +1,263 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Static files</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Static files</span></h1> + +<p>Cowboy comes with a ready to use handler for serving static files. It is provided as a convenience for serving files during development.</p> +<p>For systems in production, consider using one of the many Content Distribution Network (CDN) available on the market, as they are the best solution for serving files.</p> +<p>The static handler can serve either one file or all files from a given directory. The etag generation and mime types can be configured.</p> +<h2 id="_serve_one_file">Serve one file</h2> +<p>You can use the static handler to serve one specific file from an application's private directory. This is particularly useful to serve an <em>index.html</em> file when the client requests the <code>/</code> path, for example. The path configured is relative to the given application's private directory.</p> +<p>The following rule will serve the file <em>static/index.html</em> from the application <code>my_app</code>'s priv directory whenever the path <code>/</code> is accessed:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF0000">"/"</font>, <font color="#FF6600">cowboy_static</font>, {<font color="#FF6600">priv_file</font>, <font color="#FF6600">my_app</font>, <font color="#FF0000">"static/index.html"</font>}}</tt></pre> +</div></div> +<p>You can also specify the absolute path to a file, or the path to the file relative to the current directory:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF0000">"/"</font>, <font color="#FF6600">cowboy_static</font>, {<font color="#FF6600">file</font>, <font color="#FF0000">"/var/www/index.html"</font>}}</tt></pre> +</div></div> +<h2 id="_serve_all_files_from_a_directory">Serve all files from a directory</h2> +<p>You can also use the static handler to serve all files that can be found in the configured directory. The handler will use the <code>path_info</code> information to resolve the file location, which means that your route must end with a <code>[...]</code> pattern for it to work. All files are served, including the ones that may be found in subfolders.</p> +<p>You can specify the directory relative to an application's private directory.</p> +<p>The following rule will serve any file found in the application <code>my_app</code>'s priv directory inside the <code>static/assets</code> folder whenever the requested path begins with <code>/assets/</code>:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF0000">"/assets/[...]"</font>, <font color="#FF6600">cowboy_static</font>, {<font color="#FF6600">priv_dir</font>, <font color="#FF6600">my_app</font>, <font color="#FF0000">"static/assets"</font>}}</tt></pre> +</div></div> +<p>You can also specify the absolute path to the directory or set it relative to the current directory:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF0000">"/assets/[...]"</font>, <font color="#FF6600">cowboy_static</font>, {<font color="#FF6600">dir</font>, <font color="#FF0000">"/var/www/assets"</font>}}</tt></pre> +</div></div> +<h2 id="_customize_the_mimetype_detection">Customize the mimetype detection</h2> +<p>By default, Cowboy will attempt to recognize the mimetype of your static files by looking at the extension.</p> +<p>You can override the function that figures out the mimetype of the static files. It can be useful when Cowboy is missing a mimetype you need to handle, or when you want to reduce the list to make lookups faster. You can also give a hard-coded mimetype that will be used unconditionally.</p> +<p>Cowboy comes with two functions built-in. The default function only handles common file types used when building Web applications. The other function is an extensive list of hundreds of mimetypes that should cover almost any need you may have. You can of course create your own function.</p> +<p>To use the default function, you should not have to configure anything, as it is the default. If you insist, though, the following will do the job:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF0000">"/assets/[...]"</font>, <font color="#FF6600">cowboy_static</font>, {<font color="#FF6600">priv_dir</font>, <font color="#FF6600">my_app</font>, <font color="#FF0000">"static/assets"</font>, + [{<font color="#FF6600">mimetypes</font>, <font color="#FF6600">cow_mimetypes</font>, <font color="#FF6600">web</font>}]}}</tt></pre> +</div></div> +<p>As you can see, there is an optional field that may contain a list of less used options, like mimetypes or etag. All option types have this optional field.</p> +<p>To use the function that will detect almost any mimetype, the following configuration will do:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF0000">"/assets/[...]"</font>, <font color="#FF6600">cowboy_static</font>, {<font color="#FF6600">priv_dir</font>, <font color="#FF6600">my_app</font>, <font color="#FF0000">"static/assets"</font>, + [{<font color="#FF6600">mimetypes</font>, <font color="#FF6600">cow_mimetypes</font>, <font color="#FF6600">all</font>}]}}</tt></pre> +</div></div> +<p>You probably noticed the pattern by now. The configuration expects a module and a function name, so you can use any of your own functions instead:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF0000">"/assets/[...]"</font>, <font color="#FF6600">cowboy_static</font>, {<font color="#FF6600">priv_dir</font>, <font color="#FF6600">my_app</font>, <font color="#FF0000">"static/assets"</font>, + [{<font color="#FF6600">mimetypes</font>, <font color="#009900">Module</font>, <font color="#009900">Function</font>}]}}</tt></pre> +</div></div> +<p>The function that performs the mimetype detection receives a single argument that is the path to the file on disk. It is recommended to return the mimetype in tuple form, although a binary string is also allowed (but will require extra processing). If the function can't figure out the mimetype, then it should return <code>{<<"application">>, <<"octet-stream">>, []}</code>.</p> +<p>When the static handler fails to find the extension, it will send the file as <code>application/octet-stream</code>. A browser receiving such file will attempt to download it directly to disk.</p> +<p>Finally, the mimetype can be hard-coded for all files. This is especially useful in combination with the <code>file</code> and <code>priv_file</code> options as it avoids needless computation:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF0000">"/"</font>, <font color="#FF6600">cowboy_static</font>, {<font color="#FF6600">priv_file</font>, <font color="#FF6600">my_app</font>, <font color="#FF0000">"static/index.html"</font>, + [{<font color="#FF6600">mimetypes</font>, {<font color="#990000"><<</font><font color="#FF0000">"text"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"html"</font><font color="#990000">>></font>, []}}]}}</tt></pre> +</div></div> +<h2 id="_generate_an_etag">Generate an etag</h2> +<p>By default, the static handler will generate an etag header value based on the size and modified time. This solution can not be applied to all systems though. It would perform rather poorly over a cluster of nodes, for example, as the file metadata will vary from server to server, giving a different etag on each server.</p> +<p>You can however change the way the etag is calculated:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF0000">"/assets/[...]"</font>, <font color="#FF6600">cowboy_static</font>, {<font color="#FF6600">priv_dir</font>, <font color="#FF6600">my_app</font>, <font color="#FF0000">"static/assets"</font>, + [{<font color="#FF6600">etag</font>, <font color="#009900">Module</font>, <font color="#009900">Function</font>}]}}</tt></pre> +</div></div> +<p>This function will receive three arguments: the path to the file on disk, the size of the file and the last modification time. In a distributed setup, you would typically use the file path to retrieve an etag value that is identical across all your servers.</p> +<p>You can also completely disable etag handling:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF0000">"/assets/[...]"</font>, <font color="#FF6600">cowboy_static</font>, {<font color="#FF6600">priv_dir</font>, <font color="#FF6600">my_app</font>, <font color="#FF0000">"static/assets"</font>, + [{<font color="#FF6600">etag</font>, <font color="#000080">false</font>}]}}</tt></pre> +</div></div> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/loop_handlers/"> + Loop handlers + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/req/"> + The Req object + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/streams.asciidoc b/docs/en/cowboy/2.6/guide/streams.asciidoc new file mode 100644 index 00000000..841a9712 --- /dev/null +++ b/docs/en/cowboy/2.6/guide/streams.asciidoc @@ -0,0 +1,65 @@ +[[streams]] +== Streams + +A stream is the set of messages that form an HTTP +request/response pair. + +The term stream comes from HTTP/2. In Cowboy, it is +also used when talking about HTTP/1.1 or HTTP/1.0. +It should not be confused with streaming the request +or response body. + +All versions of HTTP allow clients to initiate +streams. HTTP/2 is the only one also allowing servers, +through its server push feature. Both client and +server-initiated streams go through the same process +in Cowboy. + +=== Stream handlers + +Stream handlers must implement five different callbacks. +Four of them are directly related; one is special. + +All callbacks receives the stream ID as first argument. + +Most of them can return a list of commands to be executed +by Cowboy. When callbacks are chained, it is possible to +intercept and modify these commands. This can be useful +for modifying responses for example. + +The `init/3` callback is invoked when a new request +comes in. It receives the Req object and the protocol options +for this listener. + +The `data/4` callback is invoked when data from the request +body is received. It receives both this data and a flag +indicating whether more is to be expected. + +The `info/3` callback is invoked when an Erlang message is +received for this stream. They will typically be messages +sent by the request process. + +Finally the `terminate/3` callback is invoked with the +terminate reason for the stream. The return value is ignored. +Note that as with all terminate callbacks in Erlang, there +is no strong guarantee that it will be called. + +The special callback `early_error/5` is called when an error +occurs before the request headers were fully received and +Cowboy is sending a response. It receives the partial Req +object, the error reason, the protocol options and the response +Cowboy will send. This response must be returned, possibly +modified. + +=== Built-in handlers + +Cowboy comes with two handlers. + +`cowboy_stream_h` is the default stream handler. +It is the core of much of the functionality of Cowboy. +All chains of stream handlers should call it last. + +`cowboy_compress_h` will automatically compress +responses when possible. It is not enabled by default. +It is a good example for writing your own handlers +that will modify responses. diff --git a/docs/en/cowboy/2.6/guide/streams/index.html b/docs/en/cowboy/2.6/guide/streams/index.html new file mode 100644 index 00000000..bf2695cc --- /dev/null +++ b/docs/en/cowboy/2.6/guide/streams/index.html @@ -0,0 +1,185 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Streams</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Streams</span></h1> + +<p>A stream is the set of messages that form an HTTP request/response pair.</p> +<p>The term stream comes from HTTP/2. In Cowboy, it is also used when talking about HTTP/1.1 or HTTP/1.0. It should not be confused with streaming the request or response body.</p> +<p>All versions of HTTP allow clients to initiate streams. HTTP/2 is the only one also allowing servers, through its server push feature. Both client and server-initiated streams go through the same process in Cowboy.</p> +<h2 id="_stream_handlers">Stream handlers</h2> +<p>Stream handlers must implement five different callbacks. Four of them are directly related; one is special.</p> +<p>All callbacks receives the stream ID as first argument.</p> +<p>Most of them can return a list of commands to be executed by Cowboy. When callbacks are chained, it is possible to intercept and modify these commands. This can be useful for modifying responses for example.</p> +<p>The <code>init/3</code> callback is invoked when a new request comes in. It receives the Req object and the protocol options for this listener.</p> +<p>The <code>data/4</code> callback is invoked when data from the request body is received. It receives both this data and a flag indicating whether more is to be expected.</p> +<p>The <code>info/3</code> callback is invoked when an Erlang message is received for this stream. They will typically be messages sent by the request process.</p> +<p>Finally the <code>terminate/3</code> callback is invoked with the terminate reason for the stream. The return value is ignored. Note that as with all terminate callbacks in Erlang, there is no strong guarantee that it will be called.</p> +<p>The special callback <code>early_error/5</code> is called when an error occurs before the request headers were fully received and Cowboy is sending a response. It receives the partial Req object, the error reason, the protocol options and the response Cowboy will send. This response must be returned, possibly modified.</p> +<h2 id="_built_in_handlers">Built-in handlers</h2> +<p>Cowboy comes with two handlers.</p> +<p><code>cowboy_stream_h</code> is the default stream handler. It is the core of much of the functionality of Cowboy. All chains of stream handlers should call it last.</p> +<p><code>cowboy_compress_h</code> will automatically compress responses when possible. It is not enabled by default. It is a good example for writing your own handlers that will modify responses.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/ws_handlers/"> + Websocket handlers + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/middlewares/"> + Middlewares + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/ws_handlers.asciidoc b/docs/en/cowboy/2.6/guide/ws_handlers.asciidoc new file mode 100644 index 00000000..71165afb --- /dev/null +++ b/docs/en/cowboy/2.6/guide/ws_handlers.asciidoc @@ -0,0 +1,293 @@ +[[ws_handlers]] +== Websocket handlers + +Websocket handlers provide an interface for upgrading HTTP/1.1 +connections to Websocket and sending or receiving frames on +the Websocket connection. + +As Websocket connections are established through the HTTP/1.1 +upgrade mechanism, Websocket handlers need to be able to first +receive the HTTP request for the upgrade, before switching to +Websocket and taking over the connection. They can then receive +or send Websocket frames, handle incoming Erlang messages or +close the connection. + +=== Upgrade + +The `init/2` callback is called when the request is received. +To establish a Websocket connection, you must switch to the +`cowboy_websocket` module: + +[source,erlang] +---- +init(Req, State) -> + {cowboy_websocket, Req, State}. +---- + +Cowboy will perform the Websocket handshake immediately. Note +that the handshake will fail if the client did not request an +upgrade to Websocket. + +The Req object becomes unavailable after this function returns. +Any information required for proper execution of the Websocket +handler must be saved in the state. + +=== Subprotocol + +The client may provide a list of Websocket subprotocols it +supports in the sec-websocket-protocol header. The server *must* +select one of them and send it back to the client or the +handshake will fail. + +For example, a client could understand both STOMP and MQTT over +Websocket, and provide the header: + +---- +sec-websocket-protocol: v12.stomp, mqtt +---- + +If the server only understands MQTT it can return: + +---- +sec-websocket-protocol: mqtt +---- + +This selection must be done in `init/2`. An example usage could +be: + +[source,erlang] +---- +init(Req0, State) -> + case cowboy_req:parse_header(<<"sec-websocket-protocol">>, Req0) of + undefined -> + {cowboy_websocket, Req0, State}; + Subprotocols -> + case lists:keymember(<<"mqtt">>, 1, Subprotocols) of + true -> + Req = cowboy_req:set_resp_header(<<"sec-websocket-protocol">>, + <<"mqtt">>, Req0), + {cowboy_websocket, Req, State}; + false -> + Req = cowboy_req:reply(400, Req0), + {ok, Req, State} + end + end. +---- + +=== Post-upgrade initialization + +Cowboy has separate processes for handling the connection +and requests. Because Websocket takes over the connection, +the Websocket protocol handling occurs in a different +process than the request handling. + +This is reflected in the different callbacks Websocket +handlers have. The `init/2` callback is called from the +temporary request process and the `websocket_` callbacks +from the connection process. + +This means that some initialization cannot be done from +`init/2`. Anything that would require the current pid, +or be tied to the current pid, will not work as intended. +The optional `websocket_init/1` can be used instead: + +[source,erlang] +---- +websocket_init(State) -> + erlang:start_timer(1000, self(), <<"Hello!">>), + {ok, State}. +---- + +All Websocket callbacks share the same return values. This +means that we can send frames to the client right after +the upgrade: + +[source,erlang] +---- +websocket_init(State) -> + {reply, {text, <<"Hello!">>}, State}. +---- + +=== Receiving frames + +Cowboy will call `websocket_handle/2` whenever a text, binary, +ping or pong frame arrives from the client. + +The handler can handle or ignore the frames. It can also +send frames back to the client or stop the connection. + +The following snippet echoes back any text frame received and +ignores all others: + +[source,erlang] +---- +websocket_handle(Frame = {text, _}, State) -> + {reply, Frame, State}; +websocket_handle(_Frame, State) -> + {ok, State}. +---- + +Note that ping and pong frames require no action from the +handler as Cowboy will automatically reply to ping frames. +They are provided for informative purposes only. + +=== Receiving Erlang messages + +Cowboy will call `websocket_info/2` whenever an Erlang message +arrives. + +The handler can handle or ignore the messages. It can also +send frames to the client or stop the connection. + +The following snippet forwards log messages to the client +and ignores all others: + +[source,erlang] +---- +websocket_info({log, Text}, State) -> + {reply, {text, Text}, State}; +websocket_info(_Info, State) -> + {ok, State}. +---- + +=== Sending frames + +// @todo This will be deprecated and eventually replaced with a +// {Commands, State} interface that allows providing more +// functionality easily. + +All `websocket_` callbacks share return values. They may +send zero, one or many frames to the client. + +To send nothing, just return an ok tuple: + +[source,erlang] +---- +websocket_info(_Info, State) -> + {ok, State}. +---- + +To send one frame, return a reply tuple with the frame to send: + +[source,erlang] +---- +websocket_info(_Info, State) -> + {reply, {text, <<"Hello!">>}, State}. +---- + +You can send frames of any type: text, binary, ping, pong +or close frames. + +To send many frames at once, return a reply tuple with the +list of frames to send: + +[source,erlang] +---- +websocket_info(_Info, State) -> + {reply, [ + {text, "Hello"}, + {text, <<"world!">>}, + {binary, <<0:8000>>} + ], State}. +---- + +They are sent in the given order. + +=== Keeping the connection alive + +Cowboy will automatically respond to ping frames sent by +the client. They are still forwarded to the handler for +informative purposes, but no further action is required. + +Cowboy does not send ping frames itself. The handler can +do it if required. A better solution in most cases is to +let the client handle pings. Doing it from the handler +would imply having an additional timer per connection and +this can be a considerable cost for servers that need to +handle large numbers of connections. + +Cowboy can be configured to close idle connections +automatically. It is highly recommended to configure +a timeout here, to avoid having processes linger longer +than needed. + +The `init/2` callback can set the timeout to be used +for the connection. For example, this would make Cowboy +close connections idle for more than 30 seconds: + +[source,erlang] +---- +init(Req, State) -> + {cowboy_websocket, Req, State, #{ + idle_timeout => 30000}}. +---- + +This value cannot be changed once it is set. It defaults to +`60000`. + +=== Limiting frame sizes + +Cowboy accepts frames of any size by default. You should +limit the size depending on what your handler may handle. +You can do this via the `init/2` callback: + +[source,erlang] +---- +init(Req, State) -> + {cowboy_websocket, Req, State, #{ + max_frame_size => 8000000}}. +---- + +The lack of limit is historical. A future version of +Cowboy will have a more reasonable default. + +=== Saving memory + +The Websocket connection process can be set to hibernate +after the callback returns. + +Simply add an `hibernate` field to the ok or reply tuples: + +[source,erlang] +---- +websocket_init(State) -> + {ok, State, hibernate}. + +websocket_handle(_Frame, State) -> + {ok, State, hibernate}. + +websocket_info(_Info, State) -> + {reply, {text, <<"Hello!">>}, State, hibernate}. +---- + +It is highly recommended to write your handlers with +hibernate enabled, as this allows to greatly reduce the +memory usage. Do note however that an increase in the +CPU usage or latency can be observed instead, in particular +for the more busy connections. + +=== Closing the connection + +The connection can be closed at any time, either by telling +Cowboy to stop it or by sending a close frame. + +To tell Cowboy to close the connection, use a stop tuple: + +[source,erlang] +---- +websocket_info(_Info, State) -> + {stop, State}. +---- + +Sending a `close` frame will immediately initiate the closing +of the Websocket connection. Note that when sending a list of +frames that include a close frame, any frame found after the +close frame will not be sent. + +The following example sends a close frame with a reason message: + +[source,erlang] +---- +websocket_info(_Info, State) -> + {reply, {close, 1000, <<"some-reason">>}, State}. +---- diff --git a/docs/en/cowboy/2.6/guide/ws_handlers/index.html b/docs/en/cowboy/2.6/guide/ws_handlers/index.html new file mode 100644 index 00000000..f09456ba --- /dev/null +++ b/docs/en/cowboy/2.6/guide/ws_handlers/index.html @@ -0,0 +1,352 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Websocket handlers</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Websocket handlers</span></h1> + +<p>Websocket handlers provide an interface for upgrading HTTP/1.1 connections to Websocket and sending or receiving frames on the Websocket connection.</p> +<p>As Websocket connections are established through the HTTP/1.1 upgrade mechanism, Websocket handlers need to be able to first receive the HTTP request for the upgrade, before switching to Websocket and taking over the connection. They can then receive or send Websocket frames, handle incoming Erlang messages or close the connection.</p> +<h2 id="_upgrade">Upgrade</h2> +<p>The <code>init/2</code> callback is called when the request is received. To establish a Websocket connection, you must switch to the <code>cowboy_websocket</code> module:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">cowboy_websocket</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>Cowboy will perform the Websocket handshake immediately. Note that the handshake will fail if the client did not request an upgrade to Websocket.</p> +<p>The Req object becomes unavailable after this function returns. Any information required for proper execution of the Websocket handler must be saved in the state.</p> +<h2 id="_subprotocol">Subprotocol</h2> +<p>The client may provide a list of Websocket subprotocols it supports in the sec-websocket-protocol header. The server <strong>must</strong> select one of them and send it back to the client or the handshake will fail.</p> +<p>For example, a client could understand both STOMP and MQTT over Websocket, and provide the header:</p> +<div class="listingblock"><div class="content"><pre>sec-websocket-protocol: v12.stomp, mqtt</pre></div></div> +<p>If the server only understands MQTT it can return:</p> +<div class="listingblock"><div class="content"><pre>sec-websocket-protocol: mqtt</pre></div></div> +<p>This selection must be done in <code>init/2</code>. An example usage could be:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req0</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">cowboy_req:parse_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"sec-websocket-protocol"</font><font color="#990000">>></font>, <font color="#009900">Req0</font>) <b><font color="#0000FF">of</font></b> + <font color="#000080">undefined</font> <font color="#990000">-></font> + {<font color="#FF6600">cowboy_websocket</font>, <font color="#009900">Req0</font>, <font color="#009900">State</font>}; + <font color="#009900">Subprotocols</font> <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">lists:keymember</font></b>(<font color="#990000"><<</font><font color="#FF0000">"mqtt"</font><font color="#990000">>></font>, <font color="#993399">1</font>, <font color="#009900">Subprotocols</font>) <b><font color="#0000FF">of</font></b> + <font color="#000080">true</font> <font color="#990000">-></font> + <font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"sec-websocket-protocol"</font><font color="#990000">>></font>, + <font color="#990000"><<</font><font color="#FF0000">"mqtt"</font><font color="#990000">>></font>, <font color="#009900">Req0</font>), + {<font color="#FF6600">cowboy_websocket</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}; + <font color="#000080">false</font> <font color="#990000">-></font> + <font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">400</font>, <font color="#009900">Req0</font>), + {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + <b><font color="#0000FF">end</font></b> + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_post_upgrade_initialization">Post-upgrade initialization</h2> +<p>Cowboy has separate processes for handling the connection and requests. Because Websocket takes over the connection, the Websocket protocol handling occurs in a different process than the request handling.</p> +<p>This is reflected in the different callbacks Websocket handlers have. The <code>init/2</code> callback is called from the temporary request process and the <code>websocket_</code> callbacks from the connection process.</p> +<p>This means that some initialization cannot be done from <code>init/2</code>. Anything that would require the current pid, or be tied to the current pid, will not work as intended. The optional <code>websocket_init/1</code> can be used instead:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">websocket_init</font></b>(<font color="#009900">State</font>) <font color="#990000">-></font> + <b><font color="#000000">erlang:start_timer</font></b>(<font color="#993399">1000</font>, <b><font color="#000080">self</font></b>(), <font color="#990000"><<</font><font color="#FF0000">"Hello!"</font><font color="#990000">>></font>), + {<font color="#FF6600">ok</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>All Websocket callbacks share the same return values. This means that we can send frames to the client right after the upgrade:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">websocket_init</font></b>(<font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">reply</font>, {<font color="#FF6600">text</font>, <font color="#990000"><<</font><font color="#FF0000">"Hello!"</font><font color="#990000">>></font>}, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_receiving_frames">Receiving frames</h2> +<p>Cowboy will call <code>websocket_handle/2</code> whenever a text, binary, ping or pong frame arrives from the client.</p> +<p>The handler can handle or ignore the frames. It can also send frames back to the client or stop the connection.</p> +<p>The following snippet echoes back any text frame received and ignores all others:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">websocket_handle</font></b>(<font color="#009900">Frame</font> <font color="#990000">=</font> {<font color="#FF6600">text</font>, <font color="#990000">_</font>}, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">reply</font>, <font color="#009900">Frame</font>, <font color="#009900">State</font>}; +<b><font color="#000000">websocket_handle</font></b>(<font color="#009900">_Frame</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>Note that ping and pong frames require no action from the handler as Cowboy will automatically reply to ping frames. They are provided for informative purposes only.</p> +<h2 id="_receiving_erlang_messages">Receiving Erlang messages</h2> +<p>Cowboy will call <code>websocket_info/2</code> whenever an Erlang message arrives.</p> +<p>The handler can handle or ignore the messages. It can also send frames to the client or stop the connection.</p> +<p>The following snippet forwards log messages to the client and ignores all others:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">websocket_info</font></b>({<b><font color="#000080">log</font></b>, <font color="#009900">Text</font>}, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">reply</font>, {<font color="#FF6600">text</font>, <font color="#009900">Text</font>}, <font color="#009900">State</font>}; +<b><font color="#000000">websocket_info</font></b>(<font color="#009900">_Info</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_sending_frames">Sending frames</h2> +<!-- @todo This will be deprecated and eventually replaced with a--> +<!-- {Commands, State} interface that allows providing more--> +<!-- functionality easily.--> +<p>All <code>websocket_</code> callbacks share return values. They may send zero, one or many frames to the client.</p> +<p>To send nothing, just return an ok tuple:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">websocket_info</font></b>(<font color="#009900">_Info</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>To send one frame, return a reply tuple with the frame to send:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">websocket_info</font></b>(<font color="#009900">_Info</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">reply</font>, {<font color="#FF6600">text</font>, <font color="#990000"><<</font><font color="#FF0000">"Hello!"</font><font color="#990000">>></font>}, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>You can send frames of any type: text, binary, ping, pong or close frames.</p> +<p>To send many frames at once, return a reply tuple with the list of frames to send:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">websocket_info</font></b>(<font color="#009900">_Info</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">reply</font>, [ + {<font color="#FF6600">text</font>, <font color="#FF0000">"Hello"</font>}, + {<font color="#FF6600">text</font>, <font color="#990000"><<</font><font color="#FF0000">"world!"</font><font color="#990000">>></font>}, + {<b><font color="#000080">binary</font></b>, <font color="#990000"><<</font><font color="#993399">0</font><font color="#990000">:</font><font color="#993399">8000</font><font color="#990000">>></font>} + ], <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>They are sent in the given order.</p> +<h2 id="_keeping_the_connection_alive">Keeping the connection alive</h2> +<p>Cowboy will automatically respond to ping frames sent by the client. They are still forwarded to the handler for informative purposes, but no further action is required.</p> +<p>Cowboy does not send ping frames itself. The handler can do it if required. A better solution in most cases is to let the client handle pings. Doing it from the handler would imply having an additional timer per connection and this can be a considerable cost for servers that need to handle large numbers of connections.</p> +<p>Cowboy can be configured to close idle connections automatically. It is highly recommended to configure a timeout here, to avoid having processes linger longer than needed.</p> +<p>The <code>init/2</code> callback can set the timeout to be used for the connection. For example, this would make Cowboy close connections idle for more than 30 seconds:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">cowboy_websocket</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>, #{ + <font color="#0000FF">idle_timeout</font> <font color="#990000">=></font> <font color="#993399">30000</font>}}<font color="#990000">.</font></tt></pre> +</div></div> +<p>This value cannot be changed once it is set. It defaults to <code>60000</code>.</p> +<h2 id="_limiting_frame_sizes">Limiting frame sizes</h2> +<p>Cowboy accepts frames of any size by default. You should limit the size depending on what your handler may handle. You can do this via the <code>init/2</code> callback:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">cowboy_websocket</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>, #{ + <font color="#0000FF">max_frame_size</font> <font color="#990000">=></font> <font color="#993399">8000000</font>}}<font color="#990000">.</font></tt></pre> +</div></div> +<p>The lack of limit is historical. A future version of Cowboy will have a more reasonable default.</p> +<h2 id="_saving_memory">Saving memory</h2> +<p>The Websocket connection process can be set to hibernate after the callback returns.</p> +<p>Simply add an <code>hibernate</code> field to the ok or reply tuples:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">websocket_init</font></b>(<font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">State</font>, <font color="#FF6600">hibernate</font>}<font color="#990000">.</font> + +<b><font color="#000000">websocket_handle</font></b>(<font color="#009900">_Frame</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">State</font>, <font color="#FF6600">hibernate</font>}<font color="#990000">.</font> + +<b><font color="#000000">websocket_info</font></b>(<font color="#009900">_Info</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">reply</font>, {<font color="#FF6600">text</font>, <font color="#990000"><<</font><font color="#FF0000">"Hello!"</font><font color="#990000">>></font>}, <font color="#009900">State</font>, <font color="#FF6600">hibernate</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>It is highly recommended to write your handlers with hibernate enabled, as this allows to greatly reduce the memory usage. Do note however that an increase in the CPU usage or latency can be observed instead, in particular for the more busy connections.</p> +<h2 id="_closing_the_connection">Closing the connection</h2> +<p>The connection can be closed at any time, either by telling Cowboy to stop it or by sending a close frame.</p> +<p>To tell Cowboy to close the connection, use a stop tuple:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">websocket_info</font></b>(<font color="#009900">_Info</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">stop</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>Sending a <code>close</code> frame will immediately initiate the closing of the Websocket connection. Note that when sending a list of frames that include a close frame, any frame found after the close frame will not be sent.</p> +<p>The following example sends a close frame with a reason message:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">websocket_info</font></b>(<font color="#009900">_Info</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">reply</font>, {<font color="#FF6600">close</font>, <font color="#993399">1000</font>, <font color="#990000"><<</font><font color="#FF0000">"some-reason"</font><font color="#990000">>></font>}, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/ws_protocol/"> + The Websocket protocol + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/streams/"> + Streams + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/guide/ws_protocol.asciidoc b/docs/en/cowboy/2.6/guide/ws_protocol.asciidoc new file mode 100644 index 00000000..8fa0673d --- /dev/null +++ b/docs/en/cowboy/2.6/guide/ws_protocol.asciidoc @@ -0,0 +1,69 @@ +[[ws_protocol]] +== The Websocket protocol + +This chapter explains what Websocket is and why it is +a vital component of soft realtime Web applications. + +=== Description + +Websocket is an extension to HTTP that emulates plain TCP +connections between the client, typically a Web browser, +and the server. It uses the HTTP Upgrade mechanism to +establish the connection. + +Websocket connections are fully asynchronous, unlike +HTTP/1.1 (synchronous) and HTTP/2 (asynchronous, but the +server can only initiate streams in response to requests). +With Websocket, the client and the server can both send +frames at any time without any restriction. It is closer +to TCP than any of the HTTP protocols. + +Websocket is an IETF standard. Cowboy supports the standard +and all drafts that were previously implemented by browsers, +excluding the initial flawed draft sometimes known as +"version 0". + +=== Websocket vs HTTP/2 + +For a few years Websocket was the only way to have a +bidirectional asynchronous connection with the server. +This changed when HTTP/2 was introduced. While HTTP/2 +requires the client to first perform a request before +the server can push data, this is only a minor restriction +as the client can do so just as it connects. + +Websocket was designed as a kind-of-TCP channel to a +server. It only defines the framing and connection +management and lets the developer implement a protocol +on top of it. For example you could implement IRC over +Websocket and use a Javascript IRC client to speak to +the server. + +HTTP/2 on the other hand is just an improvement over +the HTTP/1.1 connection and request/response mechanism. +It has the same semantics as HTTP/1.1. + +If all you need is to access an HTTP API, then HTTP/2 +should be your first choice. On the other hand, if what +you need is a different protocol, then you can use +Websocket to implement it. + +=== Implementation + +Cowboy implements Websocket as a protocol upgrade. Once the +upgrade is performed from the `init/2` callback, Cowboy +switches to Websocket. Please consult the next chapter for +more information on initiating and handling Websocket +connections. + +The implementation of Websocket in Cowboy is validated using +the Autobahn test suite, which is an extensive suite of tests +covering all aspects of the protocol. Cowboy passes the +suite with 100% success, including all optional tests. + +Cowboy's Websocket implementation also includes the +permessage-deflate and x-webkit-deflate-frame compression +extensions. + +Cowboy will automatically use compression when the +`compress` option is returned from the `init/2` function. diff --git a/docs/en/cowboy/2.6/guide/ws_protocol/index.html b/docs/en/cowboy/2.6/guide/ws_protocol/index.html new file mode 100644 index 00000000..3f6b938c --- /dev/null +++ b/docs/en/cowboy/2.6/guide/ws_protocol/index.html @@ -0,0 +1,184 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: The Websocket protocol</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>The Websocket protocol</span></h1> + +<p>This chapter explains what Websocket is and why it is a vital component of soft realtime Web applications.</p> +<h2 id="_description">Description</h2> +<p>Websocket is an extension to HTTP that emulates plain TCP connections between the client, typically a Web browser, and the server. It uses the HTTP Upgrade mechanism to establish the connection.</p> +<p>Websocket connections are fully asynchronous, unlike HTTP/1.1 (synchronous) and HTTP/2 (asynchronous, but the server can only initiate streams in response to requests). With Websocket, the client and the server can both send frames at any time without any restriction. It is closer to TCP than any of the HTTP protocols.</p> +<p>Websocket is an IETF standard. Cowboy supports the standard and all drafts that were previously implemented by browsers, excluding the initial flawed draft sometimes known as "version 0".</p> +<h2 id="_websocket_vs_http_2">Websocket vs HTTP/2</h2> +<p>For a few years Websocket was the only way to have a bidirectional asynchronous connection with the server. This changed when HTTP/2 was introduced. While HTTP/2 requires the client to first perform a request before the server can push data, this is only a minor restriction as the client can do so just as it connects.</p> +<p>Websocket was designed as a kind-of-TCP channel to a server. It only defines the framing and connection management and lets the developer implement a protocol on top of it. For example you could implement IRC over Websocket and use a Javascript IRC client to speak to the server.</p> +<p>HTTP/2 on the other hand is just an improvement over the HTTP/1.1 connection and request/response mechanism. It has the same semantics as HTTP/1.1.</p> +<p>If all you need is to access an HTTP API, then HTTP/2 should be your first choice. On the other hand, if what you need is a different protocol, then you can use Websocket to implement it.</p> +<h2 id="_implementation">Implementation</h2> +<p>Cowboy implements Websocket as a protocol upgrade. Once the upgrade is performed from the <code>init/2</code> callback, Cowboy switches to Websocket. Please consult the next chapter for more information on initiating and handling Websocket connections.</p> +<p>The implementation of Websocket in Cowboy is validated using the Autobahn test suite, which is an extensive suite of tests covering all aspects of the protocol. Cowboy passes the suite with 100% success, including all optional tests.</p> +<p>Cowboy's Websocket implementation also includes the permessage-deflate and x-webkit-deflate-frame compression extensions.</p> +<p>Cowboy will automatically use compression when the <code>compress</code> option is returned from the <code>init/2</code> function.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/resource_design/"> + Designing a resource handler + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.6/guide/ws_handlers/"> + Websocket handlers + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.6/manual/cowboy.set_env/index.html new file mode 100644 index 00000000..916d2e13 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy.set_env/index.html @@ -0,0 +1,199 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy:set_env(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy:set_env(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy:set_env - Update a listener's environment value</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">set_env</font></b>(<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>(), + <font color="#009900">Key</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>(), + <font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()) + <font color="#990000">-></font> <font color="#FF6600">ok</font></tt></pre> +</div></div> +<p>Set or update an environment value for a previously started listener.</p> +<p>This is most useful for updating the routes dynamically, without having to restart the listener.</p> +<p>The new value will only be available to new connections. Pre-existing connections will still use the old value.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Name</dt> +<dd><p>The name of the listener to update.</p> +<p>The name of the listener is the first argument given to the <a href="../cowboy.start_clear">cowboy:start_clear(3)</a>, <a href="../cowboy.start_tls">cowboy:start_tls(3)</a> or <a href="../ranch.start_listener">ranch:start_listener(3)</a> function.</p> +</dd> +<dt>Key</dt> +<dd><p>The key in the environment map. Common keys include <code>dispatch</code> and <code>middlewares</code>.</p> +</dd> +<dt>Value</dt> +<dd><p>The new value.</p> +<p>The type of the value differs depending on the key.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned on success.</p> +<p>An <code>exit:badarg</code> exception is thrown when the listener does not exist.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Update a listener's routes</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Dispatch</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_router:compile</font></b>([ + {<font color="#FF6600">'_'</font>, [ + {<font color="#FF0000">"/"</font>, <font color="#FF6600">toppage_h</font>, []}, + {<font color="#FF0000">"/ws"</font>, <font color="#FF6600">websocket_h</font>, []} + ]} +]), + +<b><font color="#000000">cowboy:set_env</font></b>(<font color="#FF6600">example</font>, <font color="#FF6600">dispatch</font>, <font color="#009900">Dispatch</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy">cowboy(3)</a>, <a href="../cowboy.start_clear">cowboy:start_clear(3)</a>, <a href="../cowboy.start_tls">cowboy:start_tls(3)</a>, <a href="../ranch.set_protocol_options">ranch:set_protocol_options(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy.start_clear/index.html b/docs/en/cowboy/2.6/manual/cowboy.start_clear/index.html new file mode 100644 index 00000000..b4ea9a1f --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy.start_clear/index.html @@ -0,0 +1,217 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy:start_clear(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy:start_clear(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy:start_clear - Listen for connections using plain TCP</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">start_clear</font></b>(<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>(), + <font color="#009900">TransportOpts</font> <font color="#990000">::</font> <b><font color="#000000">ranch_tcp:opts</font></b>(), + <font color="#009900">ProtocolOpts</font> <font color="#990000">::</font> <b><font color="#000000">opts</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">ListenerPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>()} + | {<font color="#FF6600">error</font>, <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>Start listening for connections over a clear TCP channel.</p> +<p>Both HTTP/1.1 and HTTP/2 are supported on this listener. HTTP/2 has two methods of establishing a connection over a clear TCP channel. Both the upgrade and the prior knowledge methods are supported.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Name</dt> +<dd><p>The listener name is used to refer to this listener in future calls, for example when stopping it or when updating the routes defined.</p> +<p>It can be any Erlang term. An atom is generally good enough, for example <code>api</code>, <code>my_app_clear</code> or <code>my_app_tls</code>.</p> +</dd> +<dt>TransportOpts</dt> +<dd><p>The transport options are where the TCP options, including the listener's port number, are defined. Transport options are provided as a list of keys and values, for example <code>[{port, 8080}]</code>.</p> +<p>The available options are documented in the <a href="../ranch_tcp">ranch_tcp(3)</a> manual.</p> +</dd> +<dt>ProtocolOpts</dt> +<dd><p>The protocol options are in a map containing all the options for the different protocols that may be involved when connecting to the listener, including HTTP/1.1 and HTTP/2.</p> +<p>The HTTP/1.1 options are documented in the <a href="../cowboy_http">cowboy_http(3)</a> manual; and the HTTP/2 options in <a href="../cowboy_http2">cowboy_http2(3)</a>.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>An ok tuple is returned on success. It contains the pid of the top-level supervisor for the listener.</p> +<p>An error tuple is returned on error. The error reason may be any Erlang term.</p> +<p>A common error is <code>eaddrinuse</code>. It indicates that the port configured for Cowboy is already in use.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: HTTP/2 support added. +</li> +<li><strong>2.0</strong>: Function introduced. Replaces <code>cowboy:start_http/4</code>. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Start a listener</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Dispatch</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_router:compile</font></b>([ + {<font color="#FF6600">'_'</font>, [ + {<font color="#FF0000">"/"</font>, <font color="#FF6600">toppage_h</font>, []} + ]} +]), + +{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy:start_clear</font></b>(<font color="#FF6600">example</font>, [{<font color="#FF6600">port</font>, <font color="#993399">8080</font>}], #{ + <font color="#0000FF">env</font> <font color="#990000">=></font> #{<font color="#0000FF">dispatch</font> <font color="#990000">=></font> <font color="#009900">Dispatch</font>} +})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Start a listener on a random port</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Name</font> <font color="#990000">=</font> <font color="#FF6600">example</font>, + +{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy:start_clear</font></b>(<font color="#009900">Name</font>, [], #{ + <font color="#0000FF">env</font> <font color="#990000">=></font> #{<font color="#0000FF">dispatch</font> <font color="#990000">=></font> <font color="#009900">Dispatch</font>} +}), + +<font color="#009900">Port</font> <font color="#990000">=</font> <b><font color="#000000">ranch:get_port</font></b>(<font color="#009900">Name</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy">cowboy(3)</a>, <a href="../cowboy.start_tls">cowboy:start_tls(3)</a>, <a href="../cowboy.stop_listener">cowboy:stop_listener(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy.start_tls/index.html b/docs/en/cowboy/2.6/manual/cowboy.start_tls/index.html new file mode 100644 index 00000000..beeb2e79 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy.start_tls/index.html @@ -0,0 +1,222 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy:start_tls(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy:start_tls(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy:start_tls - Listen for connections using TLS</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">start_tls</font></b>(<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>(), + <font color="#009900">TransportOpts</font> <font color="#990000">::</font> <b><font color="#000000">ranch_ssl:opts</font></b>(), + <font color="#009900">ProtocolOpts</font> <font color="#990000">::</font> <b><font color="#000000">opts</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">ListenerPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>()} + | {<font color="#FF6600">error</font>, <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>Start listening for connections over a secure TLS channel.</p> +<p>Both HTTP/1.1 and HTTP/2 are supported on this listener. The ALPN TLS extension must be used to initiate an HTTP/2 connection.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Name</dt> +<dd><p>The listener name is used to refer to this listener in future calls, for example when stopping it or when updating the routes defined.</p> +<p>It can be any Erlang term. An atom is generally good enough, for example <code>api</code>, <code>my_app_clear</code> or <code>my_app_tls</code>.</p> +</dd> +<dt>TransportOpts</dt> +<dd><p>The transport options are where the TCP options, including the listener's port number, are defined. They also contain the TLS options, like the server's certificate. Transport options are provided as a list of keys and values, for example <code>[{port, 8443}, {certfile, "path/to/cert.pem"}]</code>.</p> +<p>The available options are documented in the <a href="../ranch_ssl">ranch_ssl(3)</a> manual.</p> +</dd> +<dt>ProtocolOpts</dt> +<dd><p>The protocol options are in a map containing all the options for the different protocols that may be involved when connecting to the listener, including HTTP/1.1 and HTTP/2.</p> +<p>The HTTP/1.1 options are documented in the <a href="../cowboy_http">cowboy_http(3)</a> manual; and the HTTP/2 options in <a href="../cowboy_http2">cowboy_http2(3)</a>.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>An ok tuple is returned on success. It contains the pid of the top-level supervisor for the listener.</p> +<p>An error tuple is returned on error. The error reason may be any Erlang term.</p> +<p>A common error is <code>eaddrinuse</code>. It indicates that the port configured for Cowboy is already in use.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: HTTP/2 support added. +</li> +<li><strong>2.0</strong>: Function introduced. Replaces <code>cowboy:start_https/4</code>. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Start a listener</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Dispatch</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_router:compile</font></b>([ + {<font color="#FF6600">'_'</font>, [ + {<font color="#FF0000">"/"</font>, <font color="#FF6600">toppage_h</font>, []} + ]} +]), + +{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy:start_tls</font></b>(<font color="#FF6600">example</font>, [ + {<font color="#FF6600">port</font>, <font color="#993399">8443</font>}, + {<font color="#FF6600">cert</font>, <font color="#FF0000">"path/to/cert.pem"</font>} +], #{ + <font color="#0000FF">env</font> <font color="#990000">=></font> #{<font color="#0000FF">dispatch</font> <font color="#990000">=></font> <font color="#009900">Dispatch</font>} +})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Start a listener on a random port</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Name</font> <font color="#990000">=</font> <font color="#FF6600">example</font>, + +{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy:start_tls</font></b>(<font color="#009900">Name</font>, [ + {<font color="#FF6600">cert</font>, <font color="#FF0000">"path/to/cert.pem"</font>} +], #{ + <font color="#0000FF">env</font> <font color="#990000">=></font> #{<font color="#0000FF">dispatch</font> <font color="#990000">=></font> <font color="#009900">Dispatch</font>} +}), + +<font color="#009900">Port</font> <font color="#990000">=</font> <b><font color="#000000">ranch:get_port</font></b>(<font color="#009900">Name</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy">cowboy(3)</a>, <a href="../cowboy.start_clear">cowboy:start_clear(3)</a>, <a href="../cowboy.stop_listener">cowboy:stop_listener(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy.stop_listener/index.html b/docs/en/cowboy/2.6/manual/cowboy.stop_listener/index.html new file mode 100644 index 00000000..effbad3a --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy.stop_listener/index.html @@ -0,0 +1,182 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy:stop_listener(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy:stop_listener(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy:stop_listener - Stop the given listener</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">stop_listener</font></b>(<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>()) + <font color="#990000">-></font> <font color="#FF6600">ok</font> | {<font color="#FF6600">error</font>, <font color="#FF6600">not_found</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>Stop a previously started listener.</p> +<p>Alias of <a href="../ranch.stop_listener">ranch:stop_listener(3)</a>.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Name</dt> +<dd><p>The name of the listener to be stopped.</p> +<p>The name of the listener is the first argument given to the <a href="../cowboy.start_clear">cowboy:start_clear(3)</a>, <a href="../cowboy.start_tls">cowboy:start_tls(3)</a> or <a href="../ranch.start_listener">ranch:start_listener(3)</a> function.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned on success.</p> +<p>The <code>{error, not_found}</code> tuple is returned when the listener does not exist.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Stop a listener</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">cowboy:stop_listener</font></b>(<font color="#FF6600">example</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy">cowboy(3)</a>, <a href="../cowboy.start_clear">cowboy:start_clear(3)</a>, <a href="../cowboy.start_tls">cowboy:start_tls(3)</a>, <a href="../ranch">ranch(3)</a>, <a href="../ranch.start_listener">ranch:start_listener(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy/index.html b/docs/en/cowboy/2.6/manual/cowboy/index.html new file mode 100644 index 00000000..c650b3cf --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy/index.html @@ -0,0 +1,216 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy - HTTP server</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy</code> provides convenience functions for manipulating Ranch listeners.</p> +<h2 id="_exports">Exports</h2> +<ul><li><a href="../cowboy.start_clear">cowboy:start_clear(3)</a> - Listen for connections using plain TCP +</li> +<li><a href="../cowboy.start_tls">cowboy:start_tls(3)</a> - Listen for connections using TLS +</li> +<li><a href="../cowboy.stop_listener">cowboy:stop_listener(3)</a> - Stop the given listener +</li> +<li><a href="../cowboy.set_env">cowboy:set_env(3)</a> - Update a listener's environment value +</li> +</ul> +<h2 id="_types">Types</h2> +<h3 id="_fields">fields()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">fields</font></b>() <font color="#990000">::</font> [<font color="#009900">Name</font> + | {<font color="#009900">Name</font>, <font color="#009900">Constraints</font>} + | {<font color="#009900">Name</font>, <font color="#009900">Constraints</font>, <font color="#009900">Default</font>}] + +<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>() +<font color="#009900">Constraints</font> <font color="#990000">::</font> <font color="#009900">Constraint</font> | [<font color="#009900">Constraint</font>] +<font color="#009900">Constraint</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_constraints:constraint</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Fields description for match operations.</p> +<p>This type is used in <a href="../cowboy_router">cowboy_router(3)</a> for matching bindings and in the match functions found in <a href="../cowboy_req">cowboy_req(3)</a>.</p> +<h3 id="_http_headers">http_headers()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">http_headers</font></b>() <font color="#990000">::</font> #{<b><font color="#000080">binary</font></b>() <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>()}</tt></pre> +</div></div> +<p>HTTP headers.</p> +<h3 id="_http_status">http_status()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">http_status</font></b>() <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>() | <b><font color="#000080">binary</font></b>()</tt></pre> +</div></div> +<p>HTTP response status.</p> +<p>A binary status can be used to set a reason phrase. Note however that HTTP/2 only sends the status code and drops the reason phrase entirely.</p> +<h3 id="_http_version">http_version()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">http_version</font></b>() <font color="#990000">::</font> <font color="#FF6600">'HTTP/2'</font> | <font color="#FF6600">'HTTP/1.1'</font> | <font color="#FF6600">'HTTP/1.0'</font></tt></pre> +</div></div> +<p>HTTP version.</p> +<p>Note that semantically, HTTP/1.1 and HTTP/2 are equivalent.</p> +<h3 id="_opts">opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">opts</font></b>() <font color="#990000">::</font> <b><font color="#000000">map</font></b>()</tt></pre> +</div></div> +<p>Options for the HTTP/1.1, HTTP/2 and Websocket protocols.</p> +<p>The protocol options are in a map containing all the options for the different protocols that may be involved when connecting to the listener, including HTTP/1.1 and HTTP/2.</p> +<p>The HTTP/1.1 options are documented in the <a href="../cowboy_http">cowboy_http(3)</a> manual and the HTTP/2 options in <a href="../cowboy_http2">cowboy_http2(3)</a>.</p> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowboy(7)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_app/index.html b/docs/en/cowboy/2.6/manual/cowboy_app/index.html new file mode 100644 index 00000000..d2b5012f --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_app/index.html @@ -0,0 +1,223 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy(7)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy(7)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy - Small, fast, modern HTTP server for Erlang/OTP</p> +<h2 id="_description">Description</h2> +<p>Cowboy is an HTTP server for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols.</p> +<p>Cowboy aims to provide a complete HTTP stack. This includes the implementation of the HTTP RFCs but also any directly related standards, like Websocket or Server-Sent Events.</p> +<h2 id="_modules">Modules</h2> +<p>Functions:</p> +<ul><li><a href="../cowboy">cowboy(3)</a> - Listener management +</li> +<li><a href="../cowboy_req">cowboy_req(3)</a> - Request and response +</li> +<li><a href="../cowboy_router">cowboy_router(3)</a> - Router +</li> +<li><a href="../cowboy_constraints">cowboy_constraints(3)</a> - Constraints +</li> +</ul> +<p>Protocols:</p> +<ul><li><a href="../cowboy_http">cowboy_http(3)</a> - HTTP/1.1 +</li> +<li><a href="../cowboy_http2">cowboy_http2(3)</a> - HTTP/2 +</li> +<li><a href="../cowboy_websocket">cowboy_websocket(3)</a> - Websocket +</li> +</ul> +<p>Handlers:</p> +<ul><li><a href="../cowboy_static">cowboy_static(3)</a> - Static file handler +</li> +</ul> +<p>Stream handlers:</p> +<ul><li><a href="../cowboy_stream_h">cowboy_stream_h(3)</a> - Default stream handler +</li> +<li><a href="../cowboy_compress_h">cowboy_compress_h(3)</a> - Compress stream handler +</li> +</ul> +<p>Behaviors:</p> +<ul><li><a href="../cowboy_handler">cowboy_handler(3)</a> - Plain HTTP handlers +</li> +<li><a href="../cowboy_loop">cowboy_loop(3)</a> - Loop handlers +</li> +<li><a href="../cowboy_middleware">cowboy_middleware(3)</a> - Middlewares +</li> +<li><a href="../cowboy_rest">cowboy_rest(3)</a> - REST handlers +</li> +<li><a href="../cowboy_stream">cowboy_stream(3)</a> - Stream handlers +</li> +<li><a href="../cowboy_websocket">cowboy_websocket(3)</a> - Websocket handlers +</li> +</ul> +<p>Middlewares:</p> +<ul><li><a href="../cowboy_router">cowboy_router(3)</a> - Router middleware +</li> +<li><a href="../cowboy_handler">cowboy_handler(3)</a> - Handler middleware +</li> +</ul> +<!-- @todo http_status_codes is not linked to; what to do with it?--> +<h2 id="_dependencies">Dependencies</h2> +<ul><li><a href="../ranch">ranch(7)</a> - Socket acceptor pool for TCP protocols +</li> +<li><a href="../cowlib">cowlib(7)</a> - Support library for manipulating Web protocols +</li> +<li>ssl - Secure communication over sockets +</li> +<li>crypto - Crypto functions +</li> +</ul> +<p>All these applications must be started before the <code>cowboy</code> application. To start Cowboy and all dependencies at once:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">application:ensure_all_started</font></b>(<font color="#FF6600">cowboy</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_environment">Environment</h2> +<p>The <code>cowboy</code> application does not define any application environment configuration parameters.</p> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch">ranch(7)</a>, <a href="../cowlib">cowlib(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_compress_h/index.html b/docs/en/cowboy/2.6/manual/cowboy_compress_h/index.html new file mode 100644 index 00000000..6975d839 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_compress_h/index.html @@ -0,0 +1,181 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_compress_h(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_compress_h(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_compress_h - Compress stream handler</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy_compress_h</code> compresses response bodies automatically when the client supports it. It will not try to compress responses that already have a content encoding.</p> +<p>Normal responses will only be compressed when their size is lower than the configured threshold. Streamed responses are always compressed, including when the sendfile command is used. Because the file must be read in memory to be compressed, this module is <strong>not</strong> suitable for automatically compressing large files.</p> +<h2 id="_options">Options</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">compress_buffering</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">compress_threshold</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for the default stream handler.</p> +<p>The default value is given next to the option name:</p> +<dl><dt>compress_buffering (false)</dt> +<dd><p>Whether the output will be buffered. By default no buffering is done to provide maximum compatibility at the cost of a lower compression rate.</p> +</dd> +<dt>compress_threshold (300)</dt> +<dd><p>How large the response body must be to be compressed when the response isn't streamed.</p> +</dd> +</dl> +<h2 id="_events">Events</h2> +<p>The compress stream handler does not produce any event.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.6</strong>: The options <code>compress_buffering</code> and <code>compress_threshold</code> were added. +</li> +<li><strong>2.0</strong>: Module introduced. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowboy(7)</a>, <a href="../cowboy_stream">cowboy_stream(3)</a>, <a href="../cowboy_stream_h">cowboy_stream_h(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_constraints.int/index.html b/docs/en/cowboy/2.6/manual/cowboy_constraints.int/index.html new file mode 100644 index 00000000..1362d230 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_constraints.int/index.html @@ -0,0 +1,192 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_constraints:int(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_constraints:int(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_constraints:int - Integer constraint</p> +<h2 id="_description">Description</h2> +<p>Constraint functions implement a number of different operations.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">int</font></b>(<font color="#FF6600">forward</font>, <font color="#009900">Bin</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Int</font>} | {<font color="#FF6600">error</font>, <font color="#FF6600">not_an_integer</font>} + +<font color="#009900">Bin</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">Int</font> <font color="#990000">::</font> <b><font color="#000080">integer</font></b>()</tt></pre> +</div></div> +<p>Validate and convert the text representation of an integer.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">int</font></b>(<font color="#FF6600">reverse</font>, <font color="#009900">Int</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Bin</font>} | {<font color="#FF6600">error</font>, <font color="#FF6600">not_an_integer</font>}</tt></pre> +</div></div> +<p>Convert an integer back to its text representation.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">int</font></b>(<font color="#FF6600">format_error</font>, <font color="#009900">Error</font>) <font color="#990000">-></font> <font color="#009900">HumanReadable</font> + +<font color="#009900">Error</font> <font color="#990000">::</font> {<font color="#FF6600">not_an_integer</font>, <font color="#009900">Bin</font> | <font color="#009900">Int</font>} +<font color="#009900">HumanReadable</font> <font color="#990000">::</font> <b><font color="#000000">iolist</font></b>()</tt></pre> +</div></div> +<p>Generate a human-readable error message.</p> +<h2 id="_arguments">Arguments</h2> +<p>Arguments vary depending on the operation. Constraint functions always take the operation type as first argument, and the value as second argument.</p> +<h2 id="_return_value">Return value</h2> +<p>The return value varies depending on the operation.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Interface modified to allow for a variety of operations. +</li> +<li><strong>1.0</strong>: Constraint introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<p>This function is not meant to be called directly.</p> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_constraints">cowboy_constraints(3)</a>, <a href="../cowboy_constraints.nonempty">cowboy_constraints:nonempty(3)</a>, <a href="../cowboy_router">cowboy_router(3)</a>, <a href="../cowboy_req.match_cookies">cowboy_req:match_cookies(3)</a>, <a href="../cowboy_req.match_qs">cowboy_req:match_qs(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_constraints.nonempty/index.html b/docs/en/cowboy/2.6/manual/cowboy_constraints.nonempty/index.html new file mode 100644 index 00000000..4272e907 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_constraints.nonempty/index.html @@ -0,0 +1,191 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_constraints:nonempty(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_constraints:nonempty(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_constraints:nonempty - Non-empty constraint</p> +<h2 id="_description">Description</h2> +<p>Constraint functions implement a number of different operations.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">nonempty</font></b>(<font color="#FF6600">forward</font> | <font color="#FF6600">reverse</font>, <font color="#990000"><<>></font>) <font color="#990000">-></font> {<font color="#FF6600">error</font>, <font color="#FF6600">empty</font>}</tt></pre> +</div></div> +<p>Reject empty values.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">nonempty</font></b>(<font color="#FF6600">forward</font> | <font color="#FF6600">reverse</font>, <font color="#009900">Bin</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Bin</font>} + +<font color="#009900">Bin</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()</tt></pre> +</div></div> +<p>Accept any other binary values.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">nonempty</font></b>(<font color="#FF6600">format_error</font>, <font color="#009900">Error</font>) <font color="#990000">-></font> <font color="#009900">HumanReadable</font> + +<font color="#009900">Error</font> <font color="#990000">::</font> {<font color="#FF6600">empty</font>, <font color="#009900">Bin</font>} +<font color="#009900">HumanReadable</font> <font color="#990000">::</font> <b><font color="#000000">iolist</font></b>()</tt></pre> +</div></div> +<p>Generate a human-readable error message.</p> +<h2 id="_arguments">Arguments</h2> +<p>Arguments vary depending on the operation. Constraint functions always take the operation type as first argument, and the value as second argument.</p> +<h2 id="_return_value">Return value</h2> +<p>The return value varies depending on the operation.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Interface modified to allow for a variety of operations. +</li> +<li><strong>1.0</strong>: Constraint introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<p>This function is not meant to be called directly.</p> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_constraints">cowboy_constraints(3)</a>, <a href="../cowboy_constraints.int">cowboy_constraints:int(3)</a>, <a href="../cowboy_router">cowboy_router(3)</a>, <a href="../cowboy_req.match_cookies">cowboy_req:match_cookies(3)</a>, <a href="../cowboy_req.match_qs">cowboy_req:match_qs(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_constraints/index.html b/docs/en/cowboy/2.6/manual/cowboy_constraints/index.html new file mode 100644 index 00000000..9233c98d --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_constraints/index.html @@ -0,0 +1,183 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_constraints(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_constraints(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_constraints - Constraints</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy_constraints</code> defines the built-in constraints in Cowboy and provides an interface for manipulating these constraints.</p> +<p>Constraints are functions that define what type of input is allowed. They are used throughout Cowboy, from the router to query strings to cookies.</p> +<h2 id="_exports">Exports</h2> +<p>Built-in constraints:</p> +<ul><li><a href="../cowboy_constraints.int">cowboy_constraints:int(3)</a> - Integer constraint +</li> +<li><a href="../cowboy_constraints.nonempty">cowboy_constraints:nonempty(3)</a> - Non-empty constraint +</li> +</ul> +<h2 id="_types">Types</h2> +<h3 id="_constraint">constraint()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">constraint</font></b>() <font color="#990000">::</font> <font color="#FF6600">int</font> | <font color="#FF6600">nonempty</font> | <b><font color="#0000FF">fun</font></b>()</tt></pre> +</div></div> +<p>A constraint function.</p> +<p>The atom constraints are built-in, see the corresponding function in the exports list above.</p> +<h3 id="_reason">reason()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">reason</font></b>() <font color="#990000">::</font> {<b><font color="#000000">constraint</font></b>(), <font color="#009900">Reason</font>, <font color="#009900">Value</font>} + +<font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Reason for the constraint failure.</p> +<p>It includes the constraint function in question, a machine-readable error reason and the value that made the constraint fail.</p> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowboy(7)</a>, <a href="../cowboy">cowboy(3)</a>, <a href="../cowboy_router">cowboy_router(3)</a>, <a href="../cowboy_req.match_cookies">cowboy_req:match_cookies(3)</a>, <a href="../cowboy_req.match_qs">cowboy_req:match_qs(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_handler.terminate/index.html b/docs/en/cowboy/2.6/manual/cowboy_handler.terminate/index.html new file mode 100644 index 00000000..98128cf1 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_handler.terminate/index.html @@ -0,0 +1,194 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_handler:terminate(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_handler:terminate(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_handler:terminate - Terminate the handler</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">terminate</font></b>(<font color="#009900">Reason</font>, <font color="#009900">PartialReq</font>, <font color="#009900">State</font>, <font color="#009900">Handler</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">PartialReq</font> <font color="#990000">::</font> <b><font color="#000000">map</font></b>() +<font color="#009900">State</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">Handler</font> <font color="#990000">::</font> <b><font color="#000000">module</font></b>()</tt></pre> +</div></div> +<p>Call the optional terminate callback if it is defined.</p> +<p>Make sure to use this function at the end of the execution of modules that implement custom handler behaviors.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Reason</dt> +<dd><p>Reason for termination.</p> +</dd> +<dt>PartialReq</dt> +<dd><p>The Req object.</p> +<p>It is possible to remove fields from the Req object to save memory when the handler has no concept of requests/responses. The only requirement is that a map is provided.</p> +</dd> +<dt>State</dt> +<dd><p>Handler state.</p> +</dd> +<dt>Handler</dt> +<dd><p>Handler module.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is always returned. It can be safely ignored.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Terminate a handler normally</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cowboy_handler:terminate</font></b>(<b><font color="#000080">normal</font></b>, <font color="#009900">Req</font>, <font color="#009900">State</font>, <font color="#009900">Handler</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_handler">cowboy_handler(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_handler/index.html b/docs/en/cowboy/2.6/manual/cowboy_handler/index.html new file mode 100644 index 00000000..2e0b584d --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_handler/index.html @@ -0,0 +1,186 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_handler(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_handler(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_handler - Plain HTTP handlers</p> +<h2 id="_description">Description</h2> +<p>The <code>cowboy_handler</code> middleware executes the handler selected by the router or any other preceding middleware.</p> +<p>This middleware takes the handler module and initial state from the <code>handler</code> and <code>handler_opts</code> environment values, respectively. On completion, it adds a <code>result</code> value to the middleware environment, containing the return value of the <code>terminate/3</code> callback (if defined) and <code>ok</code> otherwise.</p> +<p>This module also defines a callback interface for handling HTTP requests.</p> +<h2 id="_callbacks">Callbacks</h2> +<p>Plain HTTP handlers implement the following interface:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<b><font color="#000000">terminate</font></b>(<font color="#009900">Reason</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> <i><font color="#9A1900">%% optional</font></i> + +<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>() +<font color="#009900">State</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000080">normal</font></b> + | {<font color="#FF6600">crash</font>, <font color="#FF6600">error</font> | <b><font color="#000080">exit</font></b> | <b><font color="#000080">throw</font></b>, <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>These two callbacks are common to all handlers.</p> +<p>Plain HTTP handlers do all their work in the <code>init/2</code> callback. Returning <code>ok</code> terminates the handler. If no response is sent, Cowboy will send a <code>204 No Content</code>.</p> +<p>The optional <code>terminate/3</code> callback will ultimately be called with the reason for the termination of the handler. Cowboy will terminate the process right after this. There is no need to perform any cleanup in this callback.</p> +<p>The following terminate reasons are defined for plain HTTP handlers:</p> +<dl><dt>normal</dt> +<dd><p>The connection was closed normally.</p> +</dd> +<dt>{crash, Class, Reason}</dt> +<dd><p>A crash occurred in the handler. <code>Class</code> and <code>Reason</code> can be used to obtain more information about the crash. The function <code>erlang:get_stacktrace/0</code> can also be called to obtain the stacktrace of the process when the crash occurred.</p> +</dd> +</dl> +<h2 id="_exports">Exports</h2> +<p>The following function should be called by modules implementing custom handlers to execute the optional terminate callback:</p> +<ul><li><a href="../cowboy_handler.terminate">cowboy_handler:terminate(3)</a> - Terminate the handler +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowboy(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_http/index.html b/docs/en/cowboy/2.6/manual/cowboy_http/index.html new file mode 100644 index 00000000..24f032ef --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_http/index.html @@ -0,0 +1,268 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_http(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_http(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_http - HTTP/1.1</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy_http</code> implements HTTP/1.1 and HTTP/1.0 as a Ranch protocol.</p> +<h2 id="_options">Options</h2> +<!-- @todo Might be worth moving cowboy_clear/tls options--> +<!-- to their respective manual, when they are added.--> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">chunked</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">connection_type</font> <font color="#990000">=></font> <font color="#FF6600">worker</font> | <font color="#FF6600">supervisor</font>, + <font color="#0000FF">http10_keepalive</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">idle_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">inactivity_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">linger_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">max_empty_lines</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">max_header_name_length</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">max_header_value_length</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">max_headers</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">max_keepalive</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">max_method_length</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">max_request_line_length</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">max_skip_body_length</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">proxy_header</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">request_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">sendfile</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">stream_handlers</font> <font color="#990000">=></font> [<b><font color="#000000">module</font></b>()] +}</tt></pre> +</div></div> +<p>Configuration for the HTTP/1.1 protocol.</p> +<p>This configuration is passed to Cowboy when starting listeners using <code>cowboy:start_clear/3</code> or <code>cowboy:start_tls/3</code> functions.</p> +<p>It can be updated without restarting listeners using the Ranch functions <code>ranch:get_protocol_options/1</code> and <code>ranch:set_protocol_options/2</code>.</p> +<p>The default value is given next to the option name:</p> +<dl><dt>chunked (true)</dt> +<dd><p>Whether chunked transfer-encoding is enabled for HTTP/1.1 connections. Note that a response streamed to the client without the chunked transfer-encoding and without a content-length header will result in the connection being closed at the end of the response body.</p> +</dd> +<dt>connection_type (supervisor)</dt> +<dd><p>Whether the connection process also acts as a supervisor.</p> +</dd> +<dt>http10_keepalive (true)</dt> +<dd><p>Whether keep-alive is enabled for HTTP/1.0 connections.</p> +</dd> +<dt>idle_timeout (60000)</dt> +<dd><p>Time in ms with no data received before Cowboy closes the connection.</p> +</dd> +<dt>inactivity_timeout (300000)</dt> +<dd><p>Time in ms with nothing received at all before Cowboy closes the connection.</p> +</dd> +<dt>linger_timeout (1000)</dt> +<dd><p>Time in ms that Cowboy will wait when closing the connection. This is necessary to avoid the TCP reset problem as described in the <a href="https://tools.ietf.org/html/rfc7230#section-6.6">section 6.6 of RFC7230</a>.</p> +</dd> +<dt>max_empty_lines (5)</dt> +<dd><p>Maximum number of empty lines before a request.</p> +</dd> +<dt>max_header_name_length (64)</dt> +<dd><p>Maximum length of header names.</p> +</dd> +<dt>max_header_value_length (4096)</dt> +<dd><p>Maximum length of header values.</p> +</dd> +<dt>max_headers (100)</dt> +<dd><p>Maximum number of headers allowed per request.</p> +</dd> +<dt>max_keepalive (100)</dt> +<dd><p>Maximum number of requests allowed per connection.</p> +</dd> +<dt>max_method_length (32)</dt> +<dd><p>Maximum length of the method.</p> +</dd> +<dt>max_request_line_length (8000)</dt> +<dd><p>Maximum length of the request line.</p> +</dd> +<dt>max_skip_body_length (1000000)</dt> +<dd><p>Maximum length Cowboy is willing to skip when the user code did not read the body fully. When the remaining length is too large or unknown Cowboy will close the connection.</p> +</dd> +<dt>proxy_header (false)</dt> +<dd><p>Whether incoming connections have a PROXY protocol header. The proxy information will be passed forward via the <code>proxy_header</code> key of the Req object.</p> +</dd> +<dt>request_timeout (5000)</dt> +<dd><p>Time in ms with no requests before Cowboy closes the connection.</p> +</dd> +<dt>sendfile (true)</dt> +<dd><p>Whether the sendfile syscall may be used. It can be useful to disable it on systems where the syscall has a buggy implementation, for example under VirtualBox when using shared folders.</p> +</dd> +<dt>stream_handlers ([cowboy_stream_h])</dt> +<dd><p>Ordered list of stream handlers that will handle all stream events.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.6</strong>: The <code>chunked</code>, <code>http10_keepalive</code>, <code>proxy_header</code> and <code>sendfile</code> options were added. +</li> +<li><strong>2.5</strong>: The <code>linger_timeout</code> option was added. +</li> +<li><strong>2.2</strong>: The <code>max_skip_body_length</code> option was added. +</li> +<li><strong>2.0</strong>: The <code>timeout</code> option was renamed <code>request_timeout</code>. +</li> +<li><strong>2.0</strong>: The <code>idle_timeout</code>, <code>inactivity_timeout</code> and <code>shutdown_timeout</code> options were added. +</li> +<li><strong>2.0</strong>: The <code>max_method_length</code> option was added. +</li> +<li><strong>2.0</strong>: The <code>max_request_line_length</code> default was increased from 4096 to 8000. +</li> +<li><strong>2.0</strong>: The <code>connection_type</code> option was added. +</li> +<li><strong>2.0</strong>: The <code>env</code> option is now a map instead of a proplist. +</li> +<li><strong>2.0</strong>: The <code>stream_handlers</code> option was added. +</li> +<li><strong>2.0</strong>: The <code>compress</code> option was removed in favor of the <code>cowboy_compress_h</code> stream handler. +</li> +<li><strong>2.0</strong>: Options are now a map instead of a proplist. +</li> +<li><strong>2.0</strong>: Protocol introduced. Replaces <code>cowboy_protocol</code>. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowboy(7)</a>, <a href="../cowboy_http2">cowboy_http2(3)</a>, <a href="../cowboy_websocket">cowboy_websocket(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_http2/index.html b/docs/en/cowboy/2.6/manual/cowboy_http2/index.html new file mode 100644 index 00000000..8c55b9d4 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_http2/index.html @@ -0,0 +1,244 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_http2(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_http2(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_http2 - HTTP/2</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy_http2</code> implements HTTP/2 as a Ranch protocol.</p> +<h2 id="_options">Options</h2> +<!-- @todo Might be worth moving cowboy_clear/tls/stream_h options--> +<!-- to their respective manual, when they are added.--> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">connection_type</font> <font color="#990000">=></font> <font color="#FF6600">worker</font> | <font color="#FF6600">supervisor</font>, + <font color="#0000FF">enable_connect_protocol</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">idle_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">inactivity_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">initial_connection_window_size</font> <font color="#990000">=></font> <font color="#993399">65535</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font>, + <font color="#0000FF">initial_stream_window_size</font> <font color="#990000">=></font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font>, + <font color="#0000FF">max_concurrent_streams</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>() | <font color="#FF6600">infinity</font>, + <font color="#0000FF">max_decode_table_size</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">max_encode_table_size</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">max_frame_size_received</font> <font color="#990000">=></font> <font color="#993399">16384</font><font color="#990000">..</font><font color="#993399">16777215</font>, + <font color="#0000FF">max_frame_size_sent</font> <font color="#990000">=></font> <font color="#993399">16384</font><font color="#990000">..</font><font color="#993399">16777215</font> | <font color="#FF6600">infinity</font>, + <font color="#0000FF">preface_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">proxy_header</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">sendfile</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">settings_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">stream_handlers</font> <font color="#990000">=></font> [<b><font color="#000000">module</font></b>()] +}</tt></pre> +</div></div> +<p>Configuration for the HTTP/2 protocol.</p> +<p>This configuration is passed to Cowboy when starting listeners using <code>cowboy:start_clear/3</code> or <code>cowboy:start_tls/3</code> functions.</p> +<p>It can be updated without restarting listeners using the Ranch functions <code>ranch:get_protocol_options/1</code> and <code>ranch:set_protocol_options/2</code>.</p> +<p>The default value is given next to the option name:</p> +<dl><dt>connection_type (supervisor)</dt> +<dd><p>Whether the connection process also acts as a supervisor.</p> +</dd> +<dt>enable_connect_protocol (false)</dt> +<dd><p>Whether to enable the extended CONNECT method to allow protocols like Websocket to be used over an HTTP/2 stream. This option is experimental and disabled by default.</p> +</dd> +<dt>idle_timeout (60000)</dt> +<dd><p>Time in ms with no data received before Cowboy closes the connection.</p> +</dd> +<dt>inactivity_timeout (300000)</dt> +<dd><p>Time in ms with nothing received at all before Cowboy closes the connection.</p> +</dd> +<dt>initial_connection_window_size (65535)</dt> +<dd><p>Initial window size for the connection. This is the total amount of data (from request bodies for example) that may be buffered by the connection across all streams before the user code explicitly requests it.</p> +<p>Note that this value cannot be lower than the default.</p> +</dd> +<dt>initial_stream_window_size (65535)</dt> +<dd><p>Initial window size for new streams. This is the total amount of data (from request bodies for example) that may be buffered by a single stream before the user code explicitly requests it.</p> +</dd> +<dt>max_concurrent_streams (infinity)</dt> +<dd><p>Maximum number of concurrent streams allowed on the connection.</p> +</dd> +<dt>max_decode_table_size (4096)</dt> +<dd><p>Maximum header table size used by the decoder. This is the value advertised to the client. The client can then choose a header table size equal or lower to the advertised value.</p> +</dd> +<dt>max_encode_table_size (4096)</dt> +<dd><p>Maximum header table size used by the encoder. The server will compare this value to what the client advertises and choose the smallest one as the encoder's header table size.</p> +</dd> +<dt>max_frame_size_received (16384)</dt> +<dd><p>Maximum size of the frames received by the server. This value is advertised to the remote endpoint which can then decide to use any value lower or equal for its frame sizes.</p> +</dd> +<dt>max_frame_size_sent (infinity)</dt> +<dd><p>Maximum size of the frames sent by the server. This option allows setting an upper limit to the frame sizes instead of blindly following the client's advertised maximum.</p> +<p>Note that actual frame sizes may be lower than the limit when there is not enough space left in the flow control window.</p> +</dd> +<dt>preface_timeout (5000)</dt> +<dd><p>Time in ms Cowboy is willing to wait for the connection preface.</p> +</dd> +<dt>proxy_header (false)</dt> +<dd><p>Whether incoming connections have a PROXY protocol header. The proxy information will be passed forward via the <code>proxy_header</code> key of the Req object.</p> +</dd> +<dt>sendfile (true)</dt> +<dd><p>Whether the sendfile syscall may be used. It can be useful to disable it on systems where the syscall has a buggy implementation, for example under VirtualBox when using shared folders.</p> +</dd> +<dt>settings_timeout (5000)</dt> +<dd><p>Time in ms Cowboy is willing to wait for a SETTINGS ack.</p> +</dd> +<dt>stream_handlers ([cowboy_stream_h])</dt> +<dd><p>Ordered list of stream handlers that will handle all stream events.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.6</strong>: The <code>proxy_header</code> and <code>sendfile</code> options were added. +</li> +<li><strong>2.4</strong>: Add the options <code>initial_connection_window_size</code>, <code>initial_stream_window_size</code>, <code>max_concurrent_streams</code>, <code>max_decode_table_size</code>, <code>max_encode_table_size</code>, <code>max_frame_size_received</code>, <code>max_frame_size_sent</code> and <code>settings_timeout</code> to configure HTTP/2 SETTINGS and related behavior. +</li> +<li><strong>2.4</strong>: Add the experimental option <code>enable_connect_protocol</code>. +</li> +<li><strong>2.0</strong>: Protocol introduced. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowboy(7)</a>, <a href="../cowboy_http">cowboy_http(3)</a>, <a href="../cowboy_websocket">cowboy_websocket(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_loop/index.html b/docs/en/cowboy/2.6/manual/cowboy_loop/index.html new file mode 100644 index 00000000..efb257f5 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_loop/index.html @@ -0,0 +1,200 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_loop(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_loop(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_loop - Loop handlers</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy_loop</code> defines a callback interface for long running HTTP connections.</p> +<p>You should switch to this behavior for long polling, server-sent events and similar long-running requests.</p> +<p>There are generally two usage patterns:</p> +<ul><li>Loop until receiving a specific message, then send a response and stop execution (for example long polling); +</li> +<li>Or initiate a response in <code>init/2</code> and stream the body in <code>info/3</code> as necessary (for example server-sent events). +</li> +</ul> +<h2 id="_callbacks">Callbacks</h2> +<p>Loop handlers implement the following interface:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) + <font color="#990000">-></font> {<font color="#FF6600">cowboy_loop</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + | {<font color="#FF6600">cowboy_loop</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>, <font color="#FF6600">hibernate</font>} + +<b><font color="#000000">info</font></b>(<font color="#009900">Info</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + | {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>, <font color="#FF6600">hibernate</font>} + | {<font color="#FF6600">stop</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<b><font color="#000000">terminate</font></b>(<font color="#009900">Reason</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> <i><font color="#9A1900">%% optional</font></i> + +<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>() +<font color="#009900">State</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">Info</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">Reason</font> <font color="#990000">::</font> <font color="#FF6600">stop</font> + | {<font color="#FF6600">crash</font>, <font color="#FF6600">error</font> | <b><font color="#000080">exit</font></b> | <b><font color="#000080">throw</font></b>, <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>The <code>init/2</code> callback is common to all handlers. To switch to the loop behavior, it must return <code>cowboy_loop</code> as the first element of the tuple.</p> +<p>The <code>info/3</code> callback will be called for every Erlang message received. It may choose to continue the receive loop or stop it.</p> +<p>The optional <code>terminate/3</code> callback will ultimately be called with the reason for the termination of the handler. Cowboy will terminate the process right after this. There is no need to perform any cleanup in this callback.</p> +<p>The following terminate reasons are defined for loop handlers:</p> +<dl><dt>stop</dt> +<dd><p>The handler requested to close the connection by returning a <code>stop</code> tuple.</p> +</dd> +<dt>{crash, Class, Reason}</dt> +<dd><p>A crash occurred in the handler. <code>Class</code> and <code>Reason</code> can be used to obtain more information about the crash. The function <code>erlang:get_stacktrace/0</code> can also be called to obtain the stacktrace of the process when the crash occurred.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Loop handlers no longer need to handle overflow/timeouts. +</li> +<li><strong>1.0</strong>: Behavior introduced. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowboy(7)</a>, <a href="../cowboy_handler">cowboy_handler(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.6/manual/cowboy_middleware/index.html new file mode 100644 index 00000000..6772cebc --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_middleware/index.html @@ -0,0 +1,196 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_middleware(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_middleware(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_middleware - Middlewares</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy_middleware</code> defines a callback interface for Cowboy middlewares.</p> +<p>Middlewares process the request sequentially in the order they are configured.</p> +<h2 id="_callbacks">Callbacks</h2> +<p>Middlewares implement the following interface:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">execute</font></b>(<font color="#009900">Req</font>, <font color="#009900">Env</font>) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">Env</font>} + | {<font color="#FF6600">suspend</font>, <b><font color="#000000">module</font></b>(), <b><font color="#000080">atom</font></b>(), [<b><font color="#000000">any</font></b>()]} + | {<font color="#FF6600">stop</font>, <font color="#009900">Req</font>} + +<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>() +<font color="#009900">Env</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_middleware:env</font></b>()</tt></pre> +</div></div> +<p>The <code>execute/2</code> is the only callback that needs to be implemented. It must execute the middleware and return with instructions for Cowboy.</p> +<dl><dt>ok</dt> +<dd><p>Cowboy should continue processing the request using the returned Req object and environment.</p> +</dd> +<dt>suspend</dt> +<dd><p>Cowboy will hibernate the process. When resuming, Cowboy will apply the returned module, function and arguments.</p> +</dd> +<dt>stop</dt> +<dd><p>Cowboy will stop middleware execution. No other middleware will be executed. This effectively ends the processing of the request.</p> +</dd> +</dl> +<h2 id="_types">Types</h2> +<h3 id="_env">env()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">env</font></b>() <font color="#990000">::</font> #{<b><font color="#000080">atom</font></b>() <font color="#990000">=></font> <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>Middleware environment.</p> +<p>A new environment is created for every request. The initial environment contained the user configured environment values (like <code>dispatch</code> for example) plus the <code>listener</code> value which contains the name of the listener for this connection.</p> +<p>Middlewares may modify the environment as necessary.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The <code>env</code> type is now a map instead of a proplist. +</li> +<li><strong>1.0</strong>: Behavior introduced. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowboy(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.binding/index.html new file mode 100644 index 00000000..93192016 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.binding/index.html @@ -0,0 +1,200 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:binding(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:binding(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:binding - Access a value bound from the route</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">binding</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font>) <font color="#990000">-></font> <b><font color="#000000">binding</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font>, <font color="#000080">undefined</font>) +<b><font color="#000000">binding</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font>, <font color="#009900">Default</font>) <font color="#990000">-></font> <b><font color="#000000">any</font></b>() | <font color="#009900">Default</font> + +<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>() +<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Return the value for the given binding.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Name</dt> +<dd><p>Desired binding name as an atom.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +<dt>Default</dt> +<dd><p>Default value returned when the binding is missing.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>By default the value is a case sensitive binary string, however constraints may change the type of this value (for example automatically converting numbers to integer).</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the value is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the username from the path</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% Route is "/users/:user"</font></i> +<font color="#009900">Username</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:binding</font></b>(<font color="#FF6600">user</font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Get the branch name, with a default</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% Route is "/log[/:branch]"</font></i> +<font color="#009900">Branch</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:binding</font></b>(<font color="#FF6600">branch</font>, <font color="#009900">Req</font>, <font color="#990000"><<</font><font color="#FF0000">"master"</font><font color="#990000">>></font>)</tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.bindings">cowboy_req:bindings(3)</a>, <a href="../cowboy_req.host_info">cowboy_req:host_info(3)</a>, <a href="../cowboy_req.path_info">cowboy_req:path_info(3)</a>, <a href="../cowboy_router">cowboy_router(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.bindings/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.bindings/index.html new file mode 100644 index 00000000..619866e5 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.bindings/index.html @@ -0,0 +1,180 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:bindings(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:bindings(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:bindings - Access all values bound from the route</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">bindings</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <b><font color="#000000">cowboy_router:bindings</font></b>()</tt></pre> +</div></div> +<p>Return a map containing all bindings.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>By default values are case sensitive binary strings, however constraints may change the type of this value (for example automatically converting numbers to integer).</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the values are returned, they are no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get all bindings</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Bindings</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:bindings</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.binding">cowboy_req:binding(3)</a>, <a href="../cowboy_req.host_info">cowboy_req:host_info(3)</a>, <a href="../cowboy_req.path_info">cowboy_req:path_info(3)</a>, <a href="../cowboy_router">cowboy_router(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.body_length/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.body_length/index.html new file mode 100644 index 00000000..21d2a807 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.body_length/index.html @@ -0,0 +1,181 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:body_length(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:body_length(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:body_length - Body length</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">body_length</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <font color="#000080">undefined</font> | <b><font color="#000000">non_neg_integer</font></b>()</tt></pre> +</div></div> +<p>Return the length of the request body.</p> +<p>The length is not always known before reading the body. In those cases Cowboy will return <code>undefined</code>. The body length is available after the body has been fully read.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The length of the request body, or <code>undefined</code> if it is not known.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the length is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the body length</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Length</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:body_length</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.has_body">cowboy_req:has_body(3)</a>, <a href="../cowboy_req.read_body">cowboy_req:read_body(3)</a>, <a href="../cowboy_req.read_urlencoded_body">cowboy_req:read_urlencoded_body(3)</a>, <a href="../cowboy_req.read_part">cowboy_req:read_part(3)</a>, <a href="../cowboy_req.read_part_body">cowboy_req:read_part_body(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.cert/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.cert/index.html new file mode 100644 index 00000000..f11355e4 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.cert/index.html @@ -0,0 +1,200 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:cert(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:cert(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:cert - Client TLS certificate</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cert</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <b><font color="#000080">binary</font></b>() | <font color="#000080">undefined</font></tt></pre> +</div></div> +<p>Return the peer's TLS certificate.</p> +<p>Using the default configuration this function will always return <code>undefined</code>. You need to explicitly configure Cowboy to request the client certificate. To do this you need to set the <code>verify</code> transport option to <code>verify_peer</code>:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy:start_tls</font></b>(<font color="#FF6600">example</font>, [ + {<font color="#FF6600">port</font>, <font color="#993399">8443</font>}, + {<font color="#FF6600">cert</font>, <font color="#FF0000">"path/to/cert.pem"</font>}, + {<font color="#FF6600">verify</font>, <font color="#FF6600">verify_peer</font>} +], #{ + <font color="#0000FF">env</font> <font color="#990000">=></font> #{<font color="#0000FF">dispatch</font> <font color="#990000">=></font> <font color="#009900">Dispatch</font>} +})<font color="#990000">.</font></tt></pre> +</div></div> +<p>You may also want to customize the <code>verify_fun</code> function. Please consult the <code>ssl</code> application's manual for more details.</p> +<p>TCP connections do not allow a certificate and this function will therefore always return <code>undefined</code>.</p> +<p>The certificate can also be obtained using pattern matching:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">cert</font> <font color="#990000">:=</font> <font color="#009900">Cert</font>} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The client TLS certificate.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.1</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the client TLS certificate.</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Cert</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:cert</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.peer">cowboy_req:peer(3)</a>, <a href="../cowboy_req.sock">cowboy_req:sock(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.delete_resp_header/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.delete_resp_header/index.html new file mode 100644 index 00000000..9a1030c5 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.delete_resp_header/index.html @@ -0,0 +1,185 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:delete_resp_header(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:delete_resp_header(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:delete_resp_header - Delete a response header</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">delete_resp_header</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <font color="#009900">Req</font> + +<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% lowercase; case insensitive</font></i></tt></pre> +</div></div> +<p>Delete the given response header.</p> +<p>The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Name</dt> +<dd><p>Header name as a lowercase binary string.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A new Req object is returned.</p> +<p>The returned Req object must be used from that point onward, otherwise the header will still be sent in the response.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Remove the content-type header from the response</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:delete_resp_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#009900">Req0</font>),</tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.set_resp_header">cowboy_req:set_resp_header(3)</a>, <a href="../cowboy_req.set_resp_headers">cowboy_req:set_resp_headers(3)</a>, <a href="../cowboy_req.has_resp_header">cowboy_req:has_resp_header(3)</a>, <a href="../cowboy_req.resp_header">cowboy_req:resp_header(3)</a>, <a href="../cowboy_req.resp_headers">cowboy_req:resp_headers(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.has_body/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.has_body/index.html new file mode 100644 index 00000000..f2c5e0a7 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.has_body/index.html @@ -0,0 +1,178 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:has_body(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:has_body(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:has_body - Is there a request body?</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">has_body</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <b><font color="#000000">boolean</font></b>()</tt></pre> +</div></div> +<p>Return whether the request has a body.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A boolean indicating whether the request has a body.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Ensure the request has a body</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#000080">true</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:has_body</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.body_length">cowboy_req:body_length(3)</a>, <a href="../cowboy_req.read_body">cowboy_req:read_body(3)</a>, <a href="../cowboy_req.read_urlencoded_body">cowboy_req:read_urlencoded_body(3)</a>, <a href="../cowboy_req.read_part">cowboy_req:read_part(3)</a>, <a href="../cowboy_req.read_part_body">cowboy_req:read_part_body(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.has_resp_body/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.has_resp_body/index.html new file mode 100644 index 00000000..8f9d675a --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.has_resp_body/index.html @@ -0,0 +1,183 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:has_resp_body(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:has_resp_body(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:has_resp_body - Is there a response body?</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">has_resp_body</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <b><font color="#000000">boolean</font></b>()</tt></pre> +</div></div> +<p>Return whether a response body has been set.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A boolean indicating whether a response body has been set.</p> +<p>This function will return <code>false</code> when an empty response body has been set.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Check whether a body has been set</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#000080">false</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:has_resp_body</font></b>(<font color="#009900">Req0</font>), +<font color="#009900">Req1</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_body</font></b>(<font color="#990000"><<</font><font color="#FF0000">"Hello!"</font><font color="#990000">>></font>, <font color="#009900">Req0</font>), +<font color="#000080">true</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:has_resp_body</font></b>(<font color="#009900">Req1</font>), +<font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_body</font></b>(<font color="#990000"><<>></font>, <font color="#009900">Req1</font>), +<font color="#000080">false</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:has_resp_body</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.set_resp_body">cowboy_req:set_resp_body(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.has_resp_header/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.has_resp_header/index.html new file mode 100644 index 00000000..f1d10282 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.has_resp_header/index.html @@ -0,0 +1,186 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:has_resp_header(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:has_resp_header(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:has_resp_header - Is the given response header set?</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">has_resp_header</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <b><font color="#000000">boolean</font></b>() + +<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% lowercase; case insensitive</font></i></tt></pre> +</div></div> +<p>Return whether the given response header has been set.</p> +<p>The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Name</dt> +<dd><p>Header name as a lowercase binary string.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A boolean indicating whether the given response header has been set.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Check whether the content-type header has been set</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#000080">false</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:has_resp_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#009900">Req0</font>), +<font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/html"</font><font color="#990000">>></font>, <font color="#009900">Req0</font>), +<font color="#000080">true</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:has_resp_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.set_resp_header">cowboy_req:set_resp_header(3)</a>, <a href="../cowboy_req.set_resp_headers">cowboy_req:set_resp_headers(3)</a>, <a href="../cowboy_req.resp_header">cowboy_req:resp_header(3)</a>, <a href="../cowboy_req.resp_headers">cowboy_req:resp_headers(3)</a>, <a href="../cowboy_req.delete_resp_header">cowboy_req:delete_resp_header(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.header/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.header/index.html new file mode 100644 index 00000000..b0e0193a --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.header/index.html @@ -0,0 +1,207 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:header(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:header(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:header - HTTP header</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">header</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font>) <font color="#990000">-></font> <b><font color="#000000">header</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font>, <font color="#000080">undefined</font>) +<b><font color="#000000">header</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font>, <font color="#009900">Default</font>) <font color="#990000">-></font> <b><font color="#000080">binary</font></b>() | <font color="#009900">Default</font> + +<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% lowercase; case insensitive</font></i> +<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Return the value for the given HTTP header.</p> +<p>The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</p> +<p>Headers can also be obtained using pattern matching:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">headers</font> <font color="#990000">:=</font> #{<font color="#009900">Name</font> <font color="#990000">:=</font> <font color="#009900">Value</font>}} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>Note that this snippet will crash if the header is missing.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Name</dt> +<dd><p>Desired HTTP header name as a lowercase binary string.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +<dt>Default</dt> +<dd><p>Default value returned when the header is missing.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The header value is returned as a binary string. When the header is missing, the default argument is returned.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the header value is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the accept header</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Accept</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Get the content-length header with a default value</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Length</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"content-length"</font><font color="#990000">>></font>, <font color="#009900">Req</font>, <font color="#990000"><<</font><font color="#FF0000">"0"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.headers">cowboy_req:headers(3)</a>, <a href="../cowboy_req.parse_header">cowboy_req:parse_header(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.headers/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.headers/index.html new file mode 100644 index 00000000..eb9a9271 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.headers/index.html @@ -0,0 +1,187 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:headers(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:headers(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:headers - HTTP headers</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">headers</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <b><font color="#000000">cowboy:http_headers</font></b>()</tt></pre> +</div></div> +<p>Return all request headers.</p> +<p>Request headers can also be obtained using pattern matching:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">headers</font> <font color="#990000">:=</font> <font color="#009900">Headers</font>} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>Headers are returned as a map with keys being lowercase binary strings, and values as binary strings.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the headers are returned, they are no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get all headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Headers</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:headers</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.header">cowboy_req:header(3)</a>, <a href="../cowboy_req.parse_header">cowboy_req:parse_header(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.host/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.host/index.html new file mode 100644 index 00000000..cba908ae --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.host/index.html @@ -0,0 +1,187 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:host(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:host(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:host - URI host name</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">host</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <font color="#009900">Host</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()</tt></pre> +</div></div> +<p>Return the host name of the effective request URI.</p> +<p>The host name can also be obtained using pattern matching:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">host</font> <font color="#990000">:=</font> <font color="#009900">Host</font>} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The host name is returned as a lowercase binary string. It is case insensitive.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the host name is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the effective request URI's host name</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Host</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:host</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.binding">cowboy_req:binding(3)</a>, <a href="../cowboy_req.bindings">cowboy_req:bindings(3)</a>, <a href="../cowboy_req.host_info">cowboy_req:host_info(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.host_info/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.host_info/index.html new file mode 100644 index 00000000..815e4ac2 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.host_info/index.html @@ -0,0 +1,181 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:host_info(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:host_info(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:host_info - Access the route's heading host segments</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">host_info</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <b><font color="#000000">cowboy_router:tokens</font></b>()</tt></pre> +</div></div> +<p>Return the tokens for the heading host segments.</p> +<p>This is the part of the host name that was matched using the <code>...</code> notation.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The tokens are returned as a list of case insensitive binary strings.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the tokens are returned, they are no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the host_info tokens</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">HostInfo</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:host_info</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.binding">cowboy_req:binding(3)</a>, <a href="../cowboy_req.bindings">cowboy_req:bindings(3)</a>, <a href="../cowboy_req.path_info">cowboy_req:path_info(3)</a>, <a href="../cowboy_router">cowboy_router(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.inform/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.inform/index.html new file mode 100644 index 00000000..c80965f9 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.inform/index.html @@ -0,0 +1,205 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:inform(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:inform(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:inform - Send an informational response</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">inform</font></b>(<font color="#009900">Status</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <b><font color="#000000">inform</font></b>(<font color="#009900">StatusCode</font>, #{}, <font color="#009900">Req</font>) + +<b><font color="#000000">inform</font></b>(<font color="#009900">Status</font>, <font color="#009900">Headers</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">Status</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:http_status</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:http_headers</font></b>()</tt></pre> +</div></div> +<p>Send an informational response.</p> +<p>Informational responses use a status code between 100 and 199. They cannot include a body. This function will not use any of the previously set headers. All headers to be sent must be given directly.</p> +<p>Any number of informational responses can be sent as long as they are sent before the proper response. Attempting to use this function after sending a normal response will result in an error.</p> +<p>The header names must be given as lowercase binary strings. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Status</dt> +<dd><p>The status code for the response.</p> +</dd> +<dt>Headers</dt> +<dd><p>The response headers.</p> +<p>Header names must be given as lowercase binary strings.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is always returned. It can be safely ignored.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.1</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Send an informational response</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:inform</font></b>(<font color="#993399">102</font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Send an informational response with headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:inform</font></b>(<font color="#993399">103</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"link"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"</style.css>; rel=preload; as=style"</font><font color="#990000">>></font>, + <font color="#990000"><<</font><font color="#FF0000">"link"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"</script.js>; rel=preload; as=script"</font><font color="#990000">>></font> +}, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.reply">cowboy_req:reply(3)</a>, <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a>, <a href="../cowboy_req.push">cowboy_req:push(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.match_cookies/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.match_cookies/index.html new file mode 100644 index 00000000..14accfb8 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.match_cookies/index.html @@ -0,0 +1,207 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:match_cookies(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:match_cookies(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:match_cookies - Match cookies against constraints</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">match_cookies</font></b>(<font color="#009900">Fields</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:fields</font></b>(), <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> #{<b><font color="#000080">atom</font></b>() <font color="#990000">=></font> <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>Parse the cookies and match specific values against constraints.</p> +<p>Cowboy will only return the cookie values specified in the fields list, and ignore all others. Fields can be either the name of the cookie requested; the name along with a list of constraints; or the name, a list of constraints and a default value in case the cookie is missing.</p> +<p>This function will crash if the cookie is missing and no default value is provided. This function will also crash if a constraint fails.</p> +<p>The name of the cookie must be provided as an atom. The key of the returned map will be that atom. The value may be converted through the use of constraints, making this function able to extract, validate and convert values all in one step.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Fields</dt> +<dd><p>Cookies to retrieve.</p> +<p>See <a href="../cowboy">cowboy(3)</a> for a complete description.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>Desired values are returned as a map. The key is the atom that was given in the list of fields, and the value is the optionally converted value after applying constraints.</p> +<p>The map contains the same keys that were given in the fields.</p> +<p>An exception is triggered when the match fails.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Match fields</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% ID and Lang are binaries.</font></i> +#{<font color="#FF6600">id</font> <font color="#990000">:=</font> <font color="#009900">ID</font>, <font color="#FF6600">lang</font> <font color="#990000">:=</font> <font color="#009900">Lang</font>} + <font color="#990000">=</font> <b><font color="#000000">cowboy_req:match_cookies</font></b>([<font color="#FF6600">id</font>, <font color="#FF6600">lang</font>], <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Match fields and apply constraints</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% ID is an integer and Lang a non-empty binary.</font></i> +#{<font color="#FF6600">id</font> <font color="#990000">:=</font> <font color="#009900">ID</font>, <font color="#FF6600">lang</font> <font color="#990000">:=</font> <font color="#009900">Lang</font>} + <font color="#990000">=</font> <b><font color="#000000">cowboy_req:match_cookies</font></b>([{<font color="#FF6600">id</font>, <font color="#FF6600">int</font>}, {<font color="#FF6600">lang</font>, <font color="#FF6600">nonempty</font>}], <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Match fields with default values</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">lang</font> <font color="#990000">:=</font> <font color="#009900">Lang</font>} + <font color="#990000">=</font> <b><font color="#000000">cowboy_req:match_cookies</font></b>([{<font color="#FF6600">lang</font>, [], <font color="#990000"><<</font><font color="#FF0000">"en-US"</font><font color="#990000">>></font>}], <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.parse_cookies">cowboy_req:parse_cookies(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.match_qs/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.match_qs/index.html new file mode 100644 index 00000000..329dd8ef --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.match_qs/index.html @@ -0,0 +1,207 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:match_qs(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:match_qs(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:match_qs - Match the query string against constraints</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">match_qs</font></b>(<font color="#009900">Fields</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:fields</font></b>(), <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> #{<b><font color="#000080">atom</font></b>() <font color="#990000">=></font> <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>Parse the query string and match specific values against constraints.</p> +<p>Cowboy will only return the query string values specified in the fields list, and ignore all others. Fields can be either the key requested; the key along with a list of constraints; or the key, a list of constraints and a default value in case the key is missing.</p> +<p>This function will crash if the key is missing and no default value is provided. This function will also crash if a constraint fails.</p> +<p>The key must be provided as an atom. The key of the returned map will be that atom. The value may be converted through the use of constraints, making this function able to extract, validate and convert values all in one step.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Fields</dt> +<dd><p>Fields to retrieve from the query string.</p> +<p>See <a href="../cowboy">cowboy(3)</a> for a complete description.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>Desired values are returned as a map. The key is the atom that was given in the list of fields, and the value is the optionally converted value after applying constraints.</p> +<p>The map contains the same keys that were given in the fields.</p> +<p>An exception is triggered when the match fails.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Match fields</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% ID and Lang are binaries.</font></i> +#{<font color="#FF6600">id</font> <font color="#990000">:=</font> <font color="#009900">ID</font>, <font color="#FF6600">lang</font> <font color="#990000">:=</font> <font color="#009900">Lang</font>} + <font color="#990000">=</font> <b><font color="#000000">cowboy_req:match_qs</font></b>([<font color="#FF6600">id</font>, <font color="#FF6600">lang</font>], <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Match fields and apply constraints</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% ID is an integer and Lang a non-empty binary.</font></i> +#{<font color="#FF6600">id</font> <font color="#990000">:=</font> <font color="#009900">ID</font>, <font color="#FF6600">lang</font> <font color="#990000">:=</font> <font color="#009900">Lang</font>} + <font color="#990000">=</font> <b><font color="#000000">cowboy_req:match_qs</font></b>([{<font color="#FF6600">id</font>, <font color="#FF6600">int</font>}, {<font color="#FF6600">lang</font>, <font color="#FF6600">nonempty</font>}], <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Match fields with default values</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">lang</font> <font color="#990000">:=</font> <font color="#009900">Lang</font>} + <font color="#990000">=</font> <b><font color="#000000">cowboy_req:match_qs</font></b>([{<font color="#FF6600">lang</font>, [], <font color="#990000"><<</font><font color="#FF0000">"en-US"</font><font color="#990000">>></font>}], <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.qs">cowboy_req:qs(3)</a>, <a href="../cowboy_req.parse_qs">cowboy_req:parse_qs(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.method/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.method/index.html new file mode 100644 index 00000000..b2218a63 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.method/index.html @@ -0,0 +1,198 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:method(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:method(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:method - HTTP method</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">method</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <font color="#009900">Method</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()</tt></pre> +</div></div> +<p>Return the request's HTTP method.</p> +<p>The method can also be obtained using pattern matching:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">method</font> <font color="#990000">:=</font> <font color="#009900">Method</font>} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The request's HTTP method is returned as a binary string. While methods are case sensitive, standard methods are always uppercase.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the method is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Ensure the request's method is GET</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#990000"><<</font><font color="#FF0000">"GET"</font><font color="#990000">>></font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:method</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Allow methods from list</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">lists:member</font></b>(<b><font color="#000000">cowboy_req:method</font></b>(<font color="#009900">Req</font>), [<font color="#990000"><<</font><font color="#FF0000">"GET"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"POST"</font><font color="#990000">>></font>]) <b><font color="#0000FF">of</font></b> + <font color="#000080">true</font> <font color="#990000">-></font> <b><font color="#000000">handle</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>); + <font color="#000080">false</font> <font color="#990000">-></font> <b><font color="#000000">method_not_allowed</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.parse_cookies/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.parse_cookies/index.html new file mode 100644 index 00000000..e9298d26 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.parse_cookies/index.html @@ -0,0 +1,187 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:parse_cookies(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:parse_cookies(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:parse_cookies - Parse cookie headers</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_cookies</font></b>(<font color="#009900">Req</font>) <font color="#990000">-></font> [{<font color="#009900">Name</font>, <font color="#009900">Value</font>}] + +<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case sensitive</font></i> +<font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case sensitive</font></i></tt></pre> +</div></div> +<p>Parse cookie headers.</p> +<p>Alias for <a href="../cowboy_req.parse_header">cowboy_req:parse_header(<<"cookie">>, Req)</a>.</p> +<p>When the cookie header is missing, <code>[]</code> is returned.</p> +<p>While an empty cookie header is not valid, some clients do send it. Cowboy will in this case also return <code>[]</code>.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The cookies are returned as a list of key/values. Keys and values are case sensitive binary strings.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the parsed header value is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>2.0</strong>: Function introduced. Replaces <code>cookie/2,3</code> and <code>cookies/1</code>. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Look for a specific cookie</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Cookies</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:parse_cookies</font></b>(<font color="#009900">Req</font>), +{<font color="#990000">_</font>, <font color="#009900">Token</font>} <font color="#990000">=</font> <b><font color="#000000">lists:keyfind</font></b>(<font color="#990000"><<</font><font color="#FF0000">"token"</font><font color="#990000">>></font>, <font color="#993399">1</font>, <font color="#009900">Cookies</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.parse_header">cowboy_req:parse_header(3)</a>, <a href="../cowboy_req.match_cookies">cowboy_req:match_cookies(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.parse_header/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.parse_header/index.html new file mode 100644 index 00000000..68b31819 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.parse_header/index.html @@ -0,0 +1,358 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:parse_header(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:parse_header(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:parse_header - Parse the given HTTP header</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_header</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font>) <font color="#990000">-></font> <font color="#009900">ParsedValue</font> | <font color="#009900">Default</font> +<b><font color="#000000">parse_header</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font>, <font color="#009900">Default</font>) <font color="#990000">-></font> <font color="#009900">ParsedValue</font> | <font color="#009900">Default</font> + +<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>() +<font color="#009900">ParsedValue</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Parse the given HTTP header.</p> +<p>The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</p> +<p>The type of the parsed value varies depending on the header. Similarly, the default value when calling <code>cowboy_req:parse_header/2</code> differs depending on the header.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Name</dt> +<dd><p>Desired HTTP header name as a lowercase binary string.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +<dt>Default</dt> +<dd><p>Default value returned when the header is missing.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The parsed header value varies depending on the header. When the header is missing, the default argument is returned.</p> +<h2 id="_headers">Headers</h2> +<p>The following snippets detail the types returned by the different headers. Unless mentioned otherwise, the default value when the header is missing will be <code>undefined</code>:</p> +<div class="listingblock"><div class="title">accept</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#009900">Req</font>) + <font color="#990000">-></font> [{{<font color="#009900">Type</font>, <font color="#009900">SubType</font>, <font color="#009900">Params</font>}, <font color="#009900">Quality</font>, <font color="#009900">AcceptExt</font>}] + +<font color="#009900">Type</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case insensitive</font></i> +<font color="#009900">SubType</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case insensitive</font></i> +<font color="#009900">Params</font> <font color="#990000">::</font> [{<font color="#009900">Key</font>, <font color="#009900">Value</font>}] +<font color="#009900">Quality</font> <font color="#990000">::</font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">1000</font> +<font color="#009900">AcceptExt</font> <font color="#990000">::</font> [<font color="#009900">Key</font> | {<font color="#009900">Key</font>, <font color="#009900">Value</font>}] +<font color="#009900">Key</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case insensitive</font></i> +<font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case sensitive</font></i></tt></pre> +</div></div> +<div class="listingblock"><div class="title">accept-charset, accept-encoding and accept-language</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_header</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font>) <font color="#990000">-></font> [{<font color="#009900">Value</font>, <font color="#009900">Quality</font>}] + +<font color="#009900">Name</font> <font color="#990000">::</font> <font color="#990000"><<</font><font color="#FF0000">"accept-charset"</font><font color="#990000">>></font> + | <font color="#990000"><<</font><font color="#FF0000">"accept-encoding"</font><font color="#990000">>></font> + | <font color="#990000"><<</font><font color="#FF0000">"accept-language"</font><font color="#990000">>></font> +<font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case insensitive</font></i> +<font color="#009900">Quality</font> <font color="#990000">::</font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">1000</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">authorization</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"authorization"</font><font color="#990000">>></font>, <font color="#009900">Req</font>) + <font color="#990000">-></font> {<font color="#FF6600">basic</font>, <font color="#009900">Username</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">Password</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">bearer</font>, <font color="#009900">Token</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">digest</font>, [{<font color="#009900">Key</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()}]}</tt></pre> +</div></div> +<!-- @todo Currently also parses connection. Do we want this? Should it be documented? Use case?--> +<div class="listingblock"><div class="title">content-length</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"content-length"</font><font color="#990000">>></font>, <font color="#009900">Req</font>) <font color="#990000">-></font> <b><font color="#000000">non_neg_integer</font></b>()</tt></pre> +</div></div> +<p>When the content-length header is missing, <code>0</code> is returned.</p> +<div class="listingblock"><div class="title">content-type</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#009900">Req</font>) + <font color="#990000">-></font> {<font color="#009900">Type</font>, <font color="#009900">SubType</font>, <font color="#009900">Params</font>} + +<font color="#009900">Type</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case insensitive</font></i> +<font color="#009900">SubType</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case insensitive</font></i> +<font color="#009900">Params</font> <font color="#990000">::</font> [{<font color="#009900">Key</font>, <font color="#009900">Value</font>}] +<font color="#009900">Key</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case insensitive</font></i> +<font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case sensitive;</font></i></tt></pre> +</div></div> +<p>Note that the value for the charset parameter is case insensitive and returned as a lowercase binary string.</p> +<div class="listingblock"><div class="title">cookie</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"cookie"</font><font color="#990000">>></font>, <font color="#009900">Req</font>) <font color="#990000">-></font> [{<font color="#009900">Name</font>, <font color="#009900">Value</font>}] + +<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case sensitive</font></i> +<font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case sensitive</font></i></tt></pre> +</div></div> +<p>When the cookie header is missing, <code>[]</code> is returned.</p> +<p>While an empty cookie header is not valid, some clients do send it. Cowboy will in this case also return <code>[]</code>.</p> +<div class="listingblock"><div class="title">expect</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"expect"</font><font color="#990000">>></font>, <font color="#009900">Req</font>) <font color="#990000">-></font> <font color="#FF6600">continue</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">if-match and if-none-match</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_header</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font>) + <font color="#990000">-></font> <font color="#FF6600">'*'</font> | [{<font color="#FF6600">weak</font> | <font color="#FF6600">strong</font>, <font color="#009900">OpaqueTag</font>}] + +<font color="#009900">Name</font> <font color="#990000">::</font> <font color="#990000"><<</font><font color="#FF0000">"if-match"</font><font color="#990000">>></font> + | <font color="#990000"><<</font><font color="#FF0000">"if-none-match"</font><font color="#990000">>></font> +<font color="#009900">OpaqueTag</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case sensitive</font></i></tt></pre> +</div></div> +<div class="listingblock"><div class="title">if-modified-since and if-unmodified-since</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_header</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font>) <font color="#990000">-></font> <b><font color="#000000">calendar:datetime</font></b>()</tt></pre> +</div></div> +<div class="listingblock"><div class="title">range</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"range"</font><font color="#990000">>></font>, <font color="#009900">Req</font>) <font color="#990000">-></font> {<font color="#009900">From</font>, <font color="#009900">To</font>} | <font color="#009900">Final</font> + +<font color="#009900">From</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>() +<font color="#009900">To</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>() | <font color="#FF6600">infinity</font> +<font color="#009900">Final</font> <font color="#990000">::</font> <b><font color="#000000">neg_integer</font></b>()</tt></pre> +</div></div> +<div class="listingblock"><div class="title">sec-websocket-extensions</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"sec-websocket-extensions"</font><font color="#990000">>></font>, <font color="#009900">Req</font>) + <font color="#990000">-></font> [{<font color="#009900">Extension</font>, <font color="#009900">Params</font>}] + +<font color="#009900">Extension</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case sensitive</font></i> +<font color="#009900">Params</font> <font color="#990000">::</font> [<font color="#009900">Key</font> | {<font color="#009900">Key</font>, <font color="#009900">Value</font>}] +<font color="#009900">Key</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case sensitive</font></i> +<font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case sensitive</font></i></tt></pre> +</div></div> +<div class="listingblock"><div class="title">sec-websocket-protocol and upgrade</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_header</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font>) <font color="#990000">-></font> [<font color="#009900">Token</font>] + +<font color="#009900">Name</font> <font color="#990000">::</font> <font color="#990000"><<</font><font color="#FF0000">"sec-websocket-protocol"</font><font color="#990000">>></font> + | <font color="#990000"><<</font><font color="#FF0000">"upgrade"</font><font color="#990000">>></font> +<font color="#009900">Token</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case insensitive</font></i></tt></pre> +</div></div> +<div class="listingblock"><div class="title">x-forwarded-for</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"x-forwarded-for"</font><font color="#990000">>></font>, <font color="#009900">Req</font>) <font color="#990000">-></font> [<font color="#009900">Token</font>] + +<font color="#009900">Token</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case sensitive</font></i></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Unknown headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_header</font></b>(<font color="#990000">_</font>, <font color="#009900">Req</font>) <font color="#990000">-></font> {<font color="#000080">undefined</font>, <font color="#009900">RawValue</font>}</tt></pre> +</div></div> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the parsed header value is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Parse the accept header with a custom default value</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% Accept everything when header is missing.</font></i> +<font color="#009900">Accept</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:parse_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#009900">Req</font>, + [{{ <font color="#990000"><<</font><font color="#FF0000">"*"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"*"</font><font color="#990000">>></font>, []}, <font color="#993399">1000</font>, []}])<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Parse the content-length header</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% Default content-length is 0.</font></i> +<font color="#009900">Length</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"content-length"</font><font color="#990000">>></font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.header">cowboy_req:header(3)</a>, <a href="../cowboy_req.headers">cowboy_req:headers(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.parse_qs/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.parse_qs/index.html new file mode 100644 index 00000000..1beb21ac --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.parse_qs/index.html @@ -0,0 +1,195 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:parse_qs(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:parse_qs(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:parse_qs - Parse the query string</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_qs</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> [{<font color="#009900">Key</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() | <font color="#000080">true</font>}]</tt></pre> +</div></div> +<p>Parse the query string as a list of key/value pairs.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The parsed query string is returned as a list of key/value pairs. The key is a binary string. The value is either a binary string, or the atom <code>true</code>. Both key and value are case sensitive.</p> +<p>The atom <code>true</code> is returned when a key is present in the query string without a value. For example, in the following URIs the key <code><<"edit">></code> will always have the value <code>true</code>:</p> +<ul><li><code>/posts/42?edit</code> +</li> +<li><code>/posts/42?edit&exclusive=1</code> +</li> +<li><code>/posts/42?exclusive=1&edit</code> +</li> +<li><code>/posts/42?exclusive=1&edit&from=web</code> +</li> +</ul> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The parsed value is not longer cached in the Req object. +</li> +<li><strong>2.0</strong>: Only the parsed query string is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>2.0</strong>: Function introduced. Replaces <code>qs_val/1</code> and <code>qs_vals/1</code>. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Parse the query string and convert the keys to atoms</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">ParsedQs</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:parse_qs</font></b>(<font color="#009900">Req</font>), +<font color="#009900">AtomsQs</font> <font color="#990000">=</font> [{<b><font color="#000000">binary_to_existing_atom</font></b>(<font color="#009900">K</font>, <font color="#FF6600">latin1</font>), <font color="#009900">V</font>} + || {<font color="#009900">K</font>, <font color="#009900">V</font>} <font color="#990000"><-</font> <font color="#009900">ParsedQs</font>]<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.qs">cowboy_req:qs(3)</a>, <a href="../cowboy_req.match_qs">cowboy_req:match_qs(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.path/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.path/index.html new file mode 100644 index 00000000..ab630a4f --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.path/index.html @@ -0,0 +1,187 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:path(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:path(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:path - URI path</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">path</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()</tt></pre> +</div></div> +<p>Return the path of the effective request URI.</p> +<p>The path can also be obtained using pattern matching:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">path</font> <font color="#990000">:=</font> <font color="#009900">Path</font>} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The path is returned as a binary string. It is case sensitive.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the path is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the effective request URI's path</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Path</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:path</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.binding">cowboy_req:binding(3)</a>, <a href="../cowboy_req.bindings">cowboy_req:bindings(3)</a>, <a href="../cowboy_req.path_info">cowboy_req:path_info(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.path_info/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.path_info/index.html new file mode 100644 index 00000000..a4eb2f45 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.path_info/index.html @@ -0,0 +1,181 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:path_info(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:path_info(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:path_info - Access the route's trailing path segments</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">path_info</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <b><font color="#000000">cowboy_router:tokens</font></b>()</tt></pre> +</div></div> +<p>Return the tokens for the trailing path segments.</p> +<p>This is the part of the host name that was matched using the <code>...</code> notation.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The tokens are returned as a list of case sensitive binary strings.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the tokens are returned, they are no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the path_info tokens</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">PathInfo</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:path_info</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.binding">cowboy_req:binding(3)</a>, <a href="../cowboy_req.bindings">cowboy_req:bindings(3)</a>, <a href="../cowboy_req.host_info">cowboy_req:host_info(3)</a>, <a href="../cowboy_router">cowboy_router(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.peer/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.peer/index.html new file mode 100644 index 00000000..4660210f --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.peer/index.html @@ -0,0 +1,191 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:peer(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:peer(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:peer - Peer address and port</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">peer</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <font color="#009900">Info</font> + +<font color="#009900">Info</font> <font color="#990000">::</font> {<b><font color="#000000">inet:ip_address</font></b>(), <b><font color="#000000">inet:port_number</font></b>()}</tt></pre> +</div></div> +<p>Return the peer's IP address and port number.</p> +<p>The peer information can also be obtained using pattern matching:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">peer</font> <font color="#990000">:=</font> {<font color="#009900">IP</font>, <font color="#009900">Port</font>}} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The peer's IP address and port number.</p> +<p>The peer is not necessarily the client's IP address and port. It is the IP address of the endpoint connecting directly to the server, which may be a gateway or a proxy.</p> +<p>The forwarded header can be used to get better information about the different endpoints from the client to the server. Note however that it is only informative; there is no reliable way of determining the source of an HTTP request.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the peer is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the peer IP address and port number.</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#009900">IP</font>, <font color="#009900">Port</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:peer</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.sock">cowboy_req:sock(3)</a>, <a href="../cowboy_req.cert">cowboy_req:cert(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.port/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.port/index.html new file mode 100644 index 00000000..dd027fca --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.port/index.html @@ -0,0 +1,188 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:port(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:port(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:port - URI port number</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">port</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <font color="#009900">Port</font> <font color="#990000">::</font> <b><font color="#000000">inet:port_number</font></b>()</tt></pre> +</div></div> +<p>Return the port number of the effective request URI.</p> +<p>Note that the port number returned by this function is obtained by parsing the host header. It may be different from the port the peer used to connect to Cowboy.</p> +<p>The port number can also be obtained using pattern matching:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">port</font> <font color="#990000">:=</font> <font color="#009900">Port</font>} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The port number is returned as an integer.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the port number is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the effective request URI's port number</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Port</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:port</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.push/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.push/index.html new file mode 100644 index 00000000..7fcfbd4f --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.push/index.html @@ -0,0 +1,214 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:push(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:push(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:push - Push a resource to the client</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">push</font></b>(<font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <b><font color="#000000">push</font></b>(<font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Req</font>, #{}) + +<b><font color="#000000">push</font></b>(<font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>(), <font color="#009900">Opts</font>) + <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() <i><font color="#9A1900">%% case sensitive</font></i> +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:http_headers</font></b>() +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:push_opts</font></b>()</tt></pre> +</div></div> +<p>Push a resource to the client.</p> +<p>Cowboy handles push requests the same way as if they came from the client, including the creation of a request handling process, routing and middlewares and so on.</p> +<p>This function does nothing when the HTTP/1.1 protocol is used. You may call it safely without first checking whether the connection uses HTTP/2.</p> +<p>The header names must be given as lowercase binary strings. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</p> +<p>Note that the headers must be the headers the client is expected to send if it were to perform the request. They are therefore request headers, and not response headers.</p> +<p>By default, Cowboy will use the GET method, an empty query string, and take the scheme, host and port directly from the current request's URI. You can override them by passing options.</p> +<p>Note that clients may cancel the push or ignore it entirely. For example browsers may ignore the resource when the connection is not considered secure.</p> +<p>It is not possible to push resources after sending a response. Any attempt will result in an error.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Path</dt> +<dd><p>The status code for the response.</p> +</dd> +<dt>Headers</dt> +<dd><p>The response headers.</p> +<p>Header names must be given as lowercase binary strings.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +<dt>Opts</dt> +<dd><p>Customize the HTTP method or the URI scheme, host, port or query string.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is always returned. It can be safely ignored.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Push a resource</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cowboy_req:push</font></b>(<font color="#FF0000">"/static/style.css"</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/css"</font><font color="#990000">>></font> +}, <font color="#009900">Req</font>),</tt></pre> +</div></div> +<div class="listingblock"><div class="title">Push a resource with a custom host</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cowboy_req:push</font></b>(<font color="#FF0000">"/static/style.css"</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/css"</font><font color="#990000">>></font> +}, #{<font color="#0000FF">host</font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"cdn.example.org"</font><font color="#990000">>></font>}, <font color="#009900">Req</font>),</tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.inform">cowboy_req:inform(3)</a>, <a href="../cowboy_req.reply">cowboy_req:reply(3)</a>, <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.qs/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.qs/index.html new file mode 100644 index 00000000..0f07ba3a --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.qs/index.html @@ -0,0 +1,187 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:qs(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:qs(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:qs - URI query string</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">qs</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <font color="#009900">Qs</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()</tt></pre> +</div></div> +<p>Return the query string of the effective request URI.</p> +<p>The query string can also be obtained using pattern matching:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">qs</font> <font color="#990000">:=</font> <font color="#009900">Qs</font>} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The query string is returned as a binary string. It is case sensitive.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the query string is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the effective request URI's query string</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Qs</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:qs</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.parse_qs">cowboy_req:parse_qs(3)</a>, <a href="../cowboy_req.match_qs">cowboy_req:match_qs(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.read_and_match_urlencoded_body/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.read_and_match_urlencoded_body/index.html new file mode 100644 index 00000000..fe433400 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.read_and_match_urlencoded_body/index.html @@ -0,0 +1,238 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:read_and_match_urlencoded_body(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:read_and_match_urlencoded_body(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:read_and_match_urlencoded_body - Read, parse and match a urlencoded request body against constraints</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">read_and_match_urlencoded_body</font></b>(<font color="#009900">Fields</font>, <font color="#009900">Req</font>) + <font color="#990000">-></font> <b><font color="#000000">read_and_match_urlencoded_body</font></b>(<font color="#009900">Fields</font>, <font color="#009900">Req</font>, #{}) + +<b><font color="#000000">read_and_match_urlencoded_body</font></b>(<font color="#009900">Fields</font>, <font color="#009900">Req</font>, <font color="#009900">Opts</font>) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Body</font>, <font color="#009900">Req</font>} + +<font color="#009900">Fields</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:fields</font></b>() +<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>() +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:read_body_opts</font></b>() +<font color="#009900">Body</font> <font color="#990000">::</font> #{<b><font color="#000080">atom</font></b>() <font color="#990000">=></font> <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>Read, parse and match a urlencoded request body against constraints.</p> +<p>This function reads the request body and parses it as <code>application/x-www-form-urlencoded</code>. It then applies the given field constraints to the urlencoded data and returns the result as a map.</p> +<p>The urlencoded media type is used by Web browsers when submitting HTML forms using the POST method.</p> +<p>Cowboy will only return the values specified in the fields list, and ignore all others. Fields can be either the key requested; the key along with a list of constraints; or the key, a list of constraints and a default value in case the key is missing.</p> +<p>This function will crash if the key is missing and no default value is provided. This function will also crash if a constraint fails.</p> +<p>The key must be provided as an atom. The key of the returned map will be that atom. The value may be converted through the use of constraints, making this function able to extract, validate and convert values all in one step.</p> +<p>Cowboy needs to read the full body before parsing. By default it will read bodies of size up to 64KB. It is possible to provide options to read larger bodies if required.</p> +<p>Cowboy will automatically handle protocol details including the expect header, chunked transfer-encoding and others.</p> +<p>Once the body has been read, Cowboy sets the content-length header if it was not previously provided.</p> +<p>This function can only be called once. Calling it again will result in undefined behavior.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Fields</dt> +<dd><p>Fields to retrieve from the urlencoded body.</p> +<p>See <a href="../cowboy">cowboy(3)</a> for a complete description.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +<dt>Opts</dt> +<dd><p>A map of body reading options. Please refer to <a href="../cowboy_req.read_body">cowboy_req:read_body(3)</a> for details about each option.</p> +<p>This function defaults the <code>length</code> to 64KB and the <code>period</code> to 5 seconds.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>An <code>ok</code> tuple is returned.</p> +<p>Desired values are returned as a map. The key is the atom that was given in the list of fields, and the value is the optionally converted value after applying constraints.</p> +<p>The map contains the same keys that were given in the fields.</p> +<p>An exception is triggered when the match fails.</p> +<p>The Req object returned in the tuple must be used from that point onward. It contains a more up to date representation of the request. For example it may have an added content-length header once the body has been read.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.5</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Match fields</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% ID and Lang are binaries.</font></i> +#{<font color="#FF6600">id</font> <font color="#990000">:=</font> <font color="#009900">ID</font>, <font color="#FF6600">lang</font> <font color="#990000">:=</font> <font color="#009900">Lang</font>} + <font color="#990000">=</font> <b><font color="#000000">cowboy_req:read_and_match_urlencoded_body</font></b>( + [<font color="#FF6600">id</font>, <font color="#FF6600">lang</font>], <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Match fields and apply constraints</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% ID is an integer and Lang a non-empty binary.</font></i> +#{<font color="#FF6600">id</font> <font color="#990000">:=</font> <font color="#009900">ID</font>, <font color="#FF6600">lang</font> <font color="#990000">:=</font> <font color="#009900">Lang</font>} + <font color="#990000">=</font> <b><font color="#000000">cowboy_req:read_and_match_urlencoded_body</font></b>( + [{<font color="#FF6600">id</font>, <font color="#FF6600">int</font>}, {<font color="#FF6600">lang</font>, <font color="#FF6600">nonempty</font>}], <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Match fields with default values</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">lang</font> <font color="#990000">:=</font> <font color="#009900">Lang</font>} + <font color="#990000">=</font> <b><font color="#000000">cowboy_req:read_and_match_urlencoded_body</font></b>( + [{<font color="#FF6600">lang</font>, [], <font color="#990000"><<</font><font color="#FF0000">"en-US"</font><font color="#990000">>></font>}], <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Allow large urlencoded bodies</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">Body</font>, <font color="#009900">Req</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:read_and_match_urlencoded_body</font></b>( + <font color="#009900">Fields</font>, <font color="#009900">Req0</font>, #{<b><font color="#000080">length</font></b> <font color="#990000">=></font> <font color="#993399">1000000</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.has_body">cowboy_req:has_body(3)</a>, <a href="../cowboy_req.body_length">cowboy_req:body_length(3)</a>, <a href="../cowboy_req.read_body">cowboy_req:read_body(3)</a>, <a href="../cowboy_req.read_urlencoded_body">cowboy_req:read_urlencoded_body(3)</a>, <a href="../cowboy_req.read_part">cowboy_req:read_part(3)</a>, <a href="../cowboy_req.read_part_body">cowboy_req:read_part_body(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.read_body/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.read_body/index.html new file mode 100644 index 00000000..2af1e323 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.read_body/index.html @@ -0,0 +1,212 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:read_body(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:read_body(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:read_body - Read the request body</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">read_body</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <b><font color="#000000">read_body</font></b>(<font color="#009900">Req</font>, #{}) + +<b><font color="#000000">read_body</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>(), <font color="#009900">Opts</font>) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Data</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">Req</font>} + | {<font color="#FF6600">more</font>, <font color="#009900">Data</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">Req</font>} + +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:read_body_opts</font></b>()</tt></pre> +</div></div> +<p>Read the request body.</p> +<p>This function reads a chunk of the request body. A <code>more</code> tuple is returned when more data remains to be read. Call the function repeatedly until an <code>ok</code> tuple is returned to read the entire body.</p> +<p>An <code>ok</code> tuple with empty data is returned when the request has no body, or when calling this function again after the body has already been read. It is therefore safe to call this function directly. Note that the body can only be read once.</p> +<p>This function reads the request body from the connection process. The connection process is responsible for reading from the socket. The exact behavior varies depending on the protocol.</p> +<p>The options therefore are only related to the communication between the request process and the connection process.</p> +<p>Cowboy will automatically handle protocol details including the expect header, chunked transfer-encoding and others.</p> +<p>Once the body has been read fully, Cowboy sets the content-length header if it was not previously provided.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +<dt>Opts</dt> +<dd><p>A map of body reading options.</p> +<p>The <code>length</code> option can be used to request smaller or bigger chunks of data to be sent. It is a best effort approach, Cowboy may send more data than configured on occasions. It defaults to 8MB.</p> +<p>The <code>period</code> indicates how long the connection process will wait before it provides us with the data it received. It defaults to 15 seconds.</p> +<p>The connection process sends data to the request process when either the <code>length</code> of data or the <code>period</code> of time is reached.</p> +<p>The <code>timeout</code> option is a safeguard in case the connection process becomes unresponsive. The function will crash if no message was received in that interval. The timeout should be larger than the period. It defaults to the period + 1 second.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A <code>more</code> tuple is returned when there are more data to be read.</p> +<p>An <code>ok</code> tuple is returned when there are no more data to be read, either because this is the last chunk of data, the body has already been read, or there was no body to begin with.</p> +<p>The data is always returned as a binary.</p> +<p>The Req object returned in the tuple must be used from that point onward. It contains a more up to date representation of the request. For example it may have an added content-length header once the body has been read.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. Replaces <code>body/1,2</code>. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Read the entire body</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">read_body</font></b>(<font color="#009900">Req0</font>, <font color="#009900">Acc</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">cowboy_req:read_body</font></b>(<font color="#009900">Req0</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">ok</font>, <font color="#009900">Data</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#990000"><<</font> <font color="#009900">Acc</font><font color="#990000">/</font><b><font color="#000080">binary</font></b>, <font color="#009900">Data</font><font color="#990000">/</font><b><font color="#000080">binary</font></b> <font color="#990000">>></font>, <font color="#009900">Req</font>}; + {<font color="#FF6600">more</font>, <font color="#009900">Data</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> <b><font color="#000000">read_body</font></b>(<font color="#009900">Req</font>, <font color="#990000"><<</font> <font color="#009900">Acc</font><font color="#990000">/</font><b><font color="#000080">binary</font></b>, <font color="#009900">Data</font><font color="#990000">/</font><b><font color="#000080">binary</font></b> <font color="#990000">>></font>) + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Read the body in small chunks</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cowboy_req:read_body</font></b>(<font color="#009900">Req</font>, #{<b><font color="#000080">length</font></b> <font color="#990000">=></font> <font color="#993399">64000</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.has_body">cowboy_req:has_body(3)</a>, <a href="../cowboy_req.body_length">cowboy_req:body_length(3)</a>, <a href="../cowboy_req.read_urlencoded_body">cowboy_req:read_urlencoded_body(3)</a>, <a href="../cowboy_req.read_and_match_urlencoded_body">cowboy_req:read_and_match_urlencoded_body(3)</a>, <a href="../cowboy_req.read_part">cowboy_req:read_part(3)</a>, <a href="../cowboy_req.read_part_body">cowboy_req:read_part_body(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.read_part/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.read_part/index.html new file mode 100644 index 00000000..33b0acd8 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.read_part/index.html @@ -0,0 +1,234 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:read_part(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:read_part(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:read_part - Read the next multipart headers</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">read_part</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <b><font color="#000000">read_part</font></b>(<font color="#009900">Req</font>, #{}) + +<b><font color="#000000">read_part</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>(), <font color="#009900">Opts</font>) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Headers</font>, <font color="#009900">Req</font>} | {<font color="#FF6600">done</font>, <font color="#009900">Req</font>} + +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:read_body_opts</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> #{<b><font color="#000080">binary</font></b>() <font color="#990000">=></font> <b><font color="#000080">binary</font></b>()}</tt></pre> +</div></div> +<p>Read the next part of a multipart body.</p> +<p>This function reads the request body and parses it as multipart. Each parts of a multipart representation have their own headers and body. This function parses and returns headers. Examples of multipart media types are <code>multipart/form-data</code> and <code>multipart/byteranges</code>.</p> +<p>Cowboy will skip any data remaining until the beginning of the next part. This includes the preamble to the multipart message but also the body of a previous part if it hasn't been read. Both are skipped automatically when calling this function.</p> +<p>Cowboy will read the body before parsing in chunks of size up to 64KB, with a period of 5 seconds. This is tailored for reading part headers and might not be the most efficient for skipping the previous part's body.</p> +<p>The headers returned are MIME headers, <strong>NOT</strong> HTTP headers. They can be parsed using the functions from the <code>cow_multipart</code> module. In addition, the <code>cow_multipart:form_data/1</code> function can be used to quickly extract information from <code>multipart/form-data</code> representations.</p> +<!-- @todo Proper link to cow_multipart:form_data.--> +<p>Once a part has been read, it can not be read again.</p> +<p>Once the body has been read, Cowboy sets the content-length header if it was not previously provided.</p> +<!-- @todo Limit the maximum size of multipart headers.--> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +<dt>Opts</dt> +<dd><p>A map of body reading options. Please refer to <a href="../cowboy_req.read_body">cowboy_req:read_body(3)</a> for details about each option.</p> +<p>This function defaults the <code>length</code> to 64KB and the <code>period</code> to 5 seconds.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>An <code>ok</code> tuple is returned containing the next part's headers as a map.</p> +<p>A <code>done</code> tuple is returned if there are no more parts to read.</p> +<p>The Req object returned in the tuple must be used from that point onward. It contains a more up to date representation of the request. For example it may have an added content-length header once the body has been read.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. Replaces <code>part/1,2</code>. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Read all parts</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">acc_multipart</font></b>(<font color="#009900">Req0</font>, <font color="#009900">Acc</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">cowboy_req:read_part</font></b>(<font color="#009900">Req0</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">ok</font>, <font color="#009900">Headers</font>, <font color="#009900">Req1</font>} <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">Body</font>, <font color="#009900">Req</font>} <font color="#990000">=</font> <b><font color="#000000">stream_body</font></b>(<font color="#009900">Req1</font>, <font color="#990000"><<>></font>), + <b><font color="#000000">acc_multipart</font></b>(<font color="#009900">Req</font>, [{<font color="#009900">Headers</font>, <font color="#009900">Body</font>}|<font color="#009900">Acc</font>]); + {<font color="#FF6600">done</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> + {<b><font color="#000000">lists:reverse</font></b>(<font color="#009900">Acc</font>), <font color="#009900">Req</font>} + <b><font color="#0000FF">end</font></b><font color="#990000">.</font> + +<b><font color="#000000">stream_body</font></b>(<font color="#009900">Req0</font>, <font color="#009900">Acc</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">cowboy_req:read_part_body</font></b>(<font color="#009900">Req0</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">more</font>, <font color="#009900">Data</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> + <b><font color="#000000">stream_body</font></b>(<font color="#009900">Req</font>, <font color="#990000"><<</font> <font color="#009900">Acc</font><font color="#990000">/</font><b><font color="#000080">binary</font></b>, <font color="#009900">Data</font><font color="#990000">/</font><b><font color="#000080">binary</font></b> <font color="#990000">>></font>); + {<font color="#FF6600">ok</font>, <font color="#009900">Data</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#990000"><<</font> <font color="#009900">Acc</font><font color="#990000">/</font><b><font color="#000080">binary</font></b>, <font color="#009900">Data</font><font color="#990000">/</font><b><font color="#000080">binary</font></b> <font color="#990000">>></font>, <font color="#009900">Req</font>} + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Read all part headers, skipping bodies</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">skip_body_multipart</font></b>(<font color="#009900">Req0</font>, <font color="#009900">Acc</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">cowboy_req:read_part</font></b>(<font color="#009900">Req0</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">ok</font>, <font color="#009900">Headers</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> + <b><font color="#000000">skip_body_multipart</font></b>(<font color="#009900">Req</font>, [<font color="#009900">Headers</font>|<font color="#009900">Acc</font>]); + {<font color="#FF6600">done</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> + {<b><font color="#000000">lists:reverse</font></b>(<font color="#009900">Acc</font>), <font color="#009900">Req</font>} + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Read a part header in larger chunks</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">Headers</font>, <font color="#009900">Req</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:read_part</font></b>(<font color="#009900">Req0</font>, #{<b><font color="#000080">length</font></b> <font color="#990000">=></font> <font color="#993399">1000000</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.has_body">cowboy_req:has_body(3)</a>, <a href="../cowboy_req.body_length">cowboy_req:body_length(3)</a>, <a href="../cowboy_req.read_body">cowboy_req:read_body(3)</a>, <a href="../cowboy_req.read_urlencoded_body">cowboy_req:read_urlencoded_body(3)</a>, <a href="../cowboy_req.read_and_match_urlencoded_body">cowboy_req:read_and_match_urlencoded_body(3)</a>, <a href="../cowboy_req.read_part_body">cowboy_req:read_part_body(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.read_part_body/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.read_part_body/index.html new file mode 100644 index 00000000..32dd33d5 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.read_part_body/index.html @@ -0,0 +1,210 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:read_part_body(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:read_part_body(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:read_part_body - Read the current part's body</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">read_part_body</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <b><font color="#000000">read_part_body</font></b>(<font color="#009900">Req</font>, #{}) + +<b><font color="#000000">read_part_body</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>(), <font color="#009900">Opts</font>) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Data</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">Req</font>} + | {<font color="#FF6600">more</font>, <font color="#009900">Data</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">Req</font>} + +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:read_body_opts</font></b>()</tt></pre> +</div></div> +<p>Read the body of the current part of the multipart message.</p> +<p>This function reads the request body and parses it as multipart. Each parts of a multipart representation have their own headers and body. This function returns the body of the current part. Examples of multipart media types are <code>multipart/form-data</code> and <code>multipart/byteranges</code>.</p> +<p>This function reads a chunk of the part's body. A <code>more</code> tuple is returned when more data remains to be read. Call the function repeatedly until an <code>ok</code> tuple is returned to read the entire body.</p> +<p>Once a part has been read, it can not be read again.</p> +<p>Once the body has been read, Cowboy sets the content-length header if it was not previously provided.</p> +<!-- @todo Limit the maximum size of multipart headers.--> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +<dt>Opts</dt> +<dd><p>A map of body reading options. Please refer to <a href="../cowboy_req.read_body">cowboy_req:read_body(3)</a> for details about each option.</p> +<p>This function uses the same default options as the <a href="../cowboy_req.read_body">cowboy_req:read_body(3)</a> function.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A <code>more</code> tuple is returned when there are more data to be read.</p> +<p>An <code>ok</code> tuple is returned when there are no more data to be read.</p> +<p>The data is always returned as a binary.</p> +<p>The Req object returned in the tuple must be used from that point onward. It contains a more up to date representation of the request. For example it may have an added content-length header once the body has been read.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. Replaces <code>part_body/1,2</code>. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Read a full part's body</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">stream_body</font></b>(<font color="#009900">Req0</font>, <font color="#009900">Acc</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">cowboy_req:read_part_body</font></b>(<font color="#009900">Req0</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">more</font>, <font color="#009900">Data</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> + <b><font color="#000000">stream_body</font></b>(<font color="#009900">Req</font>, <font color="#990000"><<</font> <font color="#009900">Acc</font><font color="#990000">/</font><b><font color="#000080">binary</font></b>, <font color="#009900">Data</font><font color="#990000">/</font><b><font color="#000080">binary</font></b> <font color="#990000">>></font>); + {<font color="#FF6600">ok</font>, <font color="#009900">Data</font>, <font color="#009900">Req</font>} <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#990000"><<</font> <font color="#009900">Acc</font><font color="#990000">/</font><b><font color="#000080">binary</font></b>, <font color="#009900">Data</font><font color="#990000">/</font><b><font color="#000080">binary</font></b> <font color="#990000">>></font>, <font color="#009900">Req</font>} + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Ensure a part's body is smaller than 64KB</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">Body</font>, <font color="#009900">Req</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:read_part_body</font></b>(<font color="#009900">Req0</font>, #{<b><font color="#000080">length</font></b> <font color="#990000">=></font> <font color="#993399">64000</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.has_body">cowboy_req:has_body(3)</a>, <a href="../cowboy_req.body_length">cowboy_req:body_length(3)</a>, <a href="../cowboy_req.read_body">cowboy_req:read_body(3)</a>, <a href="../cowboy_req.read_urlencoded_body">cowboy_req:read_urlencoded_body(3)</a>, <a href="../cowboy_req.read_and_match_urlencoded_body">cowboy_req:read_and_match_urlencoded_body(3)</a>, <a href="../cowboy_req.read_part">cowboy_req:read_part(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.read_urlencoded_body/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.read_urlencoded_body/index.html new file mode 100644 index 00000000..043b3ef0 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.read_urlencoded_body/index.html @@ -0,0 +1,204 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:read_urlencoded_body(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:read_urlencoded_body(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:read_urlencoded_body - Read and parse a urlencoded request body</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">read_urlencoded_body</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <b><font color="#000000">read_urlencoded_body</font></b>(<font color="#009900">Req</font>, #{}) + +<b><font color="#000000">read_urlencoded_body</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>(), <font color="#009900">Opts</font>) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Body</font>, <font color="#009900">Req</font>} + +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:read_body_opts</font></b>() +<font color="#009900">Body</font> <font color="#990000">::</font> [{<font color="#009900">Key</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() | <font color="#000080">true</font>}]</tt></pre> +</div></div> +<p>Read and parse a urlencoded request body.</p> +<p>This function reads the request body and parses it as <code>application/x-www-form-urlencoded</code>. It returns a list of key/values.</p> +<p>The urlencoded media type is used by Web browsers when submitting HTML forms using the POST method.</p> +<p>Cowboy needs to read the full body before parsing. By default it will read bodies of size up to 64KB. It is possible to provide options to read larger bodies if required.</p> +<p>Cowboy will automatically handle protocol details including the expect header, chunked transfer-encoding and others.</p> +<p>Once the body has been read, Cowboy sets the content-length header if it was not previously provided.</p> +<p>This function can only be called once. Calling it again will result in undefined behavior.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +<dt>Opts</dt> +<dd><p>A map of body reading options. Please refer to <a href="../cowboy_req.read_body">cowboy_req:read_body(3)</a> for details about each option.</p> +<p>This function defaults the <code>length</code> to 64KB and the <code>period</code> to 5 seconds.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>An <code>ok</code> tuple is returned containing a list of key/values found in the body.</p> +<p>The Req object returned in the tuple must be used from that point onward. It contains a more up to date representation of the request. For example it may have an added content-length header once the body has been read.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. Replaces <code>body_qs/1,2</code>. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Read a urlencoded body</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">Body</font>, <font color="#009900">Req</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:read_urlencoded_body</font></b>(<font color="#009900">Req0</font>), +{<font color="#990000">_</font>, <font color="#009900">Lang</font>} <font color="#990000">=</font> <b><font color="#000000">lists:keyfind</font></b>(<font color="#990000"><<</font><font color="#FF0000">"lang"</font><font color="#990000">>></font>, <font color="#993399">1</font>, <font color="#009900">Body</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Allow large urlencoded bodies</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">Body</font>, <font color="#009900">Req</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:read_urlencoded_body</font></b>(<font color="#009900">Req0</font>, #{<b><font color="#000080">length</font></b> <font color="#990000">=></font> <font color="#993399">1000000</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.has_body">cowboy_req:has_body(3)</a>, <a href="../cowboy_req.body_length">cowboy_req:body_length(3)</a>, <a href="../cowboy_req.read_body">cowboy_req:read_body(3)</a>, <a href="../cowboy_req.read_and_match_urlencoded_body">cowboy_req:read_and_match_urlencoded_body(3)</a>, <a href="../cowboy_req.read_part">cowboy_req:read_part(3)</a>, <a href="../cowboy_req.read_part_body">cowboy_req:read_part_body(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.reply/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.reply/index.html new file mode 100644 index 00000000..4420b98e --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.reply/index.html @@ -0,0 +1,226 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:reply(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:reply(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:reply - Send the response</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">reply</font></b>(<font color="#009900">Status</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <b><font color="#000000">reply</font></b>(<font color="#009900">StatusCode</font>, #{}, <font color="#009900">Req</font>) + +<b><font color="#000000">reply</font></b>(<font color="#009900">Status</font>, <font color="#009900">Headers</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <font color="#009900">Req</font> + +<b><font color="#000000">reply</font></b>(<font color="#009900">Status</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <font color="#009900">Req</font> + +<font color="#009900">Status</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:http_status</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:http_headers</font></b>() +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:resp_body</font></b>()</tt></pre> +</div></div> +<p>Send the response.</p> +<p>The header names must be given as lowercase binary strings. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</p> +<p>Cowboy does not allow duplicate header names. Headers set by this function may overwrite those set by <code>set_resp_header/3</code> and <code>set_resp_headers/2</code>.</p> +<p>Use <a href="../cowboy_req.set_resp_cookie">cowboy_req:set_resp_cookie(3)</a> instead of this function to set cookies.</p> +<p>The <code>reply/2,3</code> functions will send the body set previously, if any. The <code>reply/4</code> function always sends the given body, overriding any previously set.</p> +<p>You do not need to set the content-length header when sending a response body. Cowboy takes care of it automatically. You should however provide a content-type header.</p> +<p>No further data can be transmitted after this function returns. This includes the push mechanism. Attempting to send two replies, or to push resources after a reply has been sent, will result in an error.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Status</dt> +<dd><p>The status code for the response.</p> +</dd> +<dt>Headers</dt> +<dd><p>The response headers.</p> +<p>Header names must be given as lowercase binary strings.</p> +</dd> +<dt>Body</dt> +<dd><p>The body can be either a binary value, an iolist or a <code>sendfile</code> tuple telling Cowboy to send the contents of a file.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A new Req object is returned.</p> +<p>The returned Req object should be used from that point onward as it contains updated information about the state of the request.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the Req is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Reply</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">404</font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Reply with custom headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">401</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"www-authenticate"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"Basic realm=\"erlang.org\""</font><font color="#990000">>></font> +}, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Reply with custom headers and a body</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font> +}, <font color="#FF0000">"Hello world!"</font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.set_resp_cookie">cowboy_req:set_resp_cookie(3)</a>, <a href="../cowboy_req.set_resp_header">cowboy_req:set_resp_header(3)</a>, <a href="../cowboy_req.set_resp_headers">cowboy_req:set_resp_headers(3)</a>, <a href="../cowboy_req.set_resp_body">cowboy_req:set_resp_body(3)</a>, <a href="../cowboy_req.inform">cowboy_req:inform(3)</a>, <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a>, <a href="../cowboy_req.push">cowboy_req:push(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.resp_header/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.resp_header/index.html new file mode 100644 index 00000000..e23ba45b --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.resp_header/index.html @@ -0,0 +1,198 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:resp_header(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:resp_header(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:resp_header - Response header</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">resp_header</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font>) <font color="#990000">-></font> <b><font color="#000000">resp_header</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font>, <font color="#000080">undefined</font>) +<b><font color="#000000">resp_header</font></b>(<font color="#009900">Name</font>, <font color="#009900">Req</font>, <font color="#009900">Default</font>) <font color="#990000">-></font> <b><font color="#000080">binary</font></b>() | <font color="#009900">Default</font> + +<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% lowercase; case insensitive</font></i> +<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Return the value for the given response header.</p> +<p>The response header must have been set previously using <a href="../cowboy_req.set_resp_header">cowboy_req:set_resp_header(3)</a> or <a href="../cowboy_req.set_resp_headers">cowboy_req:set_resp_headers(3)</a>.</p> +<p>The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Name</dt> +<dd><p>Desired response header name as a lowercase binary string.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +<dt>Default</dt> +<dd><p>Default value returned when the header is missing.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The header value is returned as a binary string. When the header is missing, the default argument is returned.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the content-type response header</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Type</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:resp_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Get the content-type response header with a default value</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Type</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:resp_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#009900">Req</font>, <font color="#990000"><<</font><font color="#FF0000">"text/html"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.resp_headers">cowboy_req:resp_headers(3)</a>, <a href="../cowboy_req.set_resp_header">cowboy_req:set_resp_header(3)</a>, <a href="../cowboy_req.set_resp_headers">cowboy_req:set_resp_headers(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.resp_headers/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.resp_headers/index.html new file mode 100644 index 00000000..66205593 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.resp_headers/index.html @@ -0,0 +1,178 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:resp_headers(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:resp_headers(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:resp_headers - Response headers</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">resp_headers</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <b><font color="#000000">cowboy:http_headers</font></b>()</tt></pre> +</div></div> +<p>Return all response headers.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>Headers are returned as a map with keys being lowercase binary strings, and values as binary strings.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get all response headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Headers</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:resp_headers</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.resp_header">cowboy_req:resp_header(3)</a>, <a href="../cowboy_req.set_resp_header">cowboy_req:set_resp_header(3)</a>, <a href="../cowboy_req.set_resp_headers">cowboy_req:set_resp_headers(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.scheme/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.scheme/index.html new file mode 100644 index 00000000..2ed979b8 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.scheme/index.html @@ -0,0 +1,192 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:scheme(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:scheme(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:scheme - URI scheme</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">scheme</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <font color="#009900">Scheme</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()</tt></pre> +</div></div> +<p>Return the scheme of the effective request URI.</p> +<p>The scheme can also be obtained using pattern matching:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">scheme</font> <font color="#990000">:=</font> <font color="#009900">Scheme</font>} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The scheme is returned as a binary. It is case insensitive.</p> +<p>Cowboy will only set the scheme to <code><<"http">></code> or <code><<"https">></code>.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Redirect HTTP to HTTPS</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req0</font><font color="#990000">=</font>#{<font color="#FF6600">scheme</font> <font color="#990000">:=</font> <font color="#990000"><<</font><font color="#FF0000">"http"</font><font color="#990000">>></font>}, <font color="#009900">State</font>) <font color="#990000">-></font> + <font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">302</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"location"</font><font color="#990000">>></font> <font color="#990000">=></font> <b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>, #{<font color="#0000FF">scheme</font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"https"</font><font color="#990000">>></font>}) + }, <font color="#009900">Req0</font>), + {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}; +<b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + {<font color="#FF6600">cowboy_rest</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_body/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_body/index.html new file mode 100644 index 00000000..ac6a4165 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_body/index.html @@ -0,0 +1,219 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:set_resp_body(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:set_resp_body(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:set_resp_body - Set the response body</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">set_resp_body</font></b>(<font color="#009900">Body</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <font color="#009900">Req</font> + +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:resp_body</font></b>()</tt></pre> +</div></div> +<p>Set the response body.</p> +<p>The response body will be sent when a reply is initiated. Note that the functions <code>stream_reply/2,3</code> and <code>reply/4</code> will override the body set by this function.</p> +<p>This function can also be used to remove a response body that was set previously. To do so, simply call this function with an empty body.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Body</dt> +<dd><p>The body can be either a binary value, an iolist or a <code>sendfile</code> tuple telling Cowboy to send the contents of a file.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A new Req object is returned.</p> +<p>The returned Req object must be used from that point onward, otherwise the body will not be sent in the response.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The function now accepts a <code>sendfile</code> tuple. +</li> +<li><strong>2.0</strong>: The <code>set_resp_body_fun/2,3</code> functions were removed. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Set the response body</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_body</font></b>(<font color="#990000"><<</font><font color="#FF0000">"Hello world!"</font><font color="#990000">>></font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Set the response body as an iolist</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_body</font></b>([ + <font color="#FF0000">"<html><head><title>"</font>, + <b><font color="#000000">page_title</font></b>(), + <font color="#FF0000">"</title></head><body>"</font>, + <b><font color="#000000">page_body</font></b>(), + <font color="#FF0000">"</body></html>"</font> +], <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Tell Cowboy to send data from a file</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#008080">#file_info</font>{<b><font color="#000080">size</font></b><font color="#990000">=</font><font color="#009900">Size</font>}} <font color="#990000">=</font> <b><font color="#000000">file:read_file_info</font></b>(<font color="#009900">Filename</font>), +<font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_body</font></b>({<font color="#FF6600">sendfile</font>, <font color="#993399">0</font>, <font color="#009900">Size</font>, <font color="#009900">Filename</font>}, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Clear any previously set response body</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_body</font></b>(<font color="#990000"><<>></font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.set_resp_header">cowboy_req:set_resp_header(3)</a>, <a href="../cowboy_req.set_resp_headers">cowboy_req:set_resp_headers(3)</a>, <a href="../cowboy_req.reply">cowboy_req:reply(3)</a>, <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_cookie/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_cookie/index.html new file mode 100644 index 00000000..d7bf79db --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_cookie/index.html @@ -0,0 +1,244 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:set_resp_cookie(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:set_resp_cookie(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:set_resp_cookie - Set a cookie</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">set_resp_cookie</font></b>(<font color="#009900">Name</font>, <font color="#009900">Value</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <b><font color="#000000">set_resp_cookie</font></b>(<font color="#009900">Name</font>, <font color="#009900">Value</font>, [], <font color="#009900">Req</font>) + +<b><font color="#000000">set_resp_cookie</font></b>(<font color="#009900">Name</font>, <font color="#009900">Value</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>(), <font color="#009900">Opts</font>) + <font color="#990000">-></font> <font color="#009900">Req</font> + +<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case sensitive</font></i> +<font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() <i><font color="#9A1900">%% case sensitive</font></i> +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">cow_cookie:cookie_opts</font></b>()</tt></pre> +</div></div> +<p>Set a cookie to be sent with the response.</p> +<p>Note that cookie names are case sensitive.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Name</dt> +<dd><p>Cookie name.</p> +</dd> +<dt>Value</dt> +<dd><p>Cookie value.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +<dt>Opts</dt> +<dd><p>Cookie options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A new Req object is returned.</p> +<p>The returned Req object must be used from that point onward, otherwise the cookie will not be sent in the response.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: <code>set_resp_cookie/3</code> introduced as an alias to <code>set_resp_cookie/4</code> with no options. +</li> +<li><strong>2.0</strong>: The first argument type is now <code>binary()</code> instead of <code>iodata()</code>. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Set a session cookie</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">SessionID</font> <font color="#990000">=</font> <b><font color="#000000">base64:encode</font></b>(<b><font color="#000000">crypto:strong_rand_bytes</font></b>(<font color="#993399">32</font>)), +<font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_cookie</font></b>(<font color="#990000"><<</font><font color="#FF0000">"sessionid"</font><font color="#990000">>></font>, <font color="#009900">SessionID</font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Set a cookie with an expiration time</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_cookie</font></b>(<font color="#990000"><<</font><font color="#FF0000">"lang"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"fr-FR"</font><font color="#990000">>></font>, + <font color="#009900">Req0</font>, #{<font color="#0000FF">max_age</font> <font color="#990000">=></font> <font color="#993399">3600</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Delete a cookie</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_cookie</font></b>(<font color="#990000"><<</font><font color="#FF0000">"sessionid"</font><font color="#990000">>></font>, <font color="#990000"><<>></font>, + <font color="#009900">Req0</font>, #{<font color="#0000FF">max_age</font> <font color="#990000">=></font> <font color="#993399">0</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Set a cookie for a specific domain and path</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_cookie</font></b>(<font color="#990000"><<</font><font color="#FF0000">"inaccount"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"1"</font><font color="#990000">>></font>, + <font color="#009900">Req0</font>, #{<font color="#0000FF">domain</font> <font color="#990000">=></font> <font color="#FF0000">"my.example.org"</font>, <font color="#0000FF">path</font> <font color="#990000">=></font> <font color="#FF0000">"/account"</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Restrict a cookie to HTTPS</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">SessionID</font> <font color="#990000">=</font> <b><font color="#000000">base64:encode</font></b>(<b><font color="#000000">crypto:strong_rand_bytes</font></b>(<font color="#993399">32</font>)), +<font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_cookie</font></b>(<font color="#990000"><<</font><font color="#FF0000">"sessionid"</font><font color="#990000">>></font>, <font color="#009900">SessionID</font>, + <font color="#009900">Req0</font>, #{<font color="#0000FF">secure</font> <font color="#990000">=></font> <font color="#000080">true</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Restrict a cookie to HTTP</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">SessionID</font> <font color="#990000">=</font> <b><font color="#000000">base64:encode</font></b>(<b><font color="#000000">crypto:strong_rand_bytes</font></b>(<font color="#993399">32</font>)), +<font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_cookie</font></b>(<font color="#990000"><<</font><font color="#FF0000">"sessionid"</font><font color="#990000">>></font>, <font color="#009900">SessionID</font>, + <font color="#009900">Req0</font>, #{<font color="#0000FF">http_only</font> <font color="#990000">=></font> <font color="#000080">true</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.set_resp_header">cowboy_req:set_resp_header(3)</a>, <a href="../cowboy_req.set_resp_headers">cowboy_req:set_resp_headers(3)</a>, <a href="../cowboy_req.reply">cowboy_req:reply(3)</a>, <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_header/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_header/index.html new file mode 100644 index 00000000..c62175b7 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_header/index.html @@ -0,0 +1,200 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:set_resp_header(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:set_resp_header(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:set_resp_header - Set a response header</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">set_resp_header</font></b>(<font color="#009900">Name</font>, <font color="#009900">Value</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <font color="#009900">Req</font> + +<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% lowercase; case insensitive</font></i> +<font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() <i><font color="#9A1900">%% case depends on header</font></i></tt></pre> +</div></div> +<p>Set a header to be sent with the response.</p> +<p>The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</p> +<p>Cowboy does not allow duplicate header names. Headers set by this function may be overwritten by those set from the reply functions.</p> +<p>Use <a href="../cowboy_req.set_resp_cookie">cowboy_req:set_resp_cookie(3)</a> instead of this function to set cookies.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Name</dt> +<dd><p>Header name as a lowercase binary string.</p> +</dd> +<dt>Value</dt> +<dd><p>Header value.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A new Req object is returned.</p> +<p>The returned Req object must be used from that point onward, otherwise the header will not be sent in the response.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Set a header in the response</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"allow"</font><font color="#990000">>></font>, <font color="#FF0000">"GET"</font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Construct a header using iolists</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"allow"</font><font color="#990000">>></font>, + [<b><font color="#000000">allowed_methods</font></b>(), <font color="#FF0000">", OPTIONS"</font>], <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.set_resp_cookie">cowboy_req:set_resp_cookie(3)</a>, <a href="../cowboy_req.set_resp_headers">cowboy_req:set_resp_headers(3)</a>, <a href="../cowboy_req.has_resp_header">cowboy_req:has_resp_header(3)</a>, <a href="../cowboy_req.resp_header">cowboy_req:resp_header(3)</a>, <a href="../cowboy_req.resp_headers">cowboy_req:resp_headers(3)</a>, <a href="../cowboy_req.delete_resp_header">cowboy_req:delete_resp_header(3)</a>, <a href="../cowboy_req.reply">cowboy_req:reply(3)</a>, <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_headers/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_headers/index.html new file mode 100644 index 00000000..b5410da7 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_headers/index.html @@ -0,0 +1,191 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:set_resp_headers(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:set_resp_headers(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:set_resp_headers - Set several response headers</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">set_resp_headers</font></b>(<font color="#009900">Headers</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <font color="#009900">Req</font> + +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:http_headers</font></b>()</tt></pre> +</div></div> +<p>Set several headers to be sent with the response.</p> +<p>The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</p> +<p>Cowboy does not allow duplicate header names. Headers set by this function may be overwritten by those set from the reply functions. Likewise, headers set by this function may overwrite headers that were set previously.</p> +<p>Use <a href="../cowboy_req.set_resp_cookie">cowboy_req:set_resp_cookie(3)</a> instead of this function to set cookies.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Headers</dt> +<dd><p>Headers as a map with keys being lowercase binary strings, and values as binary strings.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A new Req object is returned.</p> +<p>The returned Req object must be used from that point onward, otherwise the headers will not be sent in the response.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Set several response headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_headers</font></b>(#{ + <font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/html"</font><font color="#990000">>></font>, + <font color="#990000"><<</font><font color="#FF0000">"content-encoding"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"gzip"</font><font color="#990000">>></font> +}, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.set_resp_cookie">cowboy_req:set_resp_cookie(3)</a>, <a href="../cowboy_req.set_resp_header">cowboy_req:set_resp_header(3)</a>, <a href="../cowboy_req.has_resp_header">cowboy_req:has_resp_header(3)</a>, <a href="../cowboy_req.resp_header">cowboy_req:resp_header(3)</a>, <a href="../cowboy_req.resp_headers">cowboy_req:resp_headers(3)</a>, <a href="../cowboy_req.delete_resp_header">cowboy_req:delete_resp_header(3)</a>, <a href="../cowboy_req.reply">cowboy_req:reply(3)</a>, <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.sock/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.sock/index.html new file mode 100644 index 00000000..f1957abc --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.sock/index.html @@ -0,0 +1,187 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:sock(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:sock(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:sock - Socket address and port</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">sock</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <font color="#009900">Info</font> + +<font color="#009900">Info</font> <font color="#990000">::</font> {<b><font color="#000000">inet:ip_address</font></b>(), <b><font color="#000000">inet:port_number</font></b>()}</tt></pre> +</div></div> +<p>Return the socket's IP address and port number.</p> +<p>The socket information can also be obtained using pattern matching:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">sock</font> <font color="#990000">:=</font> {<font color="#009900">IP</font>, <font color="#009900">Port</font>}} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The socket's local IP address and port number.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.1</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the socket's IP address and port number.</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#009900">IP</font>, <font color="#009900">Port</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_req:sock</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.peer">cowboy_req:peer(3)</a>, <a href="../cowboy_req.cert">cowboy_req:cert(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.stream_body/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.stream_body/index.html new file mode 100644 index 00000000..f439547c --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.stream_body/index.html @@ -0,0 +1,198 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:stream_body(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:stream_body(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:stream_body - Stream the response body</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">stream_body</font></b>(<font color="#009900">Data</font>, <font color="#009900">IsFin</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">Data</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:resp_body</font></b>() +<font color="#009900">IsFin</font> <font color="#990000">::</font> <font color="#FF6600">fin</font> | <font color="#FF6600">nofin</font></tt></pre> +</div></div> +<p>Stream the response body.</p> +<p>This function may be called as many times as needed after initiating a response using the <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a> function.</p> +<p>The second argument indicates if this call is the final call. Use the <code>nofin</code> value until you know no more data will be sent. The final call should use <code>fin</code> (possibly with an empty data value) or be a call to the <a href="../cowboy_req.stream_trailers">cowboy_req:stream_trailers(3)</a> function.</p> +<p>Note that not using <code>fin</code> for the final call is not an error; Cowboy will take care of it when the request handler terminates if needed. Depending on the resource it may however be more efficient to do it as early as possible.</p> +<p>You do not need to handle HEAD requests specifically as Cowboy will ensure no data is sent when you call this function.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Data</dt> +<dd><p>The data to be sent.</p> +</dd> +<dt>IsFin</dt> +<dd><p>A flag indicating whether this is the final piece of data to be sent.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is always returned. It can be safely ignored.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.6</strong>: The <code>Data</code> argument can now be a sendfile tuple. +</li> +<li><strong>2.0</strong>: Function introduced. Replaces <code>chunk/2</code>. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Stream the response body</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:stream_reply</font></b>(<font color="#993399">200</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font> +}, <font color="#009900">Req0</font>), +<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#990000"><<</font><font color="#FF0000">"Hello\n"</font><font color="#990000">>></font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>), +<b><font color="#000000">timer:sleep</font></b>(<font color="#993399">1000</font>), +<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#990000"><<</font><font color="#FF0000">"World!\n"</font><font color="#990000">>></font>, <font color="#FF6600">fin</font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a>, <a href="../cowboy_req.stream_events">cowboy_req:stream_events(3)</a>, <a href="../cowboy_req.stream_trailers">cowboy_req:stream_trailers(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.stream_events/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.stream_events/index.html new file mode 100644 index 00000000..5cb8a651 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.stream_events/index.html @@ -0,0 +1,212 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:stream_events(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:stream_events(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:stream_events - Stream events</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">stream_events</font></b>(<font color="#009900">Events</font>, <font color="#009900">IsFin</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">Events</font> <font color="#990000">::</font> <font color="#009900">Event</font> | [<font color="#009900">Event</font>] +<font color="#009900">IsFin</font> <font color="#990000">::</font> <font color="#FF6600">fin</font> | <font color="#FF6600">nofin</font> + +<font color="#009900">Event</font> <font color="#990000">::</font> #{ + <font color="#0000FF">comment</font> <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>(), + <font color="#0000FF">data</font> <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>(), + <font color="#0000FF">event</font> <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>() | <b><font color="#000080">atom</font></b>(), + <font color="#0000FF">id</font> <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>(), + <font color="#0000FF">retry</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>() +}</tt></pre> +</div></div> +<p>Stream events.</p> +<p>This function should only be used for <code>text/event-stream</code> responses when using server-sent events. Cowboy will automatically encode the given events to their text representation.</p> +<p>This function may be called as many times as needed after initiating a response using the <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a> function.</p> +<p>The second argument indicates if this call is the final call. Use the <code>nofin</code> value until you know no more data will be sent. The final call should use <code>fin</code> (possibly with an empty data value) or be a call to the <a href="../cowboy_req.stream_trailers">cowboy_req:stream_trailers(3)</a> function.</p> +<p>Note that not using <code>fin</code> for the final call is not an error; Cowboy will take care of it when the request handler terminates if needed. Depending on the resource it may however be more efficient to do it as early as possible.</p> +<p>You do not need to handle HEAD requests specifically as Cowboy will ensure no data is sent when you call this function.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Events</dt> +<dd><p>Events to be sent. All fields are optional.</p> +</dd> +<dt>IsFin</dt> +<dd><p>A flag indicating whether this is the final piece of data to be sent.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is always returned. It can be safely ignored.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.5</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Stream events</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:stream_reply</font></b>(<font color="#993399">200</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/event-stream"</font><font color="#990000">>></font> +}, <font color="#009900">Req0</font>), +<b><font color="#000000">cowboy_req:stream_events</font></b>(#{ + <font color="#0000FF">id</font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"comment-123"</font><font color="#990000">>></font>, + <font color="#0000FF">event</font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"add_comment"</font><font color="#990000">>></font>, + <font color="#0000FF">data</font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"Hello,\n\nI noticed something wrong in ..."</font><font color="#990000">>></font> +}, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>), +<b><font color="#000000">timer:sleep</font></b>(<font color="#993399">1000</font>), +<b><font color="#000000">cowboy_req:stream_events</font></b>(#{ + <font color="#0000FF">event</font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"debug"</font><font color="#990000">>></font>, + <font color="#0000FF">data</font> <font color="#990000">=></font> <b><font color="#000000">io_lib:format</font></b>(<font color="#FF0000">"An error occurred: ~p~n"</font>, [<font color="#009900">Error</font>]) +}, <font color="#FF6600">fin</font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a>, <a href="../cowboy_req.stream_body">cowboy_req:stream_body(3)</a>, <a href="../cowboy_req.stream_trailers">cowboy_req:stream_trailers(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.stream_reply/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.stream_reply/index.html new file mode 100644 index 00000000..27f85057 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.stream_reply/index.html @@ -0,0 +1,215 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:stream_reply(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:stream_reply(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:stream_reply - Send the response headers</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">stream_reply</font></b>(<font color="#009900">Status</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <b><font color="#000000">stream_reply</font></b>(<font color="#009900">StatusCode</font>, #{}, <font color="#009900">Req</font>) + +<b><font color="#000000">stream_reply</font></b>(<font color="#009900">Status</font>, <font color="#009900">Headers</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> <font color="#009900">Req</font> + +<font color="#009900">Status</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:http_status</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:http_headers</font></b>()</tt></pre> +</div></div> +<p>Send the response headers.</p> +<p>The header names must be given as lowercase binary strings. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</p> +<p>Cowboy does not allow duplicate header names. Headers set by this function may overwrite those set by <code>set_resp_header/3</code>.</p> +<p>Use <a href="../cowboy_req.set_resp_cookie">cowboy_req:set_resp_cookie(3)</a> instead of this function to set cookies.</p> +<p>If a response body was set before calling this function, it will not be sent.</p> +<p>Use <a href="../cowboy_req.stream_body">cowboy_req:stream_body(3)</a> to stream the response body and optionally <a href="../cowboy_req.stream_trailers">cowboy_req:stream_trailers(3)</a> to send response trailer field values.</p> +<p>You may want to set the content-length header when using this function, if it is known in advance. This will allow clients using HTTP/2 and HTTP/1.0 to process the response more efficiently.</p> +<p>The streaming method varies depending on the protocol being used. HTTP/2 will use the usual DATA frames. HTTP/1.1 will use chunked transfer-encoding, if the content-length response header is set the body will be sent without chunked chunked transfer-encoding. HTTP/1.0 will send the body unmodified and close the connection at the end if no content-length was set.</p> +<p>It is not possible to push resources after this function returns. Any attempt will result in an error.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Status</dt> +<dd><p>The status code for the response.</p> +</dd> +<dt>Headers</dt> +<dd><p>The response headers.</p> +<p>Header names must be given as lowercase binary strings.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A new Req object is returned.</p> +<p>The returned Req object must be used from that point onward in order to be able to stream the response body.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the Req is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>2.0</strong>: Function introduced. Replaces <code>chunked_reply/1,2</code>. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Initiate the response</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:stream_reply</font></b>(<font color="#993399">200</font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Stream the response with custom headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:stream_reply</font></b>(<font color="#993399">200</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font> +}, <font color="#009900">Req0</font>), +<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#990000"><<</font><font color="#FF0000">"Hello\n"</font><font color="#990000">>></font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>), +<b><font color="#000000">timer:sleep</font></b>(<font color="#993399">1000</font>), +<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#990000"><<</font><font color="#FF0000">"World!\n"</font><font color="#990000">>></font>, <font color="#FF6600">fin</font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.set_resp_cookie">cowboy_req:set_resp_cookie(3)</a>, <a href="../cowboy_req.set_resp_header">cowboy_req:set_resp_header(3)</a>, <a href="../cowboy_req.set_resp_headers">cowboy_req:set_resp_headers(3)</a>, <a href="../cowboy_req.inform">cowboy_req:inform(3)</a>, <a href="../cowboy_req.reply">cowboy_req:reply(3)</a>, <a href="../cowboy_req.stream_body">cowboy_req:stream_body(3)</a>, <a href="../cowboy_req.stream_events">cowboy_req:stream_events(3)</a>, <a href="../cowboy_req.stream_trailers">cowboy_req:stream_trailers(3)</a>, <a href="../cowboy_req.push">cowboy_req:push(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.stream_trailers/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.stream_trailers/index.html new file mode 100644 index 00000000..1e787f65 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.stream_trailers/index.html @@ -0,0 +1,195 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:stream_trailers(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:stream_trailers(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:stream_trailers - Send the response trailers</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">stream_trailers</font></b>(<font color="#009900">Trailers</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">Trailers</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:http_headers</font></b>()</tt></pre> +</div></div> +<p>Send the response trailers and terminate the stream.</p> +<p>This function can only be called once, after initiating a response using <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a> and sending zero or more body chunks using <a href="../cowboy_req.stream_body">cowboy_req:stream_body(3)</a> with the <code>nofin</code> argument set. The function <code>stream_trailers/2</code> implies <code>fin</code> and automatically terminate the response.</p> +<p>You must list all field names sent in trailers in the trailer header, otherwise they might be dropped by intermediaries or clients.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Trailers</dt> +<dd><p>Trailer field values to be sent.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is always returned. It can be safely ignored.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.2</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Stream a response body with trailers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:stream_reply</font></b>(<font color="#993399">200</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>, + <font color="#990000"><<</font><font color="#FF0000">"trailer"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"expires, content-md5"</font><font color="#990000">>></font> +}, <font color="#009900">Req0</font>), +<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#990000"><<</font><font color="#FF0000">"Hello\n"</font><font color="#990000">>></font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>), +<b><font color="#000000">timer:sleep</font></b>(<font color="#993399">1000</font>), +<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#990000"><<</font><font color="#FF0000">"World!\n"</font><font color="#990000">>></font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>)<font color="#990000">.</font> +<b><font color="#000000">cowboy_req:stream_trailers</font></b>(#{ + <font color="#990000"><<</font><font color="#FF0000">"expires"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"Sun, 10 Dec 2017 19:13:47 GMT"</font><font color="#990000">>></font>, + <font color="#990000"><<</font><font color="#FF0000">"content-md5"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"fbf68a8e34b2ded53bba54e68794b4fe"</font><font color="#990000">>></font> +}, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a>, <a href="../cowboy_req.stream_body">cowboy_req:stream_body(3)</a>, <a href="../cowboy_req.stream_events">cowboy_req:stream_events(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.uri/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.uri/index.html new file mode 100644 index 00000000..c30379a2 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.uri/index.html @@ -0,0 +1,246 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:uri(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:uri(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:uri - Reconstructed URI</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">uri</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <b><font color="#000000">uri</font></b>(<font color="#009900">Req</font>, #{}) +<b><font color="#000000">uri</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>(), <font color="#009900">Opts</font>) <font color="#990000">-></font> <font color="#009900">URI</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() + +<font color="#009900">Opts</font> <font color="#990000">::</font> #{ + <font color="#0000FF">scheme</font> <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>() | <font color="#000080">undefined</font>, + <font color="#0000FF">host</font> <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>() | <font color="#000080">undefined</font>, + <font color="#0000FF">port</font> <font color="#990000">=></font> <b><font color="#000000">inet:port_number</font></b>() | <font color="#000080">undefined</font>, + <font color="#0000FF">path</font> <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>() | <font color="#000080">undefined</font>, + <font color="#0000FF">qs</font> <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>() | <font color="#000080">undefined</font>, + <font color="#0000FF">fragment</font> <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>() | <font color="#000080">undefined</font> +}</tt></pre> +</div></div> +<p>Reconstruct the effective request URI, optionally modifying components.</p> +<p>By default Cowboy will build a URI using the components found in the request. Options allow disabling or replacing individual components.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +<dt>Opts</dt> +<dd><p>Map for overriding individual components.</p> +<p>To replace a component, provide its new value as a binary string or an iolist. To disable a component, set its value to <code>undefined</code>.</p> +<p>As this function always returns a valid URI, there are some things to note:</p> +<ul><li>Disabling the host also disables the scheme and port. +</li> +<li>There is no fragment component by default as these are not sent with the request. +</li> +<li>The port number may not appear in the resulting URI if it is the default port for the given scheme (http: 80; https: 443). +</li> +</ul> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The reconstructed URI is returned as an iolist or a binary string.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Individual components can be replaced or disabled. +</li> +<li><strong>2.0</strong>: Only the URI is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>2.0</strong>: Function introduced. Replaces <code>host_url/1</code> and <code>url/1</code>. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<p>With an effective request URI <a href="http://example.org/path/to/res?edit=1">http://example.org/path/to/res?edit=1</a> we can have:</p> +<div class="listingblock"><div class="title">Protocol relative form</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% //example.org/path/to/res?edit=1</font></i> +<b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>, #{<font color="#0000FF">scheme</font> <font color="#990000">=></font> <font color="#000080">undefined</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Serialized origin for use in the origin header</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% </font></i><u><font color="#0000FF">http://example.org</font></u> +<b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>, #{<font color="#0000FF">path</font> <font color="#990000">=></font> <font color="#000080">undefined</font>, <font color="#0000FF">qs</font> <font color="#990000">=></font> <font color="#000080">undefined</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">HTTP/1.1 origin form (path and query string only)</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% /path/to/res?edit=1</font></i> +<b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>, #{<font color="#0000FF">host</font> <font color="#990000">=></font> <font color="#000080">undefined</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Add a fragment to the URI</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% </font></i><u><font color="#0000FF">http://example.org/path/to/res</font></u><i><font color="#9A1900">?edit=1#errors</font></i> +<b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>, #{<font color="#0000FF">fragment</font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"errors"</font><font color="#990000">>></font>})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Ensure the scheme is HTTPS</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><i><font color="#9A1900">%% </font></i><u><font color="#0000FF">https://example.org/path/to/res</font></u><i><font color="#9A1900">?edit=1</font></i> +<b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>, #{<font color="#0000FF">scheme</font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"https"</font><font color="#990000">>></font>})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Convert the URI to a binary string</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">iolist_to_binary</font></b>(<b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>))<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.scheme">cowboy_req:scheme(3)</a>, <a href="../cowboy_req.host">cowboy_req:host(3)</a>, <a href="../cowboy_req.port">cowboy_req:port(3)</a>, <a href="../cowboy_req.path">cowboy_req:path(3)</a>, <a href="../cowboy_req.qs">cowboy_req:qs(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req.version/index.html b/docs/en/cowboy/2.6/manual/cowboy_req.version/index.html new file mode 100644 index 00000000..64ffe6fc --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req.version/index.html @@ -0,0 +1,187 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:version(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:version(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:version - HTTP version</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">version</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <font color="#009900">Version</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:http_version</font></b>()</tt></pre> +</div></div> +<p>Return the HTTP version used for the request.</p> +<p>The version can also be obtained using pattern matching:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>#{<font color="#FF6600">version</font> <font color="#990000">:=</font> <font color="#009900">Version</font>} <font color="#990000">=</font> <font color="#009900">Req</font><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The HTTP version used for the request is returned as an atom. It is provided for informative purposes only.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Only the version is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the HTTP version</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Version</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:version</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_req/index.html b/docs/en/cowboy/2.6/manual/cowboy_req/index.html new file mode 100644 index 00000000..8b41b6e2 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_req/index.html @@ -0,0 +1,362 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req - HTTP request and response</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy_req</code> provides functions to access, manipulate and respond to requests.</p> +<p>There are four types of functions in this module. They can be differentiated by their name and their return type:</p> +<table rules="all" width="100%" frame="border" + cellspacing="0" cellpadding="4"> +<thead><tr><th>Type</th> +<th>Name pattern</th> +<th>Return type</th> +</tr></thead><tbody><tr><td>access</td> +<td>no verb, parse_*, match_*</td> +<td><code>Value</code></td> +</tr> +<tr><td>question</td> +<td>has_*</td> +<td><code>boolean()</code></td> +</tr> +<tr><td>modification</td> +<td>set_*</td> +<td><code>Req</code></td> +</tr> +<tr><td>action</td> +<td>any other verb</td> +<td><code>ok | {Result, Value, Req}</code></td> +</tr> +</tbody></table> +<p>Any <code>Req</code> returned must be used in place of the one passed as argument. Functions that perform an action in particular write state in the Req object to make sure you are using the function correctly. For example, it's only possible to send one response, and to read the body once.</p> +<h2 id="_exports">Exports</h2> +<p>Connection:</p> +<ul><li><a href="../cowboy_req.peer">cowboy_req:peer(3)</a> - Peer address and port +</li> +<li><a href="../cowboy_req.sock">cowboy_req:sock(3)</a> - Socket address and port +</li> +<li><a href="../cowboy_req.cert">cowboy_req:cert(3)</a> - Client TLS certificate +</li> +</ul> +<p>Raw request:</p> +<ul><li><a href="../cowboy_req.method">cowboy_req:method(3)</a> - HTTP method +</li> +<li><a href="../cowboy_req.version">cowboy_req:version(3)</a> - HTTP version +</li> +<li><a href="../cowboy_req.scheme">cowboy_req:scheme(3)</a> - URI scheme +</li> +<li><a href="../cowboy_req.host">cowboy_req:host(3)</a> - URI host name +</li> +<li><a href="../cowboy_req.port">cowboy_req:port(3)</a> - URI port number +</li> +<li><a href="../cowboy_req.path">cowboy_req:path(3)</a> - URI path +</li> +<li><a href="../cowboy_req.qs">cowboy_req:qs(3)</a> - URI query string +</li> +<li><a href="../cowboy_req.uri">cowboy_req:uri(3)</a> - Reconstructed URI +</li> +<li><a href="../cowboy_req.header">cowboy_req:header(3)</a> - HTTP header +</li> +<li><a href="../cowboy_req.headers">cowboy_req:headers(3)</a> - HTTP headers +</li> +</ul> +<p>Processed request:</p> +<ul><li><a href="../cowboy_req.parse_qs">cowboy_req:parse_qs(3)</a> - Parse the query string +</li> +<li><a href="../cowboy_req.match_qs">cowboy_req:match_qs(3)</a> - Match the query string against constraints +</li> +<li><a href="../cowboy_req.parse_header">cowboy_req:parse_header(3)</a> - Parse the given HTTP header +</li> +<li><a href="../cowboy_req.parse_cookies">cowboy_req:parse_cookies(3)</a> - Parse cookie headers +</li> +<li><a href="../cowboy_req.match_cookies">cowboy_req:match_cookies(3)</a> - Match cookies against constraints +</li> +<li><a href="../cowboy_req.binding">cowboy_req:binding(3)</a> - Access a value bound from the route +</li> +<li><a href="../cowboy_req.bindings">cowboy_req:bindings(3)</a> - Access all values bound from the route +</li> +<li><a href="../cowboy_req.host_info">cowboy_req:host_info(3)</a> - Access the route's heading host segments +</li> +<li><a href="../cowboy_req.path_info">cowboy_req:path_info(3)</a> - Access the route's trailing path segments +</li> +</ul> +<p>Request body:</p> +<ul><li><a href="../cowboy_req.has_body">cowboy_req:has_body(3)</a> - Is there a request body? +</li> +<li><a href="../cowboy_req.body_length">cowboy_req:body_length(3)</a> - Body length +</li> +<li><a href="../cowboy_req.read_body">cowboy_req:read_body(3)</a> - Read the request body +</li> +<li><a href="../cowboy_req.read_urlencoded_body">cowboy_req:read_urlencoded_body(3)</a> - Read and parse a urlencoded request body +</li> +<li><a href="../cowboy_req.read_and_match_urlencoded_body">cowboy_req:read_and_match_urlencoded_body(3)</a> - Read, parse and match a urlencoded request body against constraints +</li> +<li><a href="../cowboy_req.read_part">cowboy_req:read_part(3)</a> - Read the next multipart headers +</li> +<li><a href="../cowboy_req.read_part_body">cowboy_req:read_part_body(3)</a> - Read the current part's body +</li> +</ul> +<p>Response:</p> +<ul><li><a href="../cowboy_req.set_resp_cookie">cowboy_req:set_resp_cookie(3)</a> - Set a cookie +</li> +<li><a href="../cowboy_req.set_resp_header">cowboy_req:set_resp_header(3)</a> - Set a response header +</li> +<li><a href="../cowboy_req.set_resp_headers">cowboy_req:set_resp_headers(3)</a> - Set several response headers +</li> +<li><a href="../cowboy_req.has_resp_header">cowboy_req:has_resp_header(3)</a> - Is the given response header set? +</li> +<li><a href="../cowboy_req.resp_header">cowboy_req:resp_header(3)</a> - Response header +</li> +<li><a href="../cowboy_req.resp_headers">cowboy_req:resp_headers(3)</a> - Response headers +</li> +<li><a href="../cowboy_req.delete_resp_header">cowboy_req:delete_resp_header(3)</a> - Delete a response header +</li> +<li><a href="../cowboy_req.set_resp_body">cowboy_req:set_resp_body(3)</a> - Set the response body +</li> +<li><a href="../cowboy_req.has_resp_body">cowboy_req:has_resp_body(3)</a> - Is there a response body? +</li> +<li><a href="../cowboy_req.inform">cowboy_req:inform(3)</a> - Send an informational response +</li> +<li><a href="../cowboy_req.reply">cowboy_req:reply(3)</a> - Send the response +</li> +<li><a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a> - Send the response headers +</li> +<li><a href="../cowboy_req.stream_body">cowboy_req:stream_body(3)</a> - Stream the response body +</li> +<li><a href="../cowboy_req.stream_events">cowboy_req:stream_events(3)</a> - Stream events +</li> +<li><a href="../cowboy_req.stream_trailers">cowboy_req:stream_trailers(3)</a> - Send the response trailers +</li> +<li><a href="../cowboy_req.push">cowboy_req:push(3)</a> - Push a resource to the client +</li> +</ul> +<h2 id="_types">Types</h2> +<h3 id="_push_opts">push_opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">push_opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">method</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% case sensitive</font></i> + <font color="#0000FF">scheme</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% lowercase; case insensitive</font></i> + <font color="#0000FF">host</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% lowercase; case insensitive</font></i> + <font color="#0000FF">port</font> <font color="#990000">=></font> <b><font color="#000000">inet:port_number</font></b>(), + <font color="#0000FF">qs</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case sensitive</font></i> +}</tt></pre> +</div></div> +<p>Push options.</p> +<p>By default, Cowboy will use the GET method, an empty query string, and take the scheme, host and port directly from the current request's URI.</p> +<h3 id="_read_body_opts">read_body_opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">read_body_opts</font></b>() <font color="#990000">::</font> #{ + <b><font color="#000080">length</font></b> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">period</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>() +}</tt></pre> +</div></div> +<p>Body reading options.</p> +<p>The defaults are function-specific.</p> +<h3 id="_req">req()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">req</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">method</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% case sensitive</font></i> + <font color="#FF6600">version</font> <font color="#990000">:=</font> <b><font color="#000000">cowboy:http_version</font></b>() | <b><font color="#000080">atom</font></b>(), + <font color="#FF6600">scheme</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% lowercase; case insensitive</font></i> + <font color="#FF6600">host</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% lowercase; case insensitive</font></i> + <font color="#FF6600">port</font> <font color="#990000">:=</font> <b><font color="#000000">inet:port_number</font></b>(), + <font color="#FF6600">path</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% case sensitive</font></i> + <font color="#FF6600">qs</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% case sensitive</font></i> + <font color="#FF6600">headers</font> <font color="#990000">:=</font> <b><font color="#000000">cowboy:http_headers</font></b>(), + <font color="#FF6600">peer</font> <font color="#990000">:=</font> {<b><font color="#000000">inet:ip_address</font></b>(), <b><font color="#000000">inet:port_number</font></b>()}, + <font color="#FF6600">sock</font> <font color="#990000">:=</font> {<b><font color="#000000">inet:ip_address</font></b>(), <b><font color="#000000">inet:port_number</font></b>()}, + <font color="#FF6600">cert</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>() | <font color="#000080">undefined</font> +}</tt></pre> +</div></div> +<p>The Req object.</p> +<p>Contains information about the request and response. While some fields are publicly documented, others aren't and shouldn't be used.</p> +<p>You may add custom fields if required. Make sure to namespace them by prepending an underscore and the name of your application:</p> +<div class="listingblock"><div class="title">Setting a custom field</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font>#{<font color="#009900">_myapp_auth_method</font> <font color="#990000">=></font> <font color="#FF6600">pubkey</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h3 id="_resp_body">resp_body()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">resp_body</font></b>() <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() + | {<font color="#FF6600">sendfile</font>, <font color="#009900">Offset</font>, <font color="#009900">Length</font>, <font color="#009900">Filename</font>} + +<font color="#009900">Offset</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>() +<font color="#009900">Length</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>() +<font color="#009900">Filename</font> <font color="#990000">::</font> <b><font color="#000000">file:name_all</font></b>()</tt></pre> +</div></div> +<p>Response body.</p> +<p>It can take two forms: the actual data to be sent or a tuple indicating which file to send.</p> +<p>When sending data directly, the type is either a binary or an iolist. Iolists are an efficient way to build output. Instead of concatenating strings or binaries, you can simply build a list containing the fragments you want to send in the order they should be sent:</p> +<div class="listingblock"><div class="title">Example iolists usage</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#993399">1</font><font color="#990000">></font> <font color="#009900">RespBody</font> <font color="#990000">=</font> [<font color="#FF0000">"Hello "</font>, [<font color="#990000"><<</font><font color="#FF0000">"world"</font><font color="#990000">>></font>, <font color="#FF0000">$!</font>]]<font color="#990000">.</font> +[<font color="#FF0000">"Hello "</font>,[<font color="#990000"><<</font><font color="#FF0000">"world"</font><font color="#990000">>></font>,<font color="#993399">33</font>]] +<font color="#993399">2</font><font color="#990000">></font> <b><font color="#000000">io:format</font></b>(<font color="#FF0000">"~s~n"</font>, [<font color="#009900">RespBody</font>])<font color="#990000">.</font> +<font color="#009900">Hello</font> <font color="#FF6600">world</font><font color="#990000">!</font></tt></pre> +</div></div> +<p>Note that the length must be greater than zero for any data to be sent. Cowboy will send an empty body when the length is zero.</p> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowboy(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_rest/index.html b/docs/en/cowboy/2.6/manual/cowboy_rest/index.html new file mode 100644 index 00000000..c379e0b8 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_rest/index.html @@ -0,0 +1,643 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_rest(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_rest(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_rest - REST handlers</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy_rest</code> implements the HTTP state machine.</p> +<p>Implementing REST handlers is not enough to provide a REST interface; this interface must also follow the REST constraints including HATEOAS (hypermedia as the engine of application state).</p> +<h2 id="_callbacks">Callbacks</h2> +<p>REST handlers implement the following interface:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) + <font color="#990000">-></font> {<font color="#FF6600">cowboy_rest</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Callback</font>(<font color="#009900">Req</font>, <font color="#009900">State</font>) + <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + | {<font color="#FF6600">stop</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + | {{<font color="#FF6600">switch_handler</font>, <font color="#009900">Module</font>}, <font color="#009900">Req</font>, <font color="#009900">State</font>} + | {{<font color="#FF6600">switch_handler</font>, <font color="#009900">Module</font>, <font color="#009900">Opts</font>}, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<b><font color="#000000">terminate</font></b>(<font color="#009900">Reason</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> <i><font color="#9A1900">%% optional</font></i> + +<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>() +<font color="#009900">State</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">Module</font> <font color="#990000">::</font> <b><font color="#000000">module</font></b>() +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000080">normal</font></b> + | {<font color="#FF6600">crash</font>, <font color="#FF6600">error</font> | <b><font color="#000080">exit</font></b> | <b><font color="#000080">throw</font></b>, <b><font color="#000000">any</font></b>()} + +<font color="#009900">Callback</font> <font color="#990000">-</font> <font color="#FF6600">see</font> <font color="#FF6600">below</font> +<font color="#009900">Result</font> <font color="#990000">-</font> <font color="#FF6600">see</font> <font color="#FF6600">below</font> +<font color="#009900">Default</font> <font color="#990000">-</font> <font color="#FF6600">see</font> <font color="#FF6600">below</font></tt></pre> +</div></div> +<p>The <code>init/2</code> callback is common to all handlers. To switch to the REST handler behavior, it must return <code>cowboy_rest</code> as the first element of the tuple.</p> +<p>The <code>Callback/2</code> above represents all the REST-specific callbacks. They are described in the following section of this manual. REST-specific callbacks differ by their name, semantics, result and default values. The default value is the one used when the callback has not been implemented. They otherwise all follow the same interface.</p> +<p>The <code>stop</code> tuple can be returned to stop REST processing. If no response was sent before then, Cowboy will send a <em>204 No Content</em>. The <code>stop</code> tuple can be returned from any callback, excluding <code>expires</code>, <code>generate_etag</code>, <code>last_modified</code> and <code>variances</code>.</p> +<p>A <code>switch_handler</code> tuple can be returned from these same callbacks to stop REST processing and switch to a different handler type. This is very useful to, for example, to stream the response body.</p> +<p>The optional <code>terminate/3</code> callback will ultimately be called with the reason for the termination of the handler. Cowboy will terminate the process right after this. There is no need to perform any cleanup in this callback.</p> +<p>The following terminate reasons are defined for loop handlers:</p> +<dl><dt>normal</dt> +<dd><p>The handler terminated normally.</p> +</dd> +<dt>{crash, Class, Reason}</dt> +<dd><p>A crash occurred in the handler. <code>Class</code> and <code>Reason</code> can be used to obtain more information about the crash. The function <code>erlang:get_stacktrace/0</code> can also be called to obtain the stacktrace of the process when the crash occurred.</p> +</dd> +</dl> +<h2 id="_rest_callbacks">REST callbacks</h2> +<h3 id="_acceptcallback">AcceptCallback</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">AcceptCallback</font>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <font color="#000080">true</font> | {<font color="#000080">true</font>, <font color="#009900">URI</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>()} | <font color="#000080">false</font>} +<font color="#009900">Default</font> <font color="#990000">-</font> <font color="#FF6600">crash</font></tt></pre> +</div></div> +<p>Process the request body.</p> +<p>This function should create or update the resource using the request body.</p> +<p>For PUT requests, the body is a representation of the resource that is being created or replaced.</p> +<p>For POST requests, the body is typically application-specific instructions on how to process the request, but it may also be a representation of the resource. When creating a new resource with POST at a different location, return <code>{true, URI}</code> with <code>URI</code> the new location.</p> +<p>For PATCH requests, the body is a series of instructions on how to update the resource. Patch files or JSON Patch are examples of such media types.</p> +<p>A response body may be sent. The appropriate media type, charset and language for the response can be retrieved from the Req object using the <code>media_type</code>, <code>charset</code> and <code>language</code> keys, respectively. The body can be set using <a href="../cowboy_req.set_resp_body">cowboy_req:set_resp_body(3)</a>.</p> +<h3 id="_allowed_methods">allowed_methods</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">allowed_methods</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> [<b><font color="#000080">binary</font></b>()] <i><font color="#9A1900">%% case sensitive</font></i> +<font color="#009900">Default</font> <font color="#990000">::</font> [<font color="#990000"><<</font><font color="#FF0000">"GET"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"HEAD"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"OPTIONS"</font><font color="#990000">>></font>]</tt></pre> +</div></div> +<p>Return the list of allowed methods.</p> +<h3 id="_allow_missing_post">allow_missing_post</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">allow_missing_post</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">boolean</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">true</font></tt></pre> +</div></div> +<p>Return whether POST is allowed when the resource doesn't exist.</p> +<p>Returning <code>true</code> here means that a new resource will be created. The URI for the newly created resource should be returned from the <code>AcceptCallback</code> function.</p> +<h3 id="_charsets_provided">charsets_provided</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">charsets_provided</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> [<b><font color="#000080">binary</font></b>()] <i><font color="#9A1900">%% lowercase; case insensitive</font></i> +<font color="#009900">Default</font> <font color="#990000">-</font> <font color="#FF6600">skip</font> <font color="#FF6600">this</font> <font color="#FF6600">step</font></tt></pre> +</div></div> +<p>Return the list of charsets the resource provides in order of preference.</p> +<p>During content negotiation Cowboy will pick the most appropriate charset for the client. The client advertises charsets it prefers with the accept-charset header. When that header is missing, Cowboy picks the first charset from the resource.</p> +<!-- @todo We should explain precisely how charsets are picked.--> +<p>Cowboy will add the negotiated <code>charset</code> to the Req object after this step completes:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">req</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">charset</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% lowercase; case insensitive</font></i> +}</tt></pre> +</div></div> +<p>Note that Cowboy will only append the charset to the content-type header of the response if the media type is text.</p> +<h3 id="_content_types_accepted">content_types_accepted</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">content_types_accepted</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>() | <font color="#009900">ParsedMime</font>, <font color="#009900">AcceptCallback</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>()}] +<font color="#009900">ParsedMime</font> <font color="#990000">::</font> {<font color="#009900">Type</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">SubType</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#FF6600">'*'</font> | <font color="#009900">Params</font>} +<font color="#009900">Params</font> <font color="#990000">::</font> [{<font color="#009900">Key</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()}] + +<font color="#009900">Default</font> <font color="#990000">-</font> <font color="#FF6600">crash</font></tt></pre> +</div></div> +<!-- @todo Case sensitivity of parsed mime content?--> +<p>Return the list of media types the resource accepts in order of preference.</p> +<p>A media type is made of different parts. The media type <code>text/html;charset=utf-8</code> is of type <code>text</code>, subtype <code>html</code> and has a single parameter <code>charset</code> with value <code>utf-8</code>.</p> +<!-- @todo Cowboy needs to ignore the boundary parameter for--> +<!-- multipart, as we never want to match against it. Or allow--> +<!-- ignoring specific parameters at the very least.--> +<p>Cowboy will match the content-type request header against the media types the server accepts and select the appropriate callback. When that header is missing, or when the server does not accept this media type, the request fails and an error response is returned. Cowboy will execute the callback immediately otherwise.</p> +<!-- @todo We should explain precisely how media types are picked.--> +<p>An empty parameters list <code>[]</code> means that no parameters will be accepted. When any parameter is acceptable, the tuple form should be used with parameters as the atom <code>'*'</code>.</p> +<p>Cowboy treats all parameters as case sensitive, except for the <code>charset</code> parameter, which is known to be case insensitive. You should therefore always provide the charset as a lowercase binary string.</p> +<!-- @todo Maybe this should be in the user guide instead.--> +<!-- This function will be called for POST, PUT and PATCH requests.--> +<!-- It is entirely possible to define different callbacks for different--> +<!-- methods if the handling of the request differs. Simply verify--> +<!-- what the method is with `cowboy_req:method/1` and return a--> +<!-- different list for each methods.--> +<h3 id="_content_types_provided">content_types_provided</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">content_types_provided</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>() | <font color="#009900">ParsedMime</font>, <font color="#009900">ProvideCallback</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>()}] +<font color="#009900">ParsedMime</font> <font color="#990000">::</font> {<font color="#009900">Type</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">SubType</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#FF6600">'*'</font> | <font color="#009900">Params</font>} +<font color="#009900">Params</font> <font color="#990000">::</font> [{<font color="#009900">Key</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()}] + +<font color="#009900">Default</font> <font color="#990000">-</font> [{{ <font color="#990000"><<</font><font color="#FF0000">"text"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"html"</font><font color="#990000">>></font>, <font color="#FF6600">'*'</font>}, <font color="#FF6600">to_html</font>}]</tt></pre> +</div></div> +<!-- @todo Case sensitivity of parsed mime content?--> +<!-- @todo Space required for the time being: https://github.com/spf13/hugo/issues/2398--> +<p>Return the list of media types the resource provides in order of preference.</p> +<p>A media type is made of different parts. The media type <code>text/html;charset=utf-8</code> is of type <code>text</code>, subtype <code>html</code> and has a single parameter <code>charset</code> with value <code>utf-8</code>.</p> +<!-- @todo Cowboy needs to ignore the boundary parameter for--> +<!-- multipart, as we never want to match against it. Or allow--> +<!-- ignoring specific parameters at the very least.--> +<p>During content negotiation Cowboy will pick the most appropriate media type for the client. The client advertises media types it prefers with the accept header. When that header is missing, the content negotiation fails and an error response is returned.</p> +<p>The callback given for the selected media type will be called at the end of the execution of GET and HEAD requests when a representation must be sent to the client.</p> +<!-- @todo We should explain precisely how media types are picked.--> +<p>An empty parameters list <code>[]</code> means that no parameters will be accepted. When any parameter is acceptable, the tuple form should be used with parameters as the atom <code>'*'</code>.</p> +<p>Cowboy treats all parameters as case sensitive, except for the <code>charset</code> parameter, which is known to be case insensitive. You should therefore always provide the charset as a lowercase binary string.</p> +<p>When a charset is given in the media type parameters in the accept header, Cowboy will do some additional checks to confirm that it can use this charset. When the wildcard is used then Cowboy will immediately call <code>charsets_provided</code> to confirm the charset is acceptable. If the callback is undefined Cowboy assumes any charset is acceptable. When the wildcard is not used and the charset given in the accept header matches one of the configured media types Cowboy will use that charset and skip the <code>charsets_provided</code> step entirely.</p> +<p>Cowboy will add the negotiated <code>media_type</code> to the Req object after this step completes:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">req</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">media_type</font> <font color="#990000">=></font> <font color="#009900">ParsedMime</font> +}</tt></pre> +</div></div> +<!-- @todo Case sensitivity of parsed mime content?--> +<p>Cowboy may also add the negotiated <code>charset</code> to the Req object after this step completes:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">req</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">charset</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% lowercase; case insensitive</font></i> +}</tt></pre> +</div></div> +<h3 id="_delete_completed">delete_completed</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">delete_completed</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">boolean</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">true</font></tt></pre> +</div></div> +<p>Return whether the resource has been fully deleted from the system, including from any internal cache.</p> +<p>Returning <code>false</code> will result in a <em>202 Accepted</em> response being sent instead of a <em>200 OK</em> or <em>204 No Content</em>.</p> +<h3 id="_delete_resource">delete_resource</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">delete_resource</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">boolean</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">false</font></tt></pre> +</div></div> +<p>Delete the resource.</p> +<p>Cowboy will send an error response when this function returns <code>false</code>.</p> +<h3 id="_expires">expires</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">expires</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">calendar:datetime</font></b>() | <b><font color="#000080">binary</font></b>() | <font color="#000080">undefined</font> +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">undefined</font></tt></pre> +</div></div> +<p>Return the resource's expiration date.</p> +<h3 id="_forbidden">forbidden</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">forbidden</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">boolean</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">false</font></tt></pre> +</div></div> +<p>Return whether access to the resource is forbidden.</p> +<p>A <em>403 Forbidden</em> response will be sent if this function returns <code>true</code>. This status code means that access is forbidden regardless of authentication, and that the request shouldn't be repeated.</p> +<h3 id="_generate_etag">generate_etag</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">generate_etag</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() | {<font color="#FF6600">weak</font> | <font color="#FF6600">strong</font>, <b><font color="#000080">binary</font></b>()} +<font color="#009900">Default</font> <font color="#990000">-</font> <font color="#FF6600">no</font> <font color="#FF6600">etag</font> <font color="#FF6600">value</font></tt></pre> +</div></div> +<p>Return the entity tag of the resource.</p> +<p>When a binary is returned, the value is automatically parsed to a tuple. The binary must be in the same format as the etag header, including quotes.</p> +<h3 id="_is_authorized">is_authorized</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">is_authorized</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <font color="#000080">true</font> | {<font color="#000080">false</font>, <font color="#009900">AuthHeader</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>()} +<font color="#009900">Default</font> <font color="#990000">-</font> <font color="#000080">true</font></tt></pre> +</div></div> +<p>Return whether the user is authorized to perform the action.</p> +<p>This function should be used to perform any necessary authentication of the user before attempting to perform any action on the resource.</p> +<p>When authentication fails, the <code>AuthHeader</code> value will be sent in the www-authenticate header for the <em>401 Unauthorized</em> response.</p> +<h3 id="_is_conflict">is_conflict</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">is_conflict</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">boolean</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">false</font></tt></pre> +</div></div> +<p>Return whether the PUT request results in a conflict.</p> +<p>A <em>409 Conflict</em> response is sent when <code>true</code>.</p> +<h3 id="_known_methods">known_methods</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">known_methods</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> [<b><font color="#000080">binary</font></b>()] <i><font color="#9A1900">%% case sensitive</font></i> +<font color="#009900">Default</font> <font color="#990000">::</font> [<font color="#990000"><<</font><font color="#FF0000">"GET"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"HEAD"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"POST"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"PUT"</font><font color="#990000">>></font>, + <font color="#990000"><<</font><font color="#FF0000">"PATCH"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"DELETE"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"OPTIONS"</font><font color="#990000">>></font>]</tt></pre> +</div></div> +<p>Return the list of known methods.</p> +<p>The full list of methods known by the server should be returned, regardless of their use in the resource.</p> +<p>The default value lists the methods Cowboy knows and implement in <code>cowboy_rest</code>.</p> +<h3 id="_languages_provided">languages_provided</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">languages_provided</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> [<b><font color="#000080">binary</font></b>()] <i><font color="#9A1900">%% lowercase; case insensitive</font></i> +<font color="#009900">Default</font> <font color="#990000">-</font> <font color="#FF6600">skip</font> <font color="#FF6600">this</font> <font color="#FF6600">step</font></tt></pre> +</div></div> +<p>Return the list of languages the resource provides in order of preference.</p> +<p>During content negotiation Cowboy will pick the most appropriate language for the client. The client advertises languages it prefers with the accept-language header. When that header is missing, Cowboy picks the first language from the resource.</p> +<!-- @todo We should explain precisely how languages are picked.--> +<p>Cowboy will add the negotiated <code>language</code> to the Req object after this step completes:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">req</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">language</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% lowercase; case insensitive</font></i> +}</tt></pre> +</div></div> +<h3 id="_last_modified">last_modified</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">last_modified</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">calendar:datetime</font></b>() +<font color="#009900">Default</font> <font color="#990000">-</font> <font color="#FF6600">no</font> <font color="#FF6600">last</font> <font color="#FF6600">modified</font> <font color="#FF6600">value</font></tt></pre> +</div></div> +<p>Return the resource's last modification date.</p> +<p>This date will be used to test against the if-modified-since and if-unmodified-since headers, and sent as the last-modified header in the response to GET and HEAD requests.</p> +<h3 id="_malformed_request">malformed_request</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">malformed_request</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">boolean</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">false</font></tt></pre> +</div></div> +<p>Return whether the request is malformed.</p> +<p>A request is malformed when a component required by the resource is invalid. This may include the query string or individual headers. They should be parsed and validated in this function. The body should not be read at this point.</p> +<h3 id="_moved_permanently">moved_permanently</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">moved_permanently</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> {<font color="#000080">true</font>, <font color="#009900">URI</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>()} | <font color="#000080">false</font> +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">false</font></tt></pre> +</div></div> +<p>Return whether the resource was permanently moved, and what its new location is.</p> +<h3 id="_moved_temporarily">moved_temporarily</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">moved_temporarily</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> {<font color="#000080">true</font>, <font color="#009900">URI</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>()} | <font color="#000080">false</font> +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">false</font></tt></pre> +</div></div> +<p>Return whether the resource was temporarily moved, and what its new location is.</p> +<h3 id="_multiple_choices">multiple_choices</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">multiple_choices</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">boolean</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">false</font></tt></pre> +</div></div> +<p>Return whether the client should engage in reactive negotiation.</p> +<p>Return <code>true</code> when the server has multiple representations of a resource, each with their specific identifier, but is unable to determine which is best for the client. For example an image might have different sizes and the server is unable to determine the capabilities of the client.</p> +<p>When returning <code>true</code> the server should send a body with links to the different representations. If the server has a preferred representation it can send its link inside a location header.</p> +<p>Note that when replying manually in this callback you should either call <code>cowboy_req:reply/4</code> or remove the response body that Cowboy sets to avoid surprises.</p> +<h3 id="_options">options</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">options</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}</tt></pre> +</div></div> +<p>Respond to an OPTIONS request.</p> +<p>The response should inform the client the communication options available for this resource. By default Cowboy will send a <em>200 OK</em> response with the allow header set.</p> +<h3 id="_previously_existed">previously_existed</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">previously_existed</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">boolean</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">false</font></tt></pre> +</div></div> +<p>Return whether the resource existed previously.</p> +<h3 id="_providecallback">ProvideCallback</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">ProvideCallback</font>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:resp_body</font></b>() +<font color="#009900">Default</font> <font color="#990000">-</font> <font color="#FF6600">crash</font></tt></pre> +</div></div> +<p>Return the response body.</p> +<p>The response body can be provided either as the actual data to be sent or a tuple indicating which file to send.</p> +<p>This function is called for both GET and HEAD requests. For the latter the body is not sent, however.</p> +<!-- @todo Perhaps we can optimize HEAD requests and just--> +<!-- allow calculating the length instead of returning the--> +<!-- whole thing.--> +<p>Note that there used to be a way to stream the response body. It was temporarily removed and will be added back in a later release.</p> +<!-- @todo Add a way to switch to loop handler for streaming the body.--> +<h3 id="_rate_limited">rate_limited</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">rate_limited</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <font color="#000080">false</font> | {<font color="#000080">true</font>, <font color="#009900">RetryAfter</font>} +<font color="#009900">RetryAfter</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>() | <b><font color="#000000">calendar:datetime</font></b>() +<font color="#009900">Default</font> <font color="#990000">-</font> <font color="#000080">false</font></tt></pre> +</div></div> +<p>Return whether the user is rate limited.</p> +<p>This function can be used to temporarily restrict access to a resource when the user has issued too many requests.</p> +<p>When the resource is rate limited the <code>RetryAfter</code> value will be sent in the retry-after header for the <em>429 Too Many Requests</em> response. It indicates when the resource will become available again and can be specified as a number of seconds in the future or a specific date/time.</p> +<h3 id="_resource_exists">resource_exists</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">resource_exists</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">boolean</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">true</font></tt></pre> +</div></div> +<p>Return whether the resource exists.</p> +<h3 id="_service_available">service_available</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">service_available</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">boolean</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">true</font></tt></pre> +</div></div> +<p>Return whether the service is available.</p> +<p>A <em>503 Service Unavailable</em> response will be sent when this function returns <code>false</code>.</p> +<h3 id="_uri_too_long">uri_too_long</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">uri_too_long</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">boolean</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">false</font></tt></pre> +</div></div> +<p>Return whether the requested URI is too long.</p> +<p>This function can be used to further restrict the length of the URI for this specific resource.</p> +<h3 id="_valid_content_headers">valid_content_headers</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">valid_content_headers</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">boolean</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">true</font></tt></pre> +</div></div> +<p>Return whether the content headers are valid.</p> +<p>This callback can be used to reject requests that have invalid content header values, for example an unsupported content-encoding.</p> +<h3 id="_valid_entity_length">valid_entity_length</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">valid_entity_length</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">boolean</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <font color="#000080">true</font></tt></pre> +</div></div> +<p>Return whether the request body length is within acceptable boundaries.</p> +<p>A <em>413 Request Entity Too Large</em> response will be sent if this function returns <code>false</code>.</p> +<h3 id="_variances">variances</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">variances</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Result</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + +<font color="#009900">Result</font> <font color="#990000">::</font> [<b><font color="#000080">binary</font></b>()] <i><font color="#9A1900">%% case insensitive</font></i> +<font color="#009900">Default</font> <font color="#990000">::</font> []</tt></pre> +</div></div> +<p>Return the list of request headers that affect the representation of the resource.</p> +<p>Cowboy automatically adds the accept, accept-charset and accept-language headers when necessary. It's also useful to note that some standard headers also do not need to be listed here, like the authorization header.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.6</strong>: The callback <code>rate_limited</code> was added. +</li> +<li><strong>2.1</strong>: The <code>switch_handler</code> return value was added. +</li> +<li><strong>1.0</strong>: Behavior introduced. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowboy(7)</a>, <a href="../cowboy_handler">cowboy_handler(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_router.compile/index.html b/docs/en/cowboy/2.6/manual/cowboy_router.compile/index.html new file mode 100644 index 00000000..61e65776 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_router.compile/index.html @@ -0,0 +1,188 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_router:compile(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_router:compile(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_router:compile - Compile routes to the resources</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">compile</font></b>(<b><font color="#000000">cowboy_router:routes</font></b>()) <font color="#990000">-></font> <b><font color="#000000">cowboy_router:dispatch_rules</font></b>()</tt></pre> +</div></div> +<p>Compile routes to the resources.</p> +<p>Takes a human readable list of routes and transforms it into a form more efficient to process.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Routes</dt> +<dd><p>Human readable list of routes.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>An opaque dispatch rules value is returned. This value must be given to Cowboy as a middleware environment value.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Compile routes and start a listener</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Dispatch</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_router:compile</font></b>([ + {<font color="#FF6600">'_'</font>, [ + {<font color="#FF0000">"/"</font>, <font color="#FF6600">toppage_h</font>, []}, + {<font color="#FF0000">"/[...]"</font>, <font color="#FF6600">cowboy_static</font>, {<font color="#FF6600">priv_dir</font>, <font color="#FF6600">my_example_app</font>, <font color="#FF0000">""</font>}} + ]} +]), + +{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy:start_clear</font></b>(<font color="#FF6600">example</font>, [{<font color="#FF6600">port</font>, <font color="#993399">8080</font>}], #{ + <font color="#0000FF">env</font> <font color="#990000">=></font> #{<font color="#0000FF">dispatch</font> <font color="#990000">=></font> <font color="#009900">Dispatch</font>} +})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_router">cowboy_router(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_router/index.html b/docs/en/cowboy/2.6/manual/cowboy_router/index.html new file mode 100644 index 00000000..df3d9fb4 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_router/index.html @@ -0,0 +1,205 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_router(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_router(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_router - Router middleware</p> +<h2 id="_description">Description</h2> +<p>The <code>cowboy_router</code> middleware maps the requested host and path to the handler to be used for processing the request.</p> +<p>The router takes the <code>dispatch</code> rules as input from the middleware environment. Dispatch rules are generated by calling the <a href="../cowboy_router.compile">cowboy_router:compile(3)</a> function.</p> +<p>When a route matches, the router sets the <code>handler</code> and <code>handler_opts</code> middleware environment values containing the handler module and initial state, respectively.</p> +<p>The router will stop execution when no route matches. It will send a 400 response if no host was found, and a 404 response otherwise.</p> +<h2 id="_exports">Exports</h2> +<ul><li><a href="../cowboy_router.compile">cowboy_router:compile(3)</a> - Compile routes to the resources +</li> +</ul> +<h2 id="_types">Types</h2> +<h3 id="_bindings">bindings()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">bindings</font></b>() <font color="#990000">::</font> #{<b><font color="#000080">atom</font></b>() <font color="#990000">=></font> <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>Bindings found during routing.</p> +<h3 id="_dispatch_rules">dispatch_rules()</h3> +<p>Opaque type containing the compiled routes.</p> +<h3 id="_routes">routes()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">routes</font></b>() <font color="#990000">=</font> [ + {<font color="#009900">Host</font>, <font color="#009900">PathList</font>} | + {<font color="#009900">Host</font>, <font color="#009900">Fields</font>, <font color="#009900">PathList</font>} +] + +<font color="#009900">PathList</font> <font color="#990000">::</font> [ + {<font color="#009900">Path</font>, <font color="#009900">Handler</font>, <font color="#009900">InitialState</font>} | + {<font color="#009900">Path</font>, <font color="#009900">Fields</font>, <font color="#009900">Handler</font>, <font color="#009900">InitialState</font>} +] + +<font color="#009900">Host</font> <font color="#990000">::</font> <font color="#FF6600">'_'</font> | <b><font color="#000000">iodata</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <font color="#FF6600">'_'</font> | <b><font color="#000000">iodata</font></b>() +<font color="#009900">Fields</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:fields</font></b>() +<font color="#009900">Handler</font> <font color="#990000">::</font> <b><font color="#000000">module</font></b>() +<font color="#009900">InitialState</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Human readable list of routes to handlers.</p> +<p>Cowboy uses this list to map hosts and paths, optionally augmented with constraints applied to the bindings, to handler modules.</p> +<p>The syntax for routes is currently defined in the user guide.</p> +<!-- @todo The syntax should probably be in this module,--> +<!-- and the user guide show more practical examples.--> +<h3 id="_tokens">tokens()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">tokens</font></b>() <font color="#990000">::</font> [<b><font color="#000080">binary</font></b>()]</tt></pre> +</div></div> +<p>List of <code>host_info</code> and <code>path_info</code> tokens that were found using the <code>...</code> syntax.</p> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowboy(7)</a>, <a href="../cowboy_req.binding">cowboy_req:binding(3)</a>, <a href="../cowboy_req.bindings">cowboy_req:bindings(3)</a>, <a href="../cowboy_req.host_info">cowboy_req:host_info(3)</a>, <a href="../cowboy_req.path_info">cowboy_req:path_info(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_static/index.html b/docs/en/cowboy/2.6/manual/cowboy_static/index.html new file mode 100644 index 00000000..0d871937 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_static/index.html @@ -0,0 +1,263 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_static(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_static(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_static - Static file handler</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy_static</code> implements file serving capabilities using the REST semantics provided by <code>cowboy_rest</code>.</p> +<p>The static file handler is a pre-written handler coming with Cowboy. To serve files, use it in your routes.</p> +<h2 id="_options">Options</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">opts</font></b>() <font color="#990000">::</font> {<font color="#FF6600">priv_file</font>, <font color="#009900">App</font>, <font color="#009900">Path</font>} + | {<font color="#FF6600">priv_file</font>, <font color="#009900">App</font>, <font color="#009900">Path</font>, <font color="#009900">Extra</font>} + | {<font color="#FF6600">file</font>, <font color="#009900">Path</font>} + | {<font color="#FF6600">file</font>, <font color="#009900">Path</font>, <font color="#009900">Extra</font>} + | {<font color="#FF6600">priv_dir</font>, <font color="#009900">App</font>, <font color="#009900">Path</font>} + | {<font color="#FF6600">priv_dir</font>, <font color="#009900">App</font>, <font color="#009900">Path</font>, <font color="#009900">Extra</font>} + | {<font color="#FF6600">dir</font>, <font color="#009900">Path</font>} + | {<font color="#FF6600">dir</font>, <font color="#009900">Path</font>, <font color="#009900">Extra</font>} + +<font color="#009900">App</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() | <b><font color="#000000">string</font></b>() +<font color="#009900">Extra</font> <font color="#990000">::</font> [<font color="#009900">Charset</font> | <font color="#009900">Etag</font> | <font color="#009900">Mimetypes</font>] + +<font color="#009900">Charset</font> <font color="#990000">::</font> {<font color="#FF6600">charset</font>, <b><font color="#000000">module</font></b>(), <b><font color="#000080">function</font></b>()} + | {<font color="#FF6600">charset</font>, <b><font color="#000080">binary</font></b>()} + +<font color="#009900">Etag</font> <font color="#990000">::</font> {<font color="#FF6600">etag</font>, <b><font color="#000000">module</font></b>(), <b><font color="#000080">function</font></b>()} + | {<font color="#FF6600">etag</font>, <font color="#000080">false</font>} + +<font color="#009900">Mimetypes</font> <font color="#990000">::</font> {<font color="#FF6600">mimetypes</font>, <b><font color="#000000">module</font></b>(), <b><font color="#000080">function</font></b>()} + | {<font color="#FF6600">mimetypes</font>, <b><font color="#000080">binary</font></b>() | <font color="#009900">ParsedMime</font>} + +<font color="#009900">ParsedMime</font> <font color="#990000">::</font> {<font color="#009900">Type</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">SubType</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">Params</font>} +<font color="#009900">Params</font> <font color="#990000">::</font> [{<font color="#009900">Key</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Static handler configuration.</p> +<dl><dt>priv_file</dt> +<dd><p>Send a file.</p> +<p>The path is relative to the given application's private directory.</p> +</dd> +<dt>file</dt> +<dd><p>Send a file.</p> +<p>The path is either absolute or relative to the Erlang node's current directory.</p> +</dd> +<dt>priv_dir</dt> +<dd><p>Recursively serve files from a directory.</p> +<p>The path is relative to the given application's private directory.</p> +</dd> +<dt>dir</dt> +<dd><p>Recursively serve files from a directory.</p> +<p>The path is either absolute or relative to the Erlang node's current directory.</p> +</dd> +</dl> +<p>The extra options allow you to define how the etag should be calculated and how the MIME type of files should be detected.</p> +<p>By default the static handler will not send a charset with the response. You can provide a specific charset that will be used for all files using the text media type, or provide a module and function that will be called when needed:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">detect_charset</font></b>(<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()) <font color="#990000">-></font> <font color="#009900">Charset</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()</tt></pre> +</div></div> +<p>A charset must always be returned even if it doesn't make sense considering the media type of the file. A good default is <code><<"utf-8">></code>.</p> +<p>By default the static handler will generate an etag based on the size and modification time of the file. You may disable the etag entirely with <code>{etag, false}</code> or provide a module and function that will be called when needed:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">generate_etag</font></b>(<font color="#009900">Path</font>, <font color="#009900">Size</font>, <font color="#009900">Mtime</font>) <font color="#990000">-></font> {<font color="#FF6600">strong</font> | <font color="#FF6600">weak</font>, <b><font color="#000080">binary</font></b>()} + +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">Size</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>() +<font color="#009900">Mtime</font> <font color="#990000">::</font> <b><font color="#000000">file:date_time</font></b>()</tt></pre> +</div></div> +<p>By default the static handler will detect Web-related MIME types by looking at the file extension. You can provide a specific MIME type that will always be used, or a module and function that will be called when needed:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">detect_mimetype</font></b>(<font color="#009900">Path</font>) <font color="#990000">-></font> <font color="#009900">ParsedMime</font> + +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">ParsedMime</font> <font color="#990000">::</font> {<font color="#009900">Type</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">SubType</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">Params</font>} +<font color="#009900">Params</font> <font color="#990000">::</font> [{<font color="#009900">Key</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<!-- @todo Case sensitivity of parsed mime content?--> +<p>Cowboy comes with two such functions; the default function <code>cow_mimetypes:web/1</code>, and a second function generated from the Apache <em>mime.types</em> file, <code>cow_mimetypes:all/1</code>.</p> +<p>The MIME type function should return <code>{<<"application">>, <<"octet-stream">>, []}</code> when it fails to detect a file's MIME type.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.6</strong>: The <code>charset</code> extra option was added. +</li> +<li><strong>1.0</strong>: Handler introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Custom etag function</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">generate_etag</font></b>(<font color="#009900">Path</font>, <font color="#009900">Size</font>, <font color="#009900">Mtime</font>) <font color="#990000">-></font> + {<font color="#FF6600">strong</font>, <b><font color="#000000">integer_to_binary</font></b>( + <b><font color="#000000">erlang:phash2</font></b>({<font color="#009900">Path</font>, <font color="#009900">Size</font>, <font color="#009900">Mtime</font>}, <font color="#993399">16#ffffffff</font>))}<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Custom MIME type function</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">always_octet_stream</font></b>(<font color="#009900">_Path</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">filename:extension</font></b>(<font color="#009900">Path</font>) <b><font color="#0000FF">of</font></b> + <font color="#990000"><<</font><font color="#FF0000">".erl"</font><font color="#990000">>></font> <font color="#990000">-></font> {<font color="#990000"><<</font><font color="#FF0000">"text"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"plain"</font><font color="#990000">>></font>, []}; + <font color="#990000">_</font> <font color="#990000">-></font> {<font color="#990000"><<</font><font color="#FF0000">"application"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"octet-stream"</font><font color="#990000">>></font>, []} + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowboy(7)</a>, <a href="../cowboy_router">cowboy_router(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_stream/index.html b/docs/en/cowboy/2.6/manual/cowboy_stream/index.html new file mode 100644 index 00000000..5d18cc11 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_stream/index.html @@ -0,0 +1,400 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_stream(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_stream(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_stream - Stream handlers</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy_stream</code> defines a callback interface and a protocol for handling HTTP streams.</p> +<p>An HTTP request and its associated response is called a stream. A connection may have many streams. In HTTP/1.1 they are executed sequentially, while in HTTP/2 they are executed concurrently.</p> +<p>Cowboy calls the stream handler for nearly all events related to a stream. Exceptions vary depending on the protocol.</p> +<p>Extra care must be taken when implementing stream handlers to ensure compatibility. While some modification of the events and commands is allowed, it is generally not a good idea to completely discard them.</p> +<h2 id="_callbacks">Callbacks</h2> +<p>Stream handlers must implement the following interface:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">StreamID</font>, <font color="#009900">Req</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> {<font color="#009900">Commands</font>, <font color="#009900">State</font>} +<b><font color="#000000">data</font></b>(<font color="#009900">StreamID</font>, <font color="#009900">IsFin</font>, <font color="#009900">Data</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Commands</font>, <font color="#009900">State</font>} +<b><font color="#000000">info</font></b>(<font color="#009900">StreamID</font>, <font color="#009900">Info</font>, <font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#009900">Commands</font>, <font color="#009900">State</font>} +<b><font color="#000000">terminate</font></b>(<font color="#009900">StreamID</font>, <font color="#009900">Reason</font>, <font color="#009900">State</font>) <font color="#990000">-></font> <b><font color="#000000">any</font></b>() +<b><font color="#000000">early_error</font></b>(<font color="#009900">StreamID</font>, <font color="#009900">Reason</font>, <font color="#009900">PartialReq</font>, <font color="#009900">Resp</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> <font color="#009900">Resp</font> + +<font color="#009900">StreamID</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_stream:streamid</font></b>() +<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>() +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:opts</font></b>() +<font color="#009900">Commands</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_stream:commands</font></b>() +<font color="#009900">State</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">IsFin</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_stream:fin</font></b>() +<font color="#009900">Data</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">Info</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_stream:reason</font></b>() +<font color="#009900">PartialReq</font> <font color="#990000">-</font> <b><font color="#000000">cowboy_req:req</font></b>(), <font color="#FF6600">except</font> <font color="#FF6600">all</font> <font color="#FF6600">fields</font> <font color="#FF6600">are</font> <font color="#FF6600">optional</font> +<font color="#009900">Resp</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_stream:resp_command</font></b>()</tt></pre> +</div></div> +<p>HTTP/1.1 will initialize a stream only when the request-line and all headers have been received. When errors occur before that point Cowboy will call the callback <code>early_error/5</code> with a partial request, the error reason and the response Cowboy intends to send. All other events go throuh the stream handler using the normal callbacks.</p> +<p>HTTP/2 will initialize the stream when the <code>HEADERS</code> block has been fully received and decoded. Any protocol error occuring before that will not result in a response being sent and will therefore not go through the stream handler. In addition Cowboy may terminate streams without sending an HTTP response back.</p> +<p>The stream is initialized by calling <code>init/3</code>. All streams that are initialized will eventually be terminated by calling <code>terminate/3</code>.</p> +<p>When Cowboy receives data for the stream it will call <code>data/4</code>. The data given is the request body after any transfer decoding has been applied.</p> +<p>When Cowboy receives a message addressed to a stream, or when Cowboy needs to inform the stream handler that an internal event has occurred, it will call <code>info/3</code>.</p> +<h2 id="commands">Commands</h2> +<p>Stream handlers can return a list of commands to be executed from the <code>init/3</code>, <code>data/4</code> and <code>info/3</code> callbacks. In addition, the <code>early_error/5</code> callback must return a response command.</p> +<!-- @todo The logger option and the {log, Level, Format, Args}--> +<!-- options need to be documented and tested.--> +<p>The following commands are defined:</p> +<h3 id="inform_command">inform</h3> +<p>Send an informational response to the client.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">inform</font>, <b><font color="#000000">cowboy:http_status</font></b>(), <b><font color="#000000">cowboy:http_headers</font></b>()}</tt></pre> +</div></div> +<p>Any number of informational responses may be sent, but only until the final response is sent.</p> +<h3 id="response_command">response</h3> +<p>Send a response to the client.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">response</font>, <b><font color="#000000">cowboy:http_status</font></b>(), <b><font color="#000000">cowboy:http_headers</font></b>(), + <b><font color="#000000">cowboy_req:resp_body</font></b>()}</tt></pre> +</div></div> +<p>No more data can be sent after this command.</p> +<h3 id="headers_command">headers</h3> +<p>Initiate a response to the client.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">headers</font>, <b><font color="#000000">cowboy:http_status</font></b>(), <b><font color="#000000">cowboy:http_headers</font></b>()}</tt></pre> +</div></div> +<p>This initiates a response to the client. The stream will end when a data command with the <code>fin</code> flag or a trailer command is returned.</p> +<h3 id="data_command">data</h3> +<p>Send data to the client.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">data</font>, <b><font color="#000000">fin</font></b>(), <b><font color="#000000">cowboy_req:resp_body</font></b>()}</tt></pre> +</div></div> +<h3 id="trailers_command">trailers</h3> +<p>Send response trailers to the client.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">trailers</font>, <b><font color="#000000">cowboy:http_headers</font></b>()}</tt></pre> +</div></div> +<h3 id="push_command">push</h3> +<p>Push a resource to the client.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">push</font>, <font color="#009900">Method</font>, <font color="#009900">Scheme</font>, <font color="#009900">Host</font>, <b><font color="#000000">inet:port_number</font></b>(), + <font color="#009900">Path</font>, <font color="#009900">Qs</font>, <b><font color="#000000">cowboy:http_headers</font></b>()} + +<font color="#009900">Method</font> <font color="#990000">=</font> <font color="#009900">Scheme</font> <font color="#990000">=</font> <font color="#009900">Host</font> <font color="#990000">=</font> <font color="#009900">Path</font> <font color="#990000">=</font> <font color="#009900">Qs</font> <font color="#990000">=</font> <b><font color="#000080">binary</font></b>()</tt></pre> +</div></div> +<p>The command will be ignored if the protocol does not provide any server push mechanism.</p> +<h3 id="_flow">flow</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">flow</font>, <b><font color="#000000">pos_integer</font></b>()}</tt></pre> +</div></div> +<p>Request more data to be read from the request body. The exact behavior depends on the protocol.</p> +<h3 id="_spawn">spawn</h3> +<p>Inform Cowboy that a process was spawned and should be supervised.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<b><font color="#000080">spawn</font></b>, <b><font color="#000080">pid</font></b>(), <b><font color="#000000">timeout</font></b>()}</tt></pre> +</div></div> +<h3 id="_error_response">error_response</h3> +<p>Send an error response if no response was sent previously.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">error_response</font>, <b><font color="#000000">cowboy:http_status</font></b>(), <b><font color="#000000">cowboy:http_headers</font></b>(), <b><font color="#000000">iodata</font></b>()}</tt></pre> +</div></div> +<h3 id="switch_protocol_command">switch_protocol</h3> +<p>Switch to a different protocol.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">switch_protocol</font>, <b><font color="#000000">cowboy:http_headers</font></b>(), <b><font color="#000000">module</font></b>(), <b><font color="#000000">state</font></b>()}</tt></pre> +</div></div> +<p>Contains the headers that will be sent in the 101 response, along with the module implementing the protocol we are switching to and its initial state.</p> +<p>Note that the 101 informational response will not be sent after a final response.</p> +<h3 id="_stop">stop</h3> +<p>Stop the stream.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#FF6600">stop</font></tt></pre> +</div></div> +<p>While no more data can be sent after the <code>fin</code> flag was set, the stream is still tracked by Cowboy until it is stopped by the handler.</p> +<p>The behavior when stopping a stream for which no response has been sent will vary depending on the protocol. The stream will end successfully as far as the client is concerned.</p> +<p>To indicate that an error occurred, either use <code>error_response</code> before stopping, or use <code>internal_error</code>.</p> +<h3 id="_internal_error">internal_error</h3> +<p>Stop the stream with an error.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">internal_error</font>, <font color="#009900">Reason</font>, <font color="#009900">HumanReadable</font>} + +<font color="#009900">Reason</font> <font color="#990000">=</font> <b><font color="#000000">any</font></b>() +<font color="#009900">HumanReadable</font> <font color="#990000">=</font> <b><font color="#000080">atom</font></b>()</tt></pre> +</div></div> +<p>This command should be used when the stream cannot continue because of an internal error. An <code>error_response</code> command may be sent before that to advertise to the client why the stream is dropped.</p> +<h2 id="_predefined_events">Predefined events</h2> +<p>Cowboy will forward all messages sent to the stream to the <code>info/3</code> callback. To send a message to a stream, send a message to the connection process with the form <code>{{Pid, StreamID}, Msg}</code>. The connection process will then forward <code>Msg</code> to the stream handlers.</p> +<p>Cowboy will also forward the exit signals for the processes that the stream spawned.</p> +<p>When Cowboy needs to send a response it will trigger an event that looks exactly like the corresponding command. This event must be returned to be processed by Cowboy (which is done automatically when using <a href="../cowboy_stream_h">cowboy_stream_h(3)</a>).</p> +<p>Cowboy may trigger the following events on its own, regardless of the stream handlers configured: <a href="../inform_command">inform</a> (to send a 101 informational response when upgrading to HTTP/2 or Websocket), <a href="../response_command">response</a>, <a href="../headers_command">headers</a>, <a href="../data_command">data</a> and <a href="../switch_protocol_command">switch_protocol</a>.</p> +<h2 id="_exports">Exports</h2> +<p>The following function should be called by modules implementing stream handlers to execute the next stream handler in the list:</p> +<ul><li><a href="../cowboy_stream.init">cowboy_stream:init(3)</a> - Initialize a stream +</li> +<li><a href="../cowboy_stream.data">cowboy_stream:data(3)</a> - Handle data for a stream +</li> +<li><a href="../cowboy_stream.info">cowboy_stream:info(3)</a> - Handle a message for a stream +</li> +<li><a href="../cowboy_stream.terminate">cowboy_stream:terminate(3)</a> - Terminate a stream +</li> +<li><a href="../cowboy_stream.early_error">cowboy_stream:early_error(3)</a> - Handle an early error for a stream +</li> +</ul> +<h2 id="_types">Types</h2> +<h3 id="_commands">commands()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">commands</font></b>() <font color="#990000">::</font> [<font color="#009900">Command</font>]</tt></pre> +</div></div> +<p>See the <a href="../commands">list of commands</a> for details.</p> +<h3 id="_fin">fin()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">fin</font></b>() <font color="#990000">::</font> <font color="#FF6600">fin</font> | <font color="#FF6600">nofin</font></tt></pre> +</div></div> +<p>Used in commands and events to indicate that this is the end of the stream.</p> +<h3 id="_partial_req">partial_req()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">req</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">method</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% case sensitive</font></i> + <font color="#0000FF">version</font> <font color="#990000">=></font> <b><font color="#000000">cowboy:http_version</font></b>() | <b><font color="#000080">atom</font></b>(), + <font color="#0000FF">scheme</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% lowercase; case insensitive</font></i> + <font color="#0000FF">host</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% lowercase; case insensitive</font></i> + <font color="#0000FF">port</font> <font color="#990000">=></font> <b><font color="#000000">inet:port_number</font></b>(), + <font color="#0000FF">path</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% case sensitive</font></i> + <font color="#0000FF">qs</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% case sensitive</font></i> + <font color="#0000FF">headers</font> <font color="#990000">=></font> <b><font color="#000000">cowboy:http_headers</font></b>(), + <font color="#0000FF">peer</font> <font color="#990000">=></font> {<b><font color="#000000">inet:ip_address</font></b>(), <b><font color="#000000">inet:port_number</font></b>()} +}</tt></pre> +</div></div> +<p>Partial request information received when an early error is detected.</p> +<h3 id="_reason">reason()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">reason</font></b>() <font color="#990000">::</font> <b><font color="#000080">normal</font></b> | <font color="#FF6600">switch_protocol</font> + | {<font color="#FF6600">internal_error</font>, <font color="#FF6600">timeout</font> | {<font color="#FF6600">error</font> | <b><font color="#000080">exit</font></b> | <b><font color="#000080">throw</font></b>, <b><font color="#000000">any</font></b>()}, <font color="#009900">HumanReadable</font>} + | {<font color="#FF6600">socket_error</font>, <font color="#FF6600">closed</font> | <b><font color="#000080">atom</font></b>(), <font color="#009900">HumanReadable</font>} + | {<font color="#FF6600">stream_error</font>, <font color="#009900">Error</font>, <font color="#009900">HumanReadable</font>} + | {<font color="#FF6600">connection_error</font>, <font color="#009900">Error</font>, <font color="#009900">HumanReadable</font>} + | {<font color="#FF6600">stop</font>, <b><font color="#000000">cow_http2:frame</font></b>() | {<b><font color="#000080">exit</font></b>, <b><font color="#000000">any</font></b>()}, <font color="#009900">HumanReadable</font>} + +<font color="#009900">Error</font> <font color="#990000">=</font> <b><font color="#000080">atom</font></b>() +<font color="#009900">HumanReadable</font> <font color="#990000">=</font> <b><font color="#000080">atom</font></b>()</tt></pre> +</div></div> +<p>Reason for the stream termination.</p> +<h3 id="_resp_command">resp_command()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">resp_command</font></b>() <font color="#990000">::</font> {<font color="#FF6600">response</font>, <b><font color="#000000">cowboy:http_status</font></b>(), + <b><font color="#000000">cowboy:http_headers</font></b>(), <b><font color="#000000">cowboy_req:resp_body</font></b>()}</tt></pre> +</div></div> +<p>See the <a href="../response_command">response command</a> for details.</p> +<h3 id="_streamid">streamid()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">streamid</font></b>() <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>The identifier for this stream.</p> +<p>The identifier is unique over the connection process. It is possible to form a unique identifier node-wide and cluster-wide by wrapping it in a <code>{self(), StreamID}</code> tuple.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.6</strong>: The data command can now contain a sendfile tuple. +</li> +<li><strong>2.6</strong>: The <code>{stop, {exit, any()}, HumanReadable}</code> terminate reason was added. +</li> +<li><strong>2.2</strong>: The trailers command was introduced. +</li> +<li><strong>2.0</strong>: Module introduced. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowboy(7)</a>, <a href="../cowboy_http">cowboy_http(3)</a>, <a href="../cowboy_http2">cowboy_http2(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_stream_h/index.html b/docs/en/cowboy/2.6/manual/cowboy_stream_h/index.html new file mode 100644 index 00000000..45972522 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_stream_h/index.html @@ -0,0 +1,187 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_stream_h(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_stream_h(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_stream_h - Default stream handler</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy_stream_h</code> is Cowboy's default stream handler and defines much of its behavior. It is responsible for managing the request process, sending it the request body and translating its messages into commands that Cowboy understands.</p> +<h2 id="_options">Options</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">env</font> <font color="#990000">=></font> <b><font color="#000000">cowboy_middleware:env</font></b>(), + <font color="#0000FF">middlewares</font> <font color="#990000">=></font> [<b><font color="#000000">module</font></b>()], + <font color="#000080">shutdown</font><font color="#009900">_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for the default stream handler.</p> +<p>The default value is given next to the option name:</p> +<dl><dt>env (#{})</dt> +<dd><p>Middleware environment.</p> +</dd> +<dt>middlewares ([cowboy_router, cowboy_handler])</dt> +<dd><p>Middlewares to run for every request.</p> +</dd> +<dt>shutdown_timeout (5000)</dt> +<dd><p>Time in ms Cowboy will wait for child processes to shut down before killing them.</p> +</dd> +</dl> +<h2 id="_events">Events</h2> +<p>The default stream handler spawns the request process and receives its exit signal when it terminates. It will stop the stream once its receives it.</p> +<!-- @todo It also implements the read_body mechanism.--> +<!-- Note that cowboy_stream_h sends the 100-continue automatically.--> +<p>In addition it returns a command for any event message looking like one of the following commands: <code>inform</code>, <code>response</code>, <code>headers</code>, <code>data</code>, <code>trailers</code>, <code>push</code>, <code>switch_protocol</code>. This is what allows the request process to send a response.</p> +<!-- @todo Add set_options, which updates options dynamically.--> +<p>Because this stream handler converts events from the request process into commands, other stream handlers may not work properly if they are executed</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Module introduced. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowboy(7)</a>, <a href="../cowboy_stream">cowboy_stream(3)</a>, <a href="../cowboy_compress_h">cowboy_compress_h(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/cowboy_websocket/index.html b/docs/en/cowboy/2.6/manual/cowboy_websocket/index.html new file mode 100644 index 00000000..0e1b5c14 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/cowboy_websocket/index.html @@ -0,0 +1,294 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_websocket(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_websocket(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_websocket - Websocket</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy_websocket</code> implements Websocket as a Ranch protocol. It also defines a callback interface for handling Websocket connections.</p> +<h2 id="_callbacks">Callbacks</h2> +<p>Websocket handlers must implement the following callback interface:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) + <font color="#990000">-></font> {<font color="#FF6600">cowboy_websocket</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>} + | {<font color="#FF6600">cowboy_websocket</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>, <font color="#009900">Opts</font>} + +<b><font color="#000000">websocket_init</font></b>(<font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">CallResult</font> <i><font color="#9A1900">%% optional</font></i> +<b><font color="#000000">websocket_handle</font></b>(<font color="#009900">InFrame</font>, <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">CallResult</font> +<b><font color="#000000">websocket_info</font></b>(<font color="#009900">Info</font>, <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">CallResult</font> + +<b><font color="#000000">terminate</font></b>(<font color="#009900">Reason</font>, <font color="#009900">PartialReq</font>, <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> <i><font color="#9A1900">%% optional</font></i> + +<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>() +<font color="#009900">PartialReq</font> <font color="#990000">::</font> <b><font color="#000000">map</font></b>() +<font color="#009900">State</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_websocket:opts</font></b>() +<font color="#009900">InFrame</font> <font color="#990000">::</font> <font color="#FF6600">ping</font> | <font color="#FF6600">pong</font> | {<font color="#FF6600">text</font> | <b><font color="#000080">binary</font></b> | <font color="#FF6600">ping</font> | <font color="#FF6600">pong</font>, <b><font color="#000080">binary</font></b>()} +<font color="#009900">OutFrame</font> <font color="#990000">::</font> <b><font color="#000000">cow_ws:frame</font></b>() <i><font color="#9A1900">%% see types below</font></i> +<font color="#009900">Info</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() + +<font color="#009900">CallResult</font> <font color="#990000">::</font> {<font color="#FF6600">ok</font>, <font color="#009900">State</font>} + | {<font color="#FF6600">ok</font>, <font color="#009900">State</font>, <font color="#FF6600">hibernate</font>} + | {<font color="#FF6600">reply</font>, <font color="#009900">OutFrame</font> | [<font color="#009900">OutFrame</font>], <font color="#009900">State</font>} + | {<font color="#FF6600">reply</font>, <font color="#009900">OutFrame</font> | [<font color="#009900">OutFrame</font>], <font color="#009900">State</font>, <font color="#FF6600">hibernate</font>} + | {<font color="#FF6600">stop</font>, <font color="#009900">State</font>} + +<font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000080">normal</font></b> | <font color="#FF6600">stop</font> | <font color="#FF6600">timeout</font> + | <font color="#FF6600">remote</font> | {<font color="#FF6600">remote</font>, <b><font color="#000000">cow_ws:close_code</font></b>(), <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">error</font>, <font color="#FF6600">badencoding</font> | <font color="#FF6600">badframe</font> | <font color="#FF6600">closed</font> | <b><font color="#000080">atom</font></b>()} + | {<font color="#FF6600">crash</font>, <font color="#FF6600">error</font> | <b><font color="#000080">exit</font></b> | <b><font color="#000080">throw</font></b>, <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>The <code>init/2</code> callback is common to all handlers. To upgrade the connection to Websocket, it must return <code>cowboy_websocket</code> as the first element of the tuple.</p> +<p>Any operation requiring the HTTP request must be done in the <code>init/2</code> function, as the Req object will not be available after it returns. Websocket sub-protocol selection should therefore be done in this function.</p> +<p>The optional <code>websocket_init/1</code> callback will be called once the connection has been upgraded to Websocket. It can be used to perform any required initialization of the handler.</p> +<p>Note that the <code>init/2</code> function does not run in the same process as the Websocket callbacks. Any Websocket-specific initialization must be done in <code>websocket_init/1</code>.</p> +<p>The <code>websocket_handle/2</code> callback will be called for every frame received. The <code>websocket_info/2</code> callback will be called for every Erlang message received.</p> +<p>All three Websocket callbacks may send one or more frames back to the client (by returning a <code>reply</code> tuple) or terminate the connection (by sending a <code>close</code> frame or returning a <code>stop</code> tuple).</p> +<p>The optional <code>terminate/3</code> callback will ultimately be called with the reason for the termination of the connection. This callback is common to all handlers. Note that Websocket will not provide the full Req object by default, to save memory.</p> +<p>Cowboy will terminate the process right after closing the Websocket connection. This means that there is no need to perform any cleanup in the <code>terminate/3</code> callback.</p> +<p>The following terminate reasons are defined for Websocket connections:</p> +<dl><dt>normal</dt> +<dd><p>The connection was closed normally before establishing a Websocket connection. This typically happens if an <code>ok</code> tuple is returned from the <code>init/2</code> callback.</p> +</dd> +<dt>remote</dt> +<dd><p>The remote endpoint closed the connection without giving any further details.</p> +</dd> +<dt>{remote, Code, Payload}</dt> +<dd><p>The remote endpoint closed the connection with the given <code>Code</code> and <code>Payload</code> as the reason.</p> +</dd> +<dt>stop</dt> +<dd><p>The handler requested to close the connection, either by returning a <code>stop</code> tuple or by sending a <code>close</code> frame.</p> +</dd> +<dt>timeout</dt> +<dd><p>The connection has been closed due to inactivity. The timeout value can be configured from <code>init/2</code>.</p> +</dd> +<dt>{crash, Class, Reason}</dt> +<dd><p>A crash occurred in the handler. <code>Class</code> and <code>Reason</code> can be used to obtain more information about the crash. The function <code>erlang:get_stacktrace/0</code> can also be called to obtain the stacktrace of the process when the crash occurred.</p> +</dd> +<dt>{error, badencoding}</dt> +<dd><p>A text frame was sent by the client with invalid encoding. All text frames must be valid UTF-8.</p> +</dd> +<dt>{error, badframe}</dt> +<dd><p>A protocol error has been detected.</p> +</dd> +<dt>{error, closed}</dt> +<dd><p>The socket has been closed brutally without a close frame being received first.</p> +</dd> +<dt>{error, Reason}</dt> +<dd><p>A socket error ocurred.</p> +</dd> +</dl> +<h2 id="_types">Types</h2> +<h3 id="_cow_ws_frame">cow_ws:frame()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">frame</font></b>() <font color="#990000">::</font> {<font color="#FF6600">text</font>, <b><font color="#000000">iodata</font></b>()} + | {<b><font color="#000080">binary</font></b>, <b><font color="#000000">iodata</font></b>()} + | <font color="#FF6600">ping</font> | {<font color="#FF6600">ping</font>, <b><font color="#000000">iodata</font></b>()} + | <font color="#FF6600">pong</font> | {<font color="#FF6600">pong</font>, <b><font color="#000000">iodata</font></b>()} + | <font color="#FF6600">close</font> | {<font color="#FF6600">close</font>, <b><font color="#000000">iodata</font></b>()} | {<font color="#FF6600">close</font>, <b><font color="#000000">close_code</font></b>(), <b><font color="#000000">iodata</font></b>()} + +<b><font color="#000000">close_code</font></b>() <font color="#990000">::</font> <font color="#993399">1000</font><font color="#990000">..</font><font color="#993399">1003</font> | <font color="#993399">1006</font><font color="#990000">..</font><font color="#993399">1011</font> | <font color="#993399">3000</font><font color="#990000">..</font><font color="#993399">4999</font></tt></pre> +</div></div> +<p>Websocket frames that can be sent as a response.</p> +<p>Note that there is no need to send pong frames back as Cowboy does it automatically for you.</p> +<h3 id="_opts">opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">compress</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">deflate_opts</font> <font color="#990000">=></font> <b><font color="#000000">cow_ws:deflate_opts</font></b>() + <font color="#0000FF">idle_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">max_frame_size</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>() | <font color="#FF6600">infinity</font>, + <font color="#0000FF">req_filter</font> <font color="#990000">=></font> <b><font color="#0000FF">fun</font></b>((<b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <b><font color="#000000">map</font></b>()) +}</tt></pre> +</div></div> +<p>Websocket handler options.</p> +<p>This configuration is passed to Cowboy from the <code>init/2</code> function:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + <font color="#009900">Opts</font> <font color="#990000">=</font> #{<font color="#0000FF">compress</font> <font color="#990000">=></font> <font color="#000080">true</font>}, + {<font color="#FF6600">cowboy_websocket</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>, <font color="#009900">Opts</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<p>The default value is given next to the option name:</p> +<dl><dt>compress (false)</dt> +<dd><p>Whether to enable the Websocket frame compression extension. Frames will only be compressed for the clients that support this extension.</p> +</dd> +<dt>deflate_opts (#{})</dt> +<dd><p>Configuration for the permessage-deflate Websocket extension. Allows configuring both the negotiated options and the zlib compression options. The defaults optimize the compression at the expense of some memory and CPU.</p> +</dd> +<dt>idle_timeout (60000)</dt> +<dd><p>Time in milliseconds that Cowboy will keep the connection open without receiving anything from the client.</p> +</dd> +<dt>max_frame_size (infinity)</dt> +<dd><p>Maximum frame size allowed by this Websocket handler. Cowboy will close the connection when a client attempts to send a frame that goes over this limit. For fragmented frames this applies to the size of the reconstituted frame.</p> +</dd> +<dt>req_filter</dt> +<dd><p>A function applied to the Req to compact it and only keep required information. The Req is only given back in the <code>terminate/3</code> callback. By default it keeps the method, version, URI components and peer information.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.6</strong>: Deflate options can now be configured via <code>deflate_opts</code>. +</li> +<li><strong>2.0</strong>: The Req object is no longer passed to Websocket callbacks. +</li> +<li><strong>2.0</strong>: The callback <code>websocket_terminate/3</code> was removed in favor of <code>terminate/3</code>. +</li> +<li><strong>1.0</strong>: Protocol introduced. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowboy(7)</a>, <a href="../cowboy_handler">cowboy_handler(3)</a>, <a href="../cowboy_http">cowboy_http(3)</a>, <a href="../cowboy_http2">cowboy_http2(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/http_status_codes/index.html b/docs/en/cowboy/2.6/manual/http_status_codes/index.html new file mode 100644 index 00000000..04968201 --- /dev/null +++ b/docs/en/cowboy/2.6/manual/http_status_codes/index.html @@ -0,0 +1,232 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: HTTP status codes(7)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>HTTP status codes(7)</span></h1> + +<h2 id="_name">Name</h2> +<p>HTTP status codes - status codes used by Cowboy</p> +<h2 id="_description">Description</h2> +<p>This chapter aims to list all HTTP status codes that Cowboy may return, with details on the reasons why. The list given here only includes the replies that Cowboy sends, not user replies.</p> +<h2 id="_100_continue">100 Continue</h2> +<p>When the client sends an <code>expect: 100-continue</code> header, Cowboy automatically sends a this status code before trying to read the request body. This behavior can be disabled using the appropriate body option.</p> +<h2 id="_101_switching_protocols">101 Switching Protocols</h2> +<p>This is the status code sent when switching to the Websocket protocol.</p> +<h2 id="_200_ok">200 OK</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_201_created">201 Created</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_202_accepted">202 Accepted</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_204_no_content">204 No Content</h2> +<p>This status code is sent when the processing of a request ends without any reply having been sent. It may also be sent by <code>cowboy_rest</code> under normal conditions.</p> +<h2 id="_300_multiple_choices">300 Multiple Choices</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_301_moved_permanently">301 Moved Permanently</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_303_see_other">303 See Other</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_304_not_modified">304 Not Modified</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_307_temporary_redirect">307 Temporary Redirect</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_400_bad_request">400 Bad Request</h2> +<p>Cowboy will send this status code for any of the following reasons:</p> +<ul><li>Too many empty lines were sent before the request. +</li> +<li>The request-line could not be parsed. +</li> +<li>Too many headers were sent. +</li> +<li>A header name was too long. +</li> +<li>A header value was too long. +</li> +<li>The host header was missing from an HTTP/1.1 request. +</li> +<li>The host header could not be parsed. +</li> +<li>The requested host was not found. +</li> +<li>The requested path could not be parsed. +</li> +<li>The accept header could not be parsed when using REST. +</li> +<li>REST under normal conditions. +</li> +<li>A Websocket upgrade failed. +</li> +</ul> +<h2 id="_401_unauthorized">401 Unauthorized</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_403_forbidden">403 Forbidden</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_404_not_found">404 Not Found</h2> +<p>This status code is sent when the router successfully resolved the host but didn't find a matching path for the request. It may also be sent by <code>cowboy_rest</code> under normal conditions.</p> +<h2 id="_405_method_not_allowed">405 Method Not Allowed</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_406_not_acceptable">406 Not Acceptable</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_408_request_timeout">408 Request Timeout</h2> +<p>Cowboy will send this status code to the client if the client started to send a request, indicated by the request-line being received fully, but failed to send all headers in a reasonable time.</p> +<h2 id="_409_conflict">409 Conflict</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_410_gone">410 Gone</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_412_precondition_failed">412 Precondition Failed</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_413_request_entity_too_large">413 Request Entity Too Large</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_414_request_uri_too_long">414 Request-URI Too Long</h2> +<p>Cowboy will send this status code to the client if the request-line is too long. It may also be sent by <code>cowboy_rest</code> under normal conditions.</p> +<h2 id="_415_unsupported_media_type">415 Unsupported Media Type</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_500_internal_server_error">500 Internal Server Error</h2> +<p>This status code is sent when a crash occurs in HTTP, loop or REST handlers, or when an invalid return value is returned. It may also be sent by <code>cowboy_rest</code> under normal conditions.</p> +<h2 id="_501_not_implemented">501 Not Implemented</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_503_service_unavailable">503 Service Unavailable</h2> +<p>This status code is sent by <code>cowboy_rest</code>.</p> +<h2 id="_505_http_version_not_supported">505 HTTP Version Not Supported</h2> +<p>Cowboy only supports the versions 1.0 and 1.1 of HTTP. In all other cases this status code is sent back to the client and the connection is closed.</p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/cowboy/2.6/manual/index.html b/docs/en/cowboy/2.6/manual/index.html new file mode 100644 index 00000000..40957f6d --- /dev/null +++ b/docs/en/cowboy/2.6/manual/index.html @@ -0,0 +1,223 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Cowboy Function Reference</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Cowboy Function Reference</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy - Small, fast, modern HTTP server for Erlang/OTP</p> +<h2 id="_description">Description</h2> +<p>Cowboy is an HTTP server for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols.</p> +<p>Cowboy aims to provide a complete HTTP stack. This includes the implementation of the HTTP RFCs but also any directly related standards, like Websocket or Server-Sent Events.</p> +<h2 id="_modules">Modules</h2> +<p>Functions:</p> +<ul><li><a href="cowboy">cowboy(3)</a> - Listener management +</li> +<li><a href="cowboy_req">cowboy_req(3)</a> - Request and response +</li> +<li><a href="cowboy_router">cowboy_router(3)</a> - Router +</li> +<li><a href="cowboy_constraints">cowboy_constraints(3)</a> - Constraints +</li> +</ul> +<p>Protocols:</p> +<ul><li><a href="cowboy_http">cowboy_http(3)</a> - HTTP/1.1 +</li> +<li><a href="cowboy_http2">cowboy_http2(3)</a> - HTTP/2 +</li> +<li><a href="cowboy_websocket">cowboy_websocket(3)</a> - Websocket +</li> +</ul> +<p>Handlers:</p> +<ul><li><a href="cowboy_static">cowboy_static(3)</a> - Static file handler +</li> +</ul> +<p>Stream handlers:</p> +<ul><li><a href="cowboy_stream_h">cowboy_stream_h(3)</a> - Default stream handler +</li> +<li><a href="cowboy_compress_h">cowboy_compress_h(3)</a> - Compress stream handler +</li> +</ul> +<p>Behaviors:</p> +<ul><li><a href="cowboy_handler">cowboy_handler(3)</a> - Plain HTTP handlers +</li> +<li><a href="cowboy_loop">cowboy_loop(3)</a> - Loop handlers +</li> +<li><a href="cowboy_middleware">cowboy_middleware(3)</a> - Middlewares +</li> +<li><a href="cowboy_rest">cowboy_rest(3)</a> - REST handlers +</li> +<li><a href="cowboy_stream">cowboy_stream(3)</a> - Stream handlers +</li> +<li><a href="cowboy_websocket">cowboy_websocket(3)</a> - Websocket handlers +</li> +</ul> +<p>Middlewares:</p> +<ul><li><a href="cowboy_router">cowboy_router(3)</a> - Router middleware +</li> +<li><a href="cowboy_handler">cowboy_handler(3)</a> - Handler middleware +</li> +</ul> +<!-- @todo http_status_codes is not linked to; what to do with it?--> +<h2 id="_dependencies">Dependencies</h2> +<ul><li><a href="ranch_app">ranch(7)</a> - Socket acceptor pool for TCP protocols +</li> +<li><a href="cowlib_app">cowlib(7)</a> - Support library for manipulating Web protocols +</li> +<li>ssl - Secure communication over sockets +</li> +<li>crypto - Crypto functions +</li> +</ul> +<p>All these applications must be started before the <code>cowboy</code> application. To start Cowboy and all dependencies at once:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">application:ensure_all_started</font></b>(<font color="#FF6600">cowboy</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_environment">Environment</h2> +<p>The <code>cowboy</code> application does not define any application environment configuration parameters.</p> +<h2 id="_see_also">See also</h2> +<p><a href="ranch_app">ranch(7)</a>, <a href="cowlib_app">cowlib(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.6 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li> + + <li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li> + + <li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/index.html b/docs/index.html index 047cebd1..f1668512 100644 --- a/docs/index.html +++ b/docs/index.html @@ -72,6 +72,13 @@ <ul> + <li><a href="/docs/en/cowboy/2.6/guide">Cowboy 2.6 User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.6/manual">Cowboy 2.6 Function Reference</a></li> + + + <li><a href="/docs/en/cowboy/2.5/guide">Cowboy 2.5 User Guide</a></li> diff --git a/docs/index.xml b/docs/index.xml index 978cb7ea..8da47e8a 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -221,6 +221,17 @@ HTTP/2 HTTP/2 is the most efficient protocol for consuming Web services. It enab </item> <item> + <title>The modern Web</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/modern_web/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/modern_web/</guid> + <description>Cowboy is a server for the modern Web. This chapter explains what it means and details all the standards involved. +Cowboy supports all the standards listed in this document. +HTTP/2 HTTP/2 is the most efficient protocol for consuming Web services. It enables clients to keep a connection open for long periods of time; to send requests concurrently; to reduce the size of requests through HTTP headers compression; and more. The protocol is binary, greatly reducing the resources needed to parse it.</description> + </item> + + <item> <title>Erlang and the Web</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/guide/erlang_web/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -281,6 +292,16 @@ The Web is concurrent When you access a website there is little concurrency invo </item> <item> + <title>Erlang and the Web</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/erlang_web/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/erlang_web/</guid> + <description>Erlang is the ideal platform for writing Web applications. Its features are a perfect match for the requirements of modern Web applications. +The Web is concurrent When you access a website there is little concurrency involved. A few connections are opened and requests are sent through these connections. Then the web page is displayed on your screen. Your browser will only open up to 4 or 8 connections to the server, depending on your settings.</description> + </item> + + <item> <title>Getting started</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/getting_started/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -524,6 +545,18 @@ Cowboy is a high quality project. It has a small code base, is very efficient (b </item> <item> + <title>Introduction</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/introduction/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/introduction/</guid> + <description>Cowboy is a small, fast and modern HTTP server for Erlang/OTP. +Cowboy aims to provide a complete modern Web stack. This includes HTTP/1.1, HTTP/2, Websocket, Server-Sent Events and Webmachine-based REST. +Cowboy comes with functions for introspection and tracing, enabling developers to know precisely what is happening at any time. Its modular design also easily enable developers to add instrumentation. +Cowboy is a high quality project. It has a small code base, is very efficient (both in latency and memory use) and can easily be embedded in another application.</description> + </item> + + <item> <title>Transports</title> <link>https://ninenines.eu/docs/en/ranch/1.2/guide/transports/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -776,6 +809,16 @@ This chapter walks you through all the steps of setting up Cowboy, writing your </item> <item> + <title>Getting started</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/getting_started/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/getting_started/</guid> + <description>Erlang is more than a language, it is also an operating system for your applications. Erlang developers rarely write standalone modules, they write libraries or applications, and then bundle those into what is called a release. A release contains the Erlang VM plus all applications required to run the node, so it can be pushed to production directly. +This chapter walks you through all the steps of setting up Cowboy, writing your first application and generating your first release.</description> + </item> + + <item> <title>Updating Erlang.mk</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/updating/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -980,6 +1023,18 @@ After Ranch accepts a new connection, whether it is an HTTP/1.</description> </item> <item> + <title>Flow diagram</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/flow_diagram/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/flow_diagram/</guid> + <description>Cowboy is a lightweight HTTP server with support for HTTP/1.1, HTTP/2 and Websocket. +It is built on top of Ranch. Please see the Ranch guide for more information about how the network connections are handled. +Overview As you can see on the diagram, the client begins by connecting to the server. This step is handled by a Ranch acceptor, which is a process dedicated to accepting new connections. +After Ranch accepts a new connection, whether it is an HTTP/1.</description> + </item> + + <item> <title>Websocket</title> <link>https://ninenines.eu/docs/en/gun/1.0/guide/websocket/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1198,6 +1253,17 @@ Cowboy provides two types of listeners: one listening for clear TCP connections, </item> <item> + <title>Listeners</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/listeners/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/listeners/</guid> + <description>A listener is a set of processes that listens on a port for new connections. Incoming connections get handled by Cowboy. Depending on the connection handshake, one or another protocol may be used. +This chapter is specific to Cowboy. Please refer to the Ranch User Guide for more information about listeners. +Cowboy provides two types of listeners: one listening for clear TCP connections, and one listening for secure TLS connections. Both of them support the HTTP/1.</description> + </item> + + <item> <title>SSL client authentication</title> <link>https://ninenines.eu/docs/en/ranch/1.2/guide/ssl_auth/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1341,6 +1407,18 @@ Routes need to be compiled before they can be used by Cowboy. The result of the </item> <item> + <title>Routing</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/routing/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/routing/</guid> + <description>Cowboy does nothing by default. +To make Cowboy useful, you need to map URIs to Erlang modules that will handle the requests. This is called routing. +When Cowboy receives a request, it tries to match the requested host and path to the configured routes. When there&apos;s a match, the route&apos;s associated handler is executed. +Routes need to be compiled before they can be used by Cowboy. The result of the compilation is the dispatch rules.</description> + </item> + + <item> <title>NIFs and port drivers</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/ports/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1504,6 +1582,18 @@ A field can take the form of an atom field, a tuple with constraints {field, Con </item> <item> + <title>Constraints</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/constraints/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/constraints/</guid> + <description>Constraints are validation and conversion functions applied to user input. +They are used in various places in Cowboy, including the router and the cowboy_req match functions. +Syntax Constraints are provided as a list of fields. For each field in the list, specific constraints can be applied, as well as a default value if the field is missing. +A field can take the form of an atom field, a tuple with constraints {field, Constraints} or a tuple with constraints and a default value {field, Constraints, Default}.</description> + </item> + + <item> <title>Releases</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/releases/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1635,6 +1725,19 @@ init(Req, State) -&gt; {ok, Req, State}. Despite sending no reply, a 204 No </item> <item> + <title>Handlers</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/handlers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/handlers/</guid> + <description>Handlers are Erlang modules that handle HTTP requests. +Plain HTTP handlers The most basic handler in Cowboy implements the mandatory init/2 callback, manipulates the request, optionally sends a response and then returns. +This callback receives the Req object and the initial state defined in the router configuration. +A handler that does nothing would look like this: +init(Req, State) -&gt; {ok, Req, State}. Despite sending no reply, a 204 No Content response will be sent to the client, as Cowboy makes sure that a response is sent for every request.</description> + </item> + + <item> <title>Escripts</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/escripts/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1729,6 +1832,16 @@ Loop handlers are used for requests where a response might not be immediately av </item> <item> + <title>Loop handlers</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/loop_handlers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/loop_handlers/</guid> + <description>Loop handlers are a special kind of HTTP handlers used when the response can not be sent right away. The handler enters instead a receive loop waiting for the right message before it can send a response. +Loop handlers are used for requests where a response might not be immediately available, but where you would like to keep the connection open for a while in case the response arrives. The most known example of such practice is known as long polling.</description> + </item> + + <item> <title>OTP version management</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/kerl/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1805,6 +1918,17 @@ The static handler can serve either one file or all files from a given directory </item> <item> + <title>Static files</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/static_files/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/static_files/</guid> + <description>Cowboy comes with a ready to use handler for serving static files. It is provided as a convenience for serving files during development. +For systems in production, consider using one of the many Content Distribution Network (CDN) available on the market, as they are the best solution for serving files. +The static handler can serve either one file or all files from a given directory. The etag generation and mime types can be configured.</description> + </item> + + <item> <title>Compatibility with other build tools</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/compat/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1914,6 +2038,17 @@ The Req object is the subject of a few different chapters. In this chapter we wi </item> <item> + <title>The Req object</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/req/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/req/</guid> + <description>The Req object is a variable used for obtaining information about a request, read its body or send a response. +It is not really an object in the object-oriented sense. It is a simple map that can be directly accessed or used when calling functions from the cowboy_req module. +The Req object is the subject of a few different chapters. In this chapter we will learn about the Req object and look at how to retrieve information about the request.</description> + </item> + + <item> <title>Migrating from Ranch 1.x</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.x/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2006,6 +2141,18 @@ You are not required to read it, however. If a body is present and was not read, </item> <item> + <title>Reading the request body</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/req_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/req_body/</guid> + <description>The request body can be read using the Req object. +Cowboy will not attempt to read the body until requested. You need to call the body reading functions in order to retrieve it. +Cowboy will not cache the body, it is therefore only possible to read it once. +You are not required to read it, however. If a body is present and was not read, Cowboy will either cancel or skip its download, depending on the protocol.</description> + </item> + + <item> <title>EDoc comments</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/edoc/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2101,6 +2248,18 @@ While only one response is allowed for every request, HTTP/2 introduced a mechan </item> <item> + <title>Sending a response</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/resp/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/resp/</guid> + <description>The response must be sent using the Req object. +Cowboy provides two different ways of sending responses: either directly or by streaming the body. Response headers and body may be set in advance. The response is sent as soon as one of the reply or stream reply function is called. +Cowboy also provides a simplified interface for sending files. It can also send only specific parts of a file. +While only one response is allowed for every request, HTTP/2 introduced a mechanism that allows the server to push additional resources related to the response.</description> + </item> + + <item> <title>Erlang shell</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/shell/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2172,6 +2331,16 @@ Cookies are a name/value store where the names and values are stored in plain te </item> <item> + <title>Using cookies</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/cookies/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/cookies/</guid> + <description>Cookies are a mechanism allowing applications to maintain state on top of the stateless HTTP protocol. +Cookies are a name/value store where the names and values are stored in plain text. They expire either after a delay or when the browser closes. They can be configured on a specific domain name or path, and restricted to secure resources (sent or downloaded over HTTPS), or restricted to the server (disallowing access from client-side scripts).</description> + </item> + + <item> <title>EUnit</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/eunit/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2249,6 +2418,17 @@ In the context of HTTP, multipart is most often used with the multipart/form-dat </item> <item> + <title>Multipart requests</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/multipart/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/multipart/</guid> + <description>Multipart originates from MIME, an Internet standard that extends the format of emails. +A multipart message is a list of parts. A part contains headers and a body. The body of the parts may be of any media type, and contain text or binary data. It is possible for parts to contain a multipart media type. +In the context of HTTP, multipart is most often used with the multipart/form-data media type.</description> + </item> + + <item> <title>Common Test</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/common_test/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2326,6 +2506,17 @@ We will first attempt to define REST and will look at what it means in the conte </item> <item> + <title>REST principles</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/rest_principles/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/rest_principles/</guid> + <description>This chapter will attempt to define the concepts behind REST and explain what makes a service RESTful. +REST is often confused with performing a distinct operation depending on the HTTP method, while using more than the GET and POST methods. That&apos;s highly misguided at best. +We will first attempt to define REST and will look at what it means in the context of HTTP and the Web. For a more in-depth explanation of REST, you can read Roy T.</description> + </item> + + <item> <title>Triq</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/triq/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2413,6 +2604,18 @@ init(Req, State) -&gt; {cowboy_rest, Req, State}.</description> </item> <item> + <title>REST handlers</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/rest_handlers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/rest_handlers/</guid> + <description>REST is implemented in Cowboy as a sub protocol. The request is handled as a state machine with many optional callbacks describing the resource and modifying the machine&apos;s behavior. +The REST handler is the recommended way to handle HTTP requests. +Initialization First, the init/2 callback is called. This callback is common to all handlers. To use REST for the current request, this function must return a cowboy_rest tuple. +init(Req, State) -&gt; {cowboy_rest, Req, State}.</description> + </item> + + <item> <title>Code coverage</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/coverage/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2498,6 +2701,17 @@ All paths start with the &quot;Start&quot; diagram, and all paths exclud </item> <item> + <title>REST flowcharts</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/rest_flowcharts/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/rest_flowcharts/</guid> + <description>This chapter will explain the REST handler state machine through a number of different diagrams. +There are four main paths that requests may follow. One for the method OPTIONS; one for the methods GET and HEAD; one for the methods PUT, POST and PATCH; and one for the method DELETE. +All paths start with the &quot;Start&quot; diagram, and all paths excluding the OPTIONS path go through the &quot;Content negotiation&quot; diagram and optionally the &quot;Conditional requests&quot; diagram if the resource exists.</description> + </item> + + <item> <title>Dialyzer</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/dialyzer/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2569,6 +2783,16 @@ The service Can the service become unavailable, and when it does, can we detect </item> <item> + <title>Designing a resource handler</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/resource_design/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/resource_design/</guid> + <description>This chapter aims to provide you with a list of questions you must answer in order to write a good resource handler. It is meant to be usable as a step by step guide. +The service Can the service become unavailable, and when it does, can we detect it? For example, database connectivity problems may be detected early. We may also have planned outages of all or parts of the system.</description> + </item> + + <item> <title>Xref</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/xref/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2655,6 +2879,17 @@ Websocket connections are fully asynchronous, unlike HTTP/1.1 (synchronous) and </item> <item> + <title>The Websocket protocol</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/ws_protocol/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/ws_protocol/</guid> + <description>This chapter explains what Websocket is and why it is a vital component of soft realtime Web applications. +Description Websocket is an extension to HTTP that emulates plain TCP connections between the client, typically a Web browser, and the server. It uses the HTTP Upgrade mechanism to establish the connection. +Websocket connections are fully asynchronous, unlike HTTP/1.1 (synchronous) and HTTP/2 (asynchronous, but the server can only initiate streams in response to requests).</description> + </item> + + <item> <title>List of plugins</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/external_plugins_list/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2729,6 +2964,16 @@ As Websocket connections are established through the HTTP/1.1 upgrade mechanism, </item> <item> + <title>Websocket handlers</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/ws_handlers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/ws_handlers/</guid> + <description>Websocket handlers provide an interface for upgrading HTTP/1.1 connections to Websocket and sending or receiving frames on the Websocket connection. +As Websocket connections are established through the HTTP/1.1 upgrade mechanism, Websocket handlers need to be able to first receive the HTTP request for the upgrade, before switching to Websocket and taking over the connection. They can then receive or send Websocket frames, handle incoming Erlang messages or close the connection.</description> + </item> + + <item> <title>Streams</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/guide/streams/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2795,6 +3040,17 @@ All versions of HTTP allow clients to initiate streams. HTTP/2 is the only one a </item> <item> + <title>Streams</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/streams/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/streams/</guid> + <description>A stream is the set of messages that form an HTTP request/response pair. +The term stream comes from HTTP/2. In Cowboy, it is also used when talking about HTTP/1.1 or HTTP/1.0. It should not be confused with streaming the request or response body. +All versions of HTTP allow clients to initiate streams. HTTP/2 is the only one also allowing servers, through its server push feature. Both client and server-initiated streams go through the same process in Cowboy.</description> + </item> + + <item> <title>Why Erlang.mk</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/why/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2873,6 +3129,17 @@ Cowboy will execute all middlewares in the given order, unless one of them decid </item> <item> + <title>Middlewares</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/middlewares/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/middlewares/</guid> + <description>Cowboy delegates the request processing to middleware components. By default, two middlewares are defined, for the routing and handling of the request, as is detailed in most of this guide. +Middlewares give you complete control over how requests are to be processed. You can add your own middlewares to the mix or completely change the chain of middlewares as needed. +Cowboy will execute all middlewares in the given order, unless one of them decides to stop processing.</description> + </item> + + <item> <title>Short history</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/history/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2958,6 +3225,17 @@ Features added Add option linger_timeout to control how long Cowboy will wait be </item> <item> + <title>Migrating from Cowboy 2.5 to 2.6</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.5/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.5/</guid> + <description>Cowboy 2.6 greatly refactored the HTTP/2 code, a large part of which was moved to Cowlib and is now used by both the Cowboy server and the Gun client. +A large number of tickets were also closed which resulted in many bugs fixed and many features and options added, although some of them are still experimental. +Features added Add support for the PROXY protocol header. It can be enabled via the proxy_header option.</description> + </item> + + <item> <title>HTTP and other specifications</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3019,6 +3297,16 @@ Features added Add experimental support for Websocket over HTTP/2. You can use t </item> <item> + <title>Migrating from Cowboy 2.4 to 2.5</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.4/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.4/</guid> + <description>Cowboy 2.5 focused on making the test suites pass. A variety of new features, fixes and improvements have also been worked on. +Features added Add option linger_timeout to control how long Cowboy will wait before closing the socket when shutting down the connection. This helps avoid the TCP reset problem HTTP/1.1 suffers from. The default is now 1000 ms. It is now possible to stream a response body without using chunked transfer-encoding when the protocol is HTTP/1.</description> + </item> + + <item> <title>HTTP and other specifications</title> <link>https://ninenines.eu/docs/en/cowboy/2.1/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3069,6 +3357,16 @@ Features added Add support for all functions from the module sys. Note that Cowb </item> <item> + <title>Migrating from Cowboy 2.3 to 2.4</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.3/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.3/</guid> + <description>Cowboy 2.4 focused on improving the HTTP/2 implementation. All existing tests from RFC7540 and the h2spec test suite now all pass. Numerous options have been added to control SETTINGS and related behavior. In addition experimental support for Websocket over HTTP/2 was added. +Features added Add experimental support for Websocket over HTTP/2. You can use the enable_connect_protocol option to enable. It implements the following draft: https://tools.ietf.org/html/draft-ietf-httpbis-h2-websockets-01 Add options max_decode_table_size and max_encode_table_size to restrict the size of the HPACK compression dictionary.</description> + </item> + + <item> <title>Migrating from Cowboy 1.0 to 2.0</title> <link>https://ninenines.eu/docs/en/cowboy/2.2/guide/migrating_from_1.0/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3111,6 +3409,16 @@ Features added Add support for sending trailers at the end of response bodies. T </item> <item> + <title>Migrating from Cowboy 2.2 to 2.3</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.2/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.2/</guid> + <description>Cowboy 2.3 focused on making the Cowboy processes behave properly according to OTP principles. This version is a very good milestone toward that goal and most of everything should now work. Release upgrades and a few details will be improved in future versions. +Features added Add support for all functions from the module sys. Note that Cowboy currently does not implement the sys debugging mechanisms as tracing is recommended instead. Add a max_frame_size option for Websocket handlers to close the connection when the client attempts to send a frame that&apos;s too large.</description> + </item> + + <item> <title>HTTP and other specifications</title> <link>https://ninenines.eu/docs/en/cowboy/2.2/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3152,6 +3460,16 @@ Features added It is now possible to obtain the client TLS certificate and the l </item> <item> + <title>Migrating from Cowboy 2.1 to 2.2</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.1/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.1/</guid> + <description>Cowboy 2.2 focused on adding features required for writing gRPC servers and on completing test suites for the core HTTP RFCs, fixing many bugs along the way. +Features added Add support for sending trailers at the end of response bodies. Trailers are additional header fields that may be sent after the body to add more information to the response. Their usage is required in gRPC servers. They are optional and may be discarded in other scenarios (for example if the request goes through an HTTP/1.</description> + </item> + + <item> <title>HTTP and other specifications</title> <link>https://ninenines.eu/docs/en/cowboy/2.4/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3173,6 +3491,16 @@ Compatibility Compatibility with Erlang/OTP R16, 17 and 18 has been dropped. Erl </item> <item> + <title>Migrating from Cowboy 2.0 to 2.1</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.0/</guid> + <description>Cowboy 2.1 focused on adding features that were temporarily removed in Cowboy 2.0. A number of bugs found in the 2.0 release were also fixed. +Features added It is now possible to obtain the client TLS certificate and the local IP/port for the connection from the Req object. Informational responses (1XX responses) can now be sent. They must be sent before initiating the final response. The expect: 100-continue header is now handled automatically.</description> + </item> + + <item> <title>HTTP and other specifications</title> <link>https://ninenines.eu/docs/en/cowboy/2.5/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3183,6 +3511,27 @@ HTTP IANA Registries HTTP Method Registry HTTP Status Code Registry Message He </item> <item> + <title>Migrating from Cowboy 1.0 to 2.0</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_1.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_1.0/</guid> + <description>A lot has changed between Cowboy 1.0 and 2.0. The cowboy_req interface in particular has seen a massive revamp. Hooks are gone, their functionality can now be achieved via stream handlers. +The documentation has seen great work, in particular the manual. Each module and each function now has its own dedicated manual page with full details and examples. +Compatibility Compatibility with Erlang/OTP R16, 17 and 18 has been dropped. Erlang/OTP 19.</description> + </item> + + <item> + <title>HTTP and other specifications</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/specs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/specs/</guid> + <description>This chapter intends to list all the specification documents for or related to HTTP. +HTTP IANA Registries HTTP Method Registry HTTP Status Code Registry Message Headers HTTP Parameters HTTP Alt-Svc Parameter Registry HTTP Authentication Scheme Registry HTTP Cache Directive Registry HTTP Digest Algorithm Values HTTP Origin-Bound Authentication Device Identifier Types HTTP Upgrade Token Registry HTTP Warn Codes HTTP/2 Parameters WebSocket Protocol Registries Current CORS: Cross-Origin Resource Sharing CSP2: Content Security Policy Level 2 DNT: Tracking Preference Expression (DNT) eventsource: Server-Sent Events Form content types: Form content types Preload: Preload PROXY: The PROXY protocol REST: Fielding&apos;s Dissertation RFC 1945: HTTP/1.</description> + </item> + + <item> <title>Cowboy Function Reference</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3261,6 +3610,19 @@ cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_ro </item> <item> + <title>Cowboy Function Reference</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/</guid> + <description>Name cowboy - Small, fast, modern HTTP server for Erlang/OTP +Description Cowboy is an HTTP server for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. +Cowboy aims to provide a complete HTTP stack. This includes the implementation of the HTTP RFCs but also any directly related standards, like Websocket or Server-Sent Events. +Modules Functions: +cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_router(3) - Router cowboy_constraints(3) - Constraints Protocols:</description> + </item> + + <item> <title>Cowboy User Guide</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/guide/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3315,6 +3677,15 @@ cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_ro </item> <item> + <title>Cowboy User Guide</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/</guid> + <description>Rationale The modern Web Erlang and the Web Introduction Introduction Getting started Flow diagram Configuration Listeners Routing Constraints Handlers Handlers Loop handlers Static files Request and response Request details Reading the request body Sending a response Using cookies Multipart REST REST principles Handling REST requests REST flowcharts Designing a resource handler Websocket The Websocket protocol Websocket handlers Advanced Streams Middlewares Additional information Migrating from Cowboy 2.</description> + </item> + + <item> <title>Erlang.mk User Guide</title> <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3474,6 +3845,17 @@ Description This chapter aims to list all HTTP status codes that Cowboy may retu </item> <item> + <title>HTTP status codes(7)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/http_status_codes/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/http_status_codes/</guid> + <description>Name HTTP status codes - status codes used by Cowboy +Description This chapter aims to list all HTTP status codes that Cowboy may return, with details on the reasons why. The list given here only includes the replies that Cowboy sends, not user replies. +100 Continue When the client sends an expect: 100-continue header, Cowboy automatically sends a this status code before trying to read the request body. This behavior can be disabled using the appropriate body option.</description> + </item> + + <item> <title>Ranch Function Reference</title> <link>https://ninenines.eu/docs/en/ranch/1.2/manual/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3658,6 +4040,17 @@ Exports cowboy:start_clear(3) - Listen for connections using plain TCP cowboy:s </item> <item> + <title>cowboy(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy/</guid> + <description>Name cowboy - HTTP server +Description The module cowboy provides convenience functions for manipulating Ranch listeners. +Exports cowboy:start_clear(3) - Listen for connections using plain TCP cowboy:start_tls(3) - Listen for connections using TLS cowboy:stop_listener(3) - Stop the given listener cowboy:set_env(3) - Update a listener&apos;s environment value Types fields() fields() :: [Name | {Name, Constraints} | {Name, Constraints, Default}] Name :: atom() Constraints :: Constraint | [Constraint] Constraint :: cowboy_constraints:constraint() Default :: any() Fields description for match operations.</description> + </item> + + <item> <title>cowboy(7)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_app/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3736,6 +4129,19 @@ cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_ro </item> <item> + <title>cowboy(7)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_app/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_app/</guid> + <description>Name cowboy - Small, fast, modern HTTP server for Erlang/OTP +Description Cowboy is an HTTP server for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. +Cowboy aims to provide a complete HTTP stack. This includes the implementation of the HTTP RFCs but also any directly related standards, like Websocket or Server-Sent Events. +Modules Functions: +cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_router(3) - Router cowboy_constraints(3) - Constraints Protocols:</description> + </item> + + <item> <title>cowboy:set_env(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy.set_env/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3814,6 +4220,19 @@ Arguments Name The name of the listener to update.</description> </item> <item> + <title>cowboy:set_env(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy.set_env/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy.set_env/</guid> + <description>Name cowboy:set_env - Update a listener&apos;s environment value +Description set_env(Name :: ranch:ref(), Key :: atom(), Value :: any()) -&gt; ok Set or update an environment value for a previously started listener. +This is most useful for updating the routes dynamically, without having to restart the listener. +The new value will only be available to new connections. Pre-existing connections will still use the old value. +Arguments Name The name of the listener to update.</description> + </item> + + <item> <title>cowboy:start_clear(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy.start_clear/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3886,6 +4305,18 @@ Arguments Name The listener name is used to refer to this listener in future cal </item> <item> + <title>cowboy:start_clear(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy.start_clear/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy.start_clear/</guid> + <description>Name cowboy:start_clear - Listen for connections using plain TCP +Description start_clear(Name :: ranch:ref(), TransportOpts :: ranch_tcp:opts(), ProtocolOpts :: opts()) -&gt; {ok, ListenerPid :: pid()} | {error, any()} Start listening for connections over a clear TCP channel. +Both HTTP/1.1 and HTTP/2 are supported on this listener. HTTP/2 has two methods of establishing a connection over a clear TCP channel. Both the upgrade and the prior knowledge methods are supported. +Arguments Name The listener name is used to refer to this listener in future calls, for example when stopping it or when updating the routes defined.</description> + </item> + + <item> <title>cowboy:start_tls(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy.start_tls/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3958,6 +4389,18 @@ Arguments Name The listener name is used to refer to this listener in future cal </item> <item> + <title>cowboy:start_tls(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy.start_tls/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy.start_tls/</guid> + <description>Name cowboy:start_tls - Listen for connections using TLS +Description start_tls(Name :: ranch:ref(), TransportOpts :: ranch_ssl:opts(), ProtocolOpts :: opts()) -&gt; {ok, ListenerPid :: pid()} | {error, any()} Start listening for connections over a secure TLS channel. +Both HTTP/1.1 and HTTP/2 are supported on this listener. The ALPN TLS extension must be used to initiate an HTTP/2 connection. +Arguments Name The listener name is used to refer to this listener in future calls, for example when stopping it or when updating the routes defined.</description> + </item> + + <item> <title>cowboy:stop_listener(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy.stop_listener/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4048,6 +4491,32 @@ The {error, not_found} tuple is returned when the listener does not exist.</desc </item> <item> + <title>cowboy:stop_listener(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy.stop_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy.stop_listener/</guid> + <description>Name cowboy:stop_listener - Stop the given listener +Description stop_listener(Name :: ranch:ref()) -&gt; ok | {error, not_found}. Stop a previously started listener. +Alias of ranch:stop_listener(3). +Arguments Name The name of the listener to be stopped. +The name of the listener is the first argument given to the cowboy:start_clear(3), cowboy:start_tls(3) or ranch:start_listener(3) function. + Return value The atom ok is returned on success. +The {error, not_found} tuple is returned when the listener does not exist.</description> + </item> + + <item> + <title>cowboy_compress_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_compress_h/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_compress_h/</guid> + <description>Name cowboy_compress_h - Compress stream handler +Description The module cowboy_compress_h compresses response bodies automatically when the client supports it. It will not try to compress responses that already have a content encoding. +Normal responses will only be compressed when their size is lower than the configured threshold. Streamed responses are always compressed, including when the sendfile command is used. Because the file must be read in memory to be compressed, this module is not suitable for automatically compressing large files.</description> + </item> + + <item> <title>cowboy_constraints(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_constraints/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4126,6 +4595,19 @@ cowboy_constraints:int(3) - Integer constraint cowboy_constraints:nonempty(3) - </item> <item> + <title>cowboy_constraints(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_constraints/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_constraints/</guid> + <description>Name cowboy_constraints - Constraints +Description The module cowboy_constraints defines the built-in constraints in Cowboy and provides an interface for manipulating these constraints. +Constraints are functions that define what type of input is allowed. They are used throughout Cowboy, from the router to query strings to cookies. +Exports Built-in constraints: +cowboy_constraints:int(3) - Integer constraint cowboy_constraints:nonempty(3) - Non-empty constraint Types constraint() constraint() :: int | nonempty | fun() A constraint function.</description> + </item> + + <item> <title>cowboy_constraints:int(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_constraints.int/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4204,6 +4686,19 @@ int(format_error, Error) -&gt; HumanReadable Error :: {not_an_integer, Bin | </item> <item> + <title>cowboy_constraints:int(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_constraints.int/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_constraints.int/</guid> + <description>Name cowboy_constraints:int - Integer constraint +Description Constraint functions implement a number of different operations. +int(forward, Bin) -&gt; {ok, Int} | {error, not_an_integer} Bin :: binary() Int :: integer() Validate and convert the text representation of an integer. +int(reverse, Int) -&gt; {ok, Bin} | {error, not_an_integer} Convert an integer back to its text representation. +int(format_error, Error) -&gt; HumanReadable Error :: {not_an_integer, Bin | Int} HumanReadable :: iolist() Generate a human-readable error message.</description> + </item> + + <item> <title>cowboy_constraints:nonempty(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_constraints.nonempty/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4288,6 +4783,20 @@ Arguments Arguments vary depending on the operation. Constraint functions always </item> <item> + <title>cowboy_constraints:nonempty(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_constraints.nonempty/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_constraints.nonempty/</guid> + <description>Name cowboy_constraints:nonempty - Non-empty constraint +Description Constraint functions implement a number of different operations. +nonempty(forward | reverse, &lt;&lt;&gt;&gt;) -&gt; {error, empty} Reject empty values. +nonempty(forward | reverse, Bin) -&gt; {ok, Bin} Bin :: binary() Accept any other binary values. +nonempty(format_error, Error) -&gt; HumanReadable Error :: {empty, Bin} HumanReadable :: iolist() Generate a human-readable error message. +Arguments Arguments vary depending on the operation. Constraint functions always take the operation type as first argument, and the value as second argument.</description> + </item> + + <item> <title>cowboy_handler(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_handler/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4360,6 +4869,18 @@ This module also defines a callback interface for handling HTTP requests.</descr </item> <item> + <title>cowboy_handler(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_handler/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_handler/</guid> + <description>Name cowboy_handler - Plain HTTP handlers +Description The cowboy_handler middleware executes the handler selected by the router or any other preceding middleware. +This middleware takes the handler module and initial state from the handler and handler_opts environment values, respectively. On completion, it adds a result value to the middleware environment, containing the return value of the terminate/3 callback (if defined) and ok otherwise. +This module also defines a callback interface for handling HTTP requests.</description> + </item> + + <item> <title>cowboy_handler:terminate(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_handler.terminate/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4444,6 +4965,20 @@ It is possible to remove fields from the Req object to save memory when the hand </item> <item> + <title>cowboy_handler:terminate(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_handler.terminate/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_handler.terminate/</guid> + <description>Name cowboy_handler:terminate - Terminate the handler +Description terminate(Reason, PartialReq, State, Handler) -&gt; ok Reason :: any() PartialReq :: map() State :: any() Handler :: module() Call the optional terminate callback if it is defined. +Make sure to use this function at the end of the execution of modules that implement custom handler behaviors. +Arguments Reason Reason for termination. + PartialReq The Req object. +It is possible to remove fields from the Req object to save memory when the handler has no concept of requests/responses.</description> + </item> + + <item> <title>cowboy_http(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_http/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4510,6 +5045,17 @@ Options opts() :: #{ connection_type =&gt; worker | supervisor, env =&gt </item> <item> + <title>cowboy_http(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_http/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_http/</guid> + <description>Name cowboy_http - HTTP/1.1 +Description The module cowboy_http implements HTTP/1.1 and HTTP/1.0 as a Ranch protocol. +Options opts() :: #{ chunked =&gt; boolean(), connection_type =&gt; worker | supervisor, http10_keepalive =&gt; boolean(), idle_timeout =&gt; timeout(), inactivity_timeout =&gt; timeout(), linger_timeout =&gt; timeout(), max_empty_lines =&gt; non_neg_integer(), max_header_name_length =&gt; non_neg_integer(), max_header_value_length =&gt; non_neg_integer(), max_headers =&gt; non_neg_integer(), max_keepalive =&gt; non_neg_integer(), max_method_length =&gt; non_neg_integer(), max_request_line_length =&gt; non_neg_integer(), max_skip_body_length =&gt; non_neg_integer(), proxy_header =&gt; boolean(), request_timeout =&gt; timeout(), sendfile =&gt; boolean(), stream_handlers =&gt; [module()] } Configuration for the HTTP/1.</description> + </item> + + <item> <title>cowboy_http2(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_http2/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4584,6 +5130,17 @@ Options opts() :: #{ connection_type =&gt; worker | supervisor, enable_conne </item> <item> + <title>cowboy_http2(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_http2/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_http2/</guid> + <description>Name cowboy_http2 - HTTP/2 +Description The module cowboy_http2 implements HTTP/2 as a Ranch protocol. +Options opts() :: #{ connection_type =&gt; worker | supervisor, enable_connect_protocol =&gt; boolean(), idle_timeout =&gt; timeout(), inactivity_timeout =&gt; timeout(), initial_connection_window_size =&gt; 65535..16#7fffffff, initial_stream_window_size =&gt; 0..16#7fffffff, max_concurrent_streams =&gt; non_neg_integer() | infinity, max_decode_table_size =&gt; non_neg_integer(), max_encode_table_size =&gt; non_neg_integer(), max_frame_size_received =&gt; 16384..16777215, max_frame_size_sent =&gt; 16384..16777215 | infinity, preface_timeout =&gt; timeout(), proxy_header =&gt; boolean(), sendfile =&gt; boolean(), settings_timeout =&gt; timeout(), stream_handlers =&gt; [module()] } Configuration for the HTTP/2 protocol.</description> + </item> + + <item> <title>cowboy_loop(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_loop/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4662,6 +5219,19 @@ Loop until receiving a specific message, then send a response and stop execution </item> <item> + <title>cowboy_loop(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_loop/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_loop/</guid> + <description>Name cowboy_loop - Loop handlers +Description The module cowboy_loop defines a callback interface for long running HTTP connections. +You should switch to this behavior for long polling, server-sent events and similar long-running requests. +There are generally two usage patterns: +Loop until receiving a specific message, then send a response and stop execution (for example long polling); Or initiate a response in init/2 and stream the body in info/3 as necessary (for example server-sent events).</description> + </item> + + <item> <title>cowboy_middleware(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_middleware/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4740,6 +5310,19 @@ execute(Req, Env) -&gt; {ok, Req, Env} | {suspend, module(), atom(), [any()] </item> <item> + <title>cowboy_middleware(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_middleware/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_middleware/</guid> + <description>Name cowboy_middleware - Middlewares +Description The module cowboy_middleware defines a callback interface for Cowboy middlewares. +Middlewares process the request sequentially in the order they are configured. +Callbacks Middlewares implement the following interface: +execute(Req, Env) -&gt; {ok, Req, Env} | {suspend, module(), atom(), [any()]} | {stop, Req} Req :: cowboy_req:req() Env :: cowboy_middleware:env() The execute/2 is the only callback that needs to be implemented. It must execute the middleware and return with instructions for Cowboy.</description> + </item> + + <item> <title>cowboy_req(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4812,6 +5395,18 @@ Type Name pattern Return type access no verb, parse_*, match_* Value question h </item> <item> + <title>cowboy_req(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req/</guid> + <description>Name cowboy_req - HTTP request and response +Description The module cowboy_req provides functions to access, manipulate and respond to requests. +There are four types of functions in this module. They can be differentiated by their name and their return type: +Type Name pattern Return type access no verb, parse_*, match_* Value question has_* boolean() modification set_* Req action any other verb ok | {Result, Value, Req} Any Req returned must be used in place of the one passed as argument.</description> + </item> + + <item> <title>cowboy_req:binding(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.binding/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4896,6 +5491,20 @@ Arguments Name Desired binding name as an atom. </item> <item> + <title>cowboy_req:binding(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.binding/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.binding/</guid> + <description>Name cowboy_req:binding - Access a value bound from the route +Description binding(Name, Req) -&gt; binding(Name, Req, undefined) binding(Name, Req, Default) -&gt; any() | Default Name :: atom() Req :: cowboy_req:req() Default :: any() Return the value for the given binding. +Arguments Name Desired binding name as an atom. + Req The Req object. + Default Default value returned when the binding is missing. + Return value By default the value is a case sensitive binary string, however constraints may change the type of this value (for example automatically converting numbers to integer).</description> + </item> + + <item> <title>cowboy_req:bindings(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.bindings/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4974,6 +5583,19 @@ Changelog 2.0: Only the values are returned, they are no longer wrapped in a tup </item> <item> + <title>cowboy_req:bindings(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.bindings/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.bindings/</guid> + <description>Name cowboy_req:bindings - Access all values bound from the route +Description bindings(Req :: cowboy_req:req()) -&gt; cowboy_router:bindings() Return a map containing all bindings. +Arguments Req The Req object. + Return value By default values are case sensitive binary strings, however constraints may change the type of this value (for example automatically converting numbers to integer). +Changelog 2.0: Only the values are returned, they are no longer wrapped in a tuple.</description> + </item> + + <item> <title>cowboy_req:body_length(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.body_length/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5052,6 +5674,19 @@ Arguments Req The Req object. </item> <item> + <title>cowboy_req:body_length(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.body_length/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.body_length/</guid> + <description>Name cowboy_req:body_length - Body length +Description body_length(Req :: cowboy_req:req()) -&gt; undefined | non_neg_integer() Return the length of the request body. +The length is not always known before reading the body. In those cases Cowboy will return undefined. The body length is available after the body has been fully read. +Arguments Req The Req object. + Return value The length of the request body, or undefined if it is not known.</description> + </item> + + <item> <title>cowboy_req:cert(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.1/manual/cowboy_req.cert/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5112,6 +5747,18 @@ Using the default configuration this function will always return undefined. You </item> <item> + <title>cowboy_req:cert(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.cert/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.cert/</guid> + <description>Name cowboy_req:cert - Client TLS certificate +Description cert(Req :: cowboy_req:req()) -&gt; binary() | undefined Return the peer&apos;s TLS certificate. +Using the default configuration this function will always return undefined. You need to explicitly configure Cowboy to request the client certificate. To do this you need to set the verify transport option to verify_peer: +{ok, _} = cowboy:start_tls(example, [ {port, 8443}, {cert, "path/to/cert.pem"}, {verify, verify_peer} ], #{ env =&gt; #{dispatch =&gt; Dispatch} }).</description> + </item> + + <item> <title>cowboy_req:delete_resp_header(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.delete_resp_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5196,6 +5843,20 @@ Arguments Name Header name as a lowercase binary string. </item> <item> + <title>cowboy_req:delete_resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.delete_resp_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.delete_resp_header/</guid> + <description>Name cowboy_req:delete_resp_header - Delete a response header +Description delete_resp_header(Name, Req :: cowboy_req:req()) -&gt; Req Name :: binary() %% lowercase; case insensitive Delete the given response header. +The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. +Arguments Name Header name as a lowercase binary string. + Req The Req object. + Return value A new Req object is returned.</description> + </item> + + <item> <title>cowboy_req:has_body(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.has_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5274,6 +5935,19 @@ Changelog 1.0: Function introduced. Examples Ensure the request has a body tru </item> <item> + <title>cowboy_req:has_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.has_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.has_body/</guid> + <description>Name cowboy_req:has_body - Is there a request body? +Description has_body(Req :: cowboy_req:req()) -&gt; boolean() Return whether the request has a body. +Arguments Req The Req object. + Return value A boolean indicating whether the request has a body. +Changelog 1.0: Function introduced. Examples Ensure the request has a body true = cowboy_req:has_body(Req). See also cowboy_req(3), cowboy_req:body_length(3), cowboy_req:read_body(3), cowboy_req:read_urlencoded_body(3), cowboy_req:read_part(3), cowboy_req:read_part_body(3)</description> + </item> + + <item> <title>cowboy_req:has_resp_body(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.has_resp_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5358,6 +6032,20 @@ Changelog 1.0: Function introduced. Examples Check whether a body has been set </item> <item> + <title>cowboy_req:has_resp_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.has_resp_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.has_resp_body/</guid> + <description>Name cowboy_req:has_resp_body - Is there a response body? +Description has_resp_body(Req :: cowboy_req:req()) -&gt; boolean() Return whether a response body has been set. +Arguments Req The Req object. + Return value A boolean indicating whether a response body has been set. +This function will return false when an empty response body has been set. +Changelog 1.0: Function introduced. Examples Check whether a body has been set false = cowboy_req:has_resp_body(Req0), Req1 = cowboy_req:set_resp_body(&lt;&lt;"</description> + </item> + + <item> <title>cowboy_req:has_resp_header(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.has_resp_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5430,6 +6118,18 @@ Arguments Name Header name as a lowercase binary string.</description> </item> <item> + <title>cowboy_req:has_resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.has_resp_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.has_resp_header/</guid> + <description>Name cowboy_req:has_resp_header - Is the given response header set? +Description has_resp_header(Name, Req :: cowboy_req:req()) -&gt; boolean() Name :: binary() %% lowercase; case insensitive Return whether the given response header has been set. +The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. +Arguments Name Header name as a lowercase binary string.</description> + </item> + + <item> <title>cowboy_req:header(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5502,6 +6202,18 @@ Headers can also be obtained using pattern matching:</description> </item> <item> + <title>cowboy_req:header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.header/</guid> + <description>Name cowboy_req:header - HTTP header +Description header(Name, Req) -&gt; header(Name, Req, undefined) header(Name, Req, Default) -&gt; binary() | Default Name :: binary() %% lowercase; case insensitive Req :: cowboy_req:req() Default :: any() Return the value for the given HTTP header. +The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. +Headers can also be obtained using pattern matching:</description> + </item> + + <item> <title>cowboy_req:headers(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.headers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5586,6 +6298,20 @@ Changelog 2.0: Only the headers are returned, they are no longer wrapped in a tu </item> <item> + <title>cowboy_req:headers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.headers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.headers/</guid> + <description>Name cowboy_req:headers - HTTP headers +Description headers(Req :: cowboy_req:req()) -&gt; cowboy:http_headers() Return all request headers. +Request headers can also be obtained using pattern matching: +#{headers := Headers} = Req. Arguments Req The Req object. + Return value Headers are returned as a map with keys being lowercase binary strings, and values as binary strings. +Changelog 2.0: Only the headers are returned, they are no longer wrapped in a tuple.</description> + </item> + + <item> <title>cowboy_req:host(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.host/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5670,6 +6396,20 @@ Changelog 2.0: Only the host name is returned, it is no longer wrapped in a tupl </item> <item> + <title>cowboy_req:host(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.host/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.host/</guid> + <description>Name cowboy_req:host - URI host name +Description host(Req :: cowboy_req:req()) -&gt; Host :: binary() Return the host name of the effective request URI. +The host name can also be obtained using pattern matching: +#{host := Host} = Req. Arguments Req The Req object. + Return value The host name is returned as a lowercase binary string. It is case insensitive. +Changelog 2.0: Only the host name is returned, it is no longer wrapped in a tuple.</description> + </item> + + <item> <title>cowboy_req:host_info(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.host_info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5754,6 +6494,20 @@ Changelog 2.0: Only the tokens are returned, they are no longer wrapped in a tup </item> <item> + <title>cowboy_req:host_info(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.host_info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.host_info/</guid> + <description>Name cowboy_req:host_info - Access the route&apos;s heading host segments +Description host_info(Req :: cowboy_req:req()) -&gt; cowboy_router:tokens() Return the tokens for the heading host segments. +This is the part of the host name that was matched using the ... notation. +Arguments Req The Req object. + Return value The tokens are returned as a list of case insensitive binary strings. +Changelog 2.0: Only the tokens are returned, they are no longer wrapped in a tuple.</description> + </item> + + <item> <title>cowboy_req:inform(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.1/manual/cowboy_req.inform/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5814,6 +6568,18 @@ Any number of informational responses can be sent as long as they are sent befor </item> <item> + <title>cowboy_req:inform(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.inform/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.inform/</guid> + <description>Name cowboy_req:inform - Send an informational response +Description inform(Status, Req :: cowboy_req:req()) -&gt; inform(StatusCode, #{}, Req) inform(Status, Headers, Req :: cowboy_req:req()) -&gt; ok Status :: cowboy:http_status() Headers :: cowboy:http_headers() Send an informational response. +Informational responses use a status code between 100 and 199. They cannot include a body. This function will not use any of the previously set headers. All headers to be sent must be given directly. +Any number of informational responses can be sent as long as they are sent before the proper response.</description> + </item> + + <item> <title>cowboy_req:match_cookies(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.match_cookies/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5880,6 +6646,17 @@ Cowboy will only return the cookie values specified in the fields list, and igno </item> <item> + <title>cowboy_req:match_cookies(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.match_cookies/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.match_cookies/</guid> + <description>Name cowboy_req:match_cookies - Match cookies against constraints +Description match_cookies(Fields :: cowboy:fields(), Req :: cowboy_req:req()) -&gt; #{atom() =&gt; any()} Parse the cookies and match specific values against constraints. +Cowboy will only return the cookie values specified in the fields list, and ignore all others. Fields can be either the name of the cookie requested; the name along with a list of constraints; or the name, a list of constraints and a default value in case the cookie is missing.</description> + </item> + + <item> <title>cowboy_req:match_qs(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.match_qs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5946,6 +6723,17 @@ Cowboy will only return the query string values specified in the fields list, an </item> <item> + <title>cowboy_req:match_qs(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.match_qs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.match_qs/</guid> + <description>Name cowboy_req:match_qs - Match the query string against constraints +Description match_qs(Fields :: cowboy:fields(), Req :: cowboy_req:req()) -&gt; #{atom() =&gt; any()} Parse the query string and match specific values against constraints. +Cowboy will only return the query string values specified in the fields list, and ignore all others. Fields can be either the key requested; the key along with a list of constraints; or the key, a list of constraints and a default value in case the key is missing.</description> + </item> + + <item> <title>cowboy_req:method(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.method/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6030,6 +6818,20 @@ Changelog 2.0: Only the method is returned, it is no longer wrapped in a tuple.< </item> <item> + <title>cowboy_req:method(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.method/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.method/</guid> + <description>Name cowboy_req:method - HTTP method +Description method(Req :: cowboy_req:req()) -&gt; Method :: binary() Return the request&apos;s HTTP method. +The method can also be obtained using pattern matching: +#{method := Method} = Req. Arguments Req The Req object. + Return value The request&apos;s HTTP method is returned as a binary string. While methods are case sensitive, standard methods are always uppercase. +Changelog 2.0: Only the method is returned, it is no longer wrapped in a tuple.</description> + </item> + + <item> <title>cowboy_req:parse_cookies(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.parse_cookies/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6120,6 +6922,21 @@ Arguments Req The Req object. </item> <item> + <title>cowboy_req:parse_cookies(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.parse_cookies/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.parse_cookies/</guid> + <description>Name cowboy_req:parse_cookies - Parse cookie headers +Description parse_cookies(Req) -&gt; [{Name, Value}] Name :: binary() %% case sensitive Value :: binary() %% case sensitive Parse cookie headers. +Alias for cowboy_req:parse_header(&lt;&lt;&quot;cookie&quot;&gt;&gt;, Req). +When the cookie header is missing, [] is returned. +While an empty cookie header is not valid, some clients do send it. Cowboy will in this case also return []. +Arguments Req The Req object. + Return value The cookies are returned as a list of key/values.</description> + </item> + + <item> <title>cowboy_req:parse_header(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.parse_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6192,6 +7009,18 @@ The type of the parsed value varies depending on the header.</description> </item> <item> + <title>cowboy_req:parse_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.parse_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.parse_header/</guid> + <description>Name cowboy_req:parse_header - Parse the given HTTP header +Description parse_header(Name, Req) -&gt; ParsedValue | Default parse_header(Name, Req, Default) -&gt; ParsedValue | Default Name :: binary() Req :: cowboy_req:req() ParsedValue :: any() Default :: any() Parse the given HTTP header. +The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. +The type of the parsed value varies depending on the header.</description> + </item> + + <item> <title>cowboy_req:parse_qs(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.parse_qs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6264,6 +7093,18 @@ Arguments Req The Req object. </item> <item> + <title>cowboy_req:parse_qs(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.parse_qs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.parse_qs/</guid> + <description>Name cowboy_req:parse_qs - Parse the query string +Description parse_qs(Req :: cowboy_req:req()) -&gt; [{Key :: binary(), Value :: binary() | true}] Parse the query string as a list of key/value pairs. +Arguments Req The Req object. + Return value The parsed query string is returned as a list of key/value pairs. The key is a binary string. The value is either a binary string, or the atom true. Both key and value are case sensitive.</description> + </item> + + <item> <title>cowboy_req:path(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.path/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6348,6 +7189,20 @@ Changelog 2.0: Only the path is returned, it is no longer wrapped in a tuple.</d </item> <item> + <title>cowboy_req:path(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.path/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.path/</guid> + <description>Name cowboy_req:path - URI path +Description path(Req :: cowboy_req:req()) -&gt; Path :: binary() Return the path of the effective request URI. +The path can also be obtained using pattern matching: +#{path := Path} = Req. Arguments Req The Req object. + Return value The path is returned as a binary string. It is case sensitive. +Changelog 2.0: Only the path is returned, it is no longer wrapped in a tuple.</description> + </item> + + <item> <title>cowboy_req:path_info(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.path_info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6432,6 +7287,20 @@ Changelog 2.0: Only the tokens are returned, they are no longer wrapped in a tup </item> <item> + <title>cowboy_req:path_info(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.path_info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.path_info/</guid> + <description>Name cowboy_req:path_info - Access the route&apos;s trailing path segments +Description path_info(Req :: cowboy_req:req()) -&gt; cowboy_router:tokens() Return the tokens for the trailing path segments. +This is the part of the host name that was matched using the ... notation. +Arguments Req The Req object. + Return value The tokens are returned as a list of case sensitive binary strings. +Changelog 2.0: Only the tokens are returned, they are no longer wrapped in a tuple.</description> + </item> + + <item> <title>cowboy_req:peer(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.peer/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6516,6 +7385,20 @@ The peer is not necessarily the client&apos;s IP address and port. It is the </item> <item> + <title>cowboy_req:peer(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.peer/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.peer/</guid> + <description>Name cowboy_req:peer - Peer address and port +Description peer(Req :: cowboy_req:req()) -&gt; Info Info :: {inet:ip_address(), inet:port_number()} Return the peer&apos;s IP address and port number. +The peer information can also be obtained using pattern matching: +#{peer := {IP, Port}} = Req. Arguments Req The Req object. + Return value The peer&apos;s IP address and port number. +The peer is not necessarily the client&apos;s IP address and port. It is the IP address of the endpoint connecting directly to the server, which may be a gateway or a proxy.</description> + </item> + + <item> <title>cowboy_req:port(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.port/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6594,6 +7477,19 @@ The port number can also be obtained using pattern matching: </item> <item> + <title>cowboy_req:port(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.port/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.port/</guid> + <description>Name cowboy_req:port - URI port number +Description port(Req :: cowboy_req:req()) -&gt; Port :: inet:port_number() Return the port number of the effective request URI. +Note that the port number returned by this function is obtained by parsing the host header. It may be different from the port the peer used to connect to Cowboy. +The port number can also be obtained using pattern matching: +#{port := Port} = Req. Arguments Req The Req object.</description> + </item> + + <item> <title>cowboy_req:push(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.push/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6660,6 +7556,17 @@ Cowboy handles push requests the same way as if they came from the client, inclu </item> <item> + <title>cowboy_req:push(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.push/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.push/</guid> + <description>Name cowboy_req:push - Push a resource to the client +Description push(Path, Headers, Req :: cowboy_req:req()) -&gt; push(Path, Headers, Req, #{}) push(Path, Headers, Req :: cowboy_req:req(), Opts) -&gt; ok Path :: iodata() %% case sensitive Headers :: cowboy:http_headers() Opts :: cowboy_req:push_opts() Push a resource to the client. +Cowboy handles push requests the same way as if they came from the client, including the creation of a request handling process, routing and middlewares and so on.</description> + </item> + + <item> <title>cowboy_req:qs(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.qs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6744,6 +7651,20 @@ Changelog 2.0: Only the query string is returned, it is no longer wrapped in a t </item> <item> + <title>cowboy_req:qs(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.qs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.qs/</guid> + <description>Name cowboy_req:qs - URI query string +Description qs(Req :: cowboy_req:req()) -&gt; Qs :: binary() Return the query string of the effective request URI. +The query string can also be obtained using pattern matching: +#{qs := Qs} = Req. Arguments Req The Req object. + Return value The query string is returned as a binary string. It is case sensitive. +Changelog 2.0: Only the query string is returned, it is no longer wrapped in a tuple.</description> + </item> + + <item> <title>cowboy_req:read_and_match_urlencoded_body(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.5/manual/cowboy_req.read_and_match_urlencoded_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6755,6 +7676,17 @@ This function reads the request body and parses it as application/x-www-form-url </item> <item> + <title>cowboy_req:read_and_match_urlencoded_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.read_and_match_urlencoded_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.read_and_match_urlencoded_body/</guid> + <description>Name cowboy_req:read_and_match_urlencoded_body - Read, parse and match a urlencoded request body against constraints +Description read_and_match_urlencoded_body(Fields, Req) -&gt; read_and_match_urlencoded_body(Fields, Req, #{}) read_and_match_urlencoded_body(Fields, Req, Opts) -&gt; {ok, Body, Req} Fields :: cowboy:fields() Req :: cowboy_req:req() Opts :: cowboy_req:read_body_opts() Body :: #{atom() =&gt; any()} Read, parse and match a urlencoded request body against constraints. +This function reads the request body and parses it as application/x-www-form-urlencoded. It then applies the given field constraints to the urlencoded data and returns the result as a map.</description> + </item> + + <item> <title>cowboy_req:read_body(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.read_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6821,6 +7753,17 @@ This function reads a chunk of the request body. A more tuple is returned when m </item> <item> + <title>cowboy_req:read_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.read_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.read_body/</guid> + <description>Name cowboy_req:read_body - Read the request body +Description read_body(Req :: cowboy_req:req()) -&gt; read_body(Req, #{}) read_body(Req :: cowboy_req:req(), Opts) -&gt; {ok, Data :: binary(), Req} | {more, Data :: binary(), Req} Opts :: cowboy_req:read_body_opts() Read the request body. +This function reads a chunk of the request body. A more tuple is returned when more data remains to be read. Call the function repeatedly until an ok tuple is returned to read the entire body.</description> + </item> + + <item> <title>cowboy_req:read_part(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.read_part/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6887,6 +7830,17 @@ This function reads the request body and parses it as multipart. Each parts of a </item> <item> + <title>cowboy_req:read_part(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.read_part/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.read_part/</guid> + <description>Name cowboy_req:read_part - Read the next multipart headers +Description read_part(Req :: cowboy_req:req()) -&gt; read_part(Req, #{}) read_part(Req :: cowboy_req:req(), Opts) -&gt; {ok, Headers, Req} | {done, Req} Opts :: cowboy_req:read_body_opts() Headers :: #{binary() =&gt; binary()} Read the next part of a multipart body. +This function reads the request body and parses it as multipart. Each parts of a multipart representation have their own headers and body. This function parses and returns headers.</description> + </item> + + <item> <title>cowboy_req:read_part_body(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.read_part_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6953,6 +7907,17 @@ This function reads the request body and parses it as multipart. Each parts of a </item> <item> + <title>cowboy_req:read_part_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.read_part_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.read_part_body/</guid> + <description>Name cowboy_req:read_part_body - Read the current part&apos;s body +Description read_part_body(Req :: cowboy_req:req()) -&gt; read_part_body(Req, #{}) read_part_body(Req :: cowboy_req:req(), Opts) -&gt; {ok, Data :: binary(), Req} | {more, Data :: binary(), Req} Opts :: cowboy_req:read_body_opts() Read the body of the current part of the multipart message. +This function reads the request body and parses it as multipart. Each parts of a multipart representation have their own headers and body. This function returns the body of the current part.</description> + </item> + + <item> <title>cowboy_req:read_urlencoded_body(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.read_urlencoded_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7025,6 +7990,18 @@ The urlencoded media type is used by Web browsers when submitting HTML forms usi </item> <item> + <title>cowboy_req:read_urlencoded_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.read_urlencoded_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.read_urlencoded_body/</guid> + <description>Name cowboy_req:read_urlencoded_body - Read and parse a urlencoded request body +Description read_urlencoded_body(Req :: cowboy_req:req()) -&gt; read_urlencoded_body(Req, #{}) read_urlencoded_body(Req :: cowboy_req:req(), Opts) -&gt; {ok, Body, Req} Opts :: cowboy_req:read_body_opts() Body :: [{Key :: binary(), Value :: binary() | true}] Read and parse a urlencoded request body. +This function reads the request body and parses it as application/x-www-form-urlencoded. It returns a list of key/values. +The urlencoded media type is used by Web browsers when submitting HTML forms using the POST method.</description> + </item> + + <item> <title>cowboy_req:reply(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.reply/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7091,6 +8068,17 @@ The header names must be given as lowercase binary strings. While header names a </item> <item> + <title>cowboy_req:reply(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.reply/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.reply/</guid> + <description>Name cowboy_req:reply - Send the response +Description reply(Status, Req :: cowboy_req:req()) -&gt; reply(StatusCode, #{}, Req) reply(Status, Headers, Req :: cowboy_req:req()) -&gt; Req reply(Status, Headers, Body, Req :: cowboy_req:req()) -&gt; Req Status :: cowboy:http_status() Headers :: cowboy:http_headers() Body :: cowboy_req:resp_body() Send the response. +The header names must be given as lowercase binary strings. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</description> + </item> + + <item> <title>cowboy_req:resp_header(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.resp_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7163,6 +8151,18 @@ The header name must be given as a lowercase binary string. While header names a </item> <item> + <title>cowboy_req:resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.resp_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.resp_header/</guid> + <description>Name cowboy_req:resp_header - Response header +Description resp_header(Name, Req) -&gt; resp_header(Name, Req, undefined) resp_header(Name, Req, Default) -&gt; binary() | Default Name :: binary() %% lowercase; case insensitive Req :: cowboy_req:req() Default :: any() Return the value for the given response header. +The response header must have been set previously using cowboy_req:set_resp_header(3) or cowboy_req:set_resp_headers(3). +The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</description> + </item> + + <item> <title>cowboy_req:resp_headers(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.resp_headers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7241,6 +8241,19 @@ Changelog 2.0: Function introduced. Examples Get all response headers Headers </item> <item> + <title>cowboy_req:resp_headers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.resp_headers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.resp_headers/</guid> + <description>Name cowboy_req:resp_headers - Response headers +Description resp_headers(Req :: cowboy_req:req()) -&gt; cowboy:http_headers() Return all response headers. +Arguments Req The Req object. + Return value Headers are returned as a map with keys being lowercase binary strings, and values as binary strings. +Changelog 2.0: Function introduced. Examples Get all response headers Headers = cowboy_req:resp_headers(Req). See also cowboy_req(3), cowboy_req:resp_header(3), cowboy_req:set_resp_header(3), cowboy_req:set_resp_headers(3)</description> + </item> + + <item> <title>cowboy_req:scheme(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.scheme/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7331,6 +8344,21 @@ Changelog 2.0: Function introduced.</description> </item> <item> + <title>cowboy_req:scheme(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.scheme/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.scheme/</guid> + <description>Name cowboy_req:scheme - URI scheme +Description scheme(Req :: cowboy_req:req()) -&gt; Scheme :: binary() Return the scheme of the effective request URI. +The scheme can also be obtained using pattern matching: +#{scheme := Scheme} = Req. Arguments Req The Req object. + Return value The scheme is returned as a binary. It is case insensitive. +Cowboy will only set the scheme to &lt;&lt;&quot;http&quot;&gt;&gt; or &lt;&lt;&quot;https&quot;&gt;&gt;. +Changelog 2.0: Function introduced.</description> + </item> + + <item> <title>cowboy_req:set_resp_body(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7403,6 +8431,18 @@ This function can also be used to remove a response body that was set previously </item> <item> + <title>cowboy_req:set_resp_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_body/</guid> + <description>Name cowboy_req:set_resp_body - Set the response body +Description set_resp_body(Body, Req :: cowboy_req:req()) -&gt; Req Body :: cowboy_req:resp_body() Set the response body. +The response body will be sent when a reply is initiated. Note that the functions stream_reply/2,3 and reply/4 will override the body set by this function. +This function can also be used to remove a response body that was set previously. To do so, simply call this function with an empty body.</description> + </item> + + <item> <title>cowboy_req:set_resp_cookie(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7487,6 +8527,20 @@ Arguments Name Cookie name. </item> <item> + <title>cowboy_req:set_resp_cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_cookie/</guid> + <description>Name cowboy_req:set_resp_cookie - Set a cookie +Description set_resp_cookie(Name, Value, Req :: cowboy_req:req()) -&gt; set_resp_cookie(Name, Value, [], Req) set_resp_cookie(Name, Value, Req :: cowboy_req:req(), Opts) -&gt; Req Name :: binary() %% case sensitive Value :: iodata() %% case sensitive Opts :: cow_cookie:cookie_opts() Set a cookie to be sent with the response. +Note that cookie names are case sensitive. +Arguments Name Cookie name. + Value Cookie value. + Req The Req object.</description> + </item> + + <item> <title>cowboy_req:set_resp_header(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7559,6 +8613,18 @@ Cowboy does not allow duplicate header names.</description> </item> <item> + <title>cowboy_req:set_resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_header/</guid> + <description>Name cowboy_req:set_resp_header - Set a response header +Description set_resp_header(Name, Value, Req :: cowboy_req:req()) -&gt; Req Name :: binary() %% lowercase; case insensitive Value :: iodata() %% case depends on header Set a header to be sent with the response. +The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. +Cowboy does not allow duplicate header names.</description> + </item> + + <item> <title>cowboy_req:set_resp_headers(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.set_resp_headers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7631,6 +8697,18 @@ Cowboy does not allow duplicate header names. Headers set by this function may b </item> <item> + <title>cowboy_req:set_resp_headers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_headers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_headers/</guid> + <description>Name cowboy_req:set_resp_headers - Set several response headers +Description set_resp_headers(Headers, Req :: cowboy_req:req()) -&gt; Req Headers :: cowboy:http_headers() Set several headers to be sent with the response. +The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. +Cowboy does not allow duplicate header names. Headers set by this function may be overwritten by those set from the reply functions.</description> + </item> + + <item> <title>cowboy_req:sock(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.1/manual/cowboy_req.sock/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7701,6 +8779,20 @@ Changelog 2.1: Function introduced. Examples Get the socket&apos;s IP addr </item> <item> + <title>cowboy_req:sock(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.sock/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.sock/</guid> + <description>Name cowboy_req:sock - Socket address and port +Description sock(Req :: cowboy_req:req()) -&gt; Info Info :: {inet:ip_address(), inet:port_number()} Return the socket&apos;s IP address and port number. +The socket information can also be obtained using pattern matching: +#{sock := {IP, Port}} = Req. Arguments Req The Req object. + Return value The socket&apos;s local IP address and port number. +Changelog 2.1: Function introduced. Examples Get the socket&apos;s IP address and port number.</description> + </item> + + <item> <title>cowboy_req:stream_body(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.stream_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7773,6 +8865,18 @@ The second argument indicates if this call is the final call. Use the nofin valu </item> <item> + <title>cowboy_req:stream_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.stream_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.stream_body/</guid> + <description>Name cowboy_req:stream_body - Stream the response body +Description stream_body(Data, IsFin, Req :: cowboy_req:req()) -&gt; ok Data :: cowboy_req:resp_body() IsFin :: fin | nofin Stream the response body. +This function may be called as many times as needed after initiating a response using the cowboy_req:stream_reply(3) function. +The second argument indicates if this call is the final call. Use the nofin value until you know no more data will be sent. The final call should use fin (possibly with an empty data value) or be a call to the cowboy_req:stream_trailers(3) function.</description> + </item> + + <item> <title>cowboy_req:stream_events(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.5/manual/cowboy_req.stream_events/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7784,6 +8888,17 @@ This function should only be used for text/event-stream responses when using ser </item> <item> + <title>cowboy_req:stream_events(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.stream_events/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.stream_events/</guid> + <description>Name cowboy_req:stream_events - Stream events +Description stream_events(Events, IsFin, Req :: cowboy_req:req()) -&gt; ok Events :: Event | [Event] IsFin :: fin | nofin Event :: #{ comment =&gt; iodata(), data =&gt; iodata(), event =&gt; iodata() | atom(), id =&gt; iodata(), retry =&gt; non_neg_integer() } Stream events. +This function should only be used for text/event-stream responses when using server-sent events. Cowboy will automatically encode the given events to their text representation.</description> + </item> + + <item> <title>cowboy_req:stream_reply(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.stream_reply/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7856,6 +8971,18 @@ Cowboy does not allow duplicate header names. Headers set by this function may o </item> <item> + <title>cowboy_req:stream_reply(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.stream_reply/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.stream_reply/</guid> + <description>Name cowboy_req:stream_reply - Send the response headers +Description stream_reply(Status, Req :: cowboy_req:req()) -&gt; stream_reply(StatusCode, #{}, Req) stream_reply(Status, Headers, Req :: cowboy_req:req()) -&gt; Req Status :: cowboy:http_status() Headers :: cowboy:http_headers() Send the response headers. +The header names must be given as lowercase binary strings. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. +Cowboy does not allow duplicate header names. Headers set by this function may overwrite those set by set_resp_header/3.</description> + </item> + + <item> <title>cowboy_req:stream_trailers(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.2/manual/cowboy_req.stream_trailers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7904,6 +9031,18 @@ You must list all field names sent in trailers in the trailer header, otherwise </item> <item> + <title>cowboy_req:stream_trailers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.stream_trailers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.stream_trailers/</guid> + <description>Name cowboy_req:stream_trailers - Send the response trailers +Description stream_trailers(Trailers, Req :: cowboy_req:req()) -&gt; ok Trailers :: cowboy:http_headers() Send the response trailers and terminate the stream. +This function can only be called once, after initiating a response using cowboy_req:stream_reply(3) and sending zero or more body chunks using cowboy_req:stream_body(3) with the nofin argument set. The function stream_trailers/2 implies fin and automatically terminate the response. +You must list all field names sent in trailers in the trailer header, otherwise they might be dropped by intermediaries or clients.</description> + </item> + + <item> <title>cowboy_req:uri(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.uri/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7970,6 +9109,17 @@ By default Cowboy will build a URI using the components found in the request.</d </item> <item> + <title>cowboy_req:uri(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.uri/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.uri/</guid> + <description>Name cowboy_req:uri - Reconstructed URI +Description uri(Req :: cowboy_req:req()) -&gt; uri(Req, #{}) uri(Req :: cowboy_req:req(), Opts) -&gt; URI :: iodata() Opts :: #{ scheme =&gt; iodata() | undefined, host =&gt; iodata() | undefined, port =&gt; inet:port_number() | undefined, path =&gt; iodata() | undefined, qs =&gt; iodata() | undefined, fragment =&gt; iodata() | undefined } Reconstruct the effective request URI, optionally modifying components. +By default Cowboy will build a URI using the components found in the request.</description> + </item> + + <item> <title>cowboy_req:version(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_req.version/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8054,6 +9204,20 @@ Changelog 2.0: Only the version is returned, it is no longer wrapped in a tuple. </item> <item> + <title>cowboy_req:version(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.version/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.version/</guid> + <description>Name cowboy_req:version - HTTP version +Description version(Req :: cowboy_req:req()) -&gt; Version :: cowboy:http_version() Return the HTTP version used for the request. +The version can also be obtained using pattern matching: +#{version := Version} = Req. Arguments Req The Req object. + Return value The HTTP version used for the request is returned as an atom. It is provided for informative purposes only. +Changelog 2.0: Only the version is returned, it is no longer wrapped in a tuple.</description> + </item> + + <item> <title>cowboy_rest(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_rest/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8132,6 +9296,19 @@ init(Req, State) -&gt; {cowboy_rest, Req, State} Callback(Req, State) -& </item> <item> + <title>cowboy_rest(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_rest/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_rest/</guid> + <description>Name cowboy_rest - REST handlers +Description The module cowboy_rest implements the HTTP state machine. +Implementing REST handlers is not enough to provide a REST interface; this interface must also follow the REST constraints including HATEOAS (hypermedia as the engine of application state). +Callbacks REST handlers implement the following interface: +init(Req, State) -&gt; {cowboy_rest, Req, State} Callback(Req, State) -&gt; {Result, Req, State} | {stop, Req, State} | {{switch_handler, Module}, Req, State} | {{switch_handler, Module, Opts}, Req, State} terminate(Reason, Req, State) -&gt; ok %% optional Req :: cowboy_req:req() State :: any() Module :: module() Opts :: any() Reason :: normal | {crash, error | exit | throw, any()} Callback - see below Result - see below Default - see below The init/2 callback is common to all handlers.</description> + </item> + + <item> <title>cowboy_router(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_router/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8210,6 +9387,19 @@ The router will stop execution when no route matches.</description> </item> <item> + <title>cowboy_router(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_router/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_router/</guid> + <description>Name cowboy_router - Router middleware +Description The cowboy_router middleware maps the requested host and path to the handler to be used for processing the request. +The router takes the dispatch rules as input from the middleware environment. Dispatch rules are generated by calling the cowboy_router:compile(3) function. +When a route matches, the router sets the handler and handler_opts middleware environment values containing the handler module and initial state, respectively. +The router will stop execution when no route matches.</description> + </item> + + <item> <title>cowboy_router:compile(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_router.compile/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8294,6 +9484,20 @@ Changelog 1.0: Function introduced. Examples Compile routes and start a listen </item> <item> + <title>cowboy_router:compile(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_router.compile/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_router.compile/</guid> + <description>Name cowboy_router:compile - Compile routes to the resources +Description compile(cowboy_router:routes()) -&gt; cowboy_router:dispatch_rules() Compile routes to the resources. +Takes a human readable list of routes and transforms it into a form more efficient to process. +Arguments Routes Human readable list of routes. + Return value An opaque dispatch rules value is returned. This value must be given to Cowboy as a middleware environment value. +Changelog 1.0: Function introduced. Examples Compile routes and start a listener Dispatch = cowboy_router:compile([ {'_', [ {"</description> + </item> + + <item> <title>cowboy_static(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_static/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8366,6 +9570,18 @@ Options opts() :: {priv_file, App, Path} | {priv_file, App, Path, Extra} | {file </item> <item> + <title>cowboy_static(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_static/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_static/</guid> + <description>Name cowboy_static - Static file handler +Description The module cowboy_static implements file serving capabilities using the REST semantics provided by cowboy_rest. +The static file handler is a pre-written handler coming with Cowboy. To serve files, use it in your routes. +Options opts() :: {priv_file, App, Path} | {priv_file, App, Path, Extra} | {file, Path} | {file, Path, Extra} | {priv_dir, App, Path} | {priv_dir, App, Path, Extra} | {dir, Path} | {dir, Path, Extra} App :: atom() Path :: binary() | string() Extra :: [Charset | Etag | Mimetypes] Charset :: {charset, module(), function()} | {charset, binary()} Etag :: {etag, module(), function()} | {etag, false} Mimetypes :: {mimetypes, module(), function()} | {mimetypes, binary() | ParsedMime} ParsedMime :: {Type :: binary(), SubType :: binary(), Params} Params :: [{Key :: binary(), Value :: binary()}] Static handler configuration.</description> + </item> + + <item> <title>cowboy_stream(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_stream/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8444,6 +9660,31 @@ Extra care must be taken when implementing stream handlers to ensure compatibili </item> <item> + <title>cowboy_stream(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_stream/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_stream/</guid> + <description>Name cowboy_stream - Stream handlers +Description The module cowboy_stream defines a callback interface and a protocol for handling HTTP streams. +An HTTP request and its associated response is called a stream. A connection may have many streams. In HTTP/1.1 they are executed sequentially, while in HTTP/2 they are executed concurrently. +Cowboy calls the stream handler for nearly all events related to a stream. Exceptions vary depending on the protocol. +Extra care must be taken when implementing stream handlers to ensure compatibility.</description> + </item> + + <item> + <title>cowboy_stream_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_stream_h/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_stream_h/</guid> + <description>Name cowboy_stream_h - Default stream handler +Description The module cowboy_stream_h is Cowboy&apos;s default stream handler and defines much of its behavior. It is responsible for managing the request process, sending it the request body and translating its messages into commands that Cowboy understands. +Options opts() :: #{ env =&gt; cowboy_middleware:env(), middlewares =&gt; [module()], shutdown_timeout =&gt; timeout() } Configuration for the default stream handler. +The default value is given next to the option name:</description> + </item> + + <item> <title>cowboy_websocket(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy_websocket/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8516,6 +9757,18 @@ init(Req, State) -&gt; {cowboy_websocket, Req, State} | {cowboy_websocket, R </item> <item> + <title>cowboy_websocket(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_websocket/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_websocket/</guid> + <description>Name cowboy_websocket - Websocket +Description The module cowboy_websocket implements Websocket as a Ranch protocol. It also defines a callback interface for handling Websocket connections. +Callbacks Websocket handlers must implement the following callback interface: +init(Req, State) -&gt; {cowboy_websocket, Req, State} | {cowboy_websocket, Req, State, Opts} websocket_init(State) -&gt; CallResult %% optional websocket_handle(InFrame, State) -&gt; CallResult websocket_info(Info, State) -&gt; CallResult terminate(Reason, PartialReq, State) -&gt; ok %% optional Req :: cowboy_req:req() PartialReq :: map() State :: any() Opts :: cowboy_websocket:opts() InFrame :: ping | pong | {text | binary | ping | pong, binary()} OutFrame :: cow_ws:frame() %% see types below Info :: any() CallResult :: {ok, State} | {ok, State, hibernate} | {reply, OutFrame | [OutFrame], State} | {reply, OutFrame | [OutFrame], State, hibernate} | {stop, State} Reason :: normal | stop | timeout | remote | {remote, cow_ws:close_code(), binary()} | {error, badencoding | badframe | closed | atom()} | {crash, error | exit | throw, any()} The init/2 callback is common to all handlers.</description> + </item> + + <item> <title>gun(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
