diff options
| author | Loïc Hoguin <[email protected]> | 2024-03-14 16:23:56 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2024-03-14 16:23:56 +0100 |
| commit | 5e05fe8e7877ffd6bc473b77b8ca0a12ad26bd67 (patch) | |
| tree | cdfd7f160ae7cb2943b1e422140c25a2e8f00c4e | |
| parent | 2368dc53d0c724f1899aeb2874ba1a763e11f0b8 (diff) | |
| download | ninenines.eu-5e05fe8e7877ffd6bc473b77b8ca0a12ad26bd67.tar.gz ninenines.eu-5e05fe8e7877ffd6bc473b77b8ca0a12ad26bd67.tar.bz2 ninenines.eu-5e05fe8e7877ffd6bc473b77b8ca0a12ad26bd67.zip | |
Cowboy 2.12, Cowlib 2.13, Gun 2.1
1200 files changed, 73858 insertions, 11 deletions
diff --git a/_build/data/projects/cowboy.toml b/_build/data/projects/cowboy.toml index f3f06309..1b3c9abe 100644 --- a/_build/data/projects/cowboy.toml +++ b/_build/data/projects/cowboy.toml @@ -3,8 +3,8 @@ catchphrase = "Small, fast, modern HTTP server." description = "Cowboy is the ultimate server for the modern Web with support for Websocket, HTTP/2 and REST." name = "cowboy" repository = "https://github.com/ninenines/cowboy" -versions = ["2.11", "2.10", "2.9", "2.8", "2.7", "2.6"] -branches = ["2.11.0", "22adc4de517bf54661795f6e18b6b2e62aec4140", "2.9.0", "2.8.0", "2.7.0", "2.6.3"] +versions = ["2.12", "2.11", "2.10", "2.9", "2.8", "2.7", "2.6"] +branches = ["2.12.0", "2.11.0", "22adc4de517bf54661795f6e18b6b2e62aec4140", "2.9.0", "2.8.0", "2.7.0", "2.6.3"] has_source = true has_guide = true has_manual = true diff --git a/_build/data/projects/cowlib.toml b/_build/data/projects/cowlib.toml index 3f564675..8b555596 100644 --- a/_build/data/projects/cowlib.toml +++ b/_build/data/projects/cowlib.toml @@ -3,7 +3,7 @@ catchphrase = "Support library for the Web." description = "The Web toolbox for HTTP/1.1, HTTP/2, Websocket, Multipart, Cookies, URL encoding..." name = "cowlib" repository = "https://github.com/ninenines/cowlib" -versions = ["2.12", "2.11", "2.10", "2.9", "2.8"] -branches = ["2.12.1", "2.11.0", "2.10.1", "2.9.1", "2.8.0"] +versions = ["2.13", "2.12", "2.11", "2.10", "2.9", "2.8"] +branches = ["2.13.0", "2.12.1", "2.11.0", "2.10.1", "2.9.1", "2.8.0"] has_source = true has_manual = true diff --git a/_build/data/projects/gun.toml b/_build/data/projects/gun.toml index e6793fd0..4d292421 100644 --- a/_build/data/projects/gun.toml +++ b/_build/data/projects/gun.toml @@ -3,8 +3,8 @@ catchphrase = "The smoking gun of HTTP clients." description = "Asynchronous client with support for HTTP/1.1, HTTP/2, Websocket and more." name = "gun" repository = "https://github.com/ninenines/gun" -versions = ["2.0", "1.3", "1.2", "1.1", "1.0"] -branches = ["2.0.1", "1.3.1", "1.2.0", "1.1.0", "1.0.0"] +versions = ["2.1", "2.0", "1.3", "1.2", "1.1", "1.0"] +branches = ["2.1.0", "2.0.1", "1.3.1", "1.2.0", "1.1.0", "1.0.0"] has_source = true has_guide = true has_manual = true diff --git a/docs/en/cowboy/2.10/guide/constraints/index.html b/docs/en/cowboy/2.10/guide/constraints/index.html index 2ffb1d35..a404b028 100644 --- a/docs/en/cowboy/2.10/guide/constraints/index.html +++ b/docs/en/cowboy/2.10/guide/constraints/index.html @@ -197,6 +197,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/cookies/index.html b/docs/en/cowboy/2.10/guide/cookies/index.html index b0e37524..d39ec5c0 100644 --- a/docs/en/cowboy/2.10/guide/cookies/index.html +++ b/docs/en/cowboy/2.10/guide/cookies/index.html @@ -214,6 +214,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/erlang_web/index.html b/docs/en/cowboy/2.10/guide/erlang_web/index.html index c5a2d344..fc20b3eb 100644 --- a/docs/en/cowboy/2.10/guide/erlang_web/index.html +++ b/docs/en/cowboy/2.10/guide/erlang_web/index.html @@ -163,6 +163,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/flow_diagram/index.html b/docs/en/cowboy/2.10/guide/flow_diagram/index.html index feee5b47..b39f922f 100644 --- a/docs/en/cowboy/2.10/guide/flow_diagram/index.html +++ b/docs/en/cowboy/2.10/guide/flow_diagram/index.html @@ -141,6 +141,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/getting_started/index.html b/docs/en/cowboy/2.10/guide/getting_started/index.html index 5b45d1c7..02d95258 100644 --- a/docs/en/cowboy/2.10/guide/getting_started/index.html +++ b/docs/en/cowboy/2.10/guide/getting_started/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/handlers/index.html b/docs/en/cowboy/2.10/guide/handlers/index.html index 16bdb8b8..0ff8e179 100644 --- a/docs/en/cowboy/2.10/guide/handlers/index.html +++ b/docs/en/cowboy/2.10/guide/handlers/index.html @@ -168,6 +168,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/index.html b/docs/en/cowboy/2.10/guide/index.html index 2e686e4a..3aca4656 100644 --- a/docs/en/cowboy/2.10/guide/index.html +++ b/docs/en/cowboy/2.10/guide/index.html @@ -190,6 +190,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/introduction/index.html b/docs/en/cowboy/2.10/guide/introduction/index.html index f7f337e1..0d45310c 100644 --- a/docs/en/cowboy/2.10/guide/introduction/index.html +++ b/docs/en/cowboy/2.10/guide/introduction/index.html @@ -151,6 +151,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/listeners/index.html b/docs/en/cowboy/2.10/guide/listeners/index.html index 68aad931..500a1300 100644 --- a/docs/en/cowboy/2.10/guide/listeners/index.html +++ b/docs/en/cowboy/2.10/guide/listeners/index.html @@ -181,6 +181,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/loop_handlers/index.html b/docs/en/cowboy/2.10/guide/loop_handlers/index.html index 9791a068..b3b5df6e 100644 --- a/docs/en/cowboy/2.10/guide/loop_handlers/index.html +++ b/docs/en/cowboy/2.10/guide/loop_handlers/index.html @@ -182,6 +182,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/middlewares/index.html b/docs/en/cowboy/2.10/guide/middlewares/index.html index ffdd46bc..cd183159 100644 --- a/docs/en/cowboy/2.10/guide/middlewares/index.html +++ b/docs/en/cowboy/2.10/guide/middlewares/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/migrating_from_1.0/index.html b/docs/en/cowboy/2.10/guide/migrating_from_1.0/index.html index e2c70281..9726239b 100644 --- a/docs/en/cowboy/2.10/guide/migrating_from_1.0/index.html +++ b/docs/en/cowboy/2.10/guide/migrating_from_1.0/index.html @@ -231,6 +231,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/migrating_from_2.0/index.html b/docs/en/cowboy/2.10/guide/migrating_from_2.0/index.html index 9eb6ca15..b87a4424 100644 --- a/docs/en/cowboy/2.10/guide/migrating_from_2.0/index.html +++ b/docs/en/cowboy/2.10/guide/migrating_from_2.0/index.html @@ -166,6 +166,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/migrating_from_2.1/index.html b/docs/en/cowboy/2.10/guide/migrating_from_2.1/index.html index 4702f9b7..b32b9744 100644 --- a/docs/en/cowboy/2.10/guide/migrating_from_2.1/index.html +++ b/docs/en/cowboy/2.10/guide/migrating_from_2.1/index.html @@ -177,6 +177,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/migrating_from_2.2/index.html b/docs/en/cowboy/2.10/guide/migrating_from_2.2/index.html index 24b815ba..5550c09a 100644 --- a/docs/en/cowboy/2.10/guide/migrating_from_2.2/index.html +++ b/docs/en/cowboy/2.10/guide/migrating_from_2.2/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/migrating_from_2.3/index.html b/docs/en/cowboy/2.10/guide/migrating_from_2.3/index.html index 750ab454..5bde4def 100644 --- a/docs/en/cowboy/2.10/guide/migrating_from_2.3/index.html +++ b/docs/en/cowboy/2.10/guide/migrating_from_2.3/index.html @@ -151,6 +151,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/migrating_from_2.4/index.html b/docs/en/cowboy/2.10/guide/migrating_from_2.4/index.html index 85010625..e291dd04 100644 --- a/docs/en/cowboy/2.10/guide/migrating_from_2.4/index.html +++ b/docs/en/cowboy/2.10/guide/migrating_from_2.4/index.html @@ -179,6 +179,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/migrating_from_2.5/index.html b/docs/en/cowboy/2.10/guide/migrating_from_2.5/index.html index b9d10640..3b8b0fda 100644 --- a/docs/en/cowboy/2.10/guide/migrating_from_2.5/index.html +++ b/docs/en/cowboy/2.10/guide/migrating_from_2.5/index.html @@ -194,6 +194,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/migrating_from_2.6/index.html b/docs/en/cowboy/2.10/guide/migrating_from_2.6/index.html index e01d85f4..295f5f90 100644 --- a/docs/en/cowboy/2.10/guide/migrating_from_2.6/index.html +++ b/docs/en/cowboy/2.10/guide/migrating_from_2.6/index.html @@ -215,6 +215,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/migrating_from_2.7/index.html b/docs/en/cowboy/2.10/guide/migrating_from_2.7/index.html index ab97216a..c3b1dbda 100644 --- a/docs/en/cowboy/2.10/guide/migrating_from_2.7/index.html +++ b/docs/en/cowboy/2.10/guide/migrating_from_2.7/index.html @@ -171,6 +171,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/migrating_from_2.8/index.html b/docs/en/cowboy/2.10/guide/migrating_from_2.8/index.html index 3f6224f4..b6e64e86 100644 --- a/docs/en/cowboy/2.10/guide/migrating_from_2.8/index.html +++ b/docs/en/cowboy/2.10/guide/migrating_from_2.8/index.html @@ -142,6 +142,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/migrating_from_2.9/index.html b/docs/en/cowboy/2.10/guide/migrating_from_2.9/index.html index b91da2db..ff83d85f 100644 --- a/docs/en/cowboy/2.10/guide/migrating_from_2.9/index.html +++ b/docs/en/cowboy/2.10/guide/migrating_from_2.9/index.html @@ -146,6 +146,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/modern_web/index.html b/docs/en/cowboy/2.10/guide/modern_web/index.html index 7e9742d6..db0221dd 100644 --- a/docs/en/cowboy/2.10/guide/modern_web/index.html +++ b/docs/en/cowboy/2.10/guide/modern_web/index.html @@ -145,6 +145,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/multipart/index.html b/docs/en/cowboy/2.10/guide/multipart/index.html index 1f088ee1..9169e813 100644 --- a/docs/en/cowboy/2.10/guide/multipart/index.html +++ b/docs/en/cowboy/2.10/guide/multipart/index.html @@ -218,6 +218,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/performance/index.html b/docs/en/cowboy/2.10/guide/performance/index.html index f8d13d73..9f4a9fd1 100644 --- a/docs/en/cowboy/2.10/guide/performance/index.html +++ b/docs/en/cowboy/2.10/guide/performance/index.html @@ -123,6 +123,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/req/index.html b/docs/en/cowboy/2.10/guide/req/index.html index bcb06d5a..938973c6 100644 --- a/docs/en/cowboy/2.10/guide/req/index.html +++ b/docs/en/cowboy/2.10/guide/req/index.html @@ -393,6 +393,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/req_body/index.html b/docs/en/cowboy/2.10/guide/req_body/index.html index e956779e..1fa0c68b 100644 --- a/docs/en/cowboy/2.10/guide/req_body/index.html +++ b/docs/en/cowboy/2.10/guide/req_body/index.html @@ -204,6 +204,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/resource_design/index.html b/docs/en/cowboy/2.10/guide/resource_design/index.html index b5656125..de5b6bf0 100644 --- a/docs/en/cowboy/2.10/guide/resource_design/index.html +++ b/docs/en/cowboy/2.10/guide/resource_design/index.html @@ -178,6 +178,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/resp/index.html b/docs/en/cowboy/2.10/guide/resp/index.html index 7e67fa34..95f3db03 100644 --- a/docs/en/cowboy/2.10/guide/resp/index.html +++ b/docs/en/cowboy/2.10/guide/resp/index.html @@ -360,6 +360,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/rest_flowcharts/index.html b/docs/en/cowboy/2.10/guide/rest_flowcharts/index.html index 0b3860a7..27dabe45 100644 --- a/docs/en/cowboy/2.10/guide/rest_flowcharts/index.html +++ b/docs/en/cowboy/2.10/guide/rest_flowcharts/index.html @@ -175,6 +175,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/rest_handlers/index.html b/docs/en/cowboy/2.10/guide/rest_handlers/index.html index 301c89e9..439b6e9f 100644 --- a/docs/en/cowboy/2.10/guide/rest_handlers/index.html +++ b/docs/en/cowboy/2.10/guide/rest_handlers/index.html @@ -276,6 +276,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/rest_principles/index.html b/docs/en/cowboy/2.10/guide/rest_principles/index.html index fe32c8d4..265e870a 100644 --- a/docs/en/cowboy/2.10/guide/rest_principles/index.html +++ b/docs/en/cowboy/2.10/guide/rest_principles/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/routing/index.html b/docs/en/cowboy/2.10/guide/routing/index.html index b79f8d6c..5cbe1b87 100644 --- a/docs/en/cowboy/2.10/guide/routing/index.html +++ b/docs/en/cowboy/2.10/guide/routing/index.html @@ -326,6 +326,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/specs/index.html b/docs/en/cowboy/2.10/guide/specs/index.html index 50cab470..662161cc 100644 --- a/docs/en/cowboy/2.10/guide/specs/index.html +++ b/docs/en/cowboy/2.10/guide/specs/index.html @@ -496,6 +496,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/static_files/index.html b/docs/en/cowboy/2.10/guide/static_files/index.html index 7408f771..5cf7ab57 100644 --- a/docs/en/cowboy/2.10/guide/static_files/index.html +++ b/docs/en/cowboy/2.10/guide/static_files/index.html @@ -212,6 +212,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/streams/index.html b/docs/en/cowboy/2.10/guide/streams/index.html index 1202815f..d4b7d08b 100644 --- a/docs/en/cowboy/2.10/guide/streams/index.html +++ b/docs/en/cowboy/2.10/guide/streams/index.html @@ -136,6 +136,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/ws_handlers/index.html b/docs/en/cowboy/2.10/guide/ws_handlers/index.html index 875f597d..4463e108 100644 --- a/docs/en/cowboy/2.10/guide/ws_handlers/index.html +++ b/docs/en/cowboy/2.10/guide/ws_handlers/index.html @@ -301,6 +301,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/guide/ws_protocol/index.html b/docs/en/cowboy/2.10/guide/ws_protocol/index.html index 9cac330f..15d1894c 100644 --- a/docs/en/cowboy/2.10/guide/ws_protocol/index.html +++ b/docs/en/cowboy/2.10/guide/ws_protocol/index.html @@ -133,6 +133,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.10/manual/cowboy.set_env/index.html index bc5d66e4..7fc7c5d1 100644 --- a/docs/en/cowboy/2.10/manual/cowboy.set_env/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy.set_env/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy.start_clear/index.html b/docs/en/cowboy/2.10/manual/cowboy.start_clear/index.html index 38ae9012..704330ad 100644 --- a/docs/en/cowboy/2.10/manual/cowboy.start_clear/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy.start_clear/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy.start_tls/index.html b/docs/en/cowboy/2.10/manual/cowboy.start_tls/index.html index 4d907900..e0250a44 100644 --- a/docs/en/cowboy/2.10/manual/cowboy.start_tls/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy.start_tls/index.html @@ -171,6 +171,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy.stop_listener/index.html b/docs/en/cowboy/2.10/manual/cowboy.stop_listener/index.html index 08bced53..84fd3199 100644 --- a/docs/en/cowboy/2.10/manual/cowboy.stop_listener/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy.stop_listener/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy/index.html b/docs/en/cowboy/2.10/manual/cowboy/index.html index d1861a76..72617b9c 100644 --- a/docs/en/cowboy/2.10/manual/cowboy/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy/index.html @@ -165,6 +165,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_app/index.html b/docs/en/cowboy/2.10/manual/cowboy_app/index.html index b499db2f..55f9411a 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_app/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_app/index.html @@ -176,6 +176,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_compress_h/index.html b/docs/en/cowboy/2.10/manual/cowboy_compress_h/index.html index 9ae6db7b..49263eb7 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_compress_h/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_compress_h/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_constraints.int/index.html b/docs/en/cowboy/2.10/manual/cowboy_constraints.int/index.html index 91d6aab2..e67d1316 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_constraints.int/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_constraints.int/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_constraints.nonempty/index.html b/docs/en/cowboy/2.10/manual/cowboy_constraints.nonempty/index.html index a69102e4..df383007 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_constraints.nonempty/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_constraints.nonempty/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_constraints/index.html b/docs/en/cowboy/2.10/manual/cowboy_constraints/index.html index 3b5330d1..8da8569d 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_constraints/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_constraints/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_handler.terminate/index.html b/docs/en/cowboy/2.10/manual/cowboy_handler.terminate/index.html index 7b9559a1..382b45ba 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_handler.terminate/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_handler.terminate/index.html @@ -143,6 +143,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_handler/index.html b/docs/en/cowboy/2.10/manual/cowboy_handler/index.html index 4c9fb8b0..ac176d16 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_handler/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_handler/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_http/index.html b/docs/en/cowboy/2.10/manual/cowboy_http/index.html index 56696d51..397aa8bb 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_http/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_http/index.html @@ -235,6 +235,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_http2/index.html b/docs/en/cowboy/2.10/manual/cowboy_http2/index.html index 39b54125..bd50fb4f 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_http2/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_http2/index.html @@ -269,6 +269,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_loop/index.html b/docs/en/cowboy/2.10/manual/cowboy_loop/index.html index 75581e89..c350c66a 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_loop/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_loop/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_metrics_h/index.html b/docs/en/cowboy/2.10/manual/cowboy_metrics_h/index.html index cebd7bec..d6187da8 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_metrics_h/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_metrics_h/index.html @@ -226,6 +226,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.10/manual/cowboy_middleware/index.html index d83565bc..97cb1ad1 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_middleware/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_middleware/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.binding/index.html index d3366e63..9f601046 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.binding/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.binding/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.bindings/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.bindings/index.html index 28db413a..f2e02d97 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.bindings/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.bindings/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.body_length/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.body_length/index.html index c1117aca..48bf6fec 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.body_length/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.body_length/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.cast/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.cast/index.html index 7be3700d..21b030ec 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.cast/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.cast/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.cert/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.cert/index.html index 4076bb04..ea9c46cb 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.cert/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.cert/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.delete_resp_header/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.delete_resp_header/index.html index 130e1727..d9f1d87c 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.delete_resp_header/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.delete_resp_header/index.html @@ -134,6 +134,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.filter_cookies/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.filter_cookies/index.html index 09d70c47..f035224b 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.filter_cookies/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.filter_cookies/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.has_body/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.has_body/index.html index 901b9d05..0d27179c 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.has_body/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.has_body/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.has_resp_body/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.has_resp_body/index.html index faf875bd..72c47676 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.has_resp_body/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.has_resp_body/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.has_resp_header/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.has_resp_header/index.html index 9d0dfa5a..e585a207 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.has_resp_header/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.has_resp_header/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.header/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.header/index.html index bc79ab44..cd1a5c75 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.header/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.header/index.html @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.headers/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.headers/index.html index febde358..bd8fd528 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.headers/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.headers/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.host/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.host/index.html index 2309f002..a2fa2679 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.host/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.host/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.host_info/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.host_info/index.html index f06eea60..adad4eae 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.host_info/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.host_info/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.inform/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.inform/index.html index fd21e30b..8ee8f5a5 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.inform/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.inform/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.match_cookies/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.match_cookies/index.html index 184975f3..0f8c3e5d 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.match_cookies/index.html +++ b/docs/en/cowboy/2.10/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.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.match_qs/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.match_qs/index.html index 0efe9c89..d7de6c68 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.match_qs/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.match_qs/index.html @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.method/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.method/index.html index 34fb09c0..5597cd17 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.method/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.method/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.parse_cookies/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.parse_cookies/index.html index c3f9cfce..8d574d99 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.parse_cookies/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.parse_cookies/index.html @@ -155,6 +155,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.parse_header/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.parse_header/index.html index 124d28cb..9f9e34c5 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.parse_header/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.parse_header/index.html @@ -363,6 +363,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.parse_qs/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.parse_qs/index.html index 50840b54..e9ab7c08 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.parse_qs/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.parse_qs/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.path/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.path/index.html index 779f1a38..c9cec7b8 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.path/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.path/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.path_info/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.path_info/index.html index 4a9eb195..32804165 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.path_info/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.path_info/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.peer/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.peer/index.html index c8e76fac..5b0c5122 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.peer/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.peer/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.port/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.port/index.html index 106f3d34..e699ff73 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.port/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.port/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.push/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.push/index.html index f3f18901..f835d94e 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.push/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.push/index.html @@ -163,6 +163,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.qs/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.qs/index.html index 313a3125..e89f5e69 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.qs/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.qs/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.read_and_match_urlencoded_body/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.read_and_match_urlencoded_body/index.html index 92657b3d..a2a222cc 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.read_and_match_urlencoded_body/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.read_and_match_urlencoded_body/index.html @@ -187,6 +187,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.read_body/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.read_body/index.html index 1f42573f..66f9987b 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.read_body/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.read_body/index.html @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.read_part/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.read_part/index.html index 8949f18c..907fbf97 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.read_part/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.read_part/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.read_part_body/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.read_part_body/index.html index b5869c54..acfedb29 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.read_part_body/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.read_part_body/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.read_urlencoded_body/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.read_urlencoded_body/index.html index a4acf6df..655d6152 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.read_urlencoded_body/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.read_urlencoded_body/index.html @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.reply/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.reply/index.html index bf4e48a2..c184ff89 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.reply/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.reply/index.html @@ -175,6 +175,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.resp_header/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.resp_header/index.html index 6c73584f..56e5dbee 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.resp_header/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.resp_header/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.resp_headers/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.resp_headers/index.html index 319efa3f..f3335540 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.resp_headers/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.resp_headers/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.scheme/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.scheme/index.html index 15f7b0b0..bb1176b0 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.scheme/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.scheme/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_body/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_body/index.html index ce40d4e1..d39e1e59 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_body/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_body/index.html @@ -168,6 +168,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_cookie/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_cookie/index.html index ab3c55d2..fe39a811 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_cookie/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_cookie/index.html @@ -193,6 +193,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_header/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_header/index.html index 5374aac9..e5843c37 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_header/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_header/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_headers/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_headers/index.html index 2e389c3a..3b49559f 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_headers/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.set_resp_headers/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.sock/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.sock/index.html index 604dba68..8621643f 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.sock/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.sock/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.stream_body/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.stream_body/index.html index aeee0117..cabe21eb 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.stream_body/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.stream_body/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.stream_events/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.stream_events/index.html index db0f8436..37246049 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.stream_events/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.stream_events/index.html @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.stream_reply/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.stream_reply/index.html index f51ea304..f8384470 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.stream_reply/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.stream_reply/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.stream_trailers/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.stream_trailers/index.html index 4149f5cc..4f28f2b3 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.stream_trailers/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.stream_trailers/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.uri/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.uri/index.html index 74195394..0c8140a1 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.uri/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.uri/index.html @@ -195,6 +195,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req.version/index.html b/docs/en/cowboy/2.10/manual/cowboy_req.version/index.html index bc9d1f78..162df535 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req.version/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req.version/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_req/index.html b/docs/en/cowboy/2.10/manual/cowboy_req/index.html index 37d85868..dde7056c 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_req/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_req/index.html @@ -317,6 +317,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_rest/index.html b/docs/en/cowboy/2.10/manual/cowboy_rest/index.html index 8f42a081..d2dd636a 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_rest/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_rest/index.html @@ -601,6 +601,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_router.compile/index.html b/docs/en/cowboy/2.10/manual/cowboy_router.compile/index.html index 44770cf0..15325b9a 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_router.compile/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_router.compile/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_router/index.html b/docs/en/cowboy/2.10/manual/cowboy_router/index.html index 52105d6e..4a24a3b1 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_router/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_router/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_static/index.html b/docs/en/cowboy/2.10/manual/cowboy_static/index.html index ba79ec9e..28375d4a 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_static/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_static/index.html @@ -212,6 +212,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_stream/index.html b/docs/en/cowboy/2.10/manual/cowboy_stream/index.html index 30340861..4e8d253e 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_stream/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_stream/index.html @@ -372,6 +372,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_stream_h/index.html b/docs/en/cowboy/2.10/manual/cowboy_stream_h/index.html index 874d5046..8610e4ee 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_stream_h/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_stream_h/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_tracer_h/index.html b/docs/en/cowboy/2.10/manual/cowboy_tracer_h/index.html index 5e30b8cb..9701cc85 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_tracer_h/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_tracer_h/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/cowboy_websocket/index.html b/docs/en/cowboy/2.10/manual/cowboy_websocket/index.html index fbf32ffc..667cbc21 100644 --- a/docs/en/cowboy/2.10/manual/cowboy_websocket/index.html +++ b/docs/en/cowboy/2.10/manual/cowboy_websocket/index.html @@ -297,6 +297,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/http_status_codes/index.html b/docs/en/cowboy/2.10/manual/http_status_codes/index.html index 4cec0a38..0442e089 100644 --- a/docs/en/cowboy/2.10/manual/http_status_codes/index.html +++ b/docs/en/cowboy/2.10/manual/http_status_codes/index.html @@ -181,6 +181,8 @@ + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.10/manual/index.html b/docs/en/cowboy/2.10/manual/index.html index 4e89181a..bfc0fed7 100644 --- a/docs/en/cowboy/2.10/manual/index.html +++ b/docs/en/cowboy/2.10/manual/index.html @@ -176,6 +176,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/constraints/index.html b/docs/en/cowboy/2.11/guide/constraints/index.html index 37df881f..c4d843f4 100644 --- a/docs/en/cowboy/2.11/guide/constraints/index.html +++ b/docs/en/cowboy/2.11/guide/constraints/index.html @@ -197,6 +197,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/cookies/index.html b/docs/en/cowboy/2.11/guide/cookies/index.html index 92466c2d..7785b19d 100644 --- a/docs/en/cowboy/2.11/guide/cookies/index.html +++ b/docs/en/cowboy/2.11/guide/cookies/index.html @@ -214,6 +214,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/erlang_web/index.html b/docs/en/cowboy/2.11/guide/erlang_web/index.html index 88ed292e..3addff5b 100644 --- a/docs/en/cowboy/2.11/guide/erlang_web/index.html +++ b/docs/en/cowboy/2.11/guide/erlang_web/index.html @@ -163,6 +163,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/flow_diagram/index.html b/docs/en/cowboy/2.11/guide/flow_diagram/index.html index 87eba7d9..d91bb942 100644 --- a/docs/en/cowboy/2.11/guide/flow_diagram/index.html +++ b/docs/en/cowboy/2.11/guide/flow_diagram/index.html @@ -141,6 +141,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/getting_started/index.html b/docs/en/cowboy/2.11/guide/getting_started/index.html index f021a711..e3b89280 100644 --- a/docs/en/cowboy/2.11/guide/getting_started/index.html +++ b/docs/en/cowboy/2.11/guide/getting_started/index.html @@ -218,6 +218,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/handlers/index.html b/docs/en/cowboy/2.11/guide/handlers/index.html index 2789334b..66ae82b6 100644 --- a/docs/en/cowboy/2.11/guide/handlers/index.html +++ b/docs/en/cowboy/2.11/guide/handlers/index.html @@ -168,6 +168,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/index.html b/docs/en/cowboy/2.11/guide/index.html index 4f4316a5..611957c4 100644 --- a/docs/en/cowboy/2.11/guide/index.html +++ b/docs/en/cowboy/2.11/guide/index.html @@ -192,6 +192,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/introduction/index.html b/docs/en/cowboy/2.11/guide/introduction/index.html index eaab1d63..f96668d9 100644 --- a/docs/en/cowboy/2.11/guide/introduction/index.html +++ b/docs/en/cowboy/2.11/guide/introduction/index.html @@ -151,6 +151,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/listeners/index.html b/docs/en/cowboy/2.11/guide/listeners/index.html index 30ba1fc0..42fff0f0 100644 --- a/docs/en/cowboy/2.11/guide/listeners/index.html +++ b/docs/en/cowboy/2.11/guide/listeners/index.html @@ -181,6 +181,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/loop_handlers/index.html b/docs/en/cowboy/2.11/guide/loop_handlers/index.html index bf8ec313..75c35e3a 100644 --- a/docs/en/cowboy/2.11/guide/loop_handlers/index.html +++ b/docs/en/cowboy/2.11/guide/loop_handlers/index.html @@ -200,6 +200,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/middlewares/index.html b/docs/en/cowboy/2.11/guide/middlewares/index.html index 8f8585a3..788ed0f5 100644 --- a/docs/en/cowboy/2.11/guide/middlewares/index.html +++ b/docs/en/cowboy/2.11/guide/middlewares/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/migrating_from_1.0/index.html b/docs/en/cowboy/2.11/guide/migrating_from_1.0/index.html index f7e5b362..7a33e4cf 100644 --- a/docs/en/cowboy/2.11/guide/migrating_from_1.0/index.html +++ b/docs/en/cowboy/2.11/guide/migrating_from_1.0/index.html @@ -231,6 +231,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/migrating_from_2.0/index.html b/docs/en/cowboy/2.11/guide/migrating_from_2.0/index.html index 95968666..271cd53f 100644 --- a/docs/en/cowboy/2.11/guide/migrating_from_2.0/index.html +++ b/docs/en/cowboy/2.11/guide/migrating_from_2.0/index.html @@ -166,6 +166,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/migrating_from_2.1/index.html b/docs/en/cowboy/2.11/guide/migrating_from_2.1/index.html index b7506f2c..a3a2c871 100644 --- a/docs/en/cowboy/2.11/guide/migrating_from_2.1/index.html +++ b/docs/en/cowboy/2.11/guide/migrating_from_2.1/index.html @@ -177,6 +177,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/migrating_from_2.10/index.html b/docs/en/cowboy/2.11/guide/migrating_from_2.10/index.html index a5b5f62e..1fddb3df 100644 --- a/docs/en/cowboy/2.11/guide/migrating_from_2.10/index.html +++ b/docs/en/cowboy/2.11/guide/migrating_from_2.10/index.html @@ -181,6 +181,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/migrating_from_2.2/index.html b/docs/en/cowboy/2.11/guide/migrating_from_2.2/index.html index 1937b8fd..0ee9c5ad 100644 --- a/docs/en/cowboy/2.11/guide/migrating_from_2.2/index.html +++ b/docs/en/cowboy/2.11/guide/migrating_from_2.2/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/migrating_from_2.3/index.html b/docs/en/cowboy/2.11/guide/migrating_from_2.3/index.html index 6c029be2..a2be2a94 100644 --- a/docs/en/cowboy/2.11/guide/migrating_from_2.3/index.html +++ b/docs/en/cowboy/2.11/guide/migrating_from_2.3/index.html @@ -151,6 +151,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/migrating_from_2.4/index.html b/docs/en/cowboy/2.11/guide/migrating_from_2.4/index.html index 46cde27b..fe9b62f3 100644 --- a/docs/en/cowboy/2.11/guide/migrating_from_2.4/index.html +++ b/docs/en/cowboy/2.11/guide/migrating_from_2.4/index.html @@ -179,6 +179,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/migrating_from_2.5/index.html b/docs/en/cowboy/2.11/guide/migrating_from_2.5/index.html index 9f75d051..4f26f7f1 100644 --- a/docs/en/cowboy/2.11/guide/migrating_from_2.5/index.html +++ b/docs/en/cowboy/2.11/guide/migrating_from_2.5/index.html @@ -194,6 +194,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/migrating_from_2.6/index.html b/docs/en/cowboy/2.11/guide/migrating_from_2.6/index.html index fa9f882b..7011e4d0 100644 --- a/docs/en/cowboy/2.11/guide/migrating_from_2.6/index.html +++ b/docs/en/cowboy/2.11/guide/migrating_from_2.6/index.html @@ -215,6 +215,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/migrating_from_2.7/index.html b/docs/en/cowboy/2.11/guide/migrating_from_2.7/index.html index 94cc81ff..e3dfe04a 100644 --- a/docs/en/cowboy/2.11/guide/migrating_from_2.7/index.html +++ b/docs/en/cowboy/2.11/guide/migrating_from_2.7/index.html @@ -171,6 +171,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/migrating_from_2.8/index.html b/docs/en/cowboy/2.11/guide/migrating_from_2.8/index.html index 7a1b62cf..7fdfc4df 100644 --- a/docs/en/cowboy/2.11/guide/migrating_from_2.8/index.html +++ b/docs/en/cowboy/2.11/guide/migrating_from_2.8/index.html @@ -142,6 +142,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/migrating_from_2.9/index.html b/docs/en/cowboy/2.11/guide/migrating_from_2.9/index.html index 44856d2c..a9dbb43d 100644 --- a/docs/en/cowboy/2.11/guide/migrating_from_2.9/index.html +++ b/docs/en/cowboy/2.11/guide/migrating_from_2.9/index.html @@ -146,6 +146,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/modern_web/index.html b/docs/en/cowboy/2.11/guide/modern_web/index.html index 82c034b8..545ff868 100644 --- a/docs/en/cowboy/2.11/guide/modern_web/index.html +++ b/docs/en/cowboy/2.11/guide/modern_web/index.html @@ -145,6 +145,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/multipart/index.html b/docs/en/cowboy/2.11/guide/multipart/index.html index 5a2ebcdf..b2518409 100644 --- a/docs/en/cowboy/2.11/guide/multipart/index.html +++ b/docs/en/cowboy/2.11/guide/multipart/index.html @@ -218,6 +218,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/performance/index.html b/docs/en/cowboy/2.11/guide/performance/index.html index 9b019bb3..49bcadae 100644 --- a/docs/en/cowboy/2.11/guide/performance/index.html +++ b/docs/en/cowboy/2.11/guide/performance/index.html @@ -123,6 +123,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/req/index.html b/docs/en/cowboy/2.11/guide/req/index.html index 55dedd3a..ead6e834 100644 --- a/docs/en/cowboy/2.11/guide/req/index.html +++ b/docs/en/cowboy/2.11/guide/req/index.html @@ -393,6 +393,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/req_body/index.html b/docs/en/cowboy/2.11/guide/req_body/index.html index 17f60eae..be667320 100644 --- a/docs/en/cowboy/2.11/guide/req_body/index.html +++ b/docs/en/cowboy/2.11/guide/req_body/index.html @@ -217,6 +217,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/resource_design/index.html b/docs/en/cowboy/2.11/guide/resource_design/index.html index 2a2f6713..c0e63977 100644 --- a/docs/en/cowboy/2.11/guide/resource_design/index.html +++ b/docs/en/cowboy/2.11/guide/resource_design/index.html @@ -180,6 +180,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/resp/index.html b/docs/en/cowboy/2.11/guide/resp/index.html index c1921bdd..eeb1cd6b 100644 --- a/docs/en/cowboy/2.11/guide/resp/index.html +++ b/docs/en/cowboy/2.11/guide/resp/index.html @@ -360,6 +360,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/rest_flowcharts/index.html b/docs/en/cowboy/2.11/guide/rest_flowcharts/index.html index 56252775..302469bb 100644 --- a/docs/en/cowboy/2.11/guide/rest_flowcharts/index.html +++ b/docs/en/cowboy/2.11/guide/rest_flowcharts/index.html @@ -177,6 +177,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/rest_handlers/index.html b/docs/en/cowboy/2.11/guide/rest_handlers/index.html index 97aecdb9..5b3ca2bf 100644 --- a/docs/en/cowboy/2.11/guide/rest_handlers/index.html +++ b/docs/en/cowboy/2.11/guide/rest_handlers/index.html @@ -300,6 +300,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/rest_principles/index.html b/docs/en/cowboy/2.11/guide/rest_principles/index.html index 50a82fd6..7447e41b 100644 --- a/docs/en/cowboy/2.11/guide/rest_principles/index.html +++ b/docs/en/cowboy/2.11/guide/rest_principles/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/routing/index.html b/docs/en/cowboy/2.11/guide/routing/index.html index ba148d83..d1cb2791 100644 --- a/docs/en/cowboy/2.11/guide/routing/index.html +++ b/docs/en/cowboy/2.11/guide/routing/index.html @@ -326,6 +326,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/specs/index.html b/docs/en/cowboy/2.11/guide/specs/index.html index b6240a42..e5947a5c 100644 --- a/docs/en/cowboy/2.11/guide/specs/index.html +++ b/docs/en/cowboy/2.11/guide/specs/index.html @@ -496,6 +496,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/static_files/index.html b/docs/en/cowboy/2.11/guide/static_files/index.html index 9fe2615c..bbefa689 100644 --- a/docs/en/cowboy/2.11/guide/static_files/index.html +++ b/docs/en/cowboy/2.11/guide/static_files/index.html @@ -212,6 +212,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/streams/index.html b/docs/en/cowboy/2.11/guide/streams/index.html index 08158f04..53f6a96d 100644 --- a/docs/en/cowboy/2.11/guide/streams/index.html +++ b/docs/en/cowboy/2.11/guide/streams/index.html @@ -137,6 +137,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/ws_handlers/index.html b/docs/en/cowboy/2.11/guide/ws_handlers/index.html index 1da17465..217c449d 100644 --- a/docs/en/cowboy/2.11/guide/ws_handlers/index.html +++ b/docs/en/cowboy/2.11/guide/ws_handlers/index.html @@ -301,6 +301,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/guide/ws_protocol/index.html b/docs/en/cowboy/2.11/guide/ws_protocol/index.html index 57be64e9..02e4f07d 100644 --- a/docs/en/cowboy/2.11/guide/ws_protocol/index.html +++ b/docs/en/cowboy/2.11/guide/ws_protocol/index.html @@ -133,6 +133,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy.get_env/index.html b/docs/en/cowboy/2.11/manual/cowboy.get_env/index.html index 46225c23..60ea8ba6 100644 --- a/docs/en/cowboy/2.11/manual/cowboy.get_env/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy.get_env/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.11/manual/cowboy.set_env/index.html index 9fda05a8..b4769a3e 100644 --- a/docs/en/cowboy/2.11/manual/cowboy.set_env/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy.set_env/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy.start_clear/index.html b/docs/en/cowboy/2.11/manual/cowboy.start_clear/index.html index 86e2f1f2..2adfb2ec 100644 --- a/docs/en/cowboy/2.11/manual/cowboy.start_clear/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy.start_clear/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy.start_tls/index.html b/docs/en/cowboy/2.11/manual/cowboy.start_tls/index.html index 55d7e1a8..6525e96c 100644 --- a/docs/en/cowboy/2.11/manual/cowboy.start_tls/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy.start_tls/index.html @@ -171,6 +171,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy.stop_listener/index.html b/docs/en/cowboy/2.11/manual/cowboy.stop_listener/index.html index 907b8a56..f3dda4e1 100644 --- a/docs/en/cowboy/2.11/manual/cowboy.stop_listener/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy.stop_listener/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy/index.html b/docs/en/cowboy/2.11/manual/cowboy/index.html index 44706cc8..fe134c8f 100644 --- a/docs/en/cowboy/2.11/manual/cowboy/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy/index.html @@ -167,6 +167,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_app/index.html b/docs/en/cowboy/2.11/manual/cowboy_app/index.html index 5c0a82bc..5ee6d309 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_app/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_app/index.html @@ -178,6 +178,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_compress_h/index.html b/docs/en/cowboy/2.11/manual/cowboy_compress_h/index.html index 8dcc7d60..6840b94d 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_compress_h/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_compress_h/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_constraints.int/index.html b/docs/en/cowboy/2.11/manual/cowboy_constraints.int/index.html index 66d67b7c..f0a3e54f 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_constraints.int/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_constraints.int/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_constraints.nonempty/index.html b/docs/en/cowboy/2.11/manual/cowboy_constraints.nonempty/index.html index 3382be45..b527a7e4 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_constraints.nonempty/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_constraints.nonempty/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_constraints/index.html b/docs/en/cowboy/2.11/manual/cowboy_constraints/index.html index 09c610b3..bcf947b7 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_constraints/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_constraints/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_decompress_h/index.html b/docs/en/cowboy/2.11/manual/cowboy_decompress_h/index.html index 4b879945..6c2b8703 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_decompress_h/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_decompress_h/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_handler.terminate/index.html b/docs/en/cowboy/2.11/manual/cowboy_handler.terminate/index.html index ac113b9d..39761d0c 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_handler.terminate/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_handler.terminate/index.html @@ -143,6 +143,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_handler/index.html b/docs/en/cowboy/2.11/manual/cowboy_handler/index.html index 6c6b86eb..ce6e3dcf 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_handler/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_handler/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_http/index.html b/docs/en/cowboy/2.11/manual/cowboy_http/index.html index 2f9f5657..5a8b3133 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_http/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_http/index.html @@ -241,6 +241,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_http2/index.html b/docs/en/cowboy/2.11/manual/cowboy_http2/index.html index 74bc4385..aaa20e17 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_http2/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_http2/index.html @@ -285,6 +285,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_loop/index.html b/docs/en/cowboy/2.11/manual/cowboy_loop/index.html index 59b141c0..66cf01f6 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_loop/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_loop/index.html @@ -151,6 +151,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_metrics_h/index.html b/docs/en/cowboy/2.11/manual/cowboy_metrics_h/index.html index fb03666b..8e90ed57 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_metrics_h/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_metrics_h/index.html @@ -226,6 +226,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.11/manual/cowboy_middleware/index.html index 5e8ef4dd..031e0d7b 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_middleware/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_middleware/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.binding/index.html index a1ae7513..bab69d2a 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.binding/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.binding/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.bindings/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.bindings/index.html index 43aa0f53..d52dd575 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.bindings/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.bindings/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.body_length/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.body_length/index.html index 39002e26..6d7a9831 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.body_length/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.body_length/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.cast/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.cast/index.html index 5b5b3b27..e14adcb0 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.cast/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.cast/index.html @@ -158,6 +158,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.cert/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.cert/index.html index 64a2cc49..bf9d5493 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.cert/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.cert/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.delete_resp_header/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.delete_resp_header/index.html index 6df4e59a..917f0b59 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.delete_resp_header/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.delete_resp_header/index.html @@ -134,6 +134,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.filter_cookies/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.filter_cookies/index.html index 2e7577bc..884fb653 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.filter_cookies/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.filter_cookies/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.has_body/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.has_body/index.html index 1719ac92..34a808ee 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.has_body/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.has_body/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.has_resp_body/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.has_resp_body/index.html index 1efe0dcc..428f4016 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.has_resp_body/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.has_resp_body/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.has_resp_header/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.has_resp_header/index.html index 61d057b5..1aa21fc5 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.has_resp_header/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.has_resp_header/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.header/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.header/index.html index 5ccf395f..ce93deff 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.header/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.header/index.html @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.headers/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.headers/index.html index 6bbac59c..3721a81f 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.headers/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.headers/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.host/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.host/index.html index 43e37dd1..8cc9b670 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.host/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.host/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.host_info/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.host_info/index.html index 04981c32..2e041642 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.host_info/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.host_info/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.inform/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.inform/index.html index 6be7d1d2..ba49841e 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.inform/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.inform/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.match_cookies/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.match_cookies/index.html index 69ca2e50..36d865d8 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.match_cookies/index.html +++ b/docs/en/cowboy/2.11/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.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.match_qs/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.match_qs/index.html index e30cd7f8..29fc248e 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.match_qs/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.match_qs/index.html @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.method/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.method/index.html index 200567ee..ebe0439a 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.method/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.method/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.parse_cookies/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.parse_cookies/index.html index bdef4350..88b7f986 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.parse_cookies/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.parse_cookies/index.html @@ -155,6 +155,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.parse_header/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.parse_header/index.html index f988994f..ed0b1392 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.parse_header/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.parse_header/index.html @@ -363,6 +363,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.parse_qs/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.parse_qs/index.html index 48e738ee..ed77cf01 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.parse_qs/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.parse_qs/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.path/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.path/index.html index f025af84..ebe41fb2 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.path/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.path/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.path_info/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.path_info/index.html index c4575e67..3ed412fa 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.path_info/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.path_info/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.peer/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.peer/index.html index d87eab6b..bc02a5bb 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.peer/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.peer/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.port/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.port/index.html index c83f181a..ecee0fe8 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.port/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.port/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.push/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.push/index.html index 67f9782a..5b87c050 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.push/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.push/index.html @@ -163,6 +163,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.qs/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.qs/index.html index fa853d21..2a91f83f 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.qs/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.qs/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.read_and_match_urlencoded_body/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.read_and_match_urlencoded_body/index.html index e3261a4e..442b671b 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.read_and_match_urlencoded_body/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.read_and_match_urlencoded_body/index.html @@ -187,6 +187,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.read_body/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.read_body/index.html index 18af4b11..05f8fafa 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.read_body/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.read_body/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.read_part/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.read_part/index.html index 3096add3..38d015c8 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.read_part/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.read_part/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.read_part_body/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.read_part_body/index.html index dea4b62f..fc2752c0 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.read_part_body/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.read_part_body/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.read_urlencoded_body/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.read_urlencoded_body/index.html index 6da02d49..c7b34054 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.read_urlencoded_body/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.read_urlencoded_body/index.html @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.reply/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.reply/index.html index 5227e32e..28c5f3d9 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.reply/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.reply/index.html @@ -175,6 +175,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.resp_header/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.resp_header/index.html index b96dbb63..c99b96a7 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.resp_header/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.resp_header/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.resp_headers/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.resp_headers/index.html index 2ee03f50..fb129123 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.resp_headers/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.resp_headers/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.scheme/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.scheme/index.html index 709fed5b..1a554e95 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.scheme/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.scheme/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_body/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_body/index.html index d1ac76ca..1c15622c 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_body/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_body/index.html @@ -168,6 +168,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_cookie/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_cookie/index.html index 5be3a51c..4457f17d 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_cookie/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_cookie/index.html @@ -193,6 +193,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_header/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_header/index.html index e52838d6..7705081e 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_header/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_header/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_headers/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_headers/index.html index 3e3fa63f..c7e1ac4f 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_headers/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.set_resp_headers/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.sock/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.sock/index.html index c2e0191d..857b2808 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.sock/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.sock/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.stream_body/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.stream_body/index.html index 09ef458a..4dba25b1 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.stream_body/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.stream_body/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.stream_events/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.stream_events/index.html index 5188e66f..88b9c07f 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.stream_events/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.stream_events/index.html @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.stream_reply/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.stream_reply/index.html index e36c2bd9..22435304 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.stream_reply/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.stream_reply/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.stream_trailers/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.stream_trailers/index.html index 6a7c922b..6fcbbf0e 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.stream_trailers/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.stream_trailers/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.uri/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.uri/index.html index 83b1a83f..988ed702 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.uri/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.uri/index.html @@ -195,6 +195,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.version/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.version/index.html index e2d6700d..ed195e9d 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req.version/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req.version/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_req/index.html b/docs/en/cowboy/2.11/manual/cowboy_req/index.html index add0db2f..3b99fcd5 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_req/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_req/index.html @@ -318,6 +318,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_rest/index.html b/docs/en/cowboy/2.11/manual/cowboy_rest/index.html index 901cc9dd..1644753d 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_rest/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_rest/index.html @@ -677,6 +677,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_router.compile/index.html b/docs/en/cowboy/2.11/manual/cowboy_router.compile/index.html index cbdb0b97..d89403e7 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_router.compile/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_router.compile/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_router/index.html b/docs/en/cowboy/2.11/manual/cowboy_router/index.html index ca4096ce..6c479b4f 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_router/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_router/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_static/index.html b/docs/en/cowboy/2.11/manual/cowboy_static/index.html index 0e075e8d..f0ee2460 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_static/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_static/index.html @@ -214,6 +214,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_stream.data/index.html b/docs/en/cowboy/2.11/manual/cowboy_stream.data/index.html index 678de5cd..8d929ea2 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_stream.data/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_stream.data/index.html @@ -151,6 +151,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_stream.early_error/index.html b/docs/en/cowboy/2.11/manual/cowboy_stream.early_error/index.html index 35a65388..37ec0903 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_stream.early_error/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_stream.early_error/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_stream.info/index.html b/docs/en/cowboy/2.11/manual/cowboy_stream.info/index.html index 9d5e9a01..481a5897 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_stream.info/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_stream.info/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_stream.init/index.html b/docs/en/cowboy/2.11/manual/cowboy_stream.init/index.html index ecb4f936..a8afc0ea 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_stream.init/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_stream.init/index.html @@ -151,6 +151,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_stream.terminate/index.html b/docs/en/cowboy/2.11/manual/cowboy_stream.terminate/index.html index 3686bdcb..262a04d4 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_stream.terminate/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_stream.terminate/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_stream/index.html b/docs/en/cowboy/2.11/manual/cowboy_stream/index.html index 9d70a38b..e142a318 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_stream/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_stream/index.html @@ -374,6 +374,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_stream_h/index.html b/docs/en/cowboy/2.11/manual/cowboy_stream_h/index.html index aa6c2ba4..fe3bb0e2 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_stream_h/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_stream_h/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_tracer_h/index.html b/docs/en/cowboy/2.11/manual/cowboy_tracer_h/index.html index 0187b35e..6979cb0a 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_tracer_h/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_tracer_h/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/cowboy_websocket/index.html b/docs/en/cowboy/2.11/manual/cowboy_websocket/index.html index 5d9582c7..d441088b 100644 --- a/docs/en/cowboy/2.11/manual/cowboy_websocket/index.html +++ b/docs/en/cowboy/2.11/manual/cowboy_websocket/index.html @@ -301,6 +301,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/http_status_codes/index.html b/docs/en/cowboy/2.11/manual/http_status_codes/index.html index b7ea3299..001d1eea 100644 --- a/docs/en/cowboy/2.11/manual/http_status_codes/index.html +++ b/docs/en/cowboy/2.11/manual/http_status_codes/index.html @@ -181,6 +181,8 @@ + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.11/manual/index.html b/docs/en/cowboy/2.11/manual/index.html index 66625e2b..0e4b125e 100644 --- a/docs/en/cowboy/2.11/manual/index.html +++ b/docs/en/cowboy/2.11/manual/index.html @@ -178,6 +178,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.12/guide/constraints.asciidoc b/docs/en/cowboy/2.12/guide/constraints.asciidoc new file mode 100644 index 00000000..6cc10752 --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/constraints/index.html b/docs/en/cowboy/2.12/guide/constraints/index.html new file mode 100644 index 00000000..7459af12 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/constraints/index.html @@ -0,0 +1,261 @@ +<!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=7" 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.9 +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.9 +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.9 +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.9 +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.9 +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.12/guide/routing/"> + Routing + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/handlers/"> + Handlers + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/cookies.asciidoc b/docs/en/cowboy/2.12/guide/cookies.asciidoc new file mode 100644 index 00000000..4825031b --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/cookies/index.html b/docs/en/cowboy/2.12/guide/cookies/index.html new file mode 100644 index 00000000..a3e76492 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/cookies/index.html @@ -0,0 +1,278 @@ +<!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=7" 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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.12/guide/resp/"> + Sending a response + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/multipart/"> + Multipart requests + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/cowboy.sty b/docs/en/cowboy/2.12/guide/cowboy.sty new file mode 100644 index 00000000..d5e0d3be --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/erlang_web.asciidoc b/docs/en/cowboy/2.12/guide/erlang_web.asciidoc new file mode 100644 index 00000000..9517bf70 --- /dev/null +++ b/docs/en/cowboy/2.12/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 ahead of anything else in this respect. 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.12/guide/erlang_web/index.html b/docs/en/cowboy/2.12/guide/erlang_web/index.html new file mode 100644 index 00000000..b43f2fc4 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/erlang_web/index.html @@ -0,0 +1,227 @@ +<!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=7" 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 ahead of anything else in this respect. 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.12/guide/modern_web/"> + The modern Web + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/introduction/"> + Introduction + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/flow_diagram.asciidoc b/docs/en/cowboy/2.12/guide/flow_diagram.asciidoc new file mode 100644 index 00000000..9eb74667 --- /dev/null +++ b/docs/en/cowboy/2.12/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. +By default, the request process executes the router and then +the 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.12/guide/flow_diagram/index.html b/docs/en/cowboy/2.12/guide/flow_diagram/index.html new file mode 100644 index 00000000..8915912e --- /dev/null +++ b/docs/en/cowboy/2.12/guide/flow_diagram/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: 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=7" 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. By default, the request process executes the router and then the 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.12/guide/getting_started/"> + Getting started + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/listeners/"> + Listeners + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/getting_started.asciidoc b/docs/en/cowboy/2.12/guide/getting_started.asciidoc new file mode 100644 index 00000000..a26802de --- /dev/null +++ b/docs/en/cowboy/2.12/guide/getting_started.asciidoc @@ -0,0 +1,153 @@ +[[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, and that we will use releases: + +[source,makefile] +---- +PROJECT = hello_erlang + +DEPS = cowboy +dep_cowboy_commit = 2.11.0 + +REL_DEPS = relx + +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. + +The `REL_DEPS` line tells the build system to fetch and build +`relx`, the library that will create the release. + +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.12/guide/getting_started/index.html b/docs/en/cowboy/2.12/guide/getting_started/index.html new file mode 100644 index 00000000..201ac672 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/getting_started/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: 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=7" 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.9 +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.9 +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.9 +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.9 +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, and that we will use releases:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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.11.0 + +<font color="#009900">REL_DEPS =</font> relx + +<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>The <code>REL_DEPS</code> line tells the build system to fetch and build <code>relx</code>, the library that will create the release.</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.9 +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.9 +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.9 +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.12/guide/introduction/"> + Introduction + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/flow_diagram/"> + Flow diagram + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/handlers.asciidoc b/docs/en/cowboy/2.12/guide/handlers.asciidoc new file mode 100644 index 00000000..fe6f4623 --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/handlers/index.html b/docs/en/cowboy/2.12/guide/handlers/index.html new file mode 100644 index 00000000..9376c64b --- /dev/null +++ b/docs/en/cowboy/2.12/guide/handlers/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: 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=7" 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.9 +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.9 +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.9 +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.9 +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.12/guide/constraints/"> + Constraints + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/loop_handlers/"> + Loop handlers + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/http_req_resp.png b/docs/en/cowboy/2.12/guide/http_req_resp.png Binary files differnew file mode 100644 index 00000000..41c17c8a --- /dev/null +++ b/docs/en/cowboy/2.12/guide/http_req_resp.png diff --git a/docs/en/cowboy/2.12/guide/http_req_resp.svg b/docs/en/cowboy/2.12/guide/http_req_resp.svg new file mode 100644 index 00000000..acedb152 --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/index.html b/docs/en/cowboy/2.12/guide/index.html new file mode 100644 index 00000000..06ed2ceb --- /dev/null +++ b/docs/en/cowboy/2.12/guide/index.html @@ -0,0 +1,258 @@ +<!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=7" 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> +<li><a href="performance/">Performance</a> +</li> +</ul> +<h2 id="_additional_information">Additional information</h2> +<ul><li><a href="migrating_from_2.11/">Migrating from Cowboy 2.11 to 2.12</a> +</li> +<li><a href="migrating_from_2.10/">Migrating from Cowboy 2.10 to 2.11</a> +</li> +<li><a href="migrating_from_2.9/">Migrating from Cowboy 2.9 to 2.10</a> +</li> +<li><a href="migrating_from_2.8/">Migrating from Cowboy 2.8 to 2.9</a> +</li> +<li><a href="migrating_from_2.7/">Migrating from Cowboy 2.7 to 2.8</a> +</li> +<li><a href="migrating_from_2.6/">Migrating from Cowboy 2.6 to 2.7</a> +</li> +<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.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/introduction.asciidoc b/docs/en/cowboy/2.12/guide/introduction.asciidoc new file mode 100644 index 00000000..519608d1 --- /dev/null +++ b/docs/en/cowboy/2.12/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 22.0 and newer. + +=== License + +Cowboy uses the ISC License. + +---- +Copyright (c) 2011-2024, 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.12/guide/introduction/index.html b/docs/en/cowboy/2.12/guide/introduction/index.html new file mode 100644 index 00000000..4f27b7e0 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/introduction/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: 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=7" 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 22.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-2024, 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.12/guide/erlang_web/"> + Erlang and the Web + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/getting_started/"> + Getting started + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/listeners.asciidoc b/docs/en/cowboy/2.12/guide/listeners.asciidoc new file mode 100644 index 00000000..40aff83e --- /dev/null +++ b/docs/en/cowboy/2.12/guide/listeners.asciidoc @@ -0,0 +1,128 @@ +[[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.8/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 set up a custom listener. + +[source,erlang] +---- +start(_Type, _Args) -> + Dispatch = cowboy_router:compile([ + {'_', [{"/", hello_handler, []}]} + ]), + {ok, _} = cowboy:start_tls(my_https_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. + +=== Stopping the listener + +When starting listeners along with the application it is +a good idea to also stop the listener when the application +stops. This can be done by calling `cowboy:stop_listener/1` +in the application's stop function: + +[source,erlang] +---- +stop(_State) -> + ok = cowboy:stop_listener(my_http_listener). +---- + +=== 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.12/guide/listeners/index.html b/docs/en/cowboy/2.12/guide/listeners/index.html new file mode 100644 index 00000000..6275ec2a --- /dev/null +++ b/docs/en/cowboy/2.12/guide/listeners/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: 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=7" 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.8/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.9 +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 set up a custom listener.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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_https_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="_stopping_the_listener">Stopping the listener</h2> +<p>When starting listeners along with the application it is a good idea to also stop the listener when the application stops. This can be done by calling <code>cowboy:stop_listener/1</code> in the application's stop function:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">stop</font></b>(<font color="#009900">_State</font>) <font color="#990000">-></font> + <font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">cowboy:stop_listener</font></b>(<font color="#FF6600">my_http_listener</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<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.12/guide/flow_diagram/"> + Flow diagram + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/routing/"> + Routing + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/loop_handlers.asciidoc b/docs/en/cowboy/2.12/guide/loop_handlers.asciidoc new file mode 100644 index 00000000..fc45d1c6 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/loop_handlers.asciidoc @@ -0,0 +1,150 @@ +[[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. Alternatively, the tuple may +optionally contain a positive integer to create a `timeout` +message when the process has not received messages for too +long. + +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}. +---- + +This makes the process time out after 1000ms of idle time. + +[source,erlang] +---- +init(Req, State) -> + {cowboy_loop, Req, State, 1000}. +---- + +=== 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. + +=== Idle timeout + +You may activate timeout events by returning a positive integer +`N` as part of the `loop` tuple callbacks return. The default +value is `infinity`. The `info` callback will be called with the +atom `timeout` unless a message is received within `N` milliseconds: + +[source,erlang] +---- +info(timeout, Req, State) -> + %% Do something... + {ok, Req, State, 1000}. +---- diff --git a/docs/en/cowboy/2.12/guide/loop_handlers/index.html b/docs/en/cowboy/2.12/guide/loop_handlers/index.html new file mode 100644 index 00000000..0c0ebc56 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/loop_handlers/index.html @@ -0,0 +1,264 @@ +<!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=7" 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. Alternatively, the tuple may optionally contain a positive integer to create a <code>timeout</code> message when the process has not received messages for too long.</p> +<p>This snippet enables the loop handler:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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.9 +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> +<p>This makes the process time out after 1000ms of idle time.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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="#993399">1000</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.9 +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.9 +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> +<h2 id="_idle_timeout">Idle timeout</h2> +<p>You may activate timeout events by returning a positive integer <code>N</code> as part of the <code>loop</code> tuple callbacks return. The default value is <code>infinity</code>. The <code>info</code> callback will be called with the atom <code>timeout</code> unless a message is received within <code>N</code> milliseconds:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">timeout</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something...</font></i> + {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>, <font color="#993399">1000</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.12/guide/handlers/"> + Handlers + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/static_files/"> + Static files + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/middlewares.asciidoc b/docs/en/cowboy/2.12/guide/middlewares.asciidoc new file mode 100644 index 00000000..e6be30dd --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/middlewares/index.html b/docs/en/cowboy/2.12/guide/middlewares/index.html new file mode 100644 index 00000000..5f202146 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/middlewares/index.html @@ -0,0 +1,213 @@ +<!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=7" 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.12/guide/streams/"> + Streams + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/performance/"> + Performance + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/migrating_from_1.0.asciidoc b/docs/en/cowboy/2.12/guide/migrating_from_1.0.asciidoc new file mode 100644 index 00000000..4f4ea5bf --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/migrating_from_1.0/index.html b/docs/en/cowboy/2.12/guide/migrating_from_1.0/index.html new file mode 100644 index 00000000..435d16c0 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_1.0/index.html @@ -0,0 +1,295 @@ +<!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=7" 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.12/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.12/guide/specs/"> + HTTP and other specifications + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/migrating_from_2.0.asciidoc b/docs/en/cowboy/2.12/guide/migrating_from_2.0.asciidoc new file mode 100644 index 00000000..c76430c2 --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/migrating_from_2.0/index.html b/docs/en/cowboy/2.12/guide/migrating_from_2.0/index.html new file mode 100644 index 00000000..3bfdf1a0 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.0/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.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=7" 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.12/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.12/guide/migrating_from_1.0/"> + Migrating from Cowboy 1.0 to 2.0 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/migrating_from_2.1.asciidoc b/docs/en/cowboy/2.12/guide/migrating_from_2.1.asciidoc new file mode 100644 index 00000000..3c0681ff --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/migrating_from_2.1/index.html b/docs/en/cowboy/2.12/guide/migrating_from_2.1/index.html new file mode 100644 index 00000000..0be0d024 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.1/index.html @@ -0,0 +1,241 @@ +<!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=7" 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.12/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.12/guide/migrating_from_2.0/"> + Migrating from Cowboy 2.0 to 2.1 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/migrating_from_2.10.asciidoc b/docs/en/cowboy/2.12/guide/migrating_from_2.10.asciidoc new file mode 100644 index 00000000..aaa8fe9d --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.10.asciidoc @@ -0,0 +1,139 @@ +[appendix] +== Migrating from Cowboy 2.10 to 2.11 + +Cowboy 2.11 contains a variety of new features and bug +fixes. Nearly all previously experimental features are +now marked as stable, including Websocket over HTTP/2. +Included is a fix for an HTTP/2 protocol CVE. + +Cowboy 2.11 requires Erlang/OTP 24.0 or greater. + +Cowboy is now using GitHub Actions for CI. The main reason +for the move is to reduce costs by no longer having to +self-host CI runners. The downside is that GitHub runners +are less reliable and timing dependent tests are now more +likely to fail. + +=== Features added + +* A new HTTP/2 option `max_cancel_stream_rate` has been added + to control the rate of stream cancellation the server will + accept. By default Cowboy will accept 500 cancelled streams + every 10 seconds. + +* A new stream handler `cowboy_decompress_h` has been added. + It allows automatically decompressing incoming gzipped + request bodies. It includes options to protect against + zip bombs. + +* Websocket over HTTP/2 is no longer considered experimental. + Note that the `enable_connect_protocol` option must be set + to `true` in order to use Websocket over HTTP/2 for the + time being. + +* Automatic mode for reading request bodies has been + documented. In automatic mode, Cowboy waits indefinitely + for data and sends a `request_body` message when data + comes in. It mirrors `{active, once}` socket modes. + This is ideal for loop handlers and is also used + internally for HTTP/2 Websocket. + +* Ranged requests support is no longer considered + experimental. It was added in 2.6 to both `cowboy_static` + and `cowboy_rest`. Ranged responses can be produced + either automatically (for the `bytes` unit) or manually. + REST flowcharts have been updated with the new callbacks + and steps related to handling ranged requests. + +* A new HTTP/1.1 and HTTP/2 option `reset_idle_timeout_on_send` + has been added. When enabled, the `idle_timeout` will be + reset every time Cowboy sends data to the socket. + +* Loop handlers may now return a timeout value in the place + of `hibernate`. Timeouts behave the same as in `gen_server`. + +* The `generate_etag` callback of REST handlers now accepts + `undefined` as a return value to allow conditionally + generating etags. + +* The `cowboy_compress_h` options `compress_threshold` and + `compress_buffering` are no longer considered experimental. + They were de facto stable since 2.6 as they already were + documented. + +* Functions `cowboy:get_env/2,3` have been added. + +* Better error messages have been added when trying to send + a 204 or 304 response with a body; when attempting to + send two responses to a single request; when trying to + push a response after the final response; when trying + to send a `set-cookie` header without using + `cowboy_req:set_resp_cookie/3,4`. + +=== Features removed + +* Cowboy will no longer include the NPN extension when + starting a TLS listener. This extension has long been + deprecated and replaced with the ALPN extension. Cowboy + will continue using the ALPN extension for protocol + negotiation. + +=== Bugs fixed + +* A fix was made to address the HTTP/2 CVE CVE-2023-44487 + via the new HTTP/2 option `max_cancel_stream_rate`. + +* HTTP/1.1 requests that contain both a content-length and + a transfer-encoding header will now be rejected to avoid + security risks. Previous behavior was to ignore the + content-length header as recommended by the HTTP RFC. + +* HTTP/1.1 connections would sometimes use the wrong timeout + value to determine whether the connection should be closed. + This resulted in connections staying up longer than + intended. This should no longer be the case. + +* Cowboy now reacts to socket errors immediately for HTTP/1.1 + and HTTP/2 when possible. Cowboy will notice when connections + have been closed properly earlier than before. This also + means that the socket option `send_timeout_close` will work + as expected. + +* Shutting down HTTP/1.1 pipelined requests could lead to + the current request being terminated before the response + has been sent. This has been addressed. + +* When using HTTP/1.1 an invalid Connection header will now + be rejected with a 400 status code instead of crashing. + +* The documentation now recommends increasing the HTTP/2 + option `max_frame_size_received`. Cowboy currently uses + the protocol default but will increase its default in a + future release. Until then users are recommended to set + the option to ensure larger requests are accepted and + processed with acceptable performance. + +* Cowboy could sometimes send HTTP/2 WINDOW_UPDATE frames + twice in a row. Now they should be consolidated. + +* Cowboy would sometimes send HTTP/2 WINDOW_UPDATE frames + for streams that have stopped internally. This should + no longer be the case. + +* The `cowboy_compress_h` stream handler will no longer + attempt to compress responses that have an `etag` header + to avoid caching issues. + +* The `cowboy_compress_h` will now always add `accept-encoding` + to the `vary` header as it indicates that responses may + be compressed. + +* Cowboy will now remove the `trap_exit` process flag when + HTTP/1.1 connections upgrade to Websocket. + +* Exit gracefully instead of crashing when the socket gets + closed when reading the PROXY header. + +* Missing `cowboy_stream` manual pages have been added. + +* A number of fixes were made to documentation and examples. diff --git a/docs/en/cowboy/2.12/guide/migrating_from_2.10/index.html b/docs/en/cowboy/2.12/guide/migrating_from_2.10/index.html new file mode 100644 index 00000000..e1ecebd7 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.10/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.10 to 2.11</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=7" 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.10 to 2.11</span></h1> + +<p>Cowboy 2.11 contains a variety of new features and bug fixes. Nearly all previously experimental features are now marked as stable, including Websocket over HTTP/2. Included is a fix for an HTTP/2 protocol CVE.</p> +<p>Cowboy 2.11 requires Erlang/OTP 24.0 or greater.</p> +<p>Cowboy is now using GitHub Actions for CI. The main reason for the move is to reduce costs by no longer having to self-host CI runners. The downside is that GitHub runners are less reliable and timing dependent tests are now more likely to fail.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>A new HTTP/2 option <code>max_cancel_stream_rate</code> has been added to control the rate of stream cancellation the server will accept. By default Cowboy will accept 500 cancelled streams every 10 seconds. +</li> +<li>A new stream handler <code>cowboy_decompress_h</code> has been added. It allows automatically decompressing incoming gzipped request bodies. It includes options to protect against zip bombs. +</li> +<li>Websocket over HTTP/2 is no longer considered experimental. Note that the <code>enable_connect_protocol</code> option must be set to <code>true</code> in order to use Websocket over HTTP/2 for the time being. +</li> +<li>Automatic mode for reading request bodies has been documented. In automatic mode, Cowboy waits indefinitely for data and sends a <code>request_body</code> message when data comes in. It mirrors <code>{active, once}</code> socket modes. This is ideal for loop handlers and is also used internally for HTTP/2 Websocket. +</li> +<li>Ranged requests support is no longer considered experimental. It was added in 2.6 to both <code>cowboy_static</code> and <code>cowboy_rest</code>. Ranged responses can be produced either automatically (for the <code>bytes</code> unit) or manually. REST flowcharts have been updated with the new callbacks and steps related to handling ranged requests. +</li> +<li>A new HTTP/1.1 and HTTP/2 option <code>reset_idle_timeout_on_send</code> has been added. When enabled, the <code>idle_timeout</code> will be reset every time Cowboy sends data to the socket. +</li> +<li>Loop handlers may now return a timeout value in the place of <code>hibernate</code>. Timeouts behave the same as in <code>gen_server</code>. +</li> +<li>The <code>generate_etag</code> callback of REST handlers now accepts <code>undefined</code> as a return value to allow conditionally generating etags. +</li> +<li>The <code>cowboy_compress_h</code> options <code>compress_threshold</code> and <code>compress_buffering</code> are no longer considered experimental. They were de facto stable since 2.6 as they already were documented. +</li> +<li>Functions <code>cowboy:get_env/2,3</code> have been added. +</li> +<li>Better error messages have been added when trying to send a 204 or 304 response with a body; when attempting to send two responses to a single request; when trying to push a response after the final response; when trying to send a <code>set-cookie</code> header without using <code>cowboy_req:set_resp_cookie/3,4</code>. +</li> +</ul> +<h2 id="_features_removed">Features removed</h2> +<ul><li>Cowboy will no longer include the NPN extension when starting a TLS listener. This extension has long been deprecated and replaced with the ALPN extension. Cowboy will continue using the ALPN extension for protocol negotiation. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>A fix was made to address the HTTP/2 CVE CVE-2023-44487 via the new HTTP/2 option <code>max_cancel_stream_rate</code>. +</li> +<li>HTTP/1.1 requests that contain both a content-length and a transfer-encoding header will now be rejected to avoid security risks. Previous behavior was to ignore the content-length header as recommended by the HTTP RFC. +</li> +<li>HTTP/1.1 connections would sometimes use the wrong timeout value to determine whether the connection should be closed. This resulted in connections staying up longer than intended. This should no longer be the case. +</li> +<li>Cowboy now reacts to socket errors immediately for HTTP/1.1 and HTTP/2 when possible. Cowboy will notice when connections have been closed properly earlier than before. This also means that the socket option <code>send_timeout_close</code> will work as expected. +</li> +<li>Shutting down HTTP/1.1 pipelined requests could lead to the current request being terminated before the response has been sent. This has been addressed. +</li> +<li>When using HTTP/1.1 an invalid Connection header will now be rejected with a 400 status code instead of crashing. +</li> +<li>The documentation now recommends increasing the HTTP/2 option <code>max_frame_size_received</code>. Cowboy currently uses the protocol default but will increase its default in a future release. Until then users are recommended to set the option to ensure larger requests are accepted and processed with acceptable performance. +</li> +<li>Cowboy could sometimes send HTTP/2 WINDOW_UPDATE frames twice in a row. Now they should be consolidated. +</li> +<li>Cowboy would sometimes send HTTP/2 WINDOW_UPDATE frames for streams that have stopped internally. This should no longer be the case. +</li> +<li>The <code>cowboy_compress_h</code> stream handler will no longer attempt to compress responses that have an <code>etag</code> header to avoid caching issues. +</li> +<li>The <code>cowboy_compress_h</code> will now always add <code>accept-encoding</code> to the <code>vary</code> header as it indicates that responses may be compressed. +</li> +<li>Cowboy will now remove the <code>trap_exit</code> process flag when HTTP/1.1 connections upgrade to Websocket. +</li> +<li>Exit gracefully instead of crashing when the socket gets closed when reading the PROXY header. +</li> +<li>Missing <code>cowboy_stream</code> manual pages have been added. +</li> +<li>A number of fixes were made to documentation and examples. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.11/"> + Migrating from Cowboy 2.11 to 2.12 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.9/"> + Migrating from Cowboy 2.9 to 2.10 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/migrating_from_2.11.asciidoc b/docs/en/cowboy/2.12/guide/migrating_from_2.11.asciidoc new file mode 100644 index 00000000..ab746426 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.11.asciidoc @@ -0,0 +1,15 @@ +[appendix] +== Migrating from Cowboy 2.11 to 2.12 + +Cowboy 2.12 contains a small security improvement for +the HTTP/2 protocol. + +Cowboy 2.12 requires Erlang/OTP 24.0 or greater. + +=== Features added + +* A new HTTP/2 option `max_fragmented_header_block_size` has + been added to limit the size of header blocks that are + sent over multiple HEADERS and CONTINUATION frames. + +* Update Cowlib to 2.13.0. diff --git a/docs/en/cowboy/2.12/guide/migrating_from_2.11/index.html b/docs/en/cowboy/2.12/guide/migrating_from_2.11/index.html new file mode 100644 index 00000000..c9a5f0e3 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.11/index.html @@ -0,0 +1,190 @@ +<!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.11 to 2.12</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=7" 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.11 to 2.12</span></h1> + +<p>Cowboy 2.12 contains a small security improvement for the HTTP/2 protocol.</p> +<p>Cowboy 2.12 requires Erlang/OTP 24.0 or greater.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>A new HTTP/2 option <code>max_fragmented_header_block_size</code> has been added to limit the size of header blocks that are sent over multiple HEADERS and CONTINUATION frames. +</li> +<li>Update Cowlib to 2.13.0. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/performance/"> + Performance + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.10/"> + Migrating from Cowboy 2.10 to 2.11 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/migrating_from_2.2.asciidoc b/docs/en/cowboy/2.12/guide/migrating_from_2.2.asciidoc new file mode 100644 index 00000000..dacf790e --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/migrating_from_2.2/index.html b/docs/en/cowboy/2.12/guide/migrating_from_2.2/index.html new file mode 100644 index 00000000..f2f0a656 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.2/index.html @@ -0,0 +1,213 @@ +<!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=7" 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.12/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.12/guide/migrating_from_2.1/"> + Migrating from Cowboy 2.1 to 2.2 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/migrating_from_2.3.asciidoc b/docs/en/cowboy/2.12/guide/migrating_from_2.3.asciidoc new file mode 100644 index 00000000..6a604f97 --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/migrating_from_2.3/index.html b/docs/en/cowboy/2.12/guide/migrating_from_2.3/index.html new file mode 100644 index 00000000..5f8b1aa0 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.3/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: 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=7" 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.12/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.12/guide/migrating_from_2.2/"> + Migrating from Cowboy 2.2 to 2.3 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/migrating_from_2.4.asciidoc b/docs/en/cowboy/2.12/guide/migrating_from_2.4.asciidoc new file mode 100644 index 00000000..3cdeaa54 --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/migrating_from_2.4/index.html b/docs/en/cowboy/2.12/guide/migrating_from_2.4/index.html new file mode 100644 index 00000000..4738ed37 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.4/index.html @@ -0,0 +1,243 @@ +<!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=7" 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.12/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.12/guide/migrating_from_2.3/"> + Migrating from Cowboy 2.3 to 2.4 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/migrating_from_2.5.asciidoc b/docs/en/cowboy/2.12/guide/migrating_from_2.5.asciidoc new file mode 100644 index 00000000..5196cc7e --- /dev/null +++ b/docs/en/cowboy/2.12/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 output 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.12/guide/migrating_from_2.5/index.html b/docs/en/cowboy/2.12/guide/migrating_from_2.5/index.html new file mode 100644 index 00000000..572bb6c5 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.5/index.html @@ -0,0 +1,258 @@ +<!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=7" 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 output 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.12/guide/migrating_from_2.6/"> + Migrating from Cowboy 2.6 to 2.7 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.4/"> + Migrating from Cowboy 2.4 to 2.5 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/migrating_from_2.6.asciidoc b/docs/en/cowboy/2.12/guide/migrating_from_2.6.asciidoc new file mode 100644 index 00000000..91d15887 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.6.asciidoc @@ -0,0 +1,224 @@ +[appendix] +== Migrating from Cowboy 2.6 to 2.7 + +Cowboy 2.7 improves the HTTP/2 code with optimizations +around the sending of DATA and WINDOW_UPDATE frames; +graceful shutdown of the connection when the client is +going away; and rate limiting mechanisms. New options +and mechanisms have also been added to control the +amount of memory Cowboy ends up using with both HTTP/1.1 +and HTTP/2. Much, but not all, of this work was done +to address HTTP/2 CVEs about potential denial of service. + +In addition, many of the experimental features introduced +in previous releases have been marked stable and are now +documented. + +Cowboy 2.7 requires Erlang/OTP 20.0 or greater. + +=== Features added + +* Cowboy is now compatible with both Ranch 1.7 and the + upcoming Ranch 2.0. + +* The number of HTTP/2 WINDOW_UPDATE frames Cowboy sends + has been greatly reduced. Cowboy now applies heuristics + to determine whether it is necessary to update the window, + based on the current window size and the amount of data + requested by streams (the `cowboy_req:read_body/2` length + for example). Six new options have been added to control + this behavior: `connection_window_margin_size`, + `connection_window_update_threshold`, + `max_connection_window_size`, `max_stream_window_size`, + `stream_window_margin_size` and + `stream_window_update_threshold`. + +* HTTP/2 connections will now be shut down gracefully + when receiving a GOAWAY frame. Cowboy will simply + wait for existing streams to finish before closing + the connection. + +* Functions that stream the response body now have + backpressure applied. They now wait for a message + to be sent back. The message will be held off when + using HTTP/2 and the buffer sizes exceed either + `max_connection_buffer_size` or `max_stream_buffer_size`. + For HTTP/1.1 the data is sent synchronously and we + rely instead on the TCP backpressure. + +* A new HTTP/2 option `stream_window_data_threshold` + can be used to control how little the DATA frames that + Cowboy sends can get. By default Cowboy will wait for + the window to be large enough to send either everything + queued or to reach the default maximum frame size of + 16384 bytes. + +* A new HTTP/2 option `max_receive_frame_rate` can be + used to control how fast the server is willing to receive + frames. By default it will accept 1000 frames every 10 + seconds. + +* A new HTTP/2 option `max_reset_stream_rate` can be + used to control the rate of errors the server is + willing to accept. By default it will accept 10 + stream resets every 10 seconds. + +* Flow control for incoming data has been implemented + for HTTP/1.1. Cowboy will now wait for the user code + to ask for the request body before reading it from + the socket. The option `initial_stream_flow_size` + controls how much data Cowboy will read without + being asked. + +* The HTTP/1.1 and HTTP/2 option `logger` is now + documented. + +* The Websocket option `validate_utf8` has been + added. It can be used to disable the expensive UTF-8 + validation for incoming text and close frames. + +* The experimental commands based Websocket interface + is now considered stable and has been documented. + The old interface is now deprecated. + +* A new Websocket handler command `shutdown_reason` + can be used to change the normal exit reason of + Websocket processes. By default `normal` is used; + with this command the exit reason can be changed + to `{shutdown, ShutdownReason}`. + +* The experimental stream handlers `cowboy_metrics_h` + and `cowboy_tracer_h` are now considered stable and + have been documented. + +* The stream handler commands `set_options` and `log` + are now considered stable and have been documented. + +* The router is now capable of retrieving dispatch + rules directly from the `persistent_term` storage + (available starting from Erlang/OTP 21.2). + +* Support for the status codes 208 and 508 has been + added. + +* Update Ranch to 1.7.1. + +* Update Cowlib to 2.8.0. + +=== Experimental features added + +* It is now possible to read the response body from any + process, as well as doing any other `cowboy_req` + operations. Since this is not recommended due to + race condition concerns this feature will always + remain experimental. + +=== New functions + +* The function `cowboy_req:filter_cookies/2` has been + added. It can be called before parsing/matching + cookies in order to filter out undesirables. The + main reason for doing this is to avoid most parse + errors that may occur when dealing with Web browsers + (which have a string-based Javascript interface to + cookies that is very permissive of invalid content) + and to be able to recover in other cases. + +* The function `cowboy_req:cast/2` has been added. + It can be used to send events to stream handlers. + +=== Bugs fixed + +* A number of fixes and additions were made to address the + HTTP/2 CVEs CVE-2019-9511 through CVE-2019-9518, except + for CVE-2019-9513 which required no intervention as the + relevant protocol feature is not implemented by Cowboy. + +* The HTTP/2 connection window could become larger than the + protocol allows, leading to errors. This has been corrected. + +* The presence of empty header names in HTTP/2 requests now + results in the request to be rejected. + +* Cowboy will now remove headers specific to HTTP/1.1 + (the hop by hop headers such as connection or upgrade) + when building an HTTP/2 response. + +* A bug in the HTTP/2 code that resulted in the failure to + fully send iolist response bodies has been fixed. Cowboy + would just wait indefinitely in those cases. + +* It was possible for a final empty HTTP/2 DATA frame to get + stuck and never sent when the window reached 0 and the remote + end did not increase the window anymore. This has been + corrected. + +* Cowboy now uses the host header when the HTTP/2 + :authority pseudo header is missing. A common scenario + where this occurs is when proxies translate incoming + HTTP/1.1 requests to HTTP/2. + +* HTTP/1.1 connections are now properly closed when the + user code sends less data than advertised in the response + headers. + +* Cowboy will now close HTTP/1.1 connections immediately when + a header line is missing a colon separator. Previously it + was waiting for more data. + +* It was possible for Cowboy to receive stray timeout messages + for HTTP/1.1 connections, resulting in crashes. The timeout + handling in HTTP/1.1 has been reworked and the issue should + no longer occur. + +* The type for the Req object has been updated to accept + custom fields as was already documented. + +* The authentication scheme returned when parsing the + authorization header is now case insensitive, which + means it will be returned as lowercase. + +* Cowboy no longer discards data that follows a Websocket + upgrade request. Note that the protocol does not allow + sending data before receiving a successful Websocket + upgrade response, so this fix is more out of principle + rather than to fix a real world issue. + +* The `cowboy_static` handler will now properly detect + the type of files that have an uppercase or mixed + extension component. + +* The `cowboy_static` handler is now consistent across all + supported platforms. It now explicitly rejects `path_info` + components that include a forward slash, backward slash + or NUL character. + +* The update to Ranch 1.7.1 fixes an issue with the PROXY + protocol that would cause checksum verification to fail. + +* The HTTP/1.1 error reason for `stream_error` mistakenly + contained an extra element. It has now been removed. + +* The `PartialReq` given to the `early_error` stream handler + callback now includes headers when the protocol is HTTP/2. + +* A bug where the stacktrace was incorrect in error messages + has been fixed. The problem occurred when an exception + occurred in the handler's terminate callback. + +* The REST flowchart for POST, PATCH and PUT has received + a number of fixes and had to be greatly reworked as a + result. When the method is PUT, we do not check for + the location header in the response. When the resource + doesn't exist and the method was PUT the flowchart was + largely incorrect. A 415 response may occur after the + `content_types_accepted` callback and was missing from + the flowchart. + +* The documentation for `content_types_accepted` now + includes the media type wildcard that was previously + missing. + +* The documentation for a type found in `cow_cookie` + was missing. A manual page for `cow_cookie` was added + and can be found in the Cowlib documentation. diff --git a/docs/en/cowboy/2.12/guide/migrating_from_2.6/index.html b/docs/en/cowboy/2.12/guide/migrating_from_2.6/index.html new file mode 100644 index 00000000..41cf84d0 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.6/index.html @@ -0,0 +1,279 @@ +<!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.6 to 2.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=7" 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.6 to 2.7</span></h1> + +<p>Cowboy 2.7 improves the HTTP/2 code with optimizations around the sending of DATA and WINDOW_UPDATE frames; graceful shutdown of the connection when the client is going away; and rate limiting mechanisms. New options and mechanisms have also been added to control the amount of memory Cowboy ends up using with both HTTP/1.1 and HTTP/2. Much, but not all, of this work was done to address HTTP/2 CVEs about potential denial of service.</p> +<p>In addition, many of the experimental features introduced in previous releases have been marked stable and are now documented.</p> +<p>Cowboy 2.7 requires Erlang/OTP 20.0 or greater.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Cowboy is now compatible with both Ranch 1.7 and the upcoming Ranch 2.0. +</li> +<li>The number of HTTP/2 WINDOW_UPDATE frames Cowboy sends has been greatly reduced. Cowboy now applies heuristics to determine whether it is necessary to update the window, based on the current window size and the amount of data requested by streams (the <code>cowboy_req:read_body/2</code> length for example). Six new options have been added to control this behavior: <code>connection_window_margin_size</code>, <code>connection_window_update_threshold</code>, <code>max_connection_window_size</code>, <code>max_stream_window_size</code>, <code>stream_window_margin_size</code> and <code>stream_window_update_threshold</code>. +</li> +<li>HTTP/2 connections will now be shut down gracefully when receiving a GOAWAY frame. Cowboy will simply wait for existing streams to finish before closing the connection. +</li> +<li>Functions that stream the response body now have backpressure applied. They now wait for a message to be sent back. The message will be held off when using HTTP/2 and the buffer sizes exceed either <code>max_connection_buffer_size</code> or <code>max_stream_buffer_size</code>. For HTTP/1.1 the data is sent synchronously and we rely instead on the TCP backpressure. +</li> +<li>A new HTTP/2 option <code>stream_window_data_threshold</code> can be used to control how little the DATA frames that Cowboy sends can get. By default Cowboy will wait for the window to be large enough to send either everything queued or to reach the default maximum frame size of 16384 bytes. +</li> +<li>A new HTTP/2 option <code>max_receive_frame_rate</code> can be used to control how fast the server is willing to receive frames. By default it will accept 1000 frames every 10 seconds. +</li> +<li>A new HTTP/2 option <code>max_reset_stream_rate</code> can be used to control the rate of errors the server is willing to accept. By default it will accept 10 stream resets every 10 seconds. +</li> +<li>Flow control for incoming data has been implemented for HTTP/1.1. Cowboy will now wait for the user code to ask for the request body before reading it from the socket. The option <code>initial_stream_flow_size</code> controls how much data Cowboy will read without being asked. +</li> +<li>The HTTP/1.1 and HTTP/2 option <code>logger</code> is now documented. +</li> +<li>The Websocket option <code>validate_utf8</code> has been added. It can be used to disable the expensive UTF-8 validation for incoming text and close frames. +</li> +<li>The experimental commands based Websocket interface is now considered stable and has been documented. The old interface is now deprecated. +</li> +<li>A new Websocket handler command <code>shutdown_reason</code> can be used to change the normal exit reason of Websocket processes. By default <code>normal</code> is used; with this command the exit reason can be changed to <code>{shutdown, ShutdownReason}</code>. +</li> +<li>The experimental stream handlers <code>cowboy_metrics_h</code> and <code>cowboy_tracer_h</code> are now considered stable and have been documented. +</li> +<li>The stream handler commands <code>set_options</code> and <code>log</code> are now considered stable and have been documented. +</li> +<li>The router is now capable of retrieving dispatch rules directly from the <code>persistent_term</code> storage (available starting from Erlang/OTP 21.2). +</li> +<li>Support for the status codes 208 and 508 has been added. +</li> +<li>Update Ranch to 1.7.1. +</li> +<li>Update Cowlib to 2.8.0. +</li> +</ul> +<h2 id="_experimental_features_added">Experimental features added</h2> +<ul><li>It is now possible to read the response body from any process, as well as doing any other <code>cowboy_req</code> operations. Since this is not recommended due to race condition concerns this feature will always remain experimental. +</li> +</ul> +<h2 id="_new_functions">New functions</h2> +<ul><li>The function <code>cowboy_req:filter_cookies/2</code> has been added. It can be called before parsing/matching cookies in order to filter out undesirables. The main reason for doing this is to avoid most parse errors that may occur when dealing with Web browsers (which have a string-based Javascript interface to cookies that is very permissive of invalid content) and to be able to recover in other cases. +</li> +<li>The function <code>cowboy_req:cast/2</code> has been added. It can be used to send events to stream handlers. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>A number of fixes and additions were made to address the HTTP/2 CVEs CVE-2019-9511 through CVE-2019-9518, except for CVE-2019-9513 which required no intervention as the relevant protocol feature is not implemented by Cowboy. +</li> +<li>The HTTP/2 connection window could become larger than the protocol allows, leading to errors. This has been corrected. +</li> +<li>The presence of empty header names in HTTP/2 requests now results in the request to be rejected. +</li> +<li>Cowboy will now remove headers specific to HTTP/1.1 (the hop by hop headers such as connection or upgrade) when building an HTTP/2 response. +</li> +<li>A bug in the HTTP/2 code that resulted in the failure to fully send iolist response bodies has been fixed. Cowboy would just wait indefinitely in those cases. +</li> +<li>It was possible for a final empty HTTP/2 DATA frame to get stuck and never sent when the window reached 0 and the remote end did not increase the window anymore. This has been corrected. +</li> +<li>Cowboy now uses the host header when the HTTP/2 :authority pseudo header is missing. A common scenario where this occurs is when proxies translate incoming HTTP/1.1 requests to HTTP/2. +</li> +<li>HTTP/1.1 connections are now properly closed when the user code sends less data than advertised in the response headers. +</li> +<li>Cowboy will now close HTTP/1.1 connections immediately when a header line is missing a colon separator. Previously it was waiting for more data. +</li> +<li>It was possible for Cowboy to receive stray timeout messages for HTTP/1.1 connections, resulting in crashes. The timeout handling in HTTP/1.1 has been reworked and the issue should no longer occur. +</li> +<li>The type for the Req object has been updated to accept custom fields as was already documented. +</li> +<li>The authentication scheme returned when parsing the authorization header is now case insensitive, which means it will be returned as lowercase. +</li> +<li>Cowboy no longer discards data that follows a Websocket upgrade request. Note that the protocol does not allow sending data before receiving a successful Websocket upgrade response, so this fix is more out of principle rather than to fix a real world issue. +</li> +<li>The <code>cowboy_static</code> handler will now properly detect the type of files that have an uppercase or mixed extension component. +</li> +<li>The <code>cowboy_static</code> handler is now consistent across all supported platforms. It now explicitly rejects <code>path_info</code> components that include a forward slash, backward slash or NUL character. +</li> +<li>The update to Ranch 1.7.1 fixes an issue with the PROXY protocol that would cause checksum verification to fail. +</li> +<li>The HTTP/1.1 error reason for <code>stream_error</code> mistakenly contained an extra element. It has now been removed. +</li> +<li>The <code>PartialReq</code> given to the <code>early_error</code> stream handler callback now includes headers when the protocol is HTTP/2. +</li> +<li>A bug where the stacktrace was incorrect in error messages has been fixed. The problem occurred when an exception occurred in the handler's terminate callback. +</li> +<li>The REST flowchart for POST, PATCH and PUT has received a number of fixes and had to be greatly reworked as a result. When the method is PUT, we do not check for the location header in the response. When the resource doesn't exist and the method was PUT the flowchart was largely incorrect. A 415 response may occur after the <code>content_types_accepted</code> callback and was missing from the flowchart. +</li> +<li>The documentation for <code>content_types_accepted</code> now includes the media type wildcard that was previously missing. +</li> +<li>The documentation for a type found in <code>cow_cookie</code> was missing. A manual page for <code>cow_cookie</code> was added and can be found in the Cowlib documentation. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.7/"> + Migrating from Cowboy 2.7 to 2.8 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.5/"> + Migrating from Cowboy 2.5 to 2.6 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/migrating_from_2.7.asciidoc b/docs/en/cowboy/2.12/guide/migrating_from_2.7.asciidoc new file mode 100644 index 00000000..1e52130c --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.7.asciidoc @@ -0,0 +1,118 @@ +[appendix] +== Migrating from Cowboy 2.7 to 2.8 + +Cowboy 2.8 contains many optimizations for all +protocols. HTTP/1.1 has received the largest +improvements and Cowboy will now be able to +handle noticeably more requests. Thanks to +the folks at Stressgrid for helping identify that +the performance was lower than it should have been +and for benchmarking my many changes and experiments. + +Cowboy 2.8 also contains a small number of tweaks +and bug fixes. Cowboy 2.8 is the first Cowboy release, +ever, to be consistently green on all tested platforms. +This is mostly due to the reworking of some test cases, +but a few bugs were discovered and fixed in the process. + +Cowboy 2.8 requires Erlang/OTP 22.0 or greater. It may +also work out of the box with Erlang/OTP 21.3 but this +was not tested and is not supported. + +=== Features added + +* Cowboy will now use `active,N` instead of `active,once` + to receive data from the socket. This greatly improves + the performance and allows Cowboy to process more + requests, especially for HTTP/1.1. The `active_n` + protocol option can be configured to change the + `active,N` value. The default is 100 for all protocols. + +* Add a `linger_timeout` option for HTTP/2. The default + is 1000, or one second. This helps ensure that the + final GOAWAY frame will be properly received by clients. + +* The function `cowboy_req:parse_header/2,3` will now + parse the headers `access-control-request-headers`, + `access-control-request-method`, `content-encoding`, + `content-language`, `max-forwards`, `origin`, + `proxy-authorization` and `trailer`. + +* A Performance chapter has been added to the guide. + More content will be added in future releases. + +* Update Cowlib to 2.9.1. + +=== Experimental features added + +* A `protocols` protocol option allows configuring which + protocol will be used for clear listeners. Setting it + to `[http2]` will disable HTTP/1.1 entirely. This feature + will be extended in a future release. + +=== Features modified + +* The default value for HTTP/1.1's `max_keepalive` option + has been increased. It now allows 1000 requests before + gracefully closing the connection. + +* The default value for HTTP/2's `max_received_frame_rate` + option has been increased. It now allows 10000 frames every + 10 seconds. + +* Cowboy will now accept whitespace in cookie names. This + is in line with the recommended parsing algorithm for the + upcoming cookie RFC update, and corresponds to what browsers + are doing. + +=== Bugs fixed + +* The number of Transport:send/2 calls has been optimized + for HTTP/2. Reducing the number of calls has a noticeable + impact on the number of requests that can be processed. + +* Trying to use `cowboy_req:reply/4` with a status code of + 204 or 304 and a non-empty response body will now result + in a crash. Using `cowboy_req:stream_reply/2,3` with 204 + or 304 and then attempting to send a body will also result + in a crash. These status codes disallow response bodies + and trying to send one will break HTTP/1.1 framing. + +* A crash has been fixed related to HTTP/1.1 pipelining. + The bug was most likely introduced in Cowboy 2.6 when + flow control was added for HTTP/1.1 request bodies. + +* The HTTP/1.1 protocol code could get stuck because of flow + control. This has been corrected. + +* A crash has been fixed for HTTP/1.1. It occurred when + a flow control update was requested (such as reading + the request body) after the body was fully read. + +* The timeout was incorrectly reset sometimes when a stream + (a pair of request/response) terminated. This has been + corrected. + +* Handling of hibernation for Websocket has been improved. + Websocket over HTTP/2 now supports hibernating. Stray + messages no longer cancel hibernation. + +* The `cowboy_compress_h` stream handler will now ignore + malformed accept-encoding headers instead of crashing. + +* The manual pages for `cowboy:start_clear(3)` and + `cowboy:start_tls(3)` now mentions that some protocol + options may be documented in the releevant stream + handler. + +* The manual page for `cowboy_req:parse_header(3)` was + corrected. When an unsupported header is given the + function crashes, it does not return an `undefined` tuple. + +* The routing algorithm description in the user guide has + been improved. + +* The test suites are now consistently green on all tested + platforms. Most of the test failures were caused by flaky + tests. Avoiding the use of timeouts fixed most of them. + A small number of tests had to be reworked. diff --git a/docs/en/cowboy/2.12/guide/migrating_from_2.7/index.html b/docs/en/cowboy/2.12/guide/migrating_from_2.7/index.html new file mode 100644 index 00000000..dd6ae479 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.7/index.html @@ -0,0 +1,235 @@ +<!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.7 to 2.8</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=7" 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.7 to 2.8</span></h1> + +<p>Cowboy 2.8 contains many optimizations for all protocols. HTTP/1.1 has received the largest improvements and Cowboy will now be able to handle noticeably more requests. Thanks to the folks at Stressgrid for helping identify that the performance was lower than it should have been and for benchmarking my many changes and experiments.</p> +<p>Cowboy 2.8 also contains a small number of tweaks and bug fixes. Cowboy 2.8 is the first Cowboy release, ever, to be consistently green on all tested platforms. This is mostly due to the reworking of some test cases, but a few bugs were discovered and fixed in the process.</p> +<p>Cowboy 2.8 requires Erlang/OTP 22.0 or greater. It may also work out of the box with Erlang/OTP 21.3 but this was not tested and is not supported.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Cowboy will now use <code>active,N</code> instead of <code>active,once</code> to receive data from the socket. This greatly improves the performance and allows Cowboy to process more requests, especially for HTTP/1.1. The <code>active_n</code> protocol option can be configured to change the <code>active,N</code> value. The default is 100 for all protocols. +</li> +<li>Add a <code>linger_timeout</code> option for HTTP/2. The default is 1000, or one second. This helps ensure that the final GOAWAY frame will be properly received by clients. +</li> +<li>The function <code>cowboy_req:parse_header/2,3</code> will now parse the headers <code>access-control-request-headers</code>, <code>access-control-request-method</code>, <code>content-encoding</code>, <code>content-language</code>, <code>max-forwards</code>, <code>origin</code>, <code>proxy-authorization</code> and <code>trailer</code>. +</li> +<li>A Performance chapter has been added to the guide. More content will be added in future releases. +</li> +<li>Update Cowlib to 2.9.1. +</li> +</ul> +<h2 id="_experimental_features_added">Experimental features added</h2> +<ul><li>A <code>protocols</code> protocol option allows configuring which protocol will be used for clear listeners. Setting it to <code>[http2]</code> will disable HTTP/1.1 entirely. This feature will be extended in a future release. +</li> +</ul> +<h2 id="_features_modified">Features modified</h2> +<ul><li>The default value for HTTP/1.1's <code>max_keepalive</code> option has been increased. It now allows 1000 requests before gracefully closing the connection. +</li> +<li>The default value for HTTP/2's <code>max_received_frame_rate</code> option has been increased. It now allows 10000 frames every 10 seconds. +</li> +<li>Cowboy will now accept whitespace in cookie names. This is in line with the recommended parsing algorithm for the upcoming cookie RFC update, and corresponds to what browsers are doing. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>The number of Transport:send/2 calls has been optimized for HTTP/2. Reducing the number of calls has a noticeable impact on the number of requests that can be processed. +</li> +<li>Trying to use <code>cowboy_req:reply/4</code> with a status code of 204 or 304 and a non-empty response body will now result in a crash. Using <code>cowboy_req:stream_reply/2,3</code> with 204 or 304 and then attempting to send a body will also result in a crash. These status codes disallow response bodies and trying to send one will break HTTP/1.1 framing. +</li> +<li>A crash has been fixed related to HTTP/1.1 pipelining. The bug was most likely introduced in Cowboy 2.6 when flow control was added for HTTP/1.1 request bodies. +</li> +<li>The HTTP/1.1 protocol code could get stuck because of flow control. This has been corrected. +</li> +<li>A crash has been fixed for HTTP/1.1. It occurred when a flow control update was requested (such as reading the request body) after the body was fully read. +</li> +<li>The timeout was incorrectly reset sometimes when a stream (a pair of request/response) terminated. This has been corrected. +</li> +<li>Handling of hibernation for Websocket has been improved. Websocket over HTTP/2 now supports hibernating. Stray messages no longer cancel hibernation. +</li> +<li>The <code>cowboy_compress_h</code> stream handler will now ignore malformed accept-encoding headers instead of crashing. +</li> +<li>The manual pages for <code>cowboy:start_clear(3)</code> and <code>cowboy:start_tls(3)</code> now mentions that some protocol options may be documented in the releevant stream handler. +</li> +<li>The manual page for <code>cowboy_req:parse_header(3)</code> was corrected. When an unsupported header is given the function crashes, it does not return an <code>undefined</code> tuple. +</li> +<li>The routing algorithm description in the user guide has been improved. +</li> +<li>The test suites are now consistently green on all tested platforms. Most of the test failures were caused by flaky tests. Avoiding the use of timeouts fixed most of them. A small number of tests had to be reworked. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.8/"> + Migrating from Cowboy 2.8 to 2.9 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.6/"> + Migrating from Cowboy 2.6 to 2.7 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/migrating_from_2.8.asciidoc b/docs/en/cowboy/2.12/guide/migrating_from_2.8.asciidoc new file mode 100644 index 00000000..a3a0e7c2 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.8.asciidoc @@ -0,0 +1,50 @@ +[appendix] +== Migrating from Cowboy 2.8 to 2.9 + +Cowboy 2.9 implements graceful shutdown of connection +processes for both HTTP/1.1 and HTTP/2 connections. + +Cowboy 2.9 is the first release to support the much +awaited Erlang/OTP 24 out of the box. While users that +were using Ranch 2.0 already were ready for OTP 24, +the Ranch version used by Cowboy out of the box was +not compatible and had to be updated. + +Cowboy 2.9 also contains a small number of tweaks +and bug fixes. + +Cowboy 2.9 requires Erlang/OTP 22.0 or greater. + +=== Features added + +* Cowboy will now gracefully shutdown HTTP/1.1 and HTTP/2 + connections when the supervisor asks the connection + process to exit, or when `sys:terminate/2,3` is used. + Two new configuration options were added for HTTP/2 + to determine the timeouts for the graceful shutdown + steps. + +* REST handler `AcceptCallback` can now return `{created, URI}` + or `{see_other, URI}` to determine what response status code + should be sent (typically to differentiate between a new + resource and an update). The return value `{true, URI}` is + now deprecated. + +* Update Ranch to 1.8.0. + +* Update Cowlib to 2.11.0. + +=== Bugs fixed + +* Fix concurrent body streaming getting stuck with HTTP/2. + The alarm could get into blocking state indefinitely + when two or more request processes were streaming bodies. + +* Fix HTTP/2 rate limiting using the wrong default values + in some cases. + +* Don't produce an error report when the request process + exited normally (`normal` or `shutdown` exit reasons). + +* Fix `cowboy_tracer_h` to support trace messages without + timestamps. diff --git a/docs/en/cowboy/2.12/guide/migrating_from_2.8/index.html b/docs/en/cowboy/2.12/guide/migrating_from_2.8/index.html new file mode 100644 index 00000000..23f60fd9 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.8/index.html @@ -0,0 +1,206 @@ +<!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.8 to 2.9</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=7" 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.8 to 2.9</span></h1> + +<p>Cowboy 2.9 implements graceful shutdown of connection processes for both HTTP/1.1 and HTTP/2 connections.</p> +<p>Cowboy 2.9 is the first release to support the much awaited Erlang/OTP 24 out of the box. While users that were using Ranch 2.0 already were ready for OTP 24, the Ranch version used by Cowboy out of the box was not compatible and had to be updated.</p> +<p>Cowboy 2.9 also contains a small number of tweaks and bug fixes.</p> +<p>Cowboy 2.9 requires Erlang/OTP 22.0 or greater.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Cowboy will now gracefully shutdown HTTP/1.1 and HTTP/2 connections when the supervisor asks the connection process to exit, or when <code>sys:terminate/2,3</code> is used. Two new configuration options were added for HTTP/2 to determine the timeouts for the graceful shutdown steps. +</li> +<li>REST handler <code>AcceptCallback</code> can now return <code>{created, URI}</code> or <code>{see_other, URI}</code> to determine what response status code should be sent (typically to differentiate between a new resource and an update). The return value <code>{true, URI}</code> is now deprecated. +</li> +<li>Update Ranch to 1.8.0. +</li> +<li>Update Cowlib to 2.11.0. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>Fix concurrent body streaming getting stuck with HTTP/2. The alarm could get into blocking state indefinitely when two or more request processes were streaming bodies. +</li> +<li>Fix HTTP/2 rate limiting using the wrong default values in some cases. +</li> +<li>Don't produce an error report when the request process exited normally (<code>normal</code> or <code>shutdown</code> exit reasons). +</li> +<li>Fix <code>cowboy_tracer_h</code> to support trace messages without timestamps. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.9/"> + Migrating from Cowboy 2.9 to 2.10 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.7/"> + Migrating from Cowboy 2.7 to 2.8 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/migrating_from_2.9.asciidoc b/docs/en/cowboy/2.12/guide/migrating_from_2.9.asciidoc new file mode 100644 index 00000000..7395e5f1 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.9.asciidoc @@ -0,0 +1,42 @@ +[appendix] +== Migrating from Cowboy 2.9 to 2.10 + +Cowboy 2.10 is a maintenance release adding support +for Erlang/OTP 26. The main change is a Cowlib update +to fix a compilation error that only occurs starting +from OTP 26. + +Cowboy 2.10 requires Erlang/OTP 22.0 or greater. + +=== Features added + +* Add support for `Default` value of SameSite + cookie attribute. + +* Add support for the `stale-*` cache-control directives + from RFC 5861. + +* Update Cowlib to 2.12.1. + +=== Bugs fixed + +* Fix a compilation error in Cowlib when using Erlang/OTP 26. + +* Fix data sent after RST_STREAM in HTTP/2 in rare cases. + +* Fix parsing of RST_STREAM frames to properly handle + frames that have a valid length but were not fully + received yet. + +* Remove the obsolete `Version` cookie attribute. + +* Handle more edge cases for cookie parsing based on updates + to the RFC 6265bis draft. + +* Make Basic auth parsing ignore unknown authentication + parameters and generally update the code to conform + to RFC 7617. + +* Fix URI template reserved expansion of %-encoded. + +* Update structured headers implementation to RFC 8941. diff --git a/docs/en/cowboy/2.12/guide/migrating_from_2.9/index.html b/docs/en/cowboy/2.12/guide/migrating_from_2.9/index.html new file mode 100644 index 00000000..ce8532b0 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/migrating_from_2.9/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: Migrating from Cowboy 2.9 to 2.10</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=7" 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.9 to 2.10</span></h1> + +<p>Cowboy 2.10 is a maintenance release adding support for Erlang/OTP 26. The main change is a Cowlib update to fix a compilation error that only occurs starting from OTP 26.</p> +<p>Cowboy 2.10 requires Erlang/OTP 22.0 or greater.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Add support for <code>Default</code> value of SameSite cookie attribute. +</li> +<li>Add support for the <code>stale-*</code> cache-control directives from RFC 5861. +</li> +<li>Update Cowlib to 2.12.1. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>Fix a compilation error in Cowlib when using Erlang/OTP 26. +</li> +<li>Fix data sent after RST_STREAM in HTTP/2 in rare cases. +</li> +<li>Fix parsing of RST_STREAM frames to properly handle frames that have a valid length but were not fully received yet. +</li> +<li>Remove the obsolete <code>Version</code> cookie attribute. +</li> +<li>Handle more edge cases for cookie parsing based on updates to the RFC 6265bis draft. +</li> +<li>Make Basic auth parsing ignore unknown authentication parameters and generally update the code to conform to RFC 7617. +</li> +<li>Fix URI template reserved expansion of %-encoded. +</li> +<li>Update structured headers implementation to RFC 8941. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.10/"> + Migrating from Cowboy 2.10 to 2.11 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.8/"> + Migrating from Cowboy 2.8 to 2.9 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/modern_web.asciidoc b/docs/en/cowboy/2.12/guide/modern_web.asciidoc new file mode 100644 index 00000000..48525732 --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/modern_web/index.html b/docs/en/cowboy/2.12/guide/modern_web/index.html new file mode 100644 index 00000000..971aada2 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/modern_web/index.html @@ -0,0 +1,209 @@ +<!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=7" 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.12/guide/erlang_web/"> + Erlang and the Web + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/multipart.asciidoc b/docs/en/cowboy/2.12/guide/multipart.asciidoc new file mode 100644 index 00000000..0825244c --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/multipart/index.html b/docs/en/cowboy/2.12/guide/multipart/index.html new file mode 100644 index 00000000..44904fca --- /dev/null +++ b/docs/en/cowboy/2.12/guide/multipart/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: 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=7" 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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.12/guide/cookies/"> + Using cookies + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/rest_principles/"> + REST principles + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/performance.asciidoc b/docs/en/cowboy/2.12/guide/performance.asciidoc new file mode 100644 index 00000000..10031302 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/performance.asciidoc @@ -0,0 +1,29 @@ +[[performance]] +== Performance + +This chapter describes the performance characteristics +of Cowboy and offers suggestions to get the most +performance out of your application. + +=== One process per connection + +The first version of Cowboy featured a single process +per connection, whereas the current version of Cowboy +features one process per connection plus one process +per request. This has a negative impact on performance, +but is necessary in order to provide a common interface +for both HTTP/1.1 and HTTP/2 (as well as future HTTP +versions). + +It is still possible to use a single process per +connection, and avoid the creation of additional +processes for each request, by implementing a +stream handler to process the requests. This can +be done for all requests, or just for a single +endpoint depending on the application's needs. + +Stream handlers provide an asynchronous interface +and must not block, so the implementation will +be very different from normal Cowboy handlers, +but the performance gains are important enough +to justify it in some cases. diff --git a/docs/en/cowboy/2.12/guide/performance/index.html b/docs/en/cowboy/2.12/guide/performance/index.html new file mode 100644 index 00000000..3f481d56 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/performance/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: Performance</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=7" 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>Performance</span></h1> + +<p>This chapter describes the performance characteristics of Cowboy and offers suggestions to get the most performance out of your application.</p> +<h2 id="_one_process_per_connection">One process per connection</h2> +<p>The first version of Cowboy featured a single process per connection, whereas the current version of Cowboy features one process per connection plus one process per request. This has a negative impact on performance, but is necessary in order to provide a common interface for both HTTP/1.1 and HTTP/2 (as well as future HTTP versions).</p> +<p>It is still possible to use a single process per connection, and avoid the creation of additional processes for each request, by implementing a stream handler to process the requests. This can be done for all requests, or just for a single endpoint depending on the application's needs.</p> +<p>Stream handlers provide an asynchronous interface and must not block, so the implementation will be very different from normal Cowboy handlers, but the performance gains are important enough to justify it in some cases.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/middlewares/"> + Middlewares + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.11/"> + Migrating from Cowboy 2.11 to 2.12 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/req.asciidoc b/docs/en/cowboy/2.12/guide/req.asciidoc new file mode 100644 index 00000000..754e4705 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/req.asciidoc @@ -0,0 +1,367 @@ +[[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 is allowed, but extra caution +must be used when modifying existing fields. You can +add as many new fields as necessary, however. Just make +sure to namespace the field names so that no conflict +can occur with future Cowboy updates or with 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.12/guide/req/index.html b/docs/en/cowboy/2.12/guide/req/index.html new file mode 100644 index 00000000..810c4562 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/req/index.html @@ -0,0 +1,457 @@ +<!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=7" 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.9 +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 is allowed, but extra caution must be used when modifying existing fields. You can add as many new fields as necessary, however. Just make sure to namespace the field names so that no conflict can occur with future Cowboy updates or with 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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.12/guide/static_files/"> + Static files + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/req_body/"> + Reading the request body + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/req_body.asciidoc b/docs/en/cowboy/2.12/guide/req_body.asciidoc new file mode 100644 index 00000000..88389f64 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/req_body.asciidoc @@ -0,0 +1,146 @@ +[[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}). +---- + +These two options can effectively be used to control +the rate of transmission of the request body. + +It is also possible to asynchronously read the request +body using auto mode: + +[source,erlang] +---- +Ref = make_ref(), +cowboy_req:cast({read_body, self(), Ref, auto, infinity}, Req). +---- + +Cowboy will wait indefinitely for data and then send a +`request_body` message as soon as it has data available, +regardless of length. + +[source,erlang] +---- +receive + {request_body, Ref, nofin, Data} -> + do_something(Data); + {request_body, Ref, fin, _BodyLen, Data} -> + do_something(Data) +end. +---- + +Asynchronous reading of data pairs well with loop handlers. + +=== 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.12/guide/req_body/index.html b/docs/en/cowboy/2.12/guide/req_body/index.html new file mode 100644 index 00000000..a0130b5d --- /dev/null +++ b/docs/en/cowboy/2.12/guide/req_body/index.html @@ -0,0 +1,281 @@ +<!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=7" 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.9 +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.9 +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.9 +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.9 +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>These two options can effectively be used to control the rate of transmission of the request body.</p> +<p>It is also possible to asynchronously read the request body using auto mode:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Ref</font> <font color="#990000">=</font> <b><font color="#000080">make_ref</font></b>(), +<b><font color="#000000">cowboy_req:cast</font></b>({<font color="#FF6600">read_body</font>, <b><font color="#000080">self</font></b>(), <font color="#009900">Ref</font>, <font color="#FF6600">auto</font>, <font color="#FF6600">infinity</font>}, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Cowboy will wait indefinitely for data and then send a <code>request_body</code> message as soon as it has data available, regardless of length.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">request_body</font>, <font color="#009900">Ref</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Data</font>} <font color="#990000">-></font> + <b><font color="#000000">do_something</font></b>(<font color="#009900">Data</font>); + {<font color="#FF6600">request_body</font>, <font color="#009900">Ref</font>, <font color="#FF6600">fin</font>, <font color="#009900">_BodyLen</font>, <font color="#009900">Data</font>} <font color="#990000">-></font> + <b><font color="#000000">do_something</font></b>(<font color="#009900">Data</font>) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>Asynchronous reading of data pairs well with loop handlers.</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.9 +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.9 +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.9 +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.12/guide/req/"> + The Req object + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/resp/"> + Sending a response + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/resource_design.asciidoc b/docs/en/cowboy/2.12/guide/resource_design.asciidoc new file mode 100644 index 00000000..125b437c --- /dev/null +++ b/docs/en/cowboy/2.12/guide/resource_design.asciidoc @@ -0,0 +1,241 @@ +[[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. + +Does the resource accept ranged requests? If it does, +implement the `ranges_provided` callback. Resources that +only accept `bytes` units can use the callback name +`auto` and let Cowboy automatically do ranged responses. +Other callbacks should have a name prefix of `ranged_` +for clarity. For example, `ranged_bytes` or `ranged_pages`. +If the resource needs to perform additional checks before +accepting to do a ranged responses, implement the +`range_satisfiable` callback. + +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 `ProvideCallback` callback for each +content-type returned by the `content_types_provided` +callback. + +When range requests are accepted, you must implement one +`RangeCallback` for each range unit returned by +`ranges_provided` (unless `auto` was used). This is +in addition to the `ProvideCallback` 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.12/guide/resource_design/index.html b/docs/en/cowboy/2.12/guide/resource_design/index.html new file mode 100644 index 00000000..6a9833b6 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/resource_design/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: 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=7" 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>Does the resource accept ranged requests? If it does, implement the <code>ranges_provided</code> callback. Resources that only accept <code>bytes</code> units can use the callback name <code>auto</code> and let Cowboy automatically do ranged responses. Other callbacks should have a name prefix of <code>ranged_</code> for clarity. For example, <code>ranged_bytes</code> or <code>ranged_pages</code>. If the resource needs to perform additional checks before accepting to do a ranged responses, implement the <code>range_satisfiable</code> callback.</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>ProvideCallback</code> callback for each content-type returned by the <code>content_types_provided</code> callback.</p> +<p>When range requests are accepted, you must implement one <code>RangeCallback</code> for each range unit returned by <code>ranges_provided</code> (unless <code>auto</code> was used). This is in addition to the <code>ProvideCallback</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.12/guide/rest_flowcharts/"> + REST flowcharts + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/ws_protocol/"> + The Websocket protocol + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/resp.asciidoc b/docs/en/cowboy/2.12/guide/resp.asciidoc new file mode 100644 index 00000000..1664aefc --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/resp/index.html b/docs/en/cowboy/2.12/guide/resp/index.html new file mode 100644 index 00000000..ff55132e --- /dev/null +++ b/docs/en/cowboy/2.12/guide/resp/index.html @@ -0,0 +1,424 @@ +<!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=7" 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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.12/guide/req_body/"> + Reading the request body + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/cookies/"> + Using cookies + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/rest_cond.png b/docs/en/cowboy/2.12/guide/rest_cond.png Binary files differnew file mode 100644 index 00000000..64cda347 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_cond.png diff --git a/docs/en/cowboy/2.12/guide/rest_cond.svg b/docs/en/cowboy/2.12/guide/rest_cond.svg new file mode 100644 index 00000000..542ae17d --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/rest_conneg.png b/docs/en/cowboy/2.12/guide/rest_conneg.png Binary files differnew file mode 100644 index 00000000..79aa69b6 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_conneg.png diff --git a/docs/en/cowboy/2.12/guide/rest_conneg.svg b/docs/en/cowboy/2.12/guide/rest_conneg.svg new file mode 100644 index 00000000..97bba6a3 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_conneg.svg @@ -0,0 +1,1196 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + width="744.09448819" + height="1052.3622047" + id="svg2" + version="1.1" + inkscape:version="1.3.2 (091e20ef0f, 2023-11-25, custom)" + sodipodi:docname="rest_conneg.svg" + inkscape:export-filename="/home/essen/Dropbox/Public/drawing.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns="http://www.w3.org/2000/svg" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:dc="http://purl.org/dc/elements/1.1/"> + <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" + inkscape:swatch="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.65304847" + inkscape:cx="259.55194" + inkscape:cy="483.11881" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="false" + inkscape:window-width="1440" + inkscape:window-height="900" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="1" + inkscape:snap-global="true" + showguides="true" + inkscape:showpageshadow="2" + inkscape:pagecheckerboard="0" + inkscape:deskcolor="#d1d1d1"> + <inkscape:grid + type="xygrid" + id="grid5357" + empspacing="5" + visible="false" + enabled="true" + snapvisiblegridlinesonly="true" + originx="0" + originy="0" + spacingy="1" + spacingx="1" + units="px" /> + </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="rest_conneg.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-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="246.18575" + y="310.19913" + 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="246.18575" + y="310.19913" + style="font-size:16px;line-height:1.25;font-family:sans-serif">has accept-language?</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="245.60762" + y="477.47531" + 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="245.60762" + y="477.47531" + style="font-size:16px;line-height:1.25;font-family:sans-serif">has accept-charset?</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="245.00391" + y="60.912468" + 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="245.00391" + y="60.912468" + id="tspan17171" + style="font-size:16px;line-height:1.25;font-family:sans-serif">start</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="246.11153" + y="561.14258" + 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="246.11153" + y="561.14258" + style="font-size:16px;line-height:1.25;font-family:sans-serif">charsets_provided</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="246.64278" + y="646.58331" + id="text5371-2-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-2" + x="246.64278" + y="646.58331" + style="font-size:16px;line-height:1.25;font-family:sans-serif">ranges_provided</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="246.13106" + y="142.80627" + 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="246.13106" + y="142.80627" + style="font-size:16px;line-height:1.25;font-family:sans-serif">has accept?</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="245.80684" + y="226.4736" + 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="245.80684" + y="226.4736" + style="font-size:16px;line-height:1.25;font-family:sans-serif">content_types_provided</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="246.05293" + y="393.80801" + 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="246.05293" + y="393.80801" + style="font-size:16px;line-height:1.25;font-family:sans-serif">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-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="262.26562" + y="185.95248" + 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="262.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="262.26562" + y="269.61978" + id="text5371-2-954" + 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" + style="font-size:16px;line-height:1.25;font-family:sans-serif">provided*</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="262.26562" + y="353.28702" + id="text5371-2-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-11" + x="262.26562" + y="353.28702" + 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="262.26562" + y="436.95425" + id="text5371-2-92" + 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" + style="font-size:16px;line-height:1.25;font-family:sans-serif">provided*</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="262.26562" + y="520.62152" + id="text5371-2-739" + 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" + 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="262.26562" + y="604.28876" + 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="262.26562" + y="604.28876" + style="font-size:16px;line-height:1.25;font-family:sans-serif">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-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="76.761719" + y="227.88033" + 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="76.761719" + y="227.88033" + 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="76.761719" + y="395.20209" + id="text5371-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-01" + x="76.761719" + y="395.20209" + 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="413.26172" + y="374.19577" + id="text5371-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-9-62" + x="413.26172" + y="374.19577" + style="font-size:16px;line-height:1.25;font-family:sans-serif">not provided*</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="76.761719" + y="562.52386" + id="text5371-4-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" + x="76.761719" + y="562.52386" + 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="-8.8034744" + y="663.24762" + id="text5371-4-5" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" + transform="rotate(-42.1753)"><tspan + sodipodi:role="line" + id="tspan5373-9-09" + x="-8.8034744" + y="663.24762" + style="font-size:16px;line-height:1.25;font-family:sans-serif">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-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="599.20062" + y="394.09869" + 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="599.20062" + y="394.09869" + style="font-size:16px;line-height:1.25;font-family:sans-serif">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-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> + <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-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="509.41452" + y="-106.16136" + id="text5371-4-5-9" + inkscape:export-filename="/home/essen/ninenines/cowboy/guide/rest_options.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643" + transform="rotate(45.988027)"><tspan + sodipodi:role="line" + id="tspan5373-9-09-1" + x="509.41452" + y="-106.16136" + style="font-size:16px;line-height:1.25;font-family:sans-serif">not provided*</tspan></text> + <g + transform="translate(303.92156,372.14538)" + id="g5650-6-2-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-4-5" + 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-2-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> + <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-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="246.15048" + y="730.10156" + id="text5371-2-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-2-1" + x="246.15048" + y="730.10156" + style="font-size:16px;line-height:1.25;font-family:sans-serif">variances</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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-41-0-2" + width="210.17955" + height="35.209244" + x="141.049" + y="789.44257" + 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="246.15047" + y="808.03937" + id="text5371-2-7-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-2-1-1" + x="246.15047" + y="808.03937" + style="font-size:16px;line-height:1.25;font-family:sans-serif">...</tspan></text> + </g> +</svg> diff --git a/docs/en/cowboy/2.12/guide/rest_delete.png b/docs/en/cowboy/2.12/guide/rest_delete.png Binary files differnew file mode 100644 index 00000000..56a861c0 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_delete.png diff --git a/docs/en/cowboy/2.12/guide/rest_delete.svg b/docs/en/cowboy/2.12/guide/rest_delete.svg new file mode 100644 index 00000000..2f5513cd --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/rest_flowcharts.asciidoc b/docs/en/cowboy/2.12/guide/rest_flowcharts.asciidoc new file mode 100644 index 00000000..b8d0e0d5 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_flowcharts.asciidoc @@ -0,0 +1,261 @@ +[[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. The star next +to values indicate that the value is descriptive rather than exact. + +=== 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. + +Optionally, the `ranges_provided` also returns the +name of a callback for every range unit it accepts. This +will be called at the end of the "GET and HEAD methods" +diagram in the case of ranged requests. + +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 `ProvideCallback` 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. + +For ranged requests, but only when the `ranges_provided` +callback was defined earlier, Cowboy will add the selected +`range` information to the Req object and call the +`range_satisfiable` callback. After confirming that the +range can be provided, Cowboy calls the `RangeResource` +callback and produces a ranged response using the +ranged data from the callback. + +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.12/guide/rest_flowcharts/index.html b/docs/en/cowboy/2.12/guide/rest_flowcharts/index.html new file mode 100644 index 00000000..0ee17628 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_flowcharts/index.html @@ -0,0 +1,241 @@ +<!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=7" 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. The star next to values indicate that the value is descriptive rather than exact.</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>Optionally, the <code>ranges_provided</code> also returns the name of a callback for every range unit it accepts. This will be called at the end of the "GET and HEAD methods" diagram in the case of ranged requests.</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>ProvideCallback</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.</p> +<p>For ranged requests, but only when the <code>ranges_provided</code> callback was defined earlier, Cowboy will add the selected <code>range</code> information to the Req object and call the <code>range_satisfiable</code> callback. After confirming that the range can be provided, Cowboy calls the <code>RangeResource</code> callback and produces a ranged response using the ranged data from the callback.</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.12/guide/rest_handlers/"> + REST handlers + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/resource_design/"> + Designing a resource handler + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/rest_get_head.png b/docs/en/cowboy/2.12/guide/rest_get_head.png Binary files differnew file mode 100644 index 00000000..24f8de45 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_get_head.png diff --git a/docs/en/cowboy/2.12/guide/rest_get_head.svg b/docs/en/cowboy/2.12/guide/rest_get_head.svg new file mode 100644 index 00000000..cf660897 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_get_head.svg @@ -0,0 +1,2450 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + width="744.09448819" + height="1052.3622047" + id="svg2" + version="1.1" + inkscape:version="1.3.2 (091e20ef0f, 2023-11-25, custom)" + sodipodi:docname="rest_get_head.svg" + inkscape:export-filename="/home/essen/Dropbox/Public/drawing.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns="http://www.w3.org/2000/svg" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:dc="http://purl.org/dc/elements/1.1/"> + <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" + inkscape:swatch="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.66612663" + inkscape:cx="444.35996" + inkscape:cy="784.3854" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="false" + inkscape:window-width="1440" + inkscape:window-height="900" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="1" + inkscape:snap-global="true" + showguides="true" + inkscape:showpageshadow="2" + inkscape:pagecheckerboard="0" + inkscape:deskcolor="#d1d1d1"> + <inkscape:grid + type="xygrid" + id="grid5357" + empspacing="5" + visible="false" + enabled="true" + snapvisiblegridlinesonly="true" + originx="0" + originy="0" + spacingy="1" + spacingx="1" + units="px" /> + </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="rotate(57.423293,-360.21231,998.44074)" + id="g5650-2-6-7" + inkscape:export-filename="rest_get_head.png" + inkscape:export-xdpi="89.926643" + inkscape:export-ydpi="89.926643"> + <path + inkscape:connector-curvature="0" + id="path5570-2-10-6" + 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-6-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="rotate(90,13.664042,694.60225)" + id="g5650-2-2-17-9"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-0-4" + d="m -57.78256,343.20394 v 61.59661" + 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-5-45-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="rotate(142.84301,-18.689938,738.63976)" + id="g5650-2-2-17-9-1"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-0-4-2" + d="m -57.78256,343.20394 v 61.59661" + 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-5-45-9-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="rotate(57.423293,-61.041025,828.63629)" + id="g5650-2-6"> + <path + inkscape:connector-curvature="0" + id="path5570-2-10" + d="M -57.78256,275.13761 V 404.27753" + 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-12-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="matrix(0.53842825,-0.84267136,-0.84267136,-0.53842825,668.22258,813.26466)" + id="g5650-2-6-0"> + <path + inkscape:connector-curvature="0" + id="path5570-2-10-9" + 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-6-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0.7948003,-0.60687106,-0.60687106,-0.7948003,570.69023,937.57491)" + id="g5650-2-6-0-1"> + <path + inkscape:connector-curvature="0" + id="path5570-2-10-9-1" + d="m -56.935096,252.07781 -0.800167,152.0263" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2.35779;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-6-1-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> + <g + transform="translate(656.82134,696.68054)" + id="g5650-93-2-6-9-5-7-3-5-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-3-7-2-2-9-3-1-4-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-4-0-6-0-2-6-9-7-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="translate(400.94834,696.68054)" + id="g5650-93-2-6-9-5-7-3-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-3-7-2-2-9-3-1-4" + 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-4-0-6-0-2-6-9-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> + <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(674.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 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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="translate(528.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 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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="translate(528.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 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="translate(528.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 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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="translate(240.08356,270.33438)" + 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 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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="translate(240.08356,353.23338)" + 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 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> + <g + transform="translate(528.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 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-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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-28" + width="210.17955" + height="35.209244" + x="366.01282" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-5" + width="210.17955" + height="35.209244" + x="366.01282" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8" + width="210.17955" + height="35.209244" + x="366.01282" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-4" + width="210.17955" + height="35.209244" + x="81.249367" + y="605.55103" + 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="rotate(-90,235.94692,576.81149)" + 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-dasharray:none;stroke-opacity:1" + 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="rotate(90,-13.918835,262.77429)" /> + <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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-87" + width="210.17955" + height="35.209244" + x="81.249367" + y="688.07202" + 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="rotate(-45,86.402746,-699.267)" + id="g5650-2-2-8"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-4" + d="m -57.78256,343.20394 v 61.59661" + 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-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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1" + width="210.17955" + height="35.209244" + x="511.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(788.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="471.07526" + 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="471.07526" + 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="185.63515" + y="629.15564" + 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="185.63515" + y="629.15564" + style="font-size:16px;line-height:1.25;font-family:sans-serif">ProvideCallback</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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-4-4" + width="210.17955" + height="35.209244" + x="238.076" + y="1018.396" + 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="342.46179" + y="1042.0006" + id="text5371-2-3-0-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-7-3-0" + x="342.46179" + y="1042.0006" + 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="617.14185" + y="50.114025" + 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="617.14185" + y="50.114025" + 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="186.01915" + y="709.83667" + 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="186.01915" + y="709.83667" + 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="616.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="616.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="471.38776" + 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="471.38776" + 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="471.05573" + 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="471.05573" + y="462.5274" + style="font-size:16px;line-height:1.25;font-family:sans-serif">expires</tspan></text> + <g + transform="translate(528.88515,270.08038)" + id="g5650-93-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-3-7" + 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-4-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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8-93" + width="210.17955" + height="35.209244" + x="366.013" + 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" /> + <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="470.63077" + y="627.31525" + id="text5371-2-74-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-18-0" + x="470.63077" + y="627.31525" + style="font-size:16px;line-height:1.25;font-family:sans-serif">has range?</tspan></text> + <g + transform="translate(528.88515,187.69716)" + id="g5650-93-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-3-7-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-4-0-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> + <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-8-93-1" + width="210.17955" + height="35.209244" + x="366.013" + 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="470.63077" + y="544.79431" + id="text5371-2-74-6-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-18-0-7" + x="470.63077" + y="544.79431" + style="font-size:16px;line-height:1.25;font-family:sans-serif">resource provides ranges?</tspan></text> + <g + transform="translate(528.88515,353.49259)" + id="g5650-93-2-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-3-7-2-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-4-0-6-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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8-93-1-2" + width="210.17955" + height="35.209244" + x="366.013" + 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="470.63077" + y="709.63556" + id="text5371-2-74-6-8-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-0-7-7" + x="470.63077" + y="709.63556" + style="font-size:16px;line-height:1.25;font-family:sans-serif">has if-range?</tspan></text> + <g + transform="translate(528.88515,435.58038)" + id="g5650-93-2-6-9-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-3-7-2-2-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-4-0-6-0-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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8-93-1-2-2" + width="210.17955" + height="35.209244" + x="366.013" + 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" /> + <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="470.63077" + y="792.59778" + id="text5371-2-74-6-8-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-18-0-7-7-9" + x="470.63077" + y="792.59778" + style="font-size:16px;line-height:1.25;font-family:sans-serif">requested range provided?</tspan></text> + <g + transform="translate(528.88515,518.28038)" + id="g5650-93-2-6-9-5-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-7-2-2-9-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-4-0-6-0-2-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> + <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-8-93-1-2-2-1" + width="210.17955" + height="35.209244" + x="366.013" + y="853.35419" + 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="470.83078" + y="875.15881" + id="text5371-2-74-6-8-3-8-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-6-18-0-7-7-9-9" + x="470.83078" + y="875.15881" + style="font-size:16px;line-height:1.25;font-family:sans-serif">range_satisfiable</tspan></text> + <g + transform="rotate(-34.012747,1234.1863,-299.61425)" + id="g5650-93-2-6-9-5-7-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-3-7-2-2-9-3-1" + 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-4-0-6-0-2-6-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> + <g + transform="rotate(33.477859,-837.91737,1442.2703)" + id="g5650-93-2-6-9-5-7-3-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-3-7-2-2-9-3-1-43" + 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-4-0-6-0-2-6-9-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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8-93-1-2-2-1-4" + width="210.17955" + height="35.209244" + x="366.013" + y="935.875" + 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="470.94278" + y="957.45563" + id="text5371-2-74-6-8-3-8-2-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-0-7-7-9-9-8" + x="470.94278" + y="957.45563" + style="font-size:16px;line-height:1.25;font-family:sans-serif">automatic range?</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="509.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="509.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="336.74399" + y="1000.7801" + id="text5371-2-391-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-63-9" + x="336.74399" + y="1000.7801" + 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="484.61441" + y="669.48737" + id="text5371-2-391-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-6-63-9-8" + x="484.61441" + y="669.48737" + 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="484.61441" + y="587.08673" + id="text5371-2-391-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-6-63-9-2" + x="484.61441" + y="587.08673" + 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="397.49249" + y="751.30035" + id="text5371-2-391-4-66" + 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-4" + x="397.49249" + y="751.30035" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false, or</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="484.61441" + y="834.89026" + id="text5371-2-391-4-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-63-9-0" + x="484.61441" + y="834.89026" + 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="484.61441" + y="917.41119" + id="text5371-2-391-4-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-63-9-87" + x="484.61441" + y="917.41119" + 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="570.74402" + y="1000.7801" + id="text5371-2-391-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-6-63-0" + x="570.74402" + y="1000.7801" + 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="130.73801" + y="752.90198" + 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="130.73801" + y="752.90198" + 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="705.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="705.26678" + y="176.39024" + 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="334.72018" + y="614.93298" + 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-5" + x="334.72018" + y="614.93298" + 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:#6d8e41;fill-opacity:1;stroke:none" + x="312.42276" + y="575.93713" + id="text5371-4-6-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-0-5-8" + x="312.42276" + y="575.93713" + style="font-size:16px;line-height:1.25;font-family:sans-serif;fill:#6d8e41;fill-opacity:1">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="323.40799" + y="900.71991" + id="text5371-4-6-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-9-0-5-6" + x="323.40799" + y="900.71991" + 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="318.40799" + y="744.23999" + id="text5371-4-6-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-0-5-7" + x="318.40799" + y="744.23999" + 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="372.94284" + y="665.52533" + id="text5371-4-6-1-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" + x="372.94284" + y="665.52533" + style="font-size:16px;line-height:1.25;font-family:sans-serif" + id="tspan10">no 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:end;letter-spacing:0px;word-spacing:0px;text-anchor:end;fill:#9b3b1c;fill-opacity:1;stroke:none" + x="218.43921" + y="1004.6766" + id="text5371-4-6-1-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" + x="218.43921" + y="1004.6766" + style="font-size:16px;line-height:1.25;font-family:sans-serif;text-align:end;text-anchor:end" + id="tspan10-9">error producing</tspan><tspan + sodipodi:role="line" + x="218.43921" + y="1024.6765" + style="font-size:16px;line-height:1.25;font-family:sans-serif;text-align:end;text-anchor:end" + id="tspan11">automatic</tspan><tspan + sodipodi:role="line" + x="218.43921" + y="1044.6765" + style="font-size:16px;line-height:1.25;font-family:sans-serif;text-align:end;text-anchor:end" + id="tspan12">ranged response</tspan></text> + <g + transform="translate(821.72619,-141.76777)" + id="g5650-2-2"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1" + d="m -57.78256,343.20394 v 61.59661" + 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-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:#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="23.607994" + y="793.70099" + 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="23.607994" + y="793.70099" + 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="803.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="803.12921" + y="257.43518" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <g + transform="rotate(45,477.95223,941.13721)" + 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 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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <use + x="0" + y="0" + xlink:href="#rect5273-22" + id="use5355-0" + transform="translate(642.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="471.38776" + 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="471.38776" + 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.735;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-1" + width="218.52127" + height="34.993004" + x="77.078499" + y="853.2215" + 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="186.33914" + y="874.87799" + 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="186.33914" + y="874.87799" + 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.735;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-8" + width="218.52127" + height="34.993004" + x="77.078499" + y="770.7005" + 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="185.95512" + y="793.91699" + 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="185.95512" + y="793.91699" + 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:start;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#6d8e41;fill-opacity:1;stroke:none" + x="360.77811" + y="1077.916" + id="text5371-2-8-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-6-3-0" + x="360.77811" + y="1077.916" + style="font-size:16px;line-height:1.25;font-family:sans-serif">automatic</tspan><tspan + sodipodi:role="line" + x="360.77811" + y="1097.916" + style="font-size:16px;line-height:1.25;font-family:sans-serif" + id="tspan4">ranged response</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-weight:normal;font-size:16px;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="484.05441" + y="751.09668" + id="text5371-2-8-2-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" + x="484.05441" + y="751.09668" + style="font-size:16px;line-height:1.25;font-family:sans-serif" + id="tspan6">strong etag match</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.735;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-8-6" + width="218.52127" + height="34.993004" + x="233.9435" + y="1114.3829" + 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="342.99612" + y="1137.7036" + 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-5" + x="342.99612" + y="1137.7036" + style="font-size:16px;line-height:1.25;font-family:sans-serif">206 partial content</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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-4-4-6" + width="210.17955" + height="35.209244" + x="493.94901" + y="1018.396" + 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="598.33478" + y="1040.1606" + id="text5371-2-3-0-5-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-7-3-0-6" + x="598.33478" + y="1040.1606" + style="font-size:16px;line-height:1.25;font-family:sans-serif">RangeCallback</tspan></text> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.735;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-8-6-4" + width="218.52127" + height="34.993004" + x="489.77835" + y="1114.1394" + 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="598.83099" + y="1137.4601" + id="text5371-43-3-1-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-1-5-4" + x="598.83099" + y="1137.4601" + style="font-size:16px;line-height:1.25;font-family:sans-serif">206 partial content</tspan></text> + <g + transform="matrix(0,-1,-1,0,1286.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-dasharray:none;stroke-opacity:1" + 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="rotate(90,-13.918835,262.77429)" /> + <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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-28-4" + width="210.17955" + height="35.209244" + x="658.85388" + 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="763.77954" + 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="763.77954" + 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="875.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="875.74426" + y="299.27689" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <g + transform="translate(821.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 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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,-1,0,1285.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-dasharray:none;stroke-opacity:1" + 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="rotate(90,-13.918835,262.77429)" /> + <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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-28-7" + width="210.17955" + height="35.209244" + x="658.85388" + 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="763.9436" + 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="763.9436" + 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.735;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-5" + width="218.52127" + height="34.993004" + x="654.68298" + 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="764.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="764.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="786.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="786.75421" + y="422.69736" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <g + transform="translate(821.72619,187.85116)" + id="g5650-2-2-17"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-0" + d="m -57.78256,343.20394 v 61.59661" + 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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,-1,0,1285.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-dasharray:none;stroke-opacity:1" + 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="rotate(90,-13.918835,262.77429)" /> + <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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8-9" + width="210.17955" + height="35.209244" + x="658.85388" + 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="763.45532" + 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="763.45532" + 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.735;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1" + width="218.52127" + height="34.993004" + x="654.68298" + 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="764.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="764.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="892.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="892.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="807.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="807.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="875.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="875.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.735;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-5-9" + width="218.52127" + height="34.993004" + x="654.68298" + 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="763.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="763.57257" + y="627.32867" + style="font-size:16px;line-height:1.25;font-family:sans-serif">301 moved permanently</tspan></text> + <g + transform="translate(821.72619,353.12604)" + id="g5650-2-2-65"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-5" + d="m -57.78256,343.20394 v 61.59661" + 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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,-1,0,1290.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-dasharray:none;stroke-opacity:1" + 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="rotate(90,-13.918835,262.77429)" /> + <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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8-9-1" + width="210.17955" + height="35.209244" + x="658.85388" + 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="763.45532" + 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="763.45532" + 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="807.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="807.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="875.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="875.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.735;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-5-9-2" + width="218.52127" + height="34.993004" + x="654.68298" + 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="763.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="763.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.735;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-5-9-2-4" + width="218.52127" + height="34.993004" + x="654.68298" + 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="763.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="763.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> + <rect + style="fill:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.735;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-8-6-4-8" + width="218.52127" + height="34.993004" + x="77.078499" + y="935.98315" + 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="186.57913" + y="959.51965" + id="text5371-43-3-1-7-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" + x="186.57913" + y="959.51965" + style="font-size:16px;line-height:1.25;font-family:sans-serif" + id="tspan8">416 not satisfiable</tspan></text> + </g> +</svg> diff --git a/docs/en/cowboy/2.12/guide/rest_handlers.asciidoc b/docs/en/cowboy/2.12/guide/rest_handlers.asciidoc new file mode 100644 index 00000000..19a98596 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_handlers.asciidoc @@ -0,0 +1,148 @@ +[[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` +| ranges_provided | skip +| range_satisfiable | `true` +| 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`, +`content_types_provided/2` or `ranges_provided/2`. They can take +any name (except `auto` for range callbacks), 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 +| range | The range selected for the ranged response +|=== + +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 +| accept-ranges | Range units accepted by the resource +| allow | HTTP methods allowed by the resource +| content-language | Language used in the response body +| content-range | Range of the content found in the response +| 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 +| retry-after | Delay or time the client should wait before accessing the resource +| vary | List of headers that may change the representation of the resource +| www-authenticate | Authentication information to access the resource +|=== diff --git a/docs/en/cowboy/2.12/guide/rest_handlers/index.html b/docs/en/cowboy/2.12/guide/rest_handlers/index.html new file mode 100644 index 00000000..47551ac9 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_handlers/index.html @@ -0,0 +1,364 @@ +<!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=7" 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.9 +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>ranges_provided</td> +<td>skip</td> +</tr> +<tr><td>range_satisfiable</td> +<td><code>true</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>, <code>content_types_provided/2</code> or <code>ranges_provided/2</code>. They can take any name (except <code>auto</code> for range callbacks), 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> +<tr><td>range</td> +<td>The range selected for the ranged response</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>accept-ranges</td> +<td>Range units accepted by the resource</td> +</tr> +<tr><td>allow</td> +<td>HTTP methods allowed by the resource</td> +</tr> +<tr><td>content-language</td> +<td>Language used in the response body</td> +</tr> +<tr><td>content-range</td> +<td>Range of the content found in the response</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>retry-after</td> +<td>Delay or time the client should wait before accessing the resource</td> +</tr> +<tr><td>vary</td> +<td>List of headers that may change the representation of the resource</td> +</tr> +<tr><td>www-authenticate</td> +<td>Authentication information to access the resource</td> +</tr> +</tbody></table> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/rest_principles/"> + REST principles + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/rest_flowcharts/"> + REST flowcharts + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/rest_options.png b/docs/en/cowboy/2.12/guide/rest_options.png Binary files differnew file mode 100644 index 00000000..90fd6f06 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_options.png diff --git a/docs/en/cowboy/2.12/guide/rest_options.svg b/docs/en/cowboy/2.12/guide/rest_options.svg new file mode 100644 index 00000000..496c050c --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/rest_principles.asciidoc b/docs/en/cowboy/2.12/guide/rest_principles.asciidoc new file mode 100644 index 00000000..66939cb7 --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/rest_principles/index.html b/docs/en/cowboy/2.12/guide/rest_principles/index.html new file mode 100644 index 00000000..9b4a5d8d --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_principles/index.html @@ -0,0 +1,213 @@ +<!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=7" 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.12/guide/multipart/"> + Multipart requests + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/rest_handlers/"> + REST handlers + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/rest_put_post_patch.png b/docs/en/cowboy/2.12/guide/rest_put_post_patch.png Binary files differnew file mode 100644 index 00000000..d287036c --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_put_post_patch.png diff --git a/docs/en/cowboy/2.12/guide/rest_put_post_patch.svg b/docs/en/cowboy/2.12/guide/rest_put_post_patch.svg new file mode 100644 index 00000000..4562722a --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_put_post_patch.svg @@ -0,0 +1,3143 @@ +<?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.4 5da689c313, 2019-01-14" + 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="1.4142136" + inkscape:cx="497.47589" + inkscape:cy="714.09334" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="false" + inkscape:window-width="3840" + inkscape:window-height="2086" + 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)"> + <g + transform="translate(421.28257,-221.84428)" + id="g5650-2-2-2-2" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-62-9" + d="m -57.78256,343.20394 v 61.59661" + 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-5-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + id="g5453" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + style="fill:none;stroke:#6d8e41;stroke-width:2.12262177;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 114.1942,910.0203 c 0,0 -294.38297,126.9306 96.70099,239.0229" + id="path20172-9-8-9-31-8-1-6-7" + inkscape:connector-curvature="0" /> + <path + transform="matrix(0.18935157,-0.55731409,0.57384864,0.20364468,6.2540886,937.31856)" + inkscape:transform-center-y="0.43799088" + 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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" + inkscape:transform-center-x="3.1278943" /> + </g> + <g + id="g5426" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + transform="matrix(-0.11810089,-0.59739768,-0.61712763,0.1947058,652.42994,931.72039)" + inkscape:transform-center-y="-7.1326522" + 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-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" + inkscape:transform-center-x="6.1379913" /> + <path + inkscape:connector-curvature="0" + id="path914" + d="m 750.59385,537.94185 c 107.12668,303.34881 -4.24264,485.07525 -23.33452,500.98515 -19.09189,15.9099 -313.95542,109.6015 -313.95542,109.6015" + style="fill:none;stroke:#6d8e41;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;fill-opacity:1;stroke-miterlimit:4;stroke-dasharray:none" /> + </g> + <g + id="g889" + transform="translate(10,-16)" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + inkscape:connector-curvature="0" + id="path5570-8-7-5" + d="m 521.90414,939.0149 -43.11688,74.6807" + 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 + inkscape:transform-center-x="-4.3647514" + transform="matrix(0.50911681,0.29393872,-0.29393872,0.50911681,634.67262,1005.5769)" + inkscape:transform-center-y="3.7799725" + 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-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" /> + <path + inkscape:connector-curvature="0" + id="path5570-8-7-5-4" + d="m 478.78726,1013.6956 -43.11688,74.6807" + 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 + inkscape:connector-curvature="0" + id="path5570-8-7-5-7" + d="m 440.69125,1079.6897 -43.11688,74.6807" + 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" /> + </g> + <g + transform="matrix(0,-1,-1,0,647.4606,868.39634)" + id="g5650-0-6-9-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-7-2-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-1-3-14-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="translate(421.41793,571.92423)" + id="g5650-2-2-17-8-2" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-0-3-3" + d="m -57.78256,343.20394 v 61.59661" + 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-5-45-2-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,1,1,0,56.881664,1217.6446)" + id="g5650-2-2-6-6-7-3" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-6-3-8-56" + d="m -57.78256,339.02801 v 65.70583" + 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-5-1-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + id="g4198" + transform="rotate(-45,318.17351,1431.5178)" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-6-3-8-5-9-2" + d="m 245.18127,1438.4423 h 98.55875" + style="opacity:0.8;fill:none;stroke:#9b3b1c;stroke-width:2.44948983;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> + <path + transform="matrix(0,0.58787746,0.58787746,0,103.93746,1569.3854)" + 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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="translate(233.45629,1041.7893)" + id="g5650-6-4-8-7-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-78-5-5-2-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-9-6-6-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="translate(233.45629,1121.9351)" + id="g5650-6-4-8-7-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-5-5-2-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-6-6-6-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> + <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> + <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" /> + <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(421.41793,-144.94975)" + id="g5650-2-2" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1" + d="m -57.78256,343.20394 v 61.59661" + 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-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:#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="400.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="400.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 + transform="matrix(0,-1.1339658,0.99940564,0,-410.80357,824.40253)" + 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-dasharray:none;stroke-opacity:1" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + 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,887.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-dasharray:none;stroke-opacity:1" + 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="rotate(90,-13.918835,262.77429)" /> + <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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-28-4" + width="210.17955" + height="35.209244" + x="258.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="363.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="363.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="513.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="513.12769" + y="296.02957" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <g + transform="translate(421.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 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-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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-28-7" + width="210.17955" + height="35.209244" + x="258.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="363.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="363.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="383.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="383.69171" + y="414.84009" + style="font-size:16px;line-height:1.25;font-family:sans-serif">true</tspan></text> + <g + transform="translate(669.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 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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="translate(669.41793,570.7504)" + id="g5650-2-2-2-7-5" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-62-7-7" + d="m -57.78256,343.20394 v 61.59661" + 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-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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8-9" + width="210.17955" + height="35.209244" + x="506.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" /> + <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-8-9-59" + width="210.17955" + height="35.209244" + x="506.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="611.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="611.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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1" + width="218.52127" + height="34.993004" + x="254.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="363.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="363.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,129.58395,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 v 63.05283" + 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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="translate(421.41793,93.25206)" + id="g5650-2-2-2" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-62" + d="m -57.78256,343.20394 v 61.59661" + 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-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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-28-7-6" + width="210.17955" + height="35.209244" + x="258.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="363.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="363.63538" + y="453.2847" + style="font-size:16px;line-height:1.25;font-family:sans-serif">previously_existed</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="486.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="486.84631" + y="433.29703" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <g + transform="translate(420.00372,173.10383)" + id="g5650-2-2-17-8" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-0-3" + d="m -57.78256,343.20394 v 61.59661" + 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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="matrix(0,-1,-1,0,887.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-dasharray:none;stroke-opacity:1" + 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="rotate(90,-13.918835,262.77429)" /> + <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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + 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="330.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="330.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="434.7135" + y="574.54175" + 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="434.7135" + y="574.54175" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-5-9-29" + width="218.52127" + height="34.993004" + x="254.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="363.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="363.26428" + y="612.67908" + style="font-size:16px;line-height:1.25;font-family:sans-serif">301 moved permanently</tspan></text> + <g + transform="translate(421.41793,332.05687)" + id="g5650-2-2-65-2" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-5-9" + d="m -57.78256,343.20394 v 61.59661" + 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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + sodipodi:type="star" /> + </g> + <g + transform="matrix(-0.49564432,-0.90069303,-0.86840428,0.51407322,869.63393,572.2161)" + 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-dasharray:none;stroke-opacity:1" + 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="rotate(90,-13.918835,262.77429)" /> + <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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8-9-1-4" + width="210.17955" + height="35.209244" + x="258.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="363.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="363.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="404.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="404.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="535.7135" + y="765.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="535.7135" + y="765.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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-5-9-2-1" + width="218.52127" + height="34.993004" + x="254.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="363.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="363.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 + id="g640" + transform="matrix(0.93440547,0.35621121,-0.48193086,1.2641905,627.74736,-706.85648)" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + style="fill:none;stroke:#9b3b1c;stroke-width:2.23800349;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 37.817626,839.79874 c 0,0 -164.808436,203.57016 164.308914,318.18876" + id="path20172-9-3" + inkscape:connector-curvature="0" /> + <path + transform="matrix(0.27703197,-0.51851055,0.51851055,0.27703197,45.145667,925.53953)" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + 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:#6d8e41;fill-opacity:1;stroke:none" + x="611.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="611.35022" + y="930.3703" + style="font-size:16px;line-height:1.25;font-family:sans-serif">allow_missing_post</tspan></text> + <g + transform="translate(421.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 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-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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8-9-19" + width="210.17955" + height="35.209244" + x="258.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="358.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="358.63885" + y="852.62952" + style="font-size:16px;line-height:1.25;font-family:sans-serif">method is PUT</tspan></text> + <g + transform="translate(185.41793,571.23612)" + id="g5650-2-2-65-9" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-5-1" + d="m -57.78256,343.20394 v 61.59661" + 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-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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8-9-1-8" + width="210.17955" + height="35.209244" + x="22.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="122.24432" + y="930.53601" + 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="122.24432" + y="930.53601" + 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="158.52316" + y="971.72559" + 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="158.52316" + y="971.72559" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-5-9-2-7" + width="218.52127" + height="34.993004" + x="18.374733" + y="988.60242" + 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="127.44006" + y="1012.0638" + 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="127.44006" + y="1012.0638" + 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" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <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> + <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-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" + x="175.50966" + y="1401.7865" + style="font-size:16px;line-height:1.25;font-family:sans-serif" + id="tspan4047">method is PUT?</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" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + 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="631.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="631.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="400.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="400.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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8-9-1-3-4-8" + width="210.17955" + height="35.209244" + x="258.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="363.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="363.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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-8-7-9" + width="218.52127" + height="34.993004" + x="502.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="611.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="611.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="650.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="650.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="1261.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="1261.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" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <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="17.996632" + 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="17.996632" + 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="1522.9698" + 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="1522.9698" + 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="48.210938" + y="971.72559" + 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="48.210938" + y="971.72559" + 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" /> + <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="518.26642" + y="971.72559" + 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="518.26642" + y="971.72559" + 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="262.42551" + y="414.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="262.42551" + y="414.54388" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <g + id="g5650" + transform="translate(709.41793,93.250932)" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + inkscape:connector-curvature="0" + id="path5570" + 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" + 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:#effab4;fill-opacity:1;fill-rule:nonzero;stroke:#c7d28c;stroke-width:2.73499846;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-5-5" + width="218.52127" + height="34.993004" + x="542.37476" + y="590.4502" + 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(709.41793,172.9131)" + id="g5650-2-2-2-7" + inkscape:export-xdpi="89" + inkscape:export-ydpi="89"> + <path + inkscape:connector-curvature="0" + id="path5570-2-1-62-7" + d="m -57.78256,343.20394 v 61.59661" + 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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + 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="651.97131" + y="613.91156" + 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="651.97131" + y="613.91156" + style="font-size:16px;line-height:1.25;font-family:sans-serif">404 not found</tspan></text> + <g + transform="rotate(-90,339.66397,210.35009)" + 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-dasharray:none;stroke-opacity:1" + 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="rotate(90,-13.918835,262.77429)" /> + <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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8-9-1-3" + width="210.17955" + height="35.209244" + x="546.54559" + y="510.68463" + 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="647.39459" + y="532.48065" + 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="647.39459" + y="532.48065" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8-9-5" + width="210.17955" + height="35.209244" + x="546.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="655.21442" + y="455.05814" + 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="655.21442" + y="455.05814" + 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:#9b3b1c;fill-opacity:1;stroke:none" + x="563.54547" + y="493.11707" + 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="563.54547" + y="493.11707" + 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="668.08569" + y="492.65613" + 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="668.08569" + y="492.65613" + 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="613.92944" + y="574.08282" + 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="613.92944" + y="574.08282" + 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="718.00122" + y="574.08282" + 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="718.00122" + y="574.08282" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8-9-19-2-2-3" + width="210.17955" + height="35.209244" + x="71.333359" + y="1459.5228" + 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="176.25908" + y="1481.5415" + id="text5371-2-74-0-1-3-7-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" + x="176.25908" + y="1481.5415" + style="font-size:16px;line-height:1.25;font-family:sans-serif" + id="tspan4047-7">has resp location?</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="1443.2148" + id="text5371-2-8-4-3-8-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-3-7-5-0-8-2" + x="190.83659" + y="1443.2148" + 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="290.12473" + y="1442.293" + id="text5371-4-4-9-1-1-9-1-2-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-9-2-6-8-0-1-2-1-5-8" + x="290.12473" + y="1442.293" + 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.98691607;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-5-9-2-4-1-6" + width="262.5206" + height="34.741085" + x="473.25766" + y="1142.7749" + rx="14.863847" + 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="1164.5415" + id="text5371-43-2-9-7-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-3-9-7-8-7-5-5" + x="604.32263" + y="1164.5415" + style="font-size:16px;line-height:1.25;font-family:sans-serif">415 unsupported media type</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="446.74219" + y="1195.3269" + id="text5371-4-4-9-1-1-9-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-2-12" + x="446.74219" + y="1195.3269" + style="font-size:16px;line-height:1.25;font-family:sans-serif">not 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-1-8-9-1-3-4-8-7" + width="210.17955" + height="35.209244" + x="257.91022" + 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="362.51172" + y="930.53601" + id="text5371-2-74-0-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-18-2-9-9" + x="362.51172" + y="930.53601" + 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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect5273-7-3-1-5-9-29-6" + width="218.52127" + height="34.993004" + x="247.73935" + y="988.60242" + 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="356.62891" + y="1010.9619" + id="text5371-43-2-9-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-3-9-7-5-6" + x="356.62891" + y="1010.9619" + style="font-size:16px;line-height:1.25;font-family:sans-serif">301 moved permanently</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="404.63873" + y="973.08087" + id="text5371-4-4-9-3-4-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-9-2-6-2-8-9" + x="404.63873" + y="973.08087" + 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="231.21094" + y="901.32684" + id="text5371-2-391-5-5-1-0-7-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-6-63-7-9-9-2-8-8-2" + x="231.21094" + y="901.32684" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + <g + transform="matrix(0,-1,-1,0,1139.2604,949.1691)" + id="g5650-2-0-4-5-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-dasharray:none;stroke-opacity:1" + d="m 146.3711,152.21525 c 0,0 -65.760927,60.81119 -8.48528,132.93608" + id="path20172-9-1-3" + inkscape:connector-curvature="0" + transform="rotate(90,-13.918835,262.77429)" /> + <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-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-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + 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="707.57623" + y="892.84753" + id="text5371-4-4-9-1-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" + id="tspan5373-9-2-6-8-2-6" + x="707.57623" + y="892.84753" + style="font-size:16px;line-height:1.25;font-family:sans-serif">false</tspan></text> + </g> +</svg> diff --git a/docs/en/cowboy/2.12/guide/rest_start.png b/docs/en/cowboy/2.12/guide/rest_start.png Binary files differnew file mode 100644 index 00000000..bbaa655c --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_start.png diff --git a/docs/en/cowboy/2.12/guide/rest_start.svg b/docs/en/cowboy/2.12/guide/rest_start.svg new file mode 100644 index 00000000..9a2646fd --- /dev/null +++ b/docs/en/cowboy/2.12/guide/rest_start.svg @@ -0,0 +1,1665 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + width="744.09448819" + height="1052.3622047" + id="svg2" + version="1.1" + inkscape:version="1.3.2 (091e20ef0f, 2023-11-25, custom)" + sodipodi:docname="rest_start.svg" + inkscape:export-filename="/home/essen/Dropbox/Public/drawing.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns="http://www.w3.org/2000/svg" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:dc="http://purl.org/dc/elements/1.1/"> + <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" + inkscape:swatch="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="293.49997" + inkscape:cy="315.49997" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="false" + inkscape:window-width="1440" + inkscape:window-height="900" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="1" + inkscape:snap-global="true" + showguides="true" + inkscape:showpageshadow="2" + inkscape:pagecheckerboard="0" + inkscape:deskcolor="#d1d1d1" + inkscape:export-bgcolor="#ffffffff"> + <inkscape:grid + type="xygrid" + id="grid5357" + empspacing="5" + visible="false" + enabled="true" + snapvisiblegridlinesonly="true" + originx="0" + originy="0" + spacingy="1" + spacingx="1" + units="px" /> + </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" + inkscape:export-filename="rest_start.png"> + <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">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="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_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="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">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="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">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="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">429 too many requests</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">501 not implemented</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">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.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">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="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">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-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">413 request entity too large</tspan></text> + </g> +</svg> diff --git a/docs/en/cowboy/2.12/guide/routing.asciidoc b/docs/en/cowboy/2.12/guide/routing.asciidoc new file mode 100644 index 00000000..37d3e5aa --- /dev/null +++ b/docs/en/cowboy/2.12/guide/routing.asciidoc @@ -0,0 +1,271 @@ +[[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. + +Cowboy routes requests using the following algorithm: + +* If no configured host matches the request URI, a 400 response + is returned. + +* Otherwise, the first configured host that matches the request + URI will be used. Only the paths configured for this host will + be considered. + +* If none of the configured paths found in the previous step + match the request URI, a 404 response is returned. + +* Otherwise, the handler and its initial state are added to the + environment and the request continues to be processed. + +NOTE: It is possible to run into a situation where two hosts match a +request URI, but only the paths on the second host match the +request URI. In this case the expected result is a 404 response +because the only paths used during routing are the paths from +the first configured host that matches the request URI. + +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, TransOpts, ProtoOpts +cowboy:start_clear(my_http_listener, + [{port, 8080}], + #{env => #{dispatch => Dispatch}} +). +---- + +=== Using persistent_term + +The routes can be stored in `persistent_term` starting from +Erlang/OTP 21.2. This may give a performance improvement when +there are a large number of routes. + +To use this functionality you need to compile the routes, +store them in `persistent_term` and then inform Cowboy: + +[source,erlang] +---- +Dispatch = cowboy_router:compile([ + {'_', [{'_', my_handler, #{}}]} +]), +persistent_term:put(my_app_dispatch, Dispatch), +cowboy:start_clear(my_http_listener, + [{port, 8080}], + #{env => #{dispatch => {persistent_term, my_app_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. + +When using `persistent_term` there is no need to call this function, +you can simply put the new routes in the storage. diff --git a/docs/en/cowboy/2.12/guide/routing/index.html b/docs/en/cowboy/2.12/guide/routing/index.html new file mode 100644 index 00000000..7c6bbcc0 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/routing/index.html @@ -0,0 +1,390 @@ +<!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=7" 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>Cowboy routes requests using the following algorithm:</p> +<ul><li>If no configured host matches the request URI, a 400 response is returned. +</li> +<li>Otherwise, the first configured host that matches the request URI will be used. Only the paths configured for this host will be considered. +</li> +<li>If none of the configured paths found in the previous step match the request URI, a 404 response is returned. +</li> +<li>Otherwise, the handler and its initial state are added to the environment and the request continues to be processed. +</li> +</ul> +<p>NOTE: It is possible to run into a situation where two hosts match a request URI, but only the paths on the second host match the request URI. In this case the expected result is a 404 response because the only paths used during routing are the paths from the first configured host that matches the request URI.</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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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, 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="_using_persistent_term">Using persistent_term</h2> +<p>The routes can be stored in <code>persistent_term</code> starting from Erlang/OTP 21.2. This may give a performance improvement when there are a large number of routes.</p> +<p>To use this functionality you need to compile the routes, store them in <code>persistent_term</code> and then inform Cowboy:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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="#FF6600">'_'</font>, <font color="#FF6600">my_handler</font>, #{}}]} +]), +<b><font color="#000000">persistent_term:put</font></b>(<font color="#FF6600">my_app_dispatch</font>, <font color="#009900">Dispatch</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="#FF6600">persistent_term</font>, <font color="#FF6600">my_app_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.9 +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> +<p>When using <code>persistent_term</code> there is no need to call this function, you can simply put the new routes in the storage.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/listeners/"> + Listeners + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/constraints/"> + Constraints + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/specs.asciidoc b/docs/en/cowboy/2.12/guide/specs.asciidoc new file mode 100644 index 00000000..14736b3e --- /dev/null +++ b/docs/en/cowboy/2.12/guide/specs.asciidoc @@ -0,0 +1,215 @@ +[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/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/rfc8288[RFC 8288]: Web Linking +* 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://tools.ietf.org/html/rfc8586[RFC 8586]: Loop Detection in Content Delivery Networks (CDNs) +* https://tools.ietf.org/html/rfc8594[RFC 8594]: The Sunset HTTP Header Field +* https://tools.ietf.org/html/rfc8673[RFC 8673]: HTTP Random Access and Live Content +* https://tools.ietf.org/html/rfc8674[RFC 8674]: The "safe" HTTP Preference +* https://tools.ietf.org/html/rfc8740[RFC 8740]: Using TLS 1.3 with HTTP/2 +* https://tools.ietf.org/html/rfc8941[RFC 8941]: Structured Field Values for HTTP +* https://tools.ietf.org/html/rfc8942[RFC 8942]: HTTP Client Hints +* https://www.w3.org/TR/trace-context/[Trace Context]: Trace Context +* 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/rfc5829[RFC 5829]: Link Relation Types for Simple Version Navigation between Web Resources +* 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 +* https://tools.ietf.org/html/rfc8631[RFC 8631]: Link Relation Types for Web Services +* 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) +* https://tools.ietf.org/html/rfc8565[RFC 8565]: Hypertext Jeopardy Protocol (HTJP/1.0) +* 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 +* https://tools.ietf.org/html/rfc8615[RFC 8615]: Well-Known URIs +* 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 +* https://tools.ietf.org/html/rfc8607[RFC 8607]: Calendaring Extensions to WebDAV (CalDAV): Managed Attachments + +=== 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 +* https://tools.ietf.org/html/rfc8516[RFC 8516]: "Too Many Requests" Response Code for CoAP +* https://tools.ietf.org/html/rfc8613[RFC 8613]: Object Security for Constrained RESTful Environments +* https://tools.ietf.org/html/rfc8710[RFC 8710]: Multipart Content-Format for CoAP +* https://tools.ietf.org/html/rfc8768[RFC 8768]: CoAP Hop-Limit Option diff --git a/docs/en/cowboy/2.12/guide/specs/index.html b/docs/en/cowboy/2.12/guide/specs/index.html new file mode 100644 index 00000000..69640f7f --- /dev/null +++ b/docs/en/cowboy/2.12/guide/specs/index.html @@ -0,0 +1,560 @@ +<!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=7" 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/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/rfc8288">RFC 8288</a>: Web Linking +</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://tools.ietf.org/html/rfc8586">RFC 8586</a>: Loop Detection in Content Delivery Networks (CDNs) +</li> +<li><a href="https://tools.ietf.org/html/rfc8594">RFC 8594</a>: The Sunset HTTP Header Field +</li> +<li><a href="https://tools.ietf.org/html/rfc8673">RFC 8673</a>: HTTP Random Access and Live Content +</li> +<li><a href="https://tools.ietf.org/html/rfc8674">RFC 8674</a>: The "safe" HTTP Preference +</li> +<li><a href="https://tools.ietf.org/html/rfc8740">RFC 8740</a>: Using TLS 1.3 with HTTP/2 +</li> +<li><a href="https://tools.ietf.org/html/rfc8941">RFC 8941</a>: Structured Field Values for HTTP +</li> +<li><a href="https://tools.ietf.org/html/rfc8942">RFC 8942</a>: HTTP Client Hints +</li> +<li><a href="https://www.w3.org/TR/trace-context/">Trace Context</a>: Trace Context +</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/rfc5829">RFC 5829</a>: Link Relation Types for Simple Version Navigation between Web Resources +</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="https://tools.ietf.org/html/rfc8631">RFC 8631</a>: Link Relation Types for Web Services +</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="https://tools.ietf.org/html/rfc8565">RFC 8565</a>: Hypertext Jeopardy Protocol (HTJP/1.0) +</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="https://tools.ietf.org/html/rfc8615">RFC 8615</a>: Well-Known URIs +</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> +<li><a href="https://tools.ietf.org/html/rfc8607">RFC 8607</a>: Calendaring Extensions to WebDAV (CalDAV): Managed Attachments +</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> +<li><a href="https://tools.ietf.org/html/rfc8516">RFC 8516</a>: "Too Many Requests" Response Code for CoAP +</li> +<li><a href="https://tools.ietf.org/html/rfc8613">RFC 8613</a>: Object Security for Constrained RESTful Environments +</li> +<li><a href="https://tools.ietf.org/html/rfc8710">RFC 8710</a>: Multipart Content-Format for CoAP +</li> +<li><a href="https://tools.ietf.org/html/rfc8768">RFC 8768</a>: CoAP Hop-Limit Option +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_1.0/"> + Migrating from Cowboy 1.0 to 2.0 + </a> + + + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/static_files.asciidoc b/docs/en/cowboy/2.12/guide/static_files.asciidoc new file mode 100644 index 00000000..5af911be --- /dev/null +++ b/docs/en/cowboy/2.12/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 the application's +private directory (e.g. `my_app/priv`). + +The following rule will serve any file found in the `my_app` +application's private directory in the `my_app/priv/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.12/guide/static_files/index.html b/docs/en/cowboy/2.12/guide/static_files/index.html new file mode 100644 index 00000000..1d1be77e --- /dev/null +++ b/docs/en/cowboy/2.12/guide/static_files/index.html @@ -0,0 +1,276 @@ +<!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=7" 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.9 +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.9 +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 the application's private directory (e.g. <code>my_app/priv</code>).</p> +<p>The following rule will serve any file found in the <code>my_app</code> application's private directory in the <code>my_app/priv/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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.12/guide/loop_handlers/"> + Loop handlers + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/req/"> + The Req object + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/streams.asciidoc b/docs/en/cowboy/2.12/guide/streams.asciidoc new file mode 100644 index 00000000..e8ddae05 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/streams.asciidoc @@ -0,0 +1,80 @@ +[[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 + +link:man:cowboy_stream(3)[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 four handlers. + +link:man:cowboy_stream_h(3)[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. + +link:man:cowboy_compress_h(3)[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. + +link:man:cowboy_decompress_h(3)[cowboy_decompress_h] will +automatically decompress request bodies when possible. +It is not enabled by default. It is a good example for +writing your own handlers that will modify requests. + +link:man:cowboy_metrics_h(3)[cowboy_metrics_h] gathers +metrics about a stream then passes them to a configurable +function. It is not enabled by default. + +link:man:cowboy_tracer_h(3)[cowboy_tracer_h] can be used to +conditionally trace streams based on the contents of the +request or its origin. Trace events are passed to a +configurable function. It is not enabled by default. diff --git a/docs/en/cowboy/2.12/guide/streams/index.html b/docs/en/cowboy/2.12/guide/streams/index.html new file mode 100644 index 00000000..511155be --- /dev/null +++ b/docs/en/cowboy/2.12/guide/streams/index.html @@ -0,0 +1,201 @@ +<!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=7" 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><a href="/docs/en/cowboy/2.12/manual/cowboy_stream">Stream handlers</a> 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 four handlers.</p> +<p><a href="/docs/en/cowboy/2.12/manual/cowboy_stream_h">cowboy_stream_h</a> 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><a href="/docs/en/cowboy/2.12/manual/cowboy_compress_h">cowboy_compress_h</a> 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> +<p><a href="/docs/en/cowboy/2.12/manual/cowboy_decompress_h">cowboy_decompress_h</a> will automatically decompress request bodies when possible. It is not enabled by default. It is a good example for writing your own handlers that will modify requests.</p> +<p><a href="/docs/en/cowboy/2.12/manual/cowboy_metrics_h">cowboy_metrics_h</a> gathers metrics about a stream then passes them to a configurable function. It is not enabled by default.</p> +<p><a href="/docs/en/cowboy/2.12/manual/cowboy_tracer_h">cowboy_tracer_h</a> can be used to conditionally trace streams based on the contents of the request or its origin. Trace events are passed to a configurable function. It is not enabled by default.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/ws_handlers/"> + Websocket handlers + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/middlewares/"> + Middlewares + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/ws_handlers.asciidoc b/docs/en/cowboy/2.12/guide/ws_handlers.asciidoc new file mode 100644 index 00000000..7005665e --- /dev/null +++ b/docs/en/cowboy/2.12/guide/ws_handlers.asciidoc @@ -0,0 +1,292 @@ +[[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:member(<<"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) -> + {[{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) -> + {[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) -> + {[{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 the frame to be sent: + +[source,erlang] +---- +websocket_info(_Info, State) -> + {[{text, <<"Hello!">>}], State}. +---- + +You can send frames of any type: text, binary, ping, pong +or close frames. + +You can send many frames at the same time: + +[source,erlang] +---- +websocket_info(_Info, State) -> + {[ + {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 returned tuple: + +[source,erlang] +---- +websocket_init(State) -> + {[], State, hibernate}. + +websocket_handle(_Frame, State) -> + {[], State, hibernate}. + +websocket_info(_Info, State) -> + {[{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) -> + {[{close, 1000, <<"some-reason">>}], State}. +---- diff --git a/docs/en/cowboy/2.12/guide/ws_handlers/index.html b/docs/en/cowboy/2.12/guide/ws_handlers/index.html new file mode 100644 index 00000000..e904da07 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/ws_handlers/index.html @@ -0,0 +1,365 @@ +<!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=7" 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.9 +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.9 +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:member</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.9 +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.9 +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">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.9 +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="#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.9 +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">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.9 +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 the frame to be sent:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">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>You can send many frames at the same time:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">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.9 +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.9 +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 returned tuple:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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="#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="#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">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.9 +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.9 +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">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.12/guide/ws_protocol/"> + The Websocket protocol + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/streams/"> + Streams + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/guide/ws_protocol.asciidoc b/docs/en/cowboy/2.12/guide/ws_protocol.asciidoc new file mode 100644 index 00000000..8fa0673d --- /dev/null +++ b/docs/en/cowboy/2.12/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.12/guide/ws_protocol/index.html b/docs/en/cowboy/2.12/guide/ws_protocol/index.html new file mode 100644 index 00000000..cf94b039 --- /dev/null +++ b/docs/en/cowboy/2.12/guide/ws_protocol/index.html @@ -0,0 +1,197 @@ +<!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=7" 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.12/guide/resource_design/"> + Designing a resource handler + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.12/guide/ws_handlers/"> + Websocket handlers + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy.get_env/index.html b/docs/en/cowboy/2.12/manual/cowboy.get_env/index.html new file mode 100644 index 00000000..cb51a151 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy.get_env/index.html @@ -0,0 +1,209 @@ +<!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:get_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=7" 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:get_env(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy:get_env - Retrieve a listener's environment value</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">get_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="#990000">-></font> <b><font color="#000000">any</font></b>() + +<b><font color="#000000">get_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">Default</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()) + <font color="#990000">-></font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Retrieve an environment value for a previously started listener.</p> +<p>This function may crash when the key is missing from the environment and a default value is not provided.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Name</dt> +<dd><p>The name of the listener to access.</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>Default</dt> +<dd><p>The default value if the key is missing.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The environment value is returned on success.</p> +<p>If a default was provided and the key is missing, then the default value is returned.</p> +<p>An <code>exit:badarg</code> exception is thrown when the listener does not exist.</p> +<p>An <code>exit:{badkey, Key}</code> exception is thrown when the key requested is missing and no default was provided.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.11</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Retrieve a listener's routes</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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:get_env</font></b>(<font color="#FF6600">example</font>, <font color="#FF6600">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="../cowboy.set_env">cowboy:set_env(3)</a>, <a href="../ranch.get_protocol_options">ranch:get_protocol_options(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.12/manual/cowboy.set_env/index.html new file mode 100644 index 00000000..843736d6 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy.set_env/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: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=7" 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.9 +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.9 +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="../cowboy.get_env">cowboy:get_env(3)</a>, <a href="../ranch.set_protocol_options">ranch:set_protocol_options(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy.start_clear/index.html b/docs/en/cowboy/2.12/manual/cowboy.start_clear/index.html new file mode 100644 index 00000000..37f4f4a9 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy.start_clear/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: 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=7" 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.9 +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>. Stream handlers such as <a href="../cowboy_stream_h">cowboy_stream_h(3)</a> (which is enabled by default) may also define options.</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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy.start_tls/index.html b/docs/en/cowboy/2.12/manual/cowboy.start_tls/index.html new file mode 100644 index 00000000..21e42a20 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy.start_tls/index.html @@ -0,0 +1,235 @@ +<!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=7" 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.9 +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>. Stream handlers such as <a href="../cowboy_stream_h">cowboy_stream_h(3)</a> (which is enabled by default) may also define options.</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.9 +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">certfile</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.9 +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">certfile</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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy.stop_listener/index.html b/docs/en/cowboy/2.12/manual/cowboy.stop_listener/index.html new file mode 100644 index 00000000..d40c29c3 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy.stop_listener/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: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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy/index.html b/docs/en/cowboy/2.12/manual/cowboy/index.html new file mode 100644 index 00000000..ee582449 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy/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(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=7" 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.get_env">cowboy:get_env(3)</a> - Retrieve a listener's environment value +</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.9 +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.9 +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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_app/index.html b/docs/en/cowboy/2.12/manual/cowboy_app/index.html new file mode 100644 index 00000000..0dd594b6 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_app/index.html @@ -0,0 +1,242 @@ +<!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=7" 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> +<li><a href="../cowboy_decompress_h">cowboy_decompress_h(3)</a> - Decompress stream handler +</li> +<li><a href="../cowboy_metrics_h">cowboy_metrics_h(3)</a> - Metrics stream handler +</li> +<li><a href="../cowboy_tracer_h">cowboy_tracer_h(3)</a> - Tracer 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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_compress_h/index.html b/docs/en/cowboy/2.12/manual/cowboy_compress_h/index.html new file mode 100644 index 00000000..dab59f73 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_compress_h/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_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=7" 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 or that have an etag header defined.</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.9 +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 compress 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> +<p>This option can be updated at any time using the <code>set_options</code> stream handler command.</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> +<p>This option can be updated at any time using the <code>set_options</code> stream handler command.</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.11</strong>: Compression is now disabled when the etag header is in the response headers. +</li> +<li><strong>2.11</strong>: The vary: accept-encoding header is now always set when this handler is enabled. +</li> +<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_decompress_h">cowboy_decompress_h(3)</a>, <a href="../cowboy_metrics_h">cowboy_metrics_h(3)</a>, <a href="../cowboy_stream_h">cowboy_stream_h(3)</a>, <a href="../cowboy_tracer_h">cowboy_tracer_h(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_constraints.int/index.html b/docs/en/cowboy/2.12/manual/cowboy_constraints.int/index.html new file mode 100644 index 00000000..86554db3 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_constraints.int/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_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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_constraints.nonempty/index.html b/docs/en/cowboy/2.12/manual/cowboy_constraints.nonempty/index.html new file mode 100644 index 00000000..4b830846 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_constraints.nonempty/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_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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_constraints/index.html b/docs/en/cowboy/2.12/manual/cowboy_constraints/index.html new file mode 100644 index 00000000..2136b0da --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_constraints/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_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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_decompress_h/index.html b/docs/en/cowboy/2.12/manual/cowboy_decompress_h/index.html new file mode 100644 index 00000000..2a181db9 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_decompress_h/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_decompress_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=7" 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_decompress_h(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_decompress_h - Decompress stream handler</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy_decompress_h</code> decompresses request bodies automatically when the server supports it.</p> +<p>The only compression algorithm currently supported is the gzip algorithm. Another limitation is that decompression is only attempted when gzip is the only content-encoding in the request.</p> +<p>This stream handler always adds a field to the Req object with the name <code>content_decoded</code> which is treated as a list of decoded content-encoding values. Currently this list may only contain the <code><<"gzip">></code> binary if content was decoded; or be empty otherwise.</p> +<h2 id="_options">Options</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">decompress_enabled</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">decompress_ratio_limit</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for the decompress stream handler.</p> +<p>The default value is given next to the option name:</p> +<dl><dt>decompress_ratio_limit (20)</dt> +<dd><p>The max ratio of the compressed and decompressed body before it is rejected with a <code>413 Payload Too Large</code> error response.</p> +<p>This option can be updated at any time using the <code>set_options</code> stream handler command.</p> +</dd> +<dt>decompress_enabled (true)</dt> +<dd><p>Whether the handler is enabled by default.</p> +<p>This option can be updated using the <code>set_options</code> stream handler command. This allows disabling decompression for the current stream. Attempts to enable or disable decompression after starting to read the body will be ignored.</p> +</dd> +</dl> +<h2 id="_events">Events</h2> +<p>The decompress stream handler does not produce any event.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.11</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>, <a href="../cowboy_metrics_h">cowboy_metrics_h(3)</a>, <a href="../cowboy_stream_h">cowboy_stream_h(3)</a>, <a href="../cowboy_tracer_h">cowboy_tracer_h(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_handler.terminate/index.html b/docs/en/cowboy/2.12/manual/cowboy_handler.terminate/index.html new file mode 100644 index 00000000..f33532f3 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_handler.terminate/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_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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_handler/index.html b/docs/en/cowboy/2.12/manual/cowboy_handler/index.html new file mode 100644 index 00000000..3d7ecf2c --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_handler/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_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=7" 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.9 +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.</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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_http/index.html b/docs/en/cowboy/2.12/manual/cowboy_http/index.html new file mode 100644 index 00000000..86827290 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_http/index.html @@ -0,0 +1,305 @@ +<!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=7" 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.9 +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">active_n</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <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">initial_stream_flow_size</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">linger_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">logger</font> <font color="#990000">=></font> <b><font color="#000000">module</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">reset_idle_timeout_on_send</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">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>active_n (100)</dt> +<dd><p>The number of packets Cowboy will request from the socket at once. This can be used to tweak the performance of the server. Higher values reduce the number of times Cowboy need to request more packets from the port driver at the expense of potentially higher memory being used.</p> +</dd> +<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> +<p>This option can be updated at any time using the <code>set_options</code> stream handler command.</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> +<p>This option can be updated at any time using the <code>set_options</code> stream handler command.</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_stream_flow_size (65535)</dt> +<dd><p>Amount of data in bytes Cowboy will read from the socket right after a request was fully received. This is a soft limit.</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>logger (error_logger)</dt> +<dd><p>The module that will be used to write log messages.</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 (1000)</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>reset_idle_timeout_on_send (false)</dt> +<dd><p>Whether the <code>idle_timeout</code> gets reset when sending data to the socket.</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.11</strong>: The <code>reset_idle_timeout_on_send</code> option was added. +</li> +<li><strong>2.8</strong>: The <code>active_n</code> option was added. +</li> +<li><strong>2.7</strong>: The <code>initial_stream_flow_size</code> and <code>logger</code> options were added. +</li> +<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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_http2/index.html b/docs/en/cowboy/2.12/manual/cowboy_http2/index.html new file mode 100644 index 00000000..de9db0f3 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_http2/index.html @@ -0,0 +1,353 @@ +<!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=7" 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.9 +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">active_n</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</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">connection_window_margin_size</font> <font color="#990000">=></font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font>, + <font color="#0000FF">connection_window_update_threshold</font> <font color="#990000">=></font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font>, + <font color="#0000FF">enable_connect_protocol</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">goaway_initial_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">goaway_complete_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</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">linger_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">logger</font> <font color="#990000">=></font> <b><font color="#000000">module</font></b>(), + <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_connection_buffer_size</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">max_connection_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_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_fragmented_header_block_size</font> <font color="#990000">=></font> <font color="#993399">16384</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font>, + <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">max_received_frame_rate</font> <font color="#990000">=></font> {<b><font color="#000000">pos_integer</font></b>(), <b><font color="#000000">timeout</font></b>()}, + <font color="#0000FF">max_reset_stream_rate</font> <font color="#990000">=></font> {<b><font color="#000000">pos_integer</font></b>(), <b><font color="#000000">timeout</font></b>()}, + <font color="#0000FF">max_cancel_stream_rate</font> <font color="#990000">=></font> {<b><font color="#000000">pos_integer</font></b>(), <b><font color="#000000">timeout</font></b>()}, + <font color="#0000FF">max_stream_buffer_size</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">max_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">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">reset_idle_timeout_on_send</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>()], + <font color="#0000FF">stream_window_data_threshold</font> <font color="#990000">=></font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font>, + <font color="#0000FF">stream_window_margin_size</font> <font color="#990000">=></font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font>, + <font color="#0000FF">stream_window_update_threshold</font> <font color="#990000">=></font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font> +}</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>active_n (100)</dt> +<dd><p>The number of packets Cowboy will request from the socket at once. This can be used to tweak the performance of the server. Higher values reduce the number of times Cowboy need to request more packets from the port driver at the expense of potentially higher memory being used.</p> +</dd> +<dt>connection_type (supervisor)</dt> +<dd><p>Whether the connection process also acts as a supervisor.</p> +</dd> +<dt>connection_window_margin_size (65535)</dt> +<dd><p>Extra amount in bytes to be added to the window size when updating the connection window. This is used to ensure that there is always some space available in the window.</p> +</dd> +<dt>connection_window_update_threshold (163840)</dt> +<dd><p>The connection window will only get updated when its size becomes lower than this threshold, in bytes. This is to avoid sending too many <code>WINDOW_UPDATE</code> frames.</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.</p> +<p>For backward compatibility reasons, this option is disabled by default. It must be enabled to use Websocket over HTTP/2. It will be enabled by default in a future release.</p> +</dd> +<dt>goaway_initial_timeout (1000)</dt> +<dd><p>Time in ms to wait for any in-flight stream creations before stopping to accept new streams on an existing connection during a graceful shutdown.</p> +</dd> +<dt>goaway_complete_timeout (3000)</dt> +<dd><p>Time in ms to wait for ongoing streams to complete before closing the connection during a graceful shutdown.</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 in bytes 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 in bytes 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>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>. In HTTP/2's case the GOAWAY message might also be lost when closing the connection immediately.</p> +</dd> +<dt>logger (error_logger)</dt> +<dd><p>The module that will be used to write log messages.</p> +</dd> +<dt>max_concurrent_streams (infinity)</dt> +<dd><p>Maximum number of concurrent streams allowed on the connection.</p> +</dd> +<dt>max_connection_buffer_size (16000000)</dt> +<dd><p>Maximum size of all stream buffers for this connection, in bytes. This is a soft limit used to apply backpressure to handlers that send data faster than the HTTP/2 connection allows.</p> +</dd> +<dt>max_connection_window_size (16#7fffffff)</dt> +<dd><p>Maximum connection window size in bytes. This is used as an upper bound when calculating the window size, either when reading the request body or receiving said body.</p> +</dd> +<dt>max_decode_table_size (4096)</dt> +<dd><p>Maximum header table size in bytes 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 in bytes 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_fragmented_header_block_size (32768)</dt> +<dd><p>Maximum header block size when headers are split over multiple HEADERS and CONTINUATION frames. Clients that attempt to send header blocks larger than this value will receive an ENHANCE_YOUR_CALM connection error. Note that this value is not advertised and should be large enough for legitimate requests.</p> +</dd> +<dt>max_frame_size_received (16384)</dt> +<dd><p>Maximum size in bytes 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> +<p>It is highly recommended to increase this value for performance reasons. In a future Cowboy version the default will be increased to 1MB (1048576). Too low values may result in very large file uploads failing because Cowboy will detect the large number of frames as flood and close the connection.</p> +</dd> +<dt>max_frame_size_sent (infinity)</dt> +<dd><p>Maximum size in bytes 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>max_received_frame_rate ({10000, 10000})</dt> +<dd><p>Maximum frame rate allowed per connection. The rate is expressed as a tuple <code>{NumFrames, TimeMs}</code> indicating how many frames are allowed over the given time period. This is similar to a supervisor restart intensity/period.</p> +</dd> +<dt>max_reset_stream_rate ({10, 10000})</dt> +<dd><p>Maximum reset stream rate per connection. This can be used to protect against misbehaving or malicious peers that do not follow the protocol, leading to the server resetting streams, by limiting the number of streams that can be reset over a certain time period. The rate is expressed as a tuple <code>{NumResets, TimeMs}</code>. This is similar to a supervisor restart intensity/period.</p> +</dd> +<dt>max_cancel_stream_rate ({500, 10000})</dt> +<dd><p>Maximum cancel stream rate per connection. This can be used to protect against misbehaving or malicious peers, by limiting the number of streams that the peer can reset over a certain time period. The rate is expressed as a tuple <code>{NumCancels, TimeMs}</code>. This is similar to a supervisor restart intensity/period.</p> +</dd> +<dt>max_stream_buffer_size (8000000)</dt> +<dd><p>Maximum stream buffer size in bytes. This is a soft limit used to apply backpressure to handlers that send data faster than the HTTP/2 connection allows.</p> +</dd> +<dt>max_stream_window_size (16#7fffffff)</dt> +<dd><p>Maximum stream window size in bytes. This is used as an upper bound when calculating the window size, either when reading the request body or receiving said body.</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>reset_idle_timeout_on_send (false)</dt> +<dd><p>Whether the <code>idle_timeout</code> gets reset when sending data to the socket.</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> +<dt>stream_window_data_threshold (16384)</dt> +<dd><p>Window threshold in bytes below which Cowboy will not attempt to send data, with one exception. When Cowboy has data to send and the window is high enough, Cowboy will always send the data, regardless of this option.</p> +</dd> +<dt>stream_window_margin_size (65535)</dt> +<dd><p>Extra amount in bytes to be added to the window size when updating a stream's window. This is used to ensure that there is always some space available in the window.</p> +</dd> +<dt>stream_window_update_threshold (163840)</dt> +<dd><p>A stream's window will only get updated when its size becomes lower than this threshold, in bytes. This is to avoid sending too many <code>WINDOW_UPDATE</code> frames.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.11</strong>: Websocket over HTTP/2 is now considered stable. +</li> +<li><strong>2.11</strong>: The <code>reset_idle_timeout_on_send</code> option was added. +</li> +<li><strong>2.11</strong>: Add the option <code>max_cancel_stream_rate</code> to protect against another flood scenario. +</li> +<li><strong>2.9</strong>: The <code>goaway_initial_timeout</code> and <code>goaway_complete_timeout</code> options were added. +</li> +<li><strong>2.8</strong>: The <code>active_n</code> option was added. +</li> +<li><strong>2.8</strong>: The <code>linger_timeout</code> option was added. +</li> +<li><strong>2.8</strong>: The <code>max_received_frame_rate</code> default value has been multiplied by 10 as the default was too low. +</li> +<li><strong>2.7</strong>: Add the options <code>connection_window_margin_size</code>, <code>connection_window_update_threshold</code>, <code>max_connection_window_size</code>, <code>max_stream_window_size</code>, <code>stream_window_margin_size</code> and <code>stream_window_update_threshold</code> to configure behavior on sending WINDOW_UPDATE frames; <code>max_connection_buffer_size</code> and <code>max_stream_buffer_size</code> to apply backpressure when sending data too fast; <code>max_received_frame_rate</code> and <code>max_reset_stream_rate</code> to protect against various flood scenarios; and <code>stream_window_data_threshold</code> to control how small the DATA frames that Cowboy sends can get. +</li> +<li><strong>2.7</strong>: The <code>logger</code> option was added. +</li> +<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 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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_loop/index.html b/docs/en/cowboy/2.12/manual/cowboy_loop/index.html new file mode 100644 index 00000000..233da481 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_loop/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_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=7" 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.9 +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">timeout</font></b>()} + +<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> | <b><font color="#000000">timeout</font></b>()} + | {<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.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.11</strong>: A timeout may be returned instead of <code>hibernate</code>. It functions the same way as the <code>gen_server</code> timeout. +</li> +<li><strong>2.0</strong>: Loop handlers no longer need to handle socket events. +</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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_metrics_h/index.html b/docs/en/cowboy/2.12/manual/cowboy_metrics_h/index.html new file mode 100644 index 00000000..d43d2e21 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_metrics_h/index.html @@ -0,0 +1,290 @@ +<!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_metrics_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=7" 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_metrics_h(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_metrics_h - Metrics stream handler</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy_metrics_h</code> gathers metrics and other information about a stream. It then calls the configured callback with this data.</p> +<h2 id="_types">Types</h2> +<h3 id="_metrics">metrics()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">metrics</font></b>() <font color="#990000">::</font> #{ + <i><font color="#9A1900">%% The identifier for this listener.</font></i> + <font color="#FF6600">ref</font> <font color="#990000">:=</font> <b><font color="#000000">ranch:ref</font></b>(), + + <i><font color="#9A1900">%% The pid for this connection.</font></i> + <font color="#FF6600">pid</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>(), + + <i><font color="#9A1900">%% The streamid also indicates the total number of requests on</font></i> + <i><font color="#9A1900">%% this connection (StreamID div 2 + 1).</font></i> + <font color="#FF6600">streamid</font> <font color="#990000">:=</font> <b><font color="#000000">cowboy_stream:streamid</font></b>(), + + <i><font color="#9A1900">%% The terminate reason is always useful.</font></i> + <font color="#FF6600">reason</font> <font color="#990000">:=</font> <b><font color="#000000">cowboy_stream:reason</font></b>(), + + <i><font color="#9A1900">%% A filtered Req object or a partial Req object</font></i> + <i><font color="#9A1900">%% depending on how far the request got to.</font></i> + <font color="#0000FF">req</font> <font color="#990000">=></font> <b><font color="#000000">cowboy_req:req</font></b>(), + <font color="#0000FF">partial_req</font> <font color="#990000">=></font> <b><font color="#000000">cowboy_stream:partial_req</font></b>(), + + <i><font color="#9A1900">%% Response status.</font></i> + <font color="#FF6600">resp_status</font> <font color="#990000">:=</font> <b><font color="#000000">cowboy:http_status</font></b>(), + + <i><font color="#9A1900">%% Filtered response headers.</font></i> + <font color="#FF6600">resp_headers</font> <font color="#990000">:=</font> <b><font color="#000000">cowboy:http_headers</font></b>(), + + <i><font color="#9A1900">%% Start/end of the processing of the request.</font></i> + <i><font color="#9A1900">%%</font></i> + <i><font color="#9A1900">%% This represents the time from this stream handler's init</font></i> + <i><font color="#9A1900">%% to terminate.</font></i> + <font color="#0000FF">req_start</font> <font color="#990000">=></font> <b><font color="#000080">integer</font></b>(), + <font color="#0000FF">req_end</font> <font color="#990000">=></font> <b><font color="#000080">integer</font></b>(), + + <i><font color="#9A1900">%% Start/end of the receiving of the request body.</font></i> + <i><font color="#9A1900">%% Begins when the first packet has been received.</font></i> + <font color="#0000FF">req_body_start</font> <font color="#990000">=></font> <b><font color="#000080">integer</font></b>(), + <font color="#0000FF">req_body_end</font> <font color="#990000">=></font> <b><font color="#000080">integer</font></b>(), + + <i><font color="#9A1900">%% Start/end of the sending of the response.</font></i> + <i><font color="#9A1900">%% Begins when we send the headers and ends on the final</font></i> + <i><font color="#9A1900">%% packet of the response body. If everything is sent at</font></i> + <i><font color="#9A1900">%% once these values are identical.</font></i> + <font color="#0000FF">resp_start</font> <font color="#990000">=></font> <b><font color="#000080">integer</font></b>(), + <font color="#0000FF">resp_end</font> <font color="#990000">=></font> <b><font color="#000080">integer</font></b>(), + + <i><font color="#9A1900">%% For early errors all we get is the time we received it.</font></i> + <font color="#0000FF">early_error_time</font> <font color="#990000">=></font> <b><font color="#000080">integer</font></b>(), + + <i><font color="#9A1900">%% Start/end of spawned processes. This is where most of</font></i> + <i><font color="#9A1900">%% the user code lies, excluding stream handlers. On a</font></i> + <i><font color="#9A1900">%% default Cowboy configuration there should be only one</font></i> + <i><font color="#9A1900">%% process: the request process.</font></i> + <font color="#0000FF">procs</font> <font color="#990000">=></font> <font color="#009900">ProcMetrics</font>, + + <i><font color="#9A1900">%% Informational responses sent before the final response.</font></i> + <font color="#0000FF">informational</font> <font color="#990000">=></font> [<font color="#009900">InformationalMetrics</font>], + + <i><font color="#9A1900">%% Length of the request and response bodies. This does</font></i> + <i><font color="#9A1900">%% not include the framing.</font></i> + <font color="#0000FF">req_body_length</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">resp_body_length</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + + <i><font color="#9A1900">%% Additional metadata set by the user.</font></i> + <font color="#0000FF">user_data</font> <font color="#990000">=></font> <b><font color="#000000">map</font></b>() +} + +<font color="#009900">InformationalMetrics</font> <font color="#990000">::</font> #{ + <i><font color="#9A1900">%% Informational response status.</font></i> + <font color="#FF6600">status</font> <font color="#990000">:=</font> <b><font color="#000000">cowboy:http_status</font></b>(), + + <i><font color="#9A1900">%% Headers sent with the informational response.</font></i> + <font color="#FF6600">headers</font> <font color="#990000">:=</font> <b><font color="#000000">cowboy:http_headers</font></b>(), + + <i><font color="#9A1900">%% Time when the informational response was sent.</font></i> + <font color="#FF6600">time</font> <font color="#990000">:=</font> <b><font color="#000080">integer</font></b>() +} + +<font color="#009900">ProcMetrics</font> <font color="#990000">::</font> #{<b><font color="#000080">pid</font></b>() <font color="#990000">=></font> #{ + <i><font color="#9A1900">%% Time at which the process spawned.</font></i> + <font color="#FF6600">spawn</font> <font color="#990000">:=</font> <b><font color="#000080">integer</font></b>(), + + <i><font color="#9A1900">%% Time at which the process exited.</font></i> + <b><font color="#000080">exit</font></b> <font color="#990000">=></font> <b><font color="#000080">integer</font></b>(), + + <i><font color="#9A1900">%% Reason for the process exit.</font></i> + <font color="#0000FF">reason</font> <font color="#990000">=></font> <b><font color="#000000">any</font></b>() +}}</tt></pre> +</div></div> +<p>Metrics given to the callback function.</p> +<p>Depending on the life of the stream the metrics may include more or less information.</p> +<p>The <code>set_options</code> command can be used to add additional metadata in the <code>user_data</code> metric. This can be used for example to add the handler module which was selected by the router. The option to be set is <code>metrics_user_data</code>. It takes a map which will be merged in the existing <code>user_data</code> map.</p> +<h2 id="_options">Options</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">metrics_callback</font> <font color="#990000">=></font> <b><font color="#0000FF">fun</font></b>((<b><font color="#000000">metrics</font></b>()) <font color="#990000">-></font> <b><font color="#000000">any</font></b>()), + <font color="#0000FF">metrics_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>()), + <font color="#0000FF">metrics_resp_headers_filter</font> <font color="#990000">=></font> <b><font color="#0000FF">fun</font></b>((<b><font color="#000000">cowboy:http_headers</font></b>()) <font color="#990000">-></font> <b><font color="#000000">cowboy:http_headers</font></b>()) +}</tt></pre> +</div></div> +<p>Configuration for the metrics stream handler.</p> +<dl><dt>metrics_callback - mandatory</dt> +<dd><p>The function that will be called upon completion of the stream. It only takes a single argument, the <code>metrics()</code>.</p> +</dd> +<dt>metrics_req_filter</dt> +<dd><p>A function applied to the Req to compact it and only keep required information. By default no filtering is done.</p> +</dd> +<dt>metrics_resp_headers_filter</dt> +<dd><p>A function applied to the response headers to filter them and only keep required information. By default no filtering is done.</p> +</dd> +</dl> +<h2 id="_events">Events</h2> +<p>The metrics stream handler does not produce any event.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.7</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>, <a href="../cowboy_decompress_h">cowboy_decompress_h(3)</a>, <a href="../cowboy_stream_h">cowboy_stream_h(3)</a>, <a href="../cowboy_tracer_h">cowboy_tracer_h(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.12/manual/cowboy_middleware/index.html new file mode 100644 index 00000000..52071bd9 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_middleware/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_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=7" 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.9 +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> +<!-- @todo No need to return the Req when stopping. Fix in 3.0.--> +<h2 id="_types">Types</h2> +<h3 id="_env">env()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.binding/index.html new file mode 100644 index 00000000..c2fb9f28 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.binding/index.html @@ -0,0 +1,213 @@ +<!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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.bindings/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.bindings/index.html new file mode 100644 index 00000000..856ab737 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.bindings/index.html @@ -0,0 +1,193 @@ +<!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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.body_length/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.body_length/index.html new file mode 100644 index 00000000..d4fd93a4 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.body_length/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_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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.cast/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.cast/index.html new file mode 100644 index 00000000..613d699d --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.cast/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_req:cast(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=7" 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:cast(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:cast - Cast a stream handler event</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cast</font></b>(<font color="#009900">Event</font> <font color="#990000">::</font> <b><font color="#000000">any</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="#FF6600">ok</font></tt></pre> +</div></div> +<p>Cast a stream handler event.</p> +<p>The event will be passed to stream handlers through the <code>info/3</code> callback.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Event</dt> +<dd><p>The event to be sent to stream handlers.</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.7</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Read the body using auto mode</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">read_body_auto_async</font></b>(<font color="#009900">Req</font>) <font color="#990000">-></font> + <b><font color="#000000">read_body_auto_async</font></b>(<font color="#009900">Req</font>, <b><font color="#000080">make_ref</font></b>(), <font color="#990000"><<>></font>)<font color="#990000">.</font> + +<b><font color="#000000">read_body_auto_async</font></b>(<font color="#009900">Req</font>, <font color="#009900">Ref</font>, <font color="#009900">Acc</font>) <font color="#990000">-></font> + <b><font color="#000000">cowboy_req:cast</font></b>({<font color="#FF6600">read_body</font>, <b><font color="#000080">self</font></b>(), <font color="#009900">Ref</font>, <font color="#FF6600">auto</font>, <font color="#FF6600">infinity</font>}, <font color="#009900">Req</font>), + <b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">request_body</font>, <font color="#009900">Ref</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Data</font>} <font color="#990000">-></font> + <b><font color="#000000">read_body_auto_async</font></b>(<font color="#009900">Req</font>, <font color="#009900">Ref</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">request_body</font>, <font color="#009900">Ref</font>, <font color="#FF6600">fin</font>, <font color="#009900">_BodyLen</font>, <font color="#009900">Data</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">Increase the HTTP/1.1 idle timeout</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cowboy_req:cast</font></b>({<font color="#FF6600">set_options</font>, #{ + <font color="#0000FF">idle_timeout</font> <font color="#990000">=></font> <font color="#993399">3600000</font> +}}, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Add user data to metrics</div> +<div class="content"><pre>cowboy_req:cast({set_options, #{ + metrics_user_data => #{handler => ?MODULE} +}}, Req).</pre></div></div> +<div class="listingblock"><div class="title">Enable compression buffering</div> +<div class="content"><pre>cowboy_req:cast({set_options, #{ + compress_buffering => true +}}, Req).</pre></div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_stream">cowboy_stream(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.cert/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.cert/index.html new file mode 100644 index 00000000..33e5cf75 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.cert/index.html @@ -0,0 +1,213 @@ +<!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=7" 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.9 +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.9 +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">certfile</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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.delete_resp_header/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.delete_resp_header/index.html new file mode 100644 index 00000000..bba7d913 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.delete_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: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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.filter_cookies/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.filter_cookies/index.html new file mode 100644 index 00000000..8debae92 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.filter_cookies/index.html @@ -0,0 +1,201 @@ +<!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:filter_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=7" 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:filter_cookies(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:filter_cookies - Filter cookie headers</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">filter_cookies</font></b>(<font color="#009900">Names</font>, <font color="#009900">Req</font>) <font color="#990000">-></font> <font color="#009900">Req</font> + +<font color="#009900">Names</font> <font color="#990000">::</font> [<b><font color="#000080">atom</font></b>() | <b><font color="#000080">binary</font></b>()]</tt></pre> +</div></div> +<p>Filter cookie headers.</p> +<p>This function is meant to be used before attempting to parse or match cookies in order to remove cookies that are not relevant and are potentially malformed. Because Cowboy by default crashes on malformed cookies, this function allows processing requests that would otherwise result in a 400 error.</p> +<p>Malformed cookies are unfortunately fairly common due to the string-based interface provided by browsers and this function provides a middle ground between Cowboy's strict behavior and chaotic real world use cases.</p> +<p>Note that there may still be crashes even after filtering cookies because this function does not correct malformed values. Cookies that have malformed values should probably be unset in an error response or in a redirect.</p> +<p>This function can be called even if there are no cookies in the request.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Names</dt> +<dd><p>The cookies that should be kept.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The Req object is returned with its cookie header value filtered.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.7</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Filter then parse cookies</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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:filter_cookies</font></b>([<font color="#FF6600">session_id</font>, <font color="#FF6600">token</font>], <font color="#009900">Req0</font>), +<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></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>, <a href="../cowboy_req.match_cookies">cowboy_req:match_cookies(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.has_body/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.has_body/index.html new file mode 100644 index 00000000..46d6c5b7 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.has_body/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: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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.has_resp_body/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.has_resp_body/index.html new file mode 100644 index 00000000..b404eab6 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.has_resp_body/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_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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.has_resp_header/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.has_resp_header/index.html new file mode 100644 index 00000000..67a2897c --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.has_resp_header/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_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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.header/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.header/index.html new file mode 100644 index 00000000..af46f4c0 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.header/index.html @@ -0,0 +1,220 @@ +<!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=7" 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.9 +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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.headers/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.headers/index.html new file mode 100644 index 00000000..f6e33e2b --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.headers/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: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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.host/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.host/index.html new file mode 100644 index 00000000..9dee6815 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.host/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: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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.host_info/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.host_info/index.html new file mode 100644 index 00000000..dcc1109c --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.host_info/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_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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.inform/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.inform/index.html new file mode 100644 index 00000000..e861dde9 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.inform/index.html @@ -0,0 +1,218 @@ +<!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=7" 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.9 +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.9 +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.9 +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="#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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.match_cookies/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.match_cookies/index.html new file mode 100644 index 00000000..69fe6524 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.match_cookies/index.html @@ -0,0 +1,221 @@ +<!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=7" 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.9 +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> +<p>This function will crash on invalid cookie data. How to handle this is explained in details in the manual page for <a href="../cowboy_req.parse_cookies">cowboy_req:parse_cookies(3)</a>.</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.9 +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.9 +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.9 +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.filter_cookies">cowboy_req:filter_cookies(3)</a>, <a href="../cowboy_req.parse_cookies">cowboy_req:parse_cookies(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.match_qs/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.match_qs/index.html new file mode 100644 index 00000000..d330c406 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.match_qs/index.html @@ -0,0 +1,220 @@ +<!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=7" 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.9 +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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.method/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.method/index.html new file mode 100644 index 00000000..44273e5b --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.method/index.html @@ -0,0 +1,211 @@ +<!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=7" 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.9 +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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.parse_cookies/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.parse_cookies/index.html new file mode 100644 index 00000000..add9a948 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.parse_cookies/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: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=7" 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.9 +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 or empty, <code>[]</code> is returned.</p> +<p>This function will crash on invalid cookie data. Because invalid cookies are fairly common when dealing with browsers (because of the string interface that the Javascript API provides), it is recommended to filter the cookie header value before attempting to parse it. This can be accomplished by calling the function <a href="../cowboy_req.filter_cookies">cowboy_req:filter_cookies(3)</a> first. This does not guarantee that parsing succeeds. If it still fails it is recommended to send an error response or redirect with instructions to delete the relevant cookies:</p> +<div class="listingblock"><div class="title">Recover from cookie parsing errors</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req1</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:filter_cookies</font></b>([<font color="#FF6600">session_id</font>, <font color="#FF6600">token</font>], <font color="#009900">Req0</font>), +<b><font color="#0000FF">try</font></b> <b><font color="#000000">cowboy_req:parse_cookies</font></b>(<font color="#009900">Req1</font>) <b><font color="#0000FF">of</font></b> + <font color="#009900">Cookies</font> <font color="#990000">-></font> + <b><font color="#000000">do_something</font></b>(<font color="#009900">Req1</font>, <font color="#009900">Cookies</font>) +<b><font color="#0000FF">catch</font></b> <font color="#990000">_:_</font> <font color="#990000">-></font> + <i><font color="#9A1900">%% We can't parse the cookies we need, unset them</font></i> + <i><font color="#9A1900">%% otherwise the browser will continue sending them.</font></i> + <font color="#009900">Req2</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_cookie</font></b>(<font color="#990000"><<</font><font color="#FF0000">"session_id"</font><font color="#990000">>></font>, + <font color="#990000"><<>></font>, <font color="#009900">Req1</font>, #{<font color="#0000FF">max_age</font> <font color="#990000">=></font> <font color="#993399">0</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">"token"</font><font color="#990000">>></font>, + <font color="#990000"><<>></font>, <font color="#009900">Req2</font>, #{<font color="#0000FF">max_age</font> <font color="#990000">=></font> <font color="#993399">0</font>}), + <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">500</font>, <font color="#009900">Req</font>) +<b><font color="#0000FF">end</font></b><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 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.9 +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.filter_cookies">cowboy_req:filter_cookies(3)</a>, <a href="../cowboy_req.match_cookies">cowboy_req:match_cookies(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.parse_header/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.parse_header/index.html new file mode 100644 index 00000000..d65d761d --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.parse_header/index.html @@ -0,0 +1,427 @@ +<!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=7" 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.9 +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.9 +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.9 +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">access-control-request-headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">"access-control-request-headers"</font><font color="#990000">>></font>, <font color="#009900">Req</font>) + <font color="#990000">-></font> [<font color="#009900">Header</font>] + +<font color="#009900">Header</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">access-control-request-method</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">"access-control-request-method"</font><font color="#990000">>></font>) + <font color="#990000">-></font> <font color="#009900">Method</font> + +<font color="#009900">Method</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">authorization and proxy-authorization</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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-encoding and content-language</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">Name</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="#FF0000">"content-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></tt></pre> +</div></div> +<div class="listingblock"><div class="title">content-length</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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">max-forwards</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">"max-forwards"</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> +<div class="listingblock"><div class="title">origin</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">"origin"</font><font color="#990000">>></font>, <font color="#009900">Req</font>) + <font color="#990000">-></font> [{<font color="#009900">Scheme</font>, <font color="#009900">Host</font>, <font color="#009900">Port</font>} | <font color="#009900">GUID</font>] + +<font color="#009900">Scheme</font> <font color="#990000">::</font> <font color="#990000"><<</font><font color="#FF0000">"http"</font><font color="#990000">>></font> | <font color="#990000"><<</font><font color="#FF0000">"https"</font><font color="#990000">>></font> +<font color="#009900">Host</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% case insensitive</font></i> +<font color="#009900">Port</font> <font color="#990000">::</font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">65535</font> +<font color="#009900">GUID</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Cowboy generates a reference in place of a GUID when the URI uses an unsupported uri-scheme or is not an absolute URI.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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.9 +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.9 +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">trailer</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">Header</font>] + +<font color="#009900">Header</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.9 +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> +<p>This function will crash when attempting to parse a header Cowboy does not currently understand.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.8</strong>: The function now parses <code>access-control-request-headers</code>, <code>access-control-request-method</code>, <code>content-encoding</code>, <code>content-language</code>, <code>max-forwards</code>, <code>origin</code>, <code>proxy-authorization</code> and <code>trailer</code>. +</li> +<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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.parse_qs/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.parse_qs/index.html new file mode 100644 index 00000000..fc7dc78c --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.parse_qs/index.html @@ -0,0 +1,208 @@ +<!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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.path/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.path/index.html new file mode 100644 index 00000000..2a3381be --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.path/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: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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.path_info/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.path_info/index.html new file mode 100644 index 00000000..1c58b41c --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.path_info/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_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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.peer/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.peer/index.html new file mode 100644 index 00000000..25677e7a --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.peer/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: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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.port/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.port/index.html new file mode 100644 index 00000000..2ec0d720 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.port/index.html @@ -0,0 +1,201 @@ +<!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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.push/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.push/index.html new file mode 100644 index 00000000..a2424dbc --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.push/index.html @@ -0,0 +1,227 @@ +<!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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.qs/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.qs/index.html new file mode 100644 index 00000000..a2f885b8 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.qs/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: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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.read_and_match_urlencoded_body/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.read_and_match_urlencoded_body/index.html new file mode 100644 index 00000000..7cb66b28 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.read_and_match_urlencoded_body/index.html @@ -0,0 +1,251 @@ +<!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=7" 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.9 +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.9 +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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.read_body/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.read_body/index.html new file mode 100644 index 00000000..5221037a --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.read_body/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: 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=7" 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.9 +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> +<p>Auto mode can be enabled by setting the <code>length</code> to <code>auto</code> and the <code>period</code> to <code>infinity</code>. When auto mode is used, Cowboy will send data to the handler as soon as it receives it, regardless of its size. It will wait indefinitely until data is available. Auto mode's main purpose is asynchronous body reading using <a href="../cowboy_req.cast">cowboy_req:cast(3)</a>.</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.11</strong>: The <code>length</code> option now accepts <code>auto</code> and the period now accepts <code>infinity</code>. This adds support for reading the body in auto mode. +</li> +<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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.read_part/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.read_part/index.html new file mode 100644 index 00000000..eb21ba5b --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.read_part/index.html @@ -0,0 +1,247 @@ +<!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=7" 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.9 +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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.read_part_body/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.read_part_body/index.html new file mode 100644 index 00000000..594b27bd --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.read_part_body/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_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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.read_urlencoded_body/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.read_urlencoded_body/index.html new file mode 100644 index 00000000..6eaae94b --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.read_urlencoded_body/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_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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.reply/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.reply/index.html new file mode 100644 index 00000000..18d9f53c --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.reply/index.html @@ -0,0 +1,239 @@ +<!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=7" 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.9 +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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.resp_header/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.resp_header/index.html new file mode 100644 index 00000000..0daccba2 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.resp_header/index.html @@ -0,0 +1,211 @@ +<!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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.resp_headers/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.resp_headers/index.html new file mode 100644 index 00000000..55054a75 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.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: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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.scheme/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.scheme/index.html new file mode 100644 index 00000000..e5aa6dad --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.scheme/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: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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.set_resp_body/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.set_resp_body/index.html new file mode 100644 index 00000000..89b416a6 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.set_resp_body/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: 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=7" 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.9 +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.9 +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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.set_resp_cookie/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.set_resp_cookie/index.html new file mode 100644 index 00000000..04a613c0 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.set_resp_cookie/index.html @@ -0,0 +1,257 @@ +<!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=7" 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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.set_resp_header/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.set_resp_header/index.html new file mode 100644 index 00000000..021e8917 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.set_resp_header/index.html @@ -0,0 +1,213 @@ +<!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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.set_resp_headers/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.set_resp_headers/index.html new file mode 100644 index 00000000..a1adb3bc --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.set_resp_headers/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: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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.sock/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.sock/index.html new file mode 100644 index 00000000..222240f0 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.sock/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: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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.stream_body/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.stream_body/index.html new file mode 100644 index 00000000..109102cb --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.stream_body/index.html @@ -0,0 +1,211 @@ +<!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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.stream_events/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.stream_events/index.html new file mode 100644 index 00000000..9aeccddf --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.stream_events/index.html @@ -0,0 +1,225 @@ +<!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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.stream_reply/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.stream_reply/index.html new file mode 100644 index 00000000..abca2016 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.stream_reply/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: 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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.stream_trailers/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.stream_trailers/index.html new file mode 100644 index 00000000..4ff6b368 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.stream_trailers/index.html @@ -0,0 +1,208 @@ +<!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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.uri/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.uri/index.html new file mode 100644 index 00000000..fe904cba --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.uri/index.html @@ -0,0 +1,259 @@ +<!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=7" 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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req.version/index.html b/docs/en/cowboy/2.12/manual/cowboy_req.version/index.html new file mode 100644 index 00000000..8d1084d8 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req.version/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: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=7" 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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_req/index.html b/docs/en/cowboy/2.12/manual/cowboy_req/index.html new file mode 100644 index 00000000..c1aab295 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_req/index.html @@ -0,0 +1,382 @@ +<!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=7" 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.filter_cookies">cowboy_req:filter_cookies(3)</a> - Filter cookie headers +</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> +<p>Stream handlers:</p> +<ul><li><a href="../cowboy_req.cast">cowboy_req:cast(3)</a> - Cast a stream handler event +</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.9 +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.9 +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="#FF6600">auto</font>, + <font color="#0000FF">period</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>() | <font color="#FF6600">infinity</font>, + <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> +<p>Auto mode can be enabled by setting <code>length</code> to <code>auto</code> and <code>period</code> to <code>infinity</code>. The period cannot be set to <code>infinity</code> when auto mode isn't used.</p> +<h3 id="_req">req()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font>#{<font color="#FF6600">'_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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_rest/index.html b/docs/en/cowboy/2.12/manual/cowboy_rest/index.html new file mode 100644 index 00000000..42dd6b06 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_rest/index.html @@ -0,0 +1,741 @@ +<!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=7" 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.9 +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.</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.9 +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="#FF6600">created</font>, <font color="#009900">URI</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>()} + | {<font color="#FF6600">see_other</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>{created, URI}</code> or <code>{see_other, URI}</code> with <code>URI</code> the new location.</p> +<p>The <code>see_other</code> tuple will redirect the client to the new location automatically.</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.9 +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.9 +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.9 +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.9 +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.9 +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> [{<font color="#FF6600">'*'</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> +<p>The special value <code>'*'</code> can be used to accept any media type.</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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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="#000080">undefined</font> +<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> +<p>It is possible to conditionally generate an etag. When no etag can be generated, <code>undefined</code> should be returned.</p> +<h3 id="_is_authorized">is_authorized</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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: it is only used to calculate the content length.</p> +<!-- @todo Perhaps we can optimize HEAD requests and just--> +<!-- allow calculating the length instead of returning the--> +<!-- whole thing.--> +<p>It is possible to stream the response body either by manually sending the response and returning a <code>stop</code> value; or by switching to a different handler (for example a loop handler) and manually sending the response. All headers already set by Cowboy will also be included in the response.</p> +<h2 id="_rangecallback">RangeCallback</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">RangeCallback</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="#009900">Range</font>, <font color="#009900">Body</font>}] +<font color="#009900">Range</font> <font color="#990000">::</font> {<font color="#009900">From</font>, <font color="#009900">To</font>, <font color="#009900">Total</font>} | <b><font color="#000080">binary</font></b>() +<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="#009900">Total</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>() | <font color="#FF6600">'*'</font> +<font color="#009900">Body</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 a list of ranges for the response body.</p> +<p>The range selected can be found in the key <code>range</code> in the Req object, as indicated in <code>range_satisfiable</code>.</p> +<p>Instead of returning the full response body as would be done in the <code>ProvideCallback</code>, a list of ranges must be returned. There can be one or more range. When one range is returned, a normal ranged response is sent. When multiple ranges are returned, Cowboy will automatically send a multipart/byteranges response.</p> +<p>When the total is not known the atom <code>'*'</code> can be returned.</p> +<h2 id="_ranges_provided">ranges_provided</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">ranges_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> [<font color="#009900">Range</font> | <font color="#009900">Auto</font>] +<font color="#009900">Range</font> <font color="#990000">::</font> { + <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% lowercase; case insensitive</font></i> + <font color="#009900">RangeCallback</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>() +} +<font color="#009900">Auto</font> <font color="#990000">::</font> {<font color="#990000"><<</font><font color="#FF0000">"bytes"</font><font color="#990000">>></font>, <font color="#FF6600">auto</font>} +<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 range units the resource provides.</p> +<p>During content negotiation Cowboy will build an accept-ranges response header with the list of ranges provided. Cowboy does not choose a range at this time; ranges are choosen when it comes time to call the <code>ProvideCallback</code>.</p> +<p>By default ranged requests will be handled the same as normal requests: the <code>ProvideCallback</code> will be called and the full response body will be sent.</p> +<p>It is possible to let Cowboy handle ranged responses automatically when the range unit is bytes and the atom returned is <code>auto</code> (instead of a callback name). In that case Cowboy will call the <code>ProvideCallback</code> and split the response automatically, including by producing a multipart/byteranges response if necessary.</p> +<h2 id="_range_satisfiable">range_satisfiable</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">range_satisfiable</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="#000080">false</font>, <b><font color="#000000">non_neg_integer</font></b>() | <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>Whether the range request is satisfiable.</p> +<p>When the time comes to send the response body, and when ranges have been provided via the <code>ranges_provided</code> callback, Cowboy will process the if-range and the range request headers and ensure it is satisfiable.</p> +<p>This callback allows making resource-specific checks before sending the ranged response. The default is to accept sending a ranged response.</p> +<p>Cowboy adds the requested <code>range</code> to the Req object just before calling this callback:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">range</font> <font color="#990000">=></font> { + <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% lowercase; case insensitive</font></i> + <font color="#009900">Range</font> + } +} + +<font color="#009900">Range</font> <font color="#990000">::</font> <font color="#009900">ByteRange</font> | <b><font color="#000080">binary</font></b>() + +<font color="#009900">ByteRange</font> <font color="#990000">::</font> [{<font color="#009900">FirstByte</font>, <font color="#009900">LastByte</font> | <font color="#FF6600">infinity</font>} | <font color="#009900">SuffixLen</font>] +<font color="#009900">FirstByte</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>() +<font color="#009900">LastByte</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>() +<font color="#009900">SuffixLen</font> <font color="#990000">::</font> <b><font color="#000000">neg_integer</font></b>()</tt></pre> +</div></div> +<p>Only byte ranges are parsed. Other ranges are provided as binary. Byte ranges may either be requested from first to last bytes (inclusive); from first bytes to the end (<code>infinity</code> is used to represent the last byte); or the last bytes of the representation via a negative integer (so -500 means the last 500 bytes).</p> +<p>Returning <code>false</code> will result in a 416 Range Not Satisfiable response being sent. The content-range header will be set automatically in the response if a tuple is returned. The integer value represents the total size (in the choosen unit) of the resource. An iodata value may also be returned and will be used as-is to build the content range header, prepended with the unit choosen.</p> +<h3 id="_rate_limited">rate_limited</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.11</strong>: The <code>ranges_provided</code>, <code>range_satisfiable</code> and the <code>RangeCallback</code> callbacks have been added. +</li> +<li><strong>2.11</strong>: The <code>generate_etag</code> callback can now return <code>undefined</code> to conditionally avoid generating an etag. +</li> +<li><strong>2.9</strong>: An <code>AcceptCallback</code> can now return <code>{created, URI}</code> or <code>{see_other, URI}</code>. The return value <code>{true, URI}</code> is deprecated. +</li> +<li><strong>2.7</strong>: The media type wildcard in <code>content_types_accepted</code> is now documented. +</li> +<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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_router.compile/index.html b/docs/en/cowboy/2.12/manual/cowboy_router.compile/index.html new file mode 100644 index 00000000..d9f89c7d --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_router.compile/index.html @@ -0,0 +1,201 @@ +<!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=7" 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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_router/index.html b/docs/en/cowboy/2.12/manual/cowboy_router/index.html new file mode 100644 index 00000000..d8a4cfda --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_router/index.html @@ -0,0 +1,218 @@ +<!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=7" 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. The environment can contain the rules directly or a tuple <code>{persistent_term, Key}</code>, in which case Cowboy will call <code>persistent_term:get(Key)</code> to retrieve the dispatch rules.</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.9 +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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_static/index.html b/docs/en/cowboy/2.12/manual/cowboy_static/index.html new file mode 100644 index 00000000..9066460e --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_static/index.html @@ -0,0 +1,278 @@ +<!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=7" 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.9 +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.9 +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.9 +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.9 +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.11</strong>: Support for range requests was added in 2.6 and is now considered stable. +</li> +<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.9 +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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_stream.data/index.html b/docs/en/cowboy/2.12/manual/cowboy_stream.data/index.html new file mode 100644 index 00000000..9f67d389 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_stream.data/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_stream:data(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=7" 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:data(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_stream:data - Handle data for a stream</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><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>} + +<font color="#009900">StreamID</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_stream:stream_id</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">Commands</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_stream:commands</font></b>() +<font color="#009900">State</font> <font color="#990000">-</font> <font color="#FF6600">opaque</font></tt></pre> +</div></div> +<p>Handle data for a stream.</p> +<p>This function should be called by all stream handlers. It will propagate data to the next configured stream handler. Handlers do not have to propagate data that has been fully handled.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>StreamID</dt> +<dd><p>The stream ID.</p> +</dd> +<dt>IsFin</dt> +<dd><p>Whether this is the end of the request body.</p> +</dd> +<dt>Data</dt> +<dd><p>The data received.</p> +</dd> +<dt>Commands</dt> +<dd><p>The commands to be executed.</p> +</dd> +<dt>State</dt> +<dd><p>The state for the next stream handler.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A list of commands and an opaque state is returned.</p> +<p>The list of commands returned should be included in the commands returned from the current stream handler. It can be modified if necessary.</p> +<p>The state should be stored in the current stream handler's state and passed to <code>cowboy_stream</code> when necessary. The state should be treated as opaque.</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">Propagate data to the next stream handler</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><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="#008080">#state</font>{<font color="#0000FF">next</font><font color="#990000">=</font><font color="#009900">Next0</font>}) <font color="#990000">-></font> + <font color="#009900">MyCommands</font> <font color="#990000">=</font> <b><font color="#000000">my_commands</font></b>(), + {<font color="#009900">Commands</font>, <font color="#009900">Next</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_stream:data</font></b>(<font color="#009900">StreamID</font>, <font color="#009900">IsFin</font>, <font color="#009900">Data</font>, <font color="#009900">Next0</font>), + {<font color="#009900">MyCommands</font> <font color="#990000">++</font> <font color="#009900">Commands</font>, <font color="#008080">#state</font>{<font color="#0000FF">next</font><font color="#990000">=</font><font color="#009900">Next</font>}}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_stream">cowboy_stream(3)</a>, <a href="../cowboy_stream.init">cowboy_stream:init(3)</a>, <a href="../cowboy_stream.info">cowboy_stream:info(3)</a>, <a href="../cowboy_stream.terminate">cowboy_stream:terminate(3)</a>, <a href="../cowboy_stream.early_error">cowboy_stream:early_error(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_stream.early_error/index.html b/docs/en/cowboy/2.12/manual/cowboy_stream.early_error/index.html new file mode 100644 index 00000000..9bd9ef1b --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_stream.early_error/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_stream:early_error(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=7" 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:early_error(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_stream:early_error - Handle an early error for a stream</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><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:stream_id</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_stream:partial_req</font></b>() +<font color="#009900">Resp</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_stream:resp_command</font></b>() +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:opts</font></b>()</tt></pre> +</div></div> +<p>Handle an early error for a stream.</p> +<p>This function should be called by all stream handlers. It will propagate the early error to the next configured stream handler.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>StreamID</dt> +<dd><p>The stream ID.</p> +</dd> +<dt>Reason</dt> +<dd><p>Reason for termination.</p> +</dd> +<dt>PartialReq</dt> +<dd><p>The request data that has been received so far.</p> +</dd> +<dt>Resp</dt> +<dd><p>The response that will be sent as a result of the early error.</p> +<p>It may be modified by the stream handler before or after being propagated to the next handler.</p> +</dd> +<dt>Opts</dt> +<dd><p>The protocol options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The response to be sent as a result of the early error.</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">Propagate the early error to the next stream handler</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><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> + <b><font color="#000000">cowboy_stream: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></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_stream">cowboy_stream(3)</a>, <a href="../cowboy_stream.init">cowboy_stream:init(3)</a>, <a href="../cowboy_stream.data">cowboy_stream:data(3)</a>, <a href="../cowboy_stream.info">cowboy_stream:info(3)</a>, <a href="../cowboy_stream.terminate">cowboy_stream:terminate(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_stream.info/index.html b/docs/en/cowboy/2.12/manual/cowboy_stream.info/index.html new file mode 100644 index 00000000..e278262f --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_stream.info/index.html @@ -0,0 +1,211 @@ +<!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: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=7" 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:info(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_stream:info - Handle a message for a stream</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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="#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>} + +<font color="#009900">StreamID</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_stream:stream_id</font></b>() +<font color="#009900">Info</font> <font color="#990000">::</font> <b><font color="#000000">any</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> <font color="#FF6600">opaque</font></tt></pre> +</div></div> +<p>Handle a message for a stream.</p> +<p>This function should be called by all stream handlers. It will propagate the event to the next configured stream handler. Handlers do not have to propagate events that have been fully handled.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>StreamID</dt> +<dd><p>The stream ID.</p> +</dd> +<dt>Info</dt> +<dd><p>The event received.</p> +</dd> +<dt>Commands</dt> +<dd><p>The commands to be executed.</p> +</dd> +<dt>State</dt> +<dd><p>The state for the next stream handler.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A list of commands and an opaque state is returned.</p> +<p>The list of commands returned should be included in the commands returned from the current stream handler. It can be modified if necessary.</p> +<p>The state should be stored in the current stream handler's state and passed to <code>cowboy_stream</code> when necessary. The state should be treated as opaque.</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">Propagate an event to the next stream handler</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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="#009900">StreamID</font>, <font color="#009900">Info</font>, <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">next</font><font color="#990000">=</font><font color="#009900">Next0</font>}) <font color="#990000">-></font> + <font color="#009900">MyCommands</font> <font color="#990000">=</font> <b><font color="#000000">my_commands</font></b>(), + {<font color="#009900">Commands</font>, <font color="#009900">Next</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_stream:info</font></b>(<font color="#009900">StreamID</font>, <font color="#009900">Info</font>, <font color="#009900">Next0</font>), + {<font color="#009900">MyCommands</font> <font color="#990000">++</font> <font color="#009900">Commands</font>, <font color="#008080">#state</font>{<font color="#0000FF">next</font><font color="#990000">=</font><font color="#009900">Next</font>}}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_stream">cowboy_stream(3)</a>, <a href="../cowboy_stream.init">cowboy_stream:init(3)</a>, <a href="../cowboy_stream.data">cowboy_stream:data(3)</a>, <a href="../cowboy_stream.terminate">cowboy_stream:terminate(3)</a>, <a href="../cowboy_stream.early_error">cowboy_stream:early_error(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_stream.init/index.html b/docs/en/cowboy/2.12/manual/cowboy_stream.init/index.html new file mode 100644 index 00000000..a9f08304 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_stream.init/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_stream:init(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=7" 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:init(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_stream:init - Initialize a stream</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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>} + +<font color="#009900">StreamID</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_stream:stream_id</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> <font color="#FF6600">opaque</font></tt></pre> +</div></div> +<p>Initialize a stream.</p> +<p>This function must be called by all stream handlers. It will initialize the next configured stream handler.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>StreamID</dt> +<dd><p>The stream ID.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +<dt>Opts</dt> +<dd><p>The protocol options.</p> +</dd> +<dt>Commands</dt> +<dd><p>The commands to be executed.</p> +</dd> +<dt>State</dt> +<dd><p>The state for the next stream handler.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A list of commands and an opaque state is returned.</p> +<p>The list of commands returned should be included in the commands returned from the current stream handler. It can be modified if necessary.</p> +<p>The state should be stored in the current stream handler's state and passed to <code>cowboy_stream</code> when necessary. The state should be treated as opaque.</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">Initialize the next stream handler</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">MyCommands</font> <font color="#990000">=</font> <b><font color="#000000">my_commands</font></b>(), + {<font color="#009900">Commands</font>, <font color="#009900">Next</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy_stream:init</font></b>(<font color="#009900">StreamID</font>, <font color="#009900">Req</font>, <font color="#009900">Opts</font>), + {<font color="#009900">MyCommands</font> <font color="#990000">++</font> <font color="#009900">Commands</font>, <font color="#008080">#state</font>{<font color="#0000FF">next</font><font color="#990000">=</font><font color="#009900">Next</font>}}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_stream">cowboy_stream(3)</a>, <a href="../cowboy_stream.data">cowboy_stream:data(3)</a>, <a href="../cowboy_stream.info">cowboy_stream:info(3)</a>, <a href="../cowboy_stream.terminate">cowboy_stream:terminate(3)</a>, <a href="../cowboy_stream.early_error">cowboy_stream:early_error(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_stream.terminate/index.html b/docs/en/cowboy/2.12/manual/cowboy_stream.terminate/index.html new file mode 100644 index 00000000..54e8496c --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_stream.terminate/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_stream: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=7" 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:terminate(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_stream:terminate - Terminate a stream</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">StreamID</font>, <font color="#009900">Reason</font>, <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">StreamID</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_stream:stream_id</font></b>() +<font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_stream:reason</font></b>() +<font color="#009900">State</font> <font color="#990000">-</font> <font color="#FF6600">opaque</font></tt></pre> +</div></div> +<p>Terminate a stream.</p> +<p>This function must be called by all stream handlers. It will terminate the next configured stream handler.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>StreamID</dt> +<dd><p>The stream ID.</p> +</dd> +<dt>Reason</dt> +<dd><p>Reason for termination.</p> +</dd> +<dt>State</dt> +<dd><p>The state for the next stream handler.</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 the next stream handler</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">StreamID</font>, <font color="#009900">Reason</font>, <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">next</font><font color="#990000">=</font><font color="#009900">Next0</font>}) <font color="#990000">-></font> + <b><font color="#000000">my_termination</font></b>(<font color="#009900">State</font>), + <b><font color="#000000">cowboy_stream:terminate</font></b>(<font color="#009900">StreamID</font>, <font color="#009900">Reason</font>, <font color="#009900">Next0</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_stream">cowboy_stream(3)</a>, <a href="../cowboy_stream.init">cowboy_stream:init(3)</a>, <a href="../cowboy_stream.data">cowboy_stream:data(3)</a>, <a href="../cowboy_stream.info">cowboy_stream:info(3)</a>, <a href="../cowboy_stream.early_error">cowboy_stream:early_error(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_stream/index.html b/docs/en/cowboy/2.12/manual/cowboy_stream/index.html new file mode 100644 index 00000000..64d6fa64 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_stream/index.html @@ -0,0 +1,438 @@ +<!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=7" 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.9 +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 through 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 occurring 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 order in which the commands are given matters. For example, when sending a response and at the same time creating a new child process, the first command should be the <code>spawn</code> and the second the <code>response</code>. The reason for that is that the sending of the response may result in a socket error which leads to the termination of the connection before the rest of the commands are executed.</p> +<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.9 +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.9 +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> +<p>Note that in Cowboy it is the <code>cowboy_req</code> module that sets the date and server headers. When using the command directly those headers will not be added.</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.9 +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> +<p>Note that in Cowboy it is the <code>cowboy_req</code> module that sets the date and server headers. When using the command directly those headers will not be added.</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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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.9 +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> +<p>No other command can be executed after the <code>stop</code> command.</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.9 +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> +<h3 id="_log">log</h3> +<p>Log a message.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<b><font color="#000080">log</font></b>, <b><font color="#000000">logger:level</font></b>(), <b><font color="#000000">io:format</font></b>(), <b><font color="#000080">list</font></b>()}</tt></pre> +</div></div> +<p>This command can be used to log a message using the configured <code>logger</code> module.</p> +<h3 id="_set_options">set_options</h3> +<p>Set protocol options.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">set_options</font>, <b><font color="#000000">map</font></b>()}</tt></pre> +</div></div> +<p>This can also be used to override stream handler options. For example this is supported by <a href="../cowboy_compress_h">cowboy_compress_h(3)</a>.</p> +<p>Not all options can be overridden. Please consult the relevant option's documentation for details.</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, the function <a href="../cowboy_req.cast">cowboy_req:cast(3)</a> can be used.</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.9 +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.9 +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 a direction of a stream.</p> +<h3 id="_partial_req">partial_req()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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.9 +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.9 +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.9 +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.7</strong>: The <code>log</code> and <code>set_options</code> commands were introduced. +</li> +<li><strong>2.6</strong>: The <code>data</code> 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 <code>trailers</code> 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>, <a href="../cowboy_req.cast">cowboy_req:cast(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_stream_h/index.html b/docs/en/cowboy/2.12/manual/cowboy_stream_h/index.html new file mode 100644 index 00000000..30655abe --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_stream_h/index.html @@ -0,0 +1,211 @@ +<!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=7" 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.9 +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> +<p>Because this stream handler converts events from the request process into commands, other stream handlers may not work properly if they are executed after the default stream handler. Always be mindful of in which order stream handlers will get executed.</p> +<h3 id="_request_body">Request body</h3> +<p>The default stream handler implements the <code>read_body</code> mechanism. In addition to reading the body, the handler will automatically handle the <code>expect: 100-continue</code> header and send a 100 Continue response.</p> +<p>Normally one would use <a href="../cowboy_req.read_body">cowboy_req:read_body(3)</a> to read the request body. The default stream handler will buffer data until the amount gets larger than the requested length before sending it. Alternatively, it will send whatever data it has when the period timeout triggers. Depending on the protocol, the flow control window is updated to allow receiving data for the requested length.</p> +<p>The default stream handler also comes with an automatic mode for reading the request body. This can be used by sending the event message <code>{read_body, Pid, Ref, auto, infinity}</code> using <a href="../cowboy_req.cast">cowboy_req:cast(3)</a>. The default stream handler will then send data as soon as some becomes available using one of these two messages depending on whether body reading was completed:</p> +<ul><li><code>{request_body, Ref, nofin, Data}</code> +</li> +<li><code>{request_body, Ref, fin, BodyLen, Data}</code> +</li> +</ul> +<p>Depending on the protocol, Cowboy will update the flow control window using the size of the data that was read.</p> +<p>Auto mode automatically gets disabled after data has been sent to the handler. Therefore in order to continue reading data a <code>read_body</code> event message must be sent after each <code>request_body</code> message.</p> +<h3 id="_response">Response</h3> +<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> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.11</strong>: Introduce body reading using auto mode. +</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_compress_h">cowboy_compress_h(3)</a>, <a href="../cowboy_decompress_h">cowboy_decompress_h(3)</a>, <a href="../cowboy_metrics_h">cowboy_metrics_h(3)</a>, <a href="../cowboy_tracer_h">cowboy_tracer_h(3)</a>, <a href="../cowboy_req.cast">cowboy_req:cast(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_tracer_h/index.html b/docs/en/cowboy/2.12/manual/cowboy_tracer_h/index.html new file mode 100644 index 00000000..ed82b0e6 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_tracer_h/index.html @@ -0,0 +1,213 @@ +<!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_tracer_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=7" 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_tracer_h(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_tracer_h - Tracer stream handler</p> +<h2 id="_description">Description</h2> +<p>The module <code>cowboy_tracer_h</code> can be used to conditionally trace streams based on information found in the request. Trace messages are given to the configured callback.</p> +<h2 id="_options">Options</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">tracer_callback</font> <font color="#990000">=></font> <font color="#009900">Callback</font>, + <font color="#0000FF">tracer_flags</font> <font color="#990000">=></font> [<b><font color="#000080">atom</font></b>()], + <font color="#0000FF">tracer_match_specs</font> <font color="#990000">=></font> [<font color="#009900">MatchSpec</font>] +} + +<font color="#009900">Callback</font> <font color="#990000">::</font> <b><font color="#0000FF">fun</font></b>((<font color="#FF6600">init</font> | <font color="#FF6600">terminate</font> | <b><font color="#000000">tuple</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font>) + +<font color="#009900">MatchSpec</font> <font color="#990000">::</font> <font color="#009900">MatchPredicate</font> + | {<font color="#FF6600">method</font>, <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">host</font>, <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">path</font>, <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">path_start</font>, <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">header</font>, <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">header</font>, <b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">peer_ip</font>, <b><font color="#000000">inet:ip_address</font></b>()} + +<font color="#009900">MatchPredicate</font> <font color="#990000">::</font> <b><font color="#0000FF">fun</font></b>((<b><font color="#000000">cowboy_stream:streamid</font></b>(), + <b><font color="#000000">cowboy_req:req</font></b>(), + <b><font color="#000000">cowboy:opts</font></b>()) <font color="#990000">-></font> <b><font color="#000000">boolean</font></b>()) +}</tt></pre> +</div></div> +<p>Configuration for the tracer stream handler.</p> +<p>This module will not set trace patterns. Those must be set by the user directly, either from the callback's <code>init</code> or, preferably, in advance.</p> +<dl><dt>tracer_callback</dt> +<dd><p>The function that will be called for each trace events. It will also be called before any trace event with an argument <code>init</code>, and when the stream is terminated with an argument <code>terminate</code>.</p> +<p>This option is required for tracing to be enabled. The tracer stream handler does nothing otherwise.</p> +</dd> +<dt>tracer_flags</dt> +<dd><p>Trace flags to enable. See the documentation of <code>erlang:trace/3</code> for details. Note that all trace flags are allowed except for the <code>tracer</code> flag.</p> +</dd> +<dt>tracer_match_specs</dt> +<dd><p>A list of match conditions that must all be fulfilled for the stream to be traced. Cowboy will compare these with the information found in the request and only enable tracing if all matches succeed.</p> +<p>This option is required for tracing to be enabled. The tracer stream handler does nothing otherwise.</p> +</dd> +</dl> +<h2 id="_events">Events</h2> +<p>The tracer stream handler does not produce any event.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.7</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>, <a href="../cowboy_decompress_h">cowboy_decompress_h(3)</a>, <a href="../cowboy_metrics_h">cowboy_metrics_h(3)</a>, <a href="../cowboy_stream_h">cowboy_stream_h(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/cowboy_websocket/index.html b/docs/en/cowboy/2.12/manual/cowboy_websocket/index.html new file mode 100644 index 00000000..a12f3183 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/cowboy_websocket/index.html @@ -0,0 +1,365 @@ +<!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=7" 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.9 +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">Info</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() + +<font color="#009900">CallResult</font> <font color="#990000">::</font> {<b><font color="#000000">commands</font></b>(), <font color="#009900">State</font>} + | {<b><font color="#000000">commands</font></b>(), <font color="#009900">State</font>, <font color="#FF6600">hibernate</font>} + | <font color="#009900">Deprecated</font> + +<font color="#009900">Deprecated</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">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">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, including close frames to terminate the connection; enable/disable active mode; enable/disable compression for subsequent frames; or change Websocket options.</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.</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 occurred.</p> +</dd> +</dl> +<h2 id="_types">Types</h2> +<h3 id="_commands">commands()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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>] + +<font color="#009900">Command</font> <font color="#990000">::</font> {<font color="#FF6600">active</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">deflate</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">set_options</font>, #{<font color="#0000FF">idle_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>()}} + | {<font color="#000080">shutdown</font><font color="#009900">_reason</font>, <b><font color="#000000">any</font></b>()} + | <font color="#009900">Frame</font> <font color="#990000">::</font> <b><font color="#000000">cow_ws:frame</font></b>()</tt></pre> +</div></div> +<p>Commands that may be returned from Websocket callbacks.</p> +<p>The following commands are defined:</p> +<dl><dt>active</dt> +<dd><p>Whether to disable or enable reading from the socket. This can be used to apply flow control to a Websocket connection.</p> +</dd> +<dt>deflate</dt> +<dd><p>Whether the subsequent frames should be compressed. Has no effect on connections that did not negotiate compression.</p> +</dd> +<dt>set_options</dt> +<dd><p>Set Websocket options. Currently only the option <code>idle_timeout</code> may be updated from a Websocket handler.</p> +</dd> +<dt>shutdown_reason</dt> +<dd><p>Change the shutdown reason. The Websocket process will exit with reason <code>normal</code> by default. This command can be used to exit with reason <code>{shutdown, ShutdownReason}</code> under normal conditions. This command has no effect when the Websocket process exits abnormally, for example following a crash in a handler callback.</p> +</dd> +<dt>Frame</dt> +<dd><p>Send the corresponding Websocket frame.</p> +</dd> +</dl> +<h3 id="_cow_ws_frame">cow_ws:frame()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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.9 +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">active_n</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <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>()), + <font color="#0000FF">validate_utf8</font> <font color="#990000">=></font> <b><font color="#000000">boolean</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.9 +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>active_n (100)</dt> +<dd><p>The number of packets Cowboy will request from the socket at once. This can be used to tweak the performance of the server. Higher values reduce the number of times Cowboy need to request more packets from the port driver at the expense of potentially higher memory being used.</p> +<p>This option does not apply to Websocket over HTTP/2.</p> +</dd> +<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> +<p>This option can be updated at any time using the <code>set_options</code> command.</p> +</dd> +<dt>max_frame_size (infinity)</dt> +<dd><p>Maximum frame size in bytes 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> +<dt>validate_utf8 (true)</dt> +<dd><p>Whether Cowboy should verify that the payload of <code>text</code> and <code>close</code> frames is valid UTF-8. This is required by the protocol specification but in some cases it may be more interesting to disable it in order to save resources.</p> +<p>Note that <code>binary</code> frames do not have this UTF-8 requirement and are what should be used under normal circumstances if necessary.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.11</strong>: Websocket over HTTP/2 is now considered stable. +</li> +<li><strong>2.11</strong>: HTTP/1.1 Websocket no longer traps exits by default. +</li> +<li><strong>2.8</strong>: The <code>active_n</code> option was added. +</li> +<li><strong>2.7</strong>: The commands based interface has been documented. The old interface is now deprecated. +</li> +<li><strong>2.7</strong>: The command <code>shutdown_reason</code> was introduced. +</li> +<li><strong>2.7</strong>: The option <code>validate_utf8</code> has been added. +</li> +<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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/http_status_codes/index.html b/docs/en/cowboy/2.12/manual/http_status_codes/index.html new file mode 100644 index 00000000..9e904cd3 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/http_status_codes/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: 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=7" 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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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.12/manual/index.html b/docs/en/cowboy/2.12/manual/index.html new file mode 100644 index 00000000..17546b27 --- /dev/null +++ b/docs/en/cowboy/2.12/manual/index.html @@ -0,0 +1,242 @@ +<!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=7" 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> +<li><a href="cowboy_decompress_h">cowboy_decompress_h(3)</a> - Decompress stream handler +</li> +<li><a href="cowboy_metrics_h">cowboy_metrics_h(3)</a> - Metrics stream handler +</li> +<li><a href="cowboy_tracer_h">cowboy_tracer_h(3)</a> - Tracer 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.9 +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.12 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.12/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/constraints/index.html b/docs/en/cowboy/2.6/guide/constraints/index.html index a0970490..a6b50531 100644 --- a/docs/en/cowboy/2.6/guide/constraints/index.html +++ b/docs/en/cowboy/2.6/guide/constraints/index.html @@ -197,6 +197,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/cookies/index.html b/docs/en/cowboy/2.6/guide/cookies/index.html index 8f03e45e..59188a05 100644 --- a/docs/en/cowboy/2.6/guide/cookies/index.html +++ b/docs/en/cowboy/2.6/guide/cookies/index.html @@ -214,6 +214,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/erlang_web/index.html b/docs/en/cowboy/2.6/guide/erlang_web/index.html index 50fdc989..4f9f3b85 100644 --- a/docs/en/cowboy/2.6/guide/erlang_web/index.html +++ b/docs/en/cowboy/2.6/guide/erlang_web/index.html @@ -163,6 +163,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/flow_diagram/index.html b/docs/en/cowboy/2.6/guide/flow_diagram/index.html index 4528be82..c774f2f0 100644 --- a/docs/en/cowboy/2.6/guide/flow_diagram/index.html +++ b/docs/en/cowboy/2.6/guide/flow_diagram/index.html @@ -141,6 +141,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/getting_started/index.html b/docs/en/cowboy/2.6/guide/getting_started/index.html index 04c7d73f..ed3bca94 100644 --- a/docs/en/cowboy/2.6/guide/getting_started/index.html +++ b/docs/en/cowboy/2.6/guide/getting_started/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/handlers/index.html b/docs/en/cowboy/2.6/guide/handlers/index.html index 541a9b63..8f6edc59 100644 --- a/docs/en/cowboy/2.6/guide/handlers/index.html +++ b/docs/en/cowboy/2.6/guide/handlers/index.html @@ -168,6 +168,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/index.html b/docs/en/cowboy/2.6/guide/index.html index e14ecc29..543f3ce9 100644 --- a/docs/en/cowboy/2.6/guide/index.html +++ b/docs/en/cowboy/2.6/guide/index.html @@ -182,6 +182,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/introduction/index.html b/docs/en/cowboy/2.6/guide/introduction/index.html index 69af4b52..ee12befc 100644 --- a/docs/en/cowboy/2.6/guide/introduction/index.html +++ b/docs/en/cowboy/2.6/guide/introduction/index.html @@ -151,6 +151,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/listeners/index.html b/docs/en/cowboy/2.6/guide/listeners/index.html index ed99007b..395bc4ee 100644 --- a/docs/en/cowboy/2.6/guide/listeners/index.html +++ b/docs/en/cowboy/2.6/guide/listeners/index.html @@ -172,6 +172,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/loop_handlers/index.html b/docs/en/cowboy/2.6/guide/loop_handlers/index.html index a7869169..5b8cd543 100644 --- a/docs/en/cowboy/2.6/guide/loop_handlers/index.html +++ b/docs/en/cowboy/2.6/guide/loop_handlers/index.html @@ -182,6 +182,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/middlewares/index.html b/docs/en/cowboy/2.6/guide/middlewares/index.html index 7bb23b7b..be943bee 100644 --- a/docs/en/cowboy/2.6/guide/middlewares/index.html +++ b/docs/en/cowboy/2.6/guide/middlewares/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> 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 index e756e83d..cd6de818 100644 --- 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 @@ -231,6 +231,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> 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 index e3489991..9a60ec91 100644 --- 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 @@ -166,6 +166,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> 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 index 4de663d3..bb6df49c 100644 --- 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 @@ -177,6 +177,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> 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 index 18f6fade..f2fd4d55 100644 --- 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 @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> 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 index 1e0bf890..d9dc734f 100644 --- 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 @@ -151,6 +151,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> 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 index c28a735f..31ef3b08 100644 --- 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 @@ -179,6 +179,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> 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 index 618e2b9b..00c57071 100644 --- 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 @@ -194,6 +194,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/migrating_from_2.6/index.html b/docs/en/cowboy/2.6/guide/migrating_from_2.6/index.html index 9c08c331..4dc4d3b2 100644 --- a/docs/en/cowboy/2.6/guide/migrating_from_2.6/index.html +++ b/docs/en/cowboy/2.6/guide/migrating_from_2.6/index.html @@ -131,6 +131,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/modern_web/index.html b/docs/en/cowboy/2.6/guide/modern_web/index.html index 859b2a80..b4382abc 100644 --- a/docs/en/cowboy/2.6/guide/modern_web/index.html +++ b/docs/en/cowboy/2.6/guide/modern_web/index.html @@ -145,6 +145,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/multipart/index.html b/docs/en/cowboy/2.6/guide/multipart/index.html index d8395a82..1c8d54dd 100644 --- a/docs/en/cowboy/2.6/guide/multipart/index.html +++ b/docs/en/cowboy/2.6/guide/multipart/index.html @@ -218,6 +218,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/req/index.html b/docs/en/cowboy/2.6/guide/req/index.html index d3908423..c230b2b2 100644 --- a/docs/en/cowboy/2.6/guide/req/index.html +++ b/docs/en/cowboy/2.6/guide/req/index.html @@ -393,6 +393,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/req_body/index.html b/docs/en/cowboy/2.6/guide/req_body/index.html index 7c23e159..04e575ff 100644 --- a/docs/en/cowboy/2.6/guide/req_body/index.html +++ b/docs/en/cowboy/2.6/guide/req_body/index.html @@ -204,6 +204,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/resource_design/index.html b/docs/en/cowboy/2.6/guide/resource_design/index.html index 07fbab07..66cf92e9 100644 --- a/docs/en/cowboy/2.6/guide/resource_design/index.html +++ b/docs/en/cowboy/2.6/guide/resource_design/index.html @@ -178,6 +178,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/resp/index.html b/docs/en/cowboy/2.6/guide/resp/index.html index 24910cc4..f8c4ba55 100644 --- a/docs/en/cowboy/2.6/guide/resp/index.html +++ b/docs/en/cowboy/2.6/guide/resp/index.html @@ -360,6 +360,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/rest_flowcharts/index.html b/docs/en/cowboy/2.6/guide/rest_flowcharts/index.html index 7cea3d3c..8748df1f 100644 --- a/docs/en/cowboy/2.6/guide/rest_flowcharts/index.html +++ b/docs/en/cowboy/2.6/guide/rest_flowcharts/index.html @@ -175,6 +175,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/rest_handlers/index.html b/docs/en/cowboy/2.6/guide/rest_handlers/index.html index ecaba7cf..c70d9d9a 100644 --- a/docs/en/cowboy/2.6/guide/rest_handlers/index.html +++ b/docs/en/cowboy/2.6/guide/rest_handlers/index.html @@ -276,6 +276,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/rest_principles/index.html b/docs/en/cowboy/2.6/guide/rest_principles/index.html index b9baf9af..de79d906 100644 --- a/docs/en/cowboy/2.6/guide/rest_principles/index.html +++ b/docs/en/cowboy/2.6/guide/rest_principles/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/routing/index.html b/docs/en/cowboy/2.6/guide/routing/index.html index 530c95b0..dc3a6543 100644 --- a/docs/en/cowboy/2.6/guide/routing/index.html +++ b/docs/en/cowboy/2.6/guide/routing/index.html @@ -299,6 +299,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/specs/index.html b/docs/en/cowboy/2.6/guide/specs/index.html index 9494a03b..1d8376aa 100644 --- a/docs/en/cowboy/2.6/guide/specs/index.html +++ b/docs/en/cowboy/2.6/guide/specs/index.html @@ -466,6 +466,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/static_files/index.html b/docs/en/cowboy/2.6/guide/static_files/index.html index 3566fd68..9d4a5f07 100644 --- a/docs/en/cowboy/2.6/guide/static_files/index.html +++ b/docs/en/cowboy/2.6/guide/static_files/index.html @@ -212,6 +212,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/streams/index.html b/docs/en/cowboy/2.6/guide/streams/index.html index f2873959..0af371c8 100644 --- a/docs/en/cowboy/2.6/guide/streams/index.html +++ b/docs/en/cowboy/2.6/guide/streams/index.html @@ -134,6 +134,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/ws_handlers/index.html b/docs/en/cowboy/2.6/guide/ws_handlers/index.html index e279ed60..fc917f08 100644 --- a/docs/en/cowboy/2.6/guide/ws_handlers/index.html +++ b/docs/en/cowboy/2.6/guide/ws_handlers/index.html @@ -301,6 +301,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.6/guide/ws_protocol/index.html b/docs/en/cowboy/2.6/guide/ws_protocol/index.html index d975f40c..375a169f 100644 --- a/docs/en/cowboy/2.6/guide/ws_protocol/index.html +++ b/docs/en/cowboy/2.6/guide/ws_protocol/index.html @@ -133,6 +133,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> 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 index 9f641edc..ee4f92b4 100644 --- a/docs/en/cowboy/2.6/manual/cowboy.set_env/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy.set_env/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index e886eb48..fa158708 100644 --- a/docs/en/cowboy/2.6/manual/cowboy.start_clear/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy.start_clear/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index f112b12f..10883eb2 100644 --- a/docs/en/cowboy/2.6/manual/cowboy.start_tls/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy.start_tls/index.html @@ -171,6 +171,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 6d9b24c7..155f82f9 100644 --- a/docs/en/cowboy/2.6/manual/cowboy.stop_listener/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy.stop_listener/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.6/manual/cowboy/index.html b/docs/en/cowboy/2.6/manual/cowboy/index.html index eaa078f7..44d42951 100644 --- a/docs/en/cowboy/2.6/manual/cowboy/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy/index.html @@ -165,6 +165,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.6/manual/cowboy_app/index.html b/docs/en/cowboy/2.6/manual/cowboy_app/index.html index fcd0d542..d0f4bf7f 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_app/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_app/index.html @@ -172,6 +172,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 43b59be6..cbe334eb 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_compress_h/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_compress_h/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 2956e9f9..4af7d4d0 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_constraints.int/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_constraints.int/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 20be937c..9e28ac3b 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_constraints.nonempty/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_constraints.nonempty/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.6/manual/cowboy_constraints/index.html b/docs/en/cowboy/2.6/manual/cowboy_constraints/index.html index 73f71817..ff833861 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_constraints/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_constraints/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index acf81f47..b9cf8fd2 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_handler.terminate/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_handler.terminate/index.html @@ -143,6 +143,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.6/manual/cowboy_handler/index.html b/docs/en/cowboy/2.6/manual/cowboy_handler/index.html index 5f2ee98d..a3d89623 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_handler/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_handler/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.6/manual/cowboy_http/index.html b/docs/en/cowboy/2.6/manual/cowboy_http/index.html index 58041b5f..a7140440 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_http/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_http/index.html @@ -217,6 +217,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.6/manual/cowboy_http2/index.html b/docs/en/cowboy/2.6/manual/cowboy_http2/index.html index 2cd2ec94..1b71f781 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_http2/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_http2/index.html @@ -193,6 +193,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.6/manual/cowboy_loop/index.html b/docs/en/cowboy/2.6/manual/cowboy_loop/index.html index 377163c3..fe095110 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_loop/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_loop/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.6/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.6/manual/cowboy_middleware/index.html index e43e83c6..52b371b3 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_middleware/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_middleware/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 38d10875..5600fd92 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.binding/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.binding/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 1a98c6f3..7ed2a263 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.bindings/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.bindings/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 283ae20a..92460c6f 100644 --- 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 @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 100629f9..4ae136b5 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.cert/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.cert/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 1bd26779..deaff4f0 100644 --- 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 @@ -134,6 +134,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index f8c405ae..960d6442 100644 --- 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 @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index c2430583..3963620d 100644 --- 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 @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index e644ee31..dcc481ad 100644 --- 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 @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 3653ac76..972aaf81 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.header/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.header/index.html @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 57ed202f..dd37d730 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.headers/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.headers/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index a7572be4..cbf6b05f 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.host/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.host/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index ae64bb97..9804417a 100644 --- 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 @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 43d5d171..7a084457 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.inform/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.inform/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 7fb4c36f..ad954f82 100644 --- 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 @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index dea585b3..43df19dc 100644 --- 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 @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index ad51c22f..d5827415 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.method/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.method/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 523b7361..5d0f23ab 100644 --- 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 @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 8a06b2fd..2b9d3e72 100644 --- 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 @@ -307,6 +307,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 86b8a6b7..01945d56 100644 --- 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 @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 2328be6f..d147991f 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.path/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.path/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 290b6dce..d3517e3b 100644 --- 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 @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index e30d614e..bb98d319 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.peer/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.peer/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index b5a26ea5..b6eaba06 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.port/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.port/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 5a18763a..76e404c8 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.push/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.push/index.html @@ -163,6 +163,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 9c3456e9..f16aed69 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.qs/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.qs/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 9b93d666..b82b8df9 100644 --- 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 @@ -187,6 +187,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 83ce254d..54b021c0 100644 --- 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 @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 278dd9fb..b4e755ed 100644 --- 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 @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 7a479362..5678f6d6 100644 --- 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 @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index df73a5c2..52ee2878 100644 --- 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 @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 7ff46bb4..66bc62db 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.reply/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.reply/index.html @@ -175,6 +175,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 1418dc08..f62e0be6 100644 --- 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 @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 18078b49..b53b5edb 100644 --- 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 @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 6f64831f..275b9e17 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.scheme/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.scheme/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 6e2993a7..46df356a 100644 --- 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 @@ -168,6 +168,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index b4ad2ce3..669251d4 100644 --- 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 @@ -193,6 +193,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 35ef089b..0d7e93e7 100644 --- 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 @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 7e48057b..2e3762b7 100644 --- 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 @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index e9827023..101be4e0 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.sock/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.sock/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 4d82b1ff..1189deda 100644 --- 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 @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index f035f9ae..1d40e20b 100644 --- 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 @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index c79019cf..151b0fe6 100644 --- 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 @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index bbd0fca4..2d1be3a6 100644 --- 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 @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 7a512428..f6a0090e 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.uri/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.uri/index.html @@ -195,6 +195,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index b5dbaa5c..d7d7cccb 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req.version/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req.version/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.6/manual/cowboy_req/index.html b/docs/en/cowboy/2.6/manual/cowboy_req/index.html index d04af39f..12704846 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_req/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_req/index.html @@ -311,6 +311,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.6/manual/cowboy_rest/index.html b/docs/en/cowboy/2.6/manual/cowboy_rest/index.html index 2d757d50..79022c86 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_rest/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_rest/index.html @@ -592,6 +592,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index e680268f..a777ee48 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_router.compile/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_router.compile/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.6/manual/cowboy_router/index.html b/docs/en/cowboy/2.6/manual/cowboy_router/index.html index 1810c712..157d4047 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_router/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_router/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.6/manual/cowboy_static/index.html b/docs/en/cowboy/2.6/manual/cowboy_static/index.html index 2098b53b..e84cdd33 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_static/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_static/index.html @@ -212,6 +212,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.6/manual/cowboy_stream/index.html b/docs/en/cowboy/2.6/manual/cowboy_stream/index.html index cb66fb44..7c04ca14 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_stream/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_stream/index.html @@ -349,6 +349,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index 55a32465..ea1f364a 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_stream_h/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_stream_h/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.6/manual/cowboy_websocket/index.html b/docs/en/cowboy/2.6/manual/cowboy_websocket/index.html index 72479c6a..1367a31c 100644 --- a/docs/en/cowboy/2.6/manual/cowboy_websocket/index.html +++ b/docs/en/cowboy/2.6/manual/cowboy_websocket/index.html @@ -243,6 +243,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> 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 index b3981c0e..282e7ed8 100644 --- a/docs/en/cowboy/2.6/manual/http_status_codes/index.html +++ b/docs/en/cowboy/2.6/manual/http_status_codes/index.html @@ -181,6 +181,8 @@ + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.6/manual/index.html b/docs/en/cowboy/2.6/manual/index.html index 3d7c7290..a4479de5 100644 --- a/docs/en/cowboy/2.6/manual/index.html +++ b/docs/en/cowboy/2.6/manual/index.html @@ -172,6 +172,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/constraints/index.html b/docs/en/cowboy/2.7/guide/constraints/index.html index 18fdef1f..a3500967 100644 --- a/docs/en/cowboy/2.7/guide/constraints/index.html +++ b/docs/en/cowboy/2.7/guide/constraints/index.html @@ -197,6 +197,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/cookies/index.html b/docs/en/cowboy/2.7/guide/cookies/index.html index 8abe7462..96ed5d60 100644 --- a/docs/en/cowboy/2.7/guide/cookies/index.html +++ b/docs/en/cowboy/2.7/guide/cookies/index.html @@ -214,6 +214,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/erlang_web/index.html b/docs/en/cowboy/2.7/guide/erlang_web/index.html index 4eae8862..d7b4c7f2 100644 --- a/docs/en/cowboy/2.7/guide/erlang_web/index.html +++ b/docs/en/cowboy/2.7/guide/erlang_web/index.html @@ -163,6 +163,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/flow_diagram/index.html b/docs/en/cowboy/2.7/guide/flow_diagram/index.html index 8a0a49c3..126f82f5 100644 --- a/docs/en/cowboy/2.7/guide/flow_diagram/index.html +++ b/docs/en/cowboy/2.7/guide/flow_diagram/index.html @@ -141,6 +141,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/getting_started/index.html b/docs/en/cowboy/2.7/guide/getting_started/index.html index a7af224f..f9169571 100644 --- a/docs/en/cowboy/2.7/guide/getting_started/index.html +++ b/docs/en/cowboy/2.7/guide/getting_started/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/handlers/index.html b/docs/en/cowboy/2.7/guide/handlers/index.html index f1f5fec9..7a8f8b4d 100644 --- a/docs/en/cowboy/2.7/guide/handlers/index.html +++ b/docs/en/cowboy/2.7/guide/handlers/index.html @@ -168,6 +168,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/index.html b/docs/en/cowboy/2.7/guide/index.html index d83e1c3b..f9f79ed1 100644 --- a/docs/en/cowboy/2.7/guide/index.html +++ b/docs/en/cowboy/2.7/guide/index.html @@ -182,6 +182,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/introduction/index.html b/docs/en/cowboy/2.7/guide/introduction/index.html index 281e6347..7149f838 100644 --- a/docs/en/cowboy/2.7/guide/introduction/index.html +++ b/docs/en/cowboy/2.7/guide/introduction/index.html @@ -151,6 +151,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/listeners/index.html b/docs/en/cowboy/2.7/guide/listeners/index.html index 7ee2a00e..635ad0ae 100644 --- a/docs/en/cowboy/2.7/guide/listeners/index.html +++ b/docs/en/cowboy/2.7/guide/listeners/index.html @@ -181,6 +181,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/loop_handlers/index.html b/docs/en/cowboy/2.7/guide/loop_handlers/index.html index 3b8804c8..59826e24 100644 --- a/docs/en/cowboy/2.7/guide/loop_handlers/index.html +++ b/docs/en/cowboy/2.7/guide/loop_handlers/index.html @@ -182,6 +182,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/middlewares/index.html b/docs/en/cowboy/2.7/guide/middlewares/index.html index 7de8efd4..ad9e34a3 100644 --- a/docs/en/cowboy/2.7/guide/middlewares/index.html +++ b/docs/en/cowboy/2.7/guide/middlewares/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/migrating_from_1.0/index.html b/docs/en/cowboy/2.7/guide/migrating_from_1.0/index.html index 5ff19508..e962ccc2 100644 --- a/docs/en/cowboy/2.7/guide/migrating_from_1.0/index.html +++ b/docs/en/cowboy/2.7/guide/migrating_from_1.0/index.html @@ -231,6 +231,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/migrating_from_2.0/index.html b/docs/en/cowboy/2.7/guide/migrating_from_2.0/index.html index 0db431c4..7f09498b 100644 --- a/docs/en/cowboy/2.7/guide/migrating_from_2.0/index.html +++ b/docs/en/cowboy/2.7/guide/migrating_from_2.0/index.html @@ -166,6 +166,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/migrating_from_2.1/index.html b/docs/en/cowboy/2.7/guide/migrating_from_2.1/index.html index 1fd3efec..a9f6ff41 100644 --- a/docs/en/cowboy/2.7/guide/migrating_from_2.1/index.html +++ b/docs/en/cowboy/2.7/guide/migrating_from_2.1/index.html @@ -177,6 +177,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/migrating_from_2.2/index.html b/docs/en/cowboy/2.7/guide/migrating_from_2.2/index.html index 20c27089..43c00b18 100644 --- a/docs/en/cowboy/2.7/guide/migrating_from_2.2/index.html +++ b/docs/en/cowboy/2.7/guide/migrating_from_2.2/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/migrating_from_2.3/index.html b/docs/en/cowboy/2.7/guide/migrating_from_2.3/index.html index f01815a5..81964c23 100644 --- a/docs/en/cowboy/2.7/guide/migrating_from_2.3/index.html +++ b/docs/en/cowboy/2.7/guide/migrating_from_2.3/index.html @@ -151,6 +151,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/migrating_from_2.4/index.html b/docs/en/cowboy/2.7/guide/migrating_from_2.4/index.html index 424a62f3..dd9fbb17 100644 --- a/docs/en/cowboy/2.7/guide/migrating_from_2.4/index.html +++ b/docs/en/cowboy/2.7/guide/migrating_from_2.4/index.html @@ -179,6 +179,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/migrating_from_2.5/index.html b/docs/en/cowboy/2.7/guide/migrating_from_2.5/index.html index 021ac061..7f967cd5 100644 --- a/docs/en/cowboy/2.7/guide/migrating_from_2.5/index.html +++ b/docs/en/cowboy/2.7/guide/migrating_from_2.5/index.html @@ -194,6 +194,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/migrating_from_2.6/index.html b/docs/en/cowboy/2.7/guide/migrating_from_2.6/index.html index 11a5fb4f..e7a750ba 100644 --- a/docs/en/cowboy/2.7/guide/migrating_from_2.6/index.html +++ b/docs/en/cowboy/2.7/guide/migrating_from_2.6/index.html @@ -215,6 +215,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/modern_web/index.html b/docs/en/cowboy/2.7/guide/modern_web/index.html index 3c263d4e..07148709 100644 --- a/docs/en/cowboy/2.7/guide/modern_web/index.html +++ b/docs/en/cowboy/2.7/guide/modern_web/index.html @@ -145,6 +145,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/multipart/index.html b/docs/en/cowboy/2.7/guide/multipart/index.html index fddf382b..cbbf086b 100644 --- a/docs/en/cowboy/2.7/guide/multipart/index.html +++ b/docs/en/cowboy/2.7/guide/multipart/index.html @@ -218,6 +218,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/req/index.html b/docs/en/cowboy/2.7/guide/req/index.html index a4befc98..6d624e9c 100644 --- a/docs/en/cowboy/2.7/guide/req/index.html +++ b/docs/en/cowboy/2.7/guide/req/index.html @@ -393,6 +393,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/req_body/index.html b/docs/en/cowboy/2.7/guide/req_body/index.html index e4df434a..919d2603 100644 --- a/docs/en/cowboy/2.7/guide/req_body/index.html +++ b/docs/en/cowboy/2.7/guide/req_body/index.html @@ -204,6 +204,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/resource_design/index.html b/docs/en/cowboy/2.7/guide/resource_design/index.html index 4fcb4a4e..b2c3e641 100644 --- a/docs/en/cowboy/2.7/guide/resource_design/index.html +++ b/docs/en/cowboy/2.7/guide/resource_design/index.html @@ -178,6 +178,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/resp/index.html b/docs/en/cowboy/2.7/guide/resp/index.html index fd3e748d..0fd25569 100644 --- a/docs/en/cowboy/2.7/guide/resp/index.html +++ b/docs/en/cowboy/2.7/guide/resp/index.html @@ -360,6 +360,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/rest_flowcharts/index.html b/docs/en/cowboy/2.7/guide/rest_flowcharts/index.html index f68639bc..a4f77cbb 100644 --- a/docs/en/cowboy/2.7/guide/rest_flowcharts/index.html +++ b/docs/en/cowboy/2.7/guide/rest_flowcharts/index.html @@ -175,6 +175,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/rest_handlers/index.html b/docs/en/cowboy/2.7/guide/rest_handlers/index.html index d59866e6..f589d739 100644 --- a/docs/en/cowboy/2.7/guide/rest_handlers/index.html +++ b/docs/en/cowboy/2.7/guide/rest_handlers/index.html @@ -276,6 +276,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/rest_principles/index.html b/docs/en/cowboy/2.7/guide/rest_principles/index.html index bb707a4e..58b9e9d2 100644 --- a/docs/en/cowboy/2.7/guide/rest_principles/index.html +++ b/docs/en/cowboy/2.7/guide/rest_principles/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/routing/index.html b/docs/en/cowboy/2.7/guide/routing/index.html index 49dfa998..119da290 100644 --- a/docs/en/cowboy/2.7/guide/routing/index.html +++ b/docs/en/cowboy/2.7/guide/routing/index.html @@ -316,6 +316,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/specs/index.html b/docs/en/cowboy/2.7/guide/specs/index.html index f0bf5389..2733bf34 100644 --- a/docs/en/cowboy/2.7/guide/specs/index.html +++ b/docs/en/cowboy/2.7/guide/specs/index.html @@ -480,6 +480,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/static_files/index.html b/docs/en/cowboy/2.7/guide/static_files/index.html index 9fc02220..c0427400 100644 --- a/docs/en/cowboy/2.7/guide/static_files/index.html +++ b/docs/en/cowboy/2.7/guide/static_files/index.html @@ -212,6 +212,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/streams/index.html b/docs/en/cowboy/2.7/guide/streams/index.html index f1b6d8b0..3841dfe2 100644 --- a/docs/en/cowboy/2.7/guide/streams/index.html +++ b/docs/en/cowboy/2.7/guide/streams/index.html @@ -136,6 +136,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/ws_handlers/index.html b/docs/en/cowboy/2.7/guide/ws_handlers/index.html index b15982c5..50527671 100644 --- a/docs/en/cowboy/2.7/guide/ws_handlers/index.html +++ b/docs/en/cowboy/2.7/guide/ws_handlers/index.html @@ -301,6 +301,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/guide/ws_protocol/index.html b/docs/en/cowboy/2.7/guide/ws_protocol/index.html index 76a0085e..4c04c375 100644 --- a/docs/en/cowboy/2.7/guide/ws_protocol/index.html +++ b/docs/en/cowboy/2.7/guide/ws_protocol/index.html @@ -133,6 +133,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.7/manual/cowboy.set_env/index.html index 07d8e976..37a45a43 100644 --- a/docs/en/cowboy/2.7/manual/cowboy.set_env/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy.set_env/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy.start_clear/index.html b/docs/en/cowboy/2.7/manual/cowboy.start_clear/index.html index de973890..0cd0a52d 100644 --- a/docs/en/cowboy/2.7/manual/cowboy.start_clear/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy.start_clear/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy.start_tls/index.html b/docs/en/cowboy/2.7/manual/cowboy.start_tls/index.html index 8c44c98e..8319c84c 100644 --- a/docs/en/cowboy/2.7/manual/cowboy.start_tls/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy.start_tls/index.html @@ -171,6 +171,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy.stop_listener/index.html b/docs/en/cowboy/2.7/manual/cowboy.stop_listener/index.html index 0975e670..358a56af 100644 --- a/docs/en/cowboy/2.7/manual/cowboy.stop_listener/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy.stop_listener/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy/index.html b/docs/en/cowboy/2.7/manual/cowboy/index.html index cadaf25b..81d0e39b 100644 --- a/docs/en/cowboy/2.7/manual/cowboy/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy/index.html @@ -165,6 +165,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_app/index.html b/docs/en/cowboy/2.7/manual/cowboy_app/index.html index 2e705943..04f75bb0 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_app/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_app/index.html @@ -176,6 +176,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_compress_h/index.html b/docs/en/cowboy/2.7/manual/cowboy_compress_h/index.html index 4a6ab1f0..92f8e7cb 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_compress_h/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_compress_h/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_constraints.int/index.html b/docs/en/cowboy/2.7/manual/cowboy_constraints.int/index.html index d1c3c011..a7c6bfba 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_constraints.int/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_constraints.int/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_constraints.nonempty/index.html b/docs/en/cowboy/2.7/manual/cowboy_constraints.nonempty/index.html index b8679e9d..1680d7b9 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_constraints.nonempty/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_constraints.nonempty/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_constraints/index.html b/docs/en/cowboy/2.7/manual/cowboy_constraints/index.html index 6b0d9d32..458ecf3f 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_constraints/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_constraints/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_handler.terminate/index.html b/docs/en/cowboy/2.7/manual/cowboy_handler.terminate/index.html index 38ffde58..0e911fe0 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_handler.terminate/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_handler.terminate/index.html @@ -143,6 +143,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_handler/index.html b/docs/en/cowboy/2.7/manual/cowboy_handler/index.html index 64d70898..631a605a 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_handler/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_handler/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_http/index.html b/docs/en/cowboy/2.7/manual/cowboy_http/index.html index f61cb6ae..b104149d 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_http/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_http/index.html @@ -229,6 +229,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_http2/index.html b/docs/en/cowboy/2.7/manual/cowboy_http2/index.html index 09e90dc2..6b2bdb01 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_http2/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_http2/index.html @@ -245,6 +245,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_loop/index.html b/docs/en/cowboy/2.7/manual/cowboy_loop/index.html index 831a8c45..cb130446 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_loop/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_loop/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_metrics_h/index.html b/docs/en/cowboy/2.7/manual/cowboy_metrics_h/index.html index 0f4c8bfe..90ce0616 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_metrics_h/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_metrics_h/index.html @@ -226,6 +226,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.7/manual/cowboy_middleware/index.html index b53b6f3f..41e0438d 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_middleware/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_middleware/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.binding/index.html index b20493b8..84f01a64 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.binding/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.binding/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.bindings/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.bindings/index.html index 16ad95e4..c6a15f14 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.bindings/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.bindings/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.body_length/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.body_length/index.html index 5334a2ef..155f3c7d 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.body_length/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.body_length/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.cast/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.cast/index.html index 74a6e187..67b1714f 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.cast/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.cast/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.cert/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.cert/index.html index b098e588..724998d4 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.cert/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.cert/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.delete_resp_header/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.delete_resp_header/index.html index 00b37c80..71a37073 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.delete_resp_header/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.delete_resp_header/index.html @@ -134,6 +134,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.filter_cookies/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.filter_cookies/index.html index 3eceb630..87d53fdf 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.filter_cookies/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.filter_cookies/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.has_body/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.has_body/index.html index e799ad10..7b349366 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.has_body/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.has_body/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.has_resp_body/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.has_resp_body/index.html index c3e7d016..78dc48d1 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.has_resp_body/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.has_resp_body/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.has_resp_header/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.has_resp_header/index.html index afaaca96..81e8bee1 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.has_resp_header/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.has_resp_header/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.header/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.header/index.html index 92168439..ac6294fc 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.header/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.header/index.html @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.headers/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.headers/index.html index eb8a4a7a..a398fa80 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.headers/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.headers/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.host/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.host/index.html index 41482169..f34e1659 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.host/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.host/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.host_info/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.host_info/index.html index 84adef89..2c2dcb91 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.host_info/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.host_info/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.inform/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.inform/index.html index f84b505a..db4defc7 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.inform/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.inform/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.match_cookies/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.match_cookies/index.html index 3c79d88d..404a9e63 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.match_cookies/index.html +++ b/docs/en/cowboy/2.7/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.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.match_qs/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.match_qs/index.html index 532d1376..056abc55 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.match_qs/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.match_qs/index.html @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.method/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.method/index.html index f8ee0c97..403d93fe 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.method/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.method/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.parse_cookies/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.parse_cookies/index.html index 9ecb2d8c..a2675ed7 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.parse_cookies/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.parse_cookies/index.html @@ -155,6 +155,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.parse_header/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.parse_header/index.html index 051324ff..37f61ed2 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.parse_header/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.parse_header/index.html @@ -307,6 +307,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.parse_qs/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.parse_qs/index.html index fdc4713f..5a60a5f7 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.parse_qs/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.parse_qs/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.path/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.path/index.html index 10b1c470..5dda8d8f 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.path/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.path/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.path_info/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.path_info/index.html index e8e470e9..0baba386 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.path_info/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.path_info/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.peer/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.peer/index.html index 2ede5998..d3a6dc01 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.peer/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.peer/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.port/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.port/index.html index 01ed5aec..12de689e 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.port/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.port/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.push/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.push/index.html index 9af26bcb..dd390533 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.push/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.push/index.html @@ -163,6 +163,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.qs/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.qs/index.html index e3282dfa..276c87f1 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.qs/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.qs/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.read_and_match_urlencoded_body/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.read_and_match_urlencoded_body/index.html index f24b3eb9..a53936fb 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.read_and_match_urlencoded_body/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.read_and_match_urlencoded_body/index.html @@ -187,6 +187,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.read_body/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.read_body/index.html index 51700c7d..2260b297 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.read_body/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.read_body/index.html @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.read_part/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.read_part/index.html index ce95070b..b1a044b6 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.read_part/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.read_part/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.read_part_body/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.read_part_body/index.html index 7e9df244..efc2f9b3 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.read_part_body/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.read_part_body/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.read_urlencoded_body/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.read_urlencoded_body/index.html index e8e50e17..c72cab17 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.read_urlencoded_body/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.read_urlencoded_body/index.html @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.reply/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.reply/index.html index 7d418fab..d0a651a7 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.reply/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.reply/index.html @@ -175,6 +175,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.resp_header/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.resp_header/index.html index f8231353..5925cfc0 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.resp_header/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.resp_header/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.resp_headers/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.resp_headers/index.html index 8f588b83..e10ebb96 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.resp_headers/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.resp_headers/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.scheme/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.scheme/index.html index 0512a7f7..c8492fd3 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.scheme/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.scheme/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_body/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_body/index.html index f172ce99..9613ed4d 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_body/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_body/index.html @@ -168,6 +168,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_cookie/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_cookie/index.html index 69f99542..de63b1e7 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_cookie/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_cookie/index.html @@ -193,6 +193,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_header/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_header/index.html index fd9f65fa..4653ffae 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_header/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_header/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_headers/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_headers/index.html index 6802da45..3d6cc6ba 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_headers/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.set_resp_headers/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.sock/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.sock/index.html index 3ad5d60c..2a123170 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.sock/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.sock/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.stream_body/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.stream_body/index.html index 482a59ca..ffa3e9ae 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.stream_body/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.stream_body/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.stream_events/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.stream_events/index.html index da6c7849..c9811a45 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.stream_events/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.stream_events/index.html @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.stream_reply/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.stream_reply/index.html index daae3d6a..61554766 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.stream_reply/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.stream_reply/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.stream_trailers/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.stream_trailers/index.html index d5ca3ab3..b50d5e0b 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.stream_trailers/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.stream_trailers/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.uri/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.uri/index.html index d33ae28d..ef812c6e 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.uri/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.uri/index.html @@ -195,6 +195,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req.version/index.html b/docs/en/cowboy/2.7/manual/cowboy_req.version/index.html index 51b66ff9..6ce2e958 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req.version/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req.version/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_req/index.html b/docs/en/cowboy/2.7/manual/cowboy_req/index.html index eb666d29..9c4255a4 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_req/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_req/index.html @@ -317,6 +317,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_rest/index.html b/docs/en/cowboy/2.7/manual/cowboy_rest/index.html index f823b5f6..a03ace19 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_rest/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_rest/index.html @@ -595,6 +595,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_router.compile/index.html b/docs/en/cowboy/2.7/manual/cowboy_router.compile/index.html index b3541799..97b66b96 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_router.compile/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_router.compile/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_router/index.html b/docs/en/cowboy/2.7/manual/cowboy_router/index.html index a7850d67..ac4113c9 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_router/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_router/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_static/index.html b/docs/en/cowboy/2.7/manual/cowboy_static/index.html index 963e1efb..b1c08739 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_static/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_static/index.html @@ -212,6 +212,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_stream/index.html b/docs/en/cowboy/2.7/manual/cowboy_stream/index.html index be7e48df..f885c92c 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_stream/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_stream/index.html @@ -372,6 +372,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_stream_h/index.html b/docs/en/cowboy/2.7/manual/cowboy_stream_h/index.html index 02413fc8..64cb0ae3 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_stream_h/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_stream_h/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_tracer_h/index.html b/docs/en/cowboy/2.7/manual/cowboy_tracer_h/index.html index d75dbaf9..6cb6d661 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_tracer_h/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_tracer_h/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/cowboy_websocket/index.html b/docs/en/cowboy/2.7/manual/cowboy_websocket/index.html index e785e147..19a67dc7 100644 --- a/docs/en/cowboy/2.7/manual/cowboy_websocket/index.html +++ b/docs/en/cowboy/2.7/manual/cowboy_websocket/index.html @@ -290,6 +290,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/http_status_codes/index.html b/docs/en/cowboy/2.7/manual/http_status_codes/index.html index c3f6b397..0ef3960e 100644 --- a/docs/en/cowboy/2.7/manual/http_status_codes/index.html +++ b/docs/en/cowboy/2.7/manual/http_status_codes/index.html @@ -181,6 +181,8 @@ + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.7/manual/index.html b/docs/en/cowboy/2.7/manual/index.html index 7fa1308c..f400d779 100644 --- a/docs/en/cowboy/2.7/manual/index.html +++ b/docs/en/cowboy/2.7/manual/index.html @@ -176,6 +176,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/constraints/index.html b/docs/en/cowboy/2.8/guide/constraints/index.html index 217ebd3e..a8ffb949 100644 --- a/docs/en/cowboy/2.8/guide/constraints/index.html +++ b/docs/en/cowboy/2.8/guide/constraints/index.html @@ -197,6 +197,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/cookies/index.html b/docs/en/cowboy/2.8/guide/cookies/index.html index c921cce9..85543baf 100644 --- a/docs/en/cowboy/2.8/guide/cookies/index.html +++ b/docs/en/cowboy/2.8/guide/cookies/index.html @@ -214,6 +214,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/erlang_web/index.html b/docs/en/cowboy/2.8/guide/erlang_web/index.html index 9c3517bd..c0ab37cb 100644 --- a/docs/en/cowboy/2.8/guide/erlang_web/index.html +++ b/docs/en/cowboy/2.8/guide/erlang_web/index.html @@ -163,6 +163,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/flow_diagram/index.html b/docs/en/cowboy/2.8/guide/flow_diagram/index.html index 7bb467cd..4064b803 100644 --- a/docs/en/cowboy/2.8/guide/flow_diagram/index.html +++ b/docs/en/cowboy/2.8/guide/flow_diagram/index.html @@ -141,6 +141,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/getting_started/index.html b/docs/en/cowboy/2.8/guide/getting_started/index.html index 89e77133..941efd77 100644 --- a/docs/en/cowboy/2.8/guide/getting_started/index.html +++ b/docs/en/cowboy/2.8/guide/getting_started/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/handlers/index.html b/docs/en/cowboy/2.8/guide/handlers/index.html index 46633214..484604d1 100644 --- a/docs/en/cowboy/2.8/guide/handlers/index.html +++ b/docs/en/cowboy/2.8/guide/handlers/index.html @@ -168,6 +168,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/index.html b/docs/en/cowboy/2.8/guide/index.html index cb6e0646..f8422208 100644 --- a/docs/en/cowboy/2.8/guide/index.html +++ b/docs/en/cowboy/2.8/guide/index.html @@ -186,6 +186,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/introduction/index.html b/docs/en/cowboy/2.8/guide/introduction/index.html index 276e25b6..e62f3f4f 100644 --- a/docs/en/cowboy/2.8/guide/introduction/index.html +++ b/docs/en/cowboy/2.8/guide/introduction/index.html @@ -151,6 +151,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/listeners/index.html b/docs/en/cowboy/2.8/guide/listeners/index.html index cac9b4cb..64fd7248 100644 --- a/docs/en/cowboy/2.8/guide/listeners/index.html +++ b/docs/en/cowboy/2.8/guide/listeners/index.html @@ -181,6 +181,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/loop_handlers/index.html b/docs/en/cowboy/2.8/guide/loop_handlers/index.html index 845e7c03..fe6b3e5c 100644 --- a/docs/en/cowboy/2.8/guide/loop_handlers/index.html +++ b/docs/en/cowboy/2.8/guide/loop_handlers/index.html @@ -182,6 +182,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/middlewares/index.html b/docs/en/cowboy/2.8/guide/middlewares/index.html index cf6f3651..05c8cca1 100644 --- a/docs/en/cowboy/2.8/guide/middlewares/index.html +++ b/docs/en/cowboy/2.8/guide/middlewares/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/migrating_from_1.0/index.html b/docs/en/cowboy/2.8/guide/migrating_from_1.0/index.html index afe312f8..c89879e0 100644 --- a/docs/en/cowboy/2.8/guide/migrating_from_1.0/index.html +++ b/docs/en/cowboy/2.8/guide/migrating_from_1.0/index.html @@ -231,6 +231,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/migrating_from_2.0/index.html b/docs/en/cowboy/2.8/guide/migrating_from_2.0/index.html index d1fe792f..364e0059 100644 --- a/docs/en/cowboy/2.8/guide/migrating_from_2.0/index.html +++ b/docs/en/cowboy/2.8/guide/migrating_from_2.0/index.html @@ -166,6 +166,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/migrating_from_2.1/index.html b/docs/en/cowboy/2.8/guide/migrating_from_2.1/index.html index 2b63ad03..0a043bb4 100644 --- a/docs/en/cowboy/2.8/guide/migrating_from_2.1/index.html +++ b/docs/en/cowboy/2.8/guide/migrating_from_2.1/index.html @@ -177,6 +177,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/migrating_from_2.2/index.html b/docs/en/cowboy/2.8/guide/migrating_from_2.2/index.html index 18d57fcd..2eb98c8d 100644 --- a/docs/en/cowboy/2.8/guide/migrating_from_2.2/index.html +++ b/docs/en/cowboy/2.8/guide/migrating_from_2.2/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/migrating_from_2.3/index.html b/docs/en/cowboy/2.8/guide/migrating_from_2.3/index.html index b2eaf92a..6654f7b7 100644 --- a/docs/en/cowboy/2.8/guide/migrating_from_2.3/index.html +++ b/docs/en/cowboy/2.8/guide/migrating_from_2.3/index.html @@ -151,6 +151,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/migrating_from_2.4/index.html b/docs/en/cowboy/2.8/guide/migrating_from_2.4/index.html index a193a47b..d879fad1 100644 --- a/docs/en/cowboy/2.8/guide/migrating_from_2.4/index.html +++ b/docs/en/cowboy/2.8/guide/migrating_from_2.4/index.html @@ -179,6 +179,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/migrating_from_2.5/index.html b/docs/en/cowboy/2.8/guide/migrating_from_2.5/index.html index c837e5fb..06e0d5a2 100644 --- a/docs/en/cowboy/2.8/guide/migrating_from_2.5/index.html +++ b/docs/en/cowboy/2.8/guide/migrating_from_2.5/index.html @@ -194,6 +194,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/migrating_from_2.6/index.html b/docs/en/cowboy/2.8/guide/migrating_from_2.6/index.html index 55c05614..88024429 100644 --- a/docs/en/cowboy/2.8/guide/migrating_from_2.6/index.html +++ b/docs/en/cowboy/2.8/guide/migrating_from_2.6/index.html @@ -215,6 +215,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/migrating_from_2.7/index.html b/docs/en/cowboy/2.8/guide/migrating_from_2.7/index.html index 5a1b3f5f..0fd52c2e 100644 --- a/docs/en/cowboy/2.8/guide/migrating_from_2.7/index.html +++ b/docs/en/cowboy/2.8/guide/migrating_from_2.7/index.html @@ -171,6 +171,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/modern_web/index.html b/docs/en/cowboy/2.8/guide/modern_web/index.html index 5c9d52eb..5121781b 100644 --- a/docs/en/cowboy/2.8/guide/modern_web/index.html +++ b/docs/en/cowboy/2.8/guide/modern_web/index.html @@ -145,6 +145,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/multipart/index.html b/docs/en/cowboy/2.8/guide/multipart/index.html index 17038738..03dc06a4 100644 --- a/docs/en/cowboy/2.8/guide/multipart/index.html +++ b/docs/en/cowboy/2.8/guide/multipart/index.html @@ -218,6 +218,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/performance/index.html b/docs/en/cowboy/2.8/guide/performance/index.html index d4241525..f4a194ff 100644 --- a/docs/en/cowboy/2.8/guide/performance/index.html +++ b/docs/en/cowboy/2.8/guide/performance/index.html @@ -123,6 +123,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/req/index.html b/docs/en/cowboy/2.8/guide/req/index.html index de2751e8..1582d85d 100644 --- a/docs/en/cowboy/2.8/guide/req/index.html +++ b/docs/en/cowboy/2.8/guide/req/index.html @@ -393,6 +393,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/req_body/index.html b/docs/en/cowboy/2.8/guide/req_body/index.html index b7368064..71f2f032 100644 --- a/docs/en/cowboy/2.8/guide/req_body/index.html +++ b/docs/en/cowboy/2.8/guide/req_body/index.html @@ -204,6 +204,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/resource_design/index.html b/docs/en/cowboy/2.8/guide/resource_design/index.html index 6bfb0861..4a41fefa 100644 --- a/docs/en/cowboy/2.8/guide/resource_design/index.html +++ b/docs/en/cowboy/2.8/guide/resource_design/index.html @@ -178,6 +178,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/resp/index.html b/docs/en/cowboy/2.8/guide/resp/index.html index 2b806063..5704f610 100644 --- a/docs/en/cowboy/2.8/guide/resp/index.html +++ b/docs/en/cowboy/2.8/guide/resp/index.html @@ -360,6 +360,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/rest_flowcharts/index.html b/docs/en/cowboy/2.8/guide/rest_flowcharts/index.html index fe3518f5..5c117c02 100644 --- a/docs/en/cowboy/2.8/guide/rest_flowcharts/index.html +++ b/docs/en/cowboy/2.8/guide/rest_flowcharts/index.html @@ -175,6 +175,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/rest_handlers/index.html b/docs/en/cowboy/2.8/guide/rest_handlers/index.html index 301fc022..5fe15289 100644 --- a/docs/en/cowboy/2.8/guide/rest_handlers/index.html +++ b/docs/en/cowboy/2.8/guide/rest_handlers/index.html @@ -276,6 +276,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/rest_principles/index.html b/docs/en/cowboy/2.8/guide/rest_principles/index.html index e95023db..f0ed0087 100644 --- a/docs/en/cowboy/2.8/guide/rest_principles/index.html +++ b/docs/en/cowboy/2.8/guide/rest_principles/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/routing/index.html b/docs/en/cowboy/2.8/guide/routing/index.html index 87d15093..d6a88ad3 100644 --- a/docs/en/cowboy/2.8/guide/routing/index.html +++ b/docs/en/cowboy/2.8/guide/routing/index.html @@ -326,6 +326,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/specs/index.html b/docs/en/cowboy/2.8/guide/specs/index.html index 717cdcc5..c522b36b 100644 --- a/docs/en/cowboy/2.8/guide/specs/index.html +++ b/docs/en/cowboy/2.8/guide/specs/index.html @@ -492,6 +492,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/static_files/index.html b/docs/en/cowboy/2.8/guide/static_files/index.html index 6b1ad954..167c237f 100644 --- a/docs/en/cowboy/2.8/guide/static_files/index.html +++ b/docs/en/cowboy/2.8/guide/static_files/index.html @@ -212,6 +212,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/streams/index.html b/docs/en/cowboy/2.8/guide/streams/index.html index 7675574f..d81e3d51 100644 --- a/docs/en/cowboy/2.8/guide/streams/index.html +++ b/docs/en/cowboy/2.8/guide/streams/index.html @@ -136,6 +136,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/ws_handlers/index.html b/docs/en/cowboy/2.8/guide/ws_handlers/index.html index d5b6014d..fe8d32a7 100644 --- a/docs/en/cowboy/2.8/guide/ws_handlers/index.html +++ b/docs/en/cowboy/2.8/guide/ws_handlers/index.html @@ -301,6 +301,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/guide/ws_protocol/index.html b/docs/en/cowboy/2.8/guide/ws_protocol/index.html index 68b58e57..e0783f0e 100644 --- a/docs/en/cowboy/2.8/guide/ws_protocol/index.html +++ b/docs/en/cowboy/2.8/guide/ws_protocol/index.html @@ -133,6 +133,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.8/manual/cowboy.set_env/index.html index 5ab5203b..f63f58f2 100644 --- a/docs/en/cowboy/2.8/manual/cowboy.set_env/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy.set_env/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy.start_clear/index.html b/docs/en/cowboy/2.8/manual/cowboy.start_clear/index.html index 0cfbc898..648e14ff 100644 --- a/docs/en/cowboy/2.8/manual/cowboy.start_clear/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy.start_clear/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy.start_tls/index.html b/docs/en/cowboy/2.8/manual/cowboy.start_tls/index.html index 90bf6cdb..80318ece 100644 --- a/docs/en/cowboy/2.8/manual/cowboy.start_tls/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy.start_tls/index.html @@ -171,6 +171,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy.stop_listener/index.html b/docs/en/cowboy/2.8/manual/cowboy.stop_listener/index.html index 53cf4f73..57d256d7 100644 --- a/docs/en/cowboy/2.8/manual/cowboy.stop_listener/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy.stop_listener/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy/index.html b/docs/en/cowboy/2.8/manual/cowboy/index.html index 19aca1f4..ac35f3d2 100644 --- a/docs/en/cowboy/2.8/manual/cowboy/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy/index.html @@ -165,6 +165,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_app/index.html b/docs/en/cowboy/2.8/manual/cowboy_app/index.html index d29ace58..f939f7d7 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_app/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_app/index.html @@ -176,6 +176,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_compress_h/index.html b/docs/en/cowboy/2.8/manual/cowboy_compress_h/index.html index 8baa2dd4..27f52879 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_compress_h/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_compress_h/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_constraints.int/index.html b/docs/en/cowboy/2.8/manual/cowboy_constraints.int/index.html index 8473ce9f..b1621bbc 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_constraints.int/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_constraints.int/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_constraints.nonempty/index.html b/docs/en/cowboy/2.8/manual/cowboy_constraints.nonempty/index.html index 8caa9040..6e6d4f5b 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_constraints.nonempty/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_constraints.nonempty/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_constraints/index.html b/docs/en/cowboy/2.8/manual/cowboy_constraints/index.html index 0f6a0731..5e965f2d 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_constraints/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_constraints/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_handler.terminate/index.html b/docs/en/cowboy/2.8/manual/cowboy_handler.terminate/index.html index fa5ceb54..18f85c38 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_handler.terminate/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_handler.terminate/index.html @@ -143,6 +143,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_handler/index.html b/docs/en/cowboy/2.8/manual/cowboy_handler/index.html index 33163340..014e7611 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_handler/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_handler/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_http/index.html b/docs/en/cowboy/2.8/manual/cowboy_http/index.html index 5ce4b058..5e11a8bf 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_http/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_http/index.html @@ -235,6 +235,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_http2/index.html b/docs/en/cowboy/2.8/manual/cowboy_http2/index.html index e9f7aff0..8a2664c3 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_http2/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_http2/index.html @@ -259,6 +259,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_loop/index.html b/docs/en/cowboy/2.8/manual/cowboy_loop/index.html index 96107881..b853403a 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_loop/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_loop/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_metrics_h/index.html b/docs/en/cowboy/2.8/manual/cowboy_metrics_h/index.html index 4dcae13f..17a31b57 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_metrics_h/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_metrics_h/index.html @@ -226,6 +226,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.8/manual/cowboy_middleware/index.html index 1be20773..981babdf 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_middleware/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_middleware/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.binding/index.html index b91e52c7..6c345b79 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.binding/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.binding/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.bindings/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.bindings/index.html index 13b943ac..5db24c1d 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.bindings/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.bindings/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.body_length/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.body_length/index.html index 7392d1e9..898c643c 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.body_length/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.body_length/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.cast/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.cast/index.html index 928a988d..45157e83 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.cast/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.cast/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.cert/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.cert/index.html index 83bc2bcc..8299e95d 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.cert/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.cert/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.delete_resp_header/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.delete_resp_header/index.html index 902f5b38..deef9171 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.delete_resp_header/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.delete_resp_header/index.html @@ -134,6 +134,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.filter_cookies/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.filter_cookies/index.html index e9fd5b2a..3f2b1075 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.filter_cookies/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.filter_cookies/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.has_body/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.has_body/index.html index 1ceaa274..c787eb70 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.has_body/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.has_body/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.has_resp_body/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.has_resp_body/index.html index a69e682f..de980837 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.has_resp_body/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.has_resp_body/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.has_resp_header/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.has_resp_header/index.html index ed18b33b..4f41fc51 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.has_resp_header/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.has_resp_header/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.header/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.header/index.html index 8449bd9d..dbb065e4 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.header/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.header/index.html @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.headers/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.headers/index.html index a9d1de25..d22d11cd 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.headers/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.headers/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.host/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.host/index.html index e2ceab17..3db52617 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.host/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.host/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.host_info/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.host_info/index.html index 160495be..31124429 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.host_info/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.host_info/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.inform/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.inform/index.html index bf4977fd..b4320be6 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.inform/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.inform/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.match_cookies/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.match_cookies/index.html index c6d79b84..e9e0a436 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.match_cookies/index.html +++ b/docs/en/cowboy/2.8/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.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.match_qs/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.match_qs/index.html index 01fd2df8..4bd5f8bc 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.match_qs/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.match_qs/index.html @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.method/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.method/index.html index aae3ea3a..3a96befe 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.method/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.method/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.parse_cookies/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.parse_cookies/index.html index 6566bb37..e79ed273 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.parse_cookies/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.parse_cookies/index.html @@ -155,6 +155,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.parse_header/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.parse_header/index.html index d67e85ca..44d36cf5 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.parse_header/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.parse_header/index.html @@ -363,6 +363,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.parse_qs/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.parse_qs/index.html index 6c0b5c09..e0fb000a 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.parse_qs/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.parse_qs/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.path/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.path/index.html index 71596f6a..05f27aea 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.path/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.path/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.path_info/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.path_info/index.html index 19f8ec80..9110b0fd 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.path_info/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.path_info/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.peer/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.peer/index.html index 9f981300..2a2f90da 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.peer/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.peer/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.port/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.port/index.html index 63116f12..838df53a 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.port/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.port/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.push/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.push/index.html index 09f90386..300d5c93 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.push/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.push/index.html @@ -163,6 +163,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.qs/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.qs/index.html index 547da1f2..714403d4 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.qs/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.qs/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.read_and_match_urlencoded_body/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.read_and_match_urlencoded_body/index.html index 90e09a25..ad21a370 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.read_and_match_urlencoded_body/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.read_and_match_urlencoded_body/index.html @@ -187,6 +187,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.read_body/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.read_body/index.html index 8a28d17d..02b459a7 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.read_body/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.read_body/index.html @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.read_part/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.read_part/index.html index 50399bc9..3d4d041f 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.read_part/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.read_part/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.read_part_body/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.read_part_body/index.html index 6efc785b..53027bbd 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.read_part_body/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.read_part_body/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.read_urlencoded_body/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.read_urlencoded_body/index.html index a0104f1e..fa1b85ea 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.read_urlencoded_body/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.read_urlencoded_body/index.html @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.reply/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.reply/index.html index a7c9eddd..d23ec20c 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.reply/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.reply/index.html @@ -175,6 +175,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.resp_header/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.resp_header/index.html index 3ba7e7d7..48b75923 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.resp_header/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.resp_header/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.resp_headers/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.resp_headers/index.html index 10768be5..2b6fbe62 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.resp_headers/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.resp_headers/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.scheme/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.scheme/index.html index d37ec1e5..7193c9bb 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.scheme/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.scheme/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_body/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_body/index.html index 7ec40bf1..5bd37602 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_body/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_body/index.html @@ -168,6 +168,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_cookie/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_cookie/index.html index 343ee0be..82fa1b16 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_cookie/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_cookie/index.html @@ -193,6 +193,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_header/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_header/index.html index 38113b9c..c4d68e65 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_header/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_header/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_headers/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_headers/index.html index 0fecb5d4..b242368b 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_headers/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.set_resp_headers/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.sock/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.sock/index.html index 2119a4a5..a4fec1de 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.sock/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.sock/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.stream_body/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.stream_body/index.html index e392d518..39a05b2d 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.stream_body/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.stream_body/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.stream_events/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.stream_events/index.html index 95dfc14d..99cc8f9a 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.stream_events/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.stream_events/index.html @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.stream_reply/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.stream_reply/index.html index b5152027..585b6f51 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.stream_reply/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.stream_reply/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.stream_trailers/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.stream_trailers/index.html index 0fd9de14..a6807774 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.stream_trailers/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.stream_trailers/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.uri/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.uri/index.html index f79e11e9..35ad52d2 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.uri/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.uri/index.html @@ -195,6 +195,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req.version/index.html b/docs/en/cowboy/2.8/manual/cowboy_req.version/index.html index c46814a2..a9093565 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req.version/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req.version/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_req/index.html b/docs/en/cowboy/2.8/manual/cowboy_req/index.html index 5d577db8..ddfc4020 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_req/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_req/index.html @@ -317,6 +317,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_rest/index.html b/docs/en/cowboy/2.8/manual/cowboy_rest/index.html index 3d7be0b8..867efc47 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_rest/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_rest/index.html @@ -595,6 +595,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_router.compile/index.html b/docs/en/cowboy/2.8/manual/cowboy_router.compile/index.html index 4996a3d3..05f0e996 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_router.compile/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_router.compile/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_router/index.html b/docs/en/cowboy/2.8/manual/cowboy_router/index.html index 0d1d1f07..b1502be1 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_router/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_router/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_static/index.html b/docs/en/cowboy/2.8/manual/cowboy_static/index.html index b02a2324..1e5a36c2 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_static/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_static/index.html @@ -212,6 +212,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_stream/index.html b/docs/en/cowboy/2.8/manual/cowboy_stream/index.html index 9cea6a3d..12bbe75e 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_stream/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_stream/index.html @@ -372,6 +372,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_stream_h/index.html b/docs/en/cowboy/2.8/manual/cowboy_stream_h/index.html index 93911300..98c903cb 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_stream_h/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_stream_h/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_tracer_h/index.html b/docs/en/cowboy/2.8/manual/cowboy_tracer_h/index.html index 8f2db4a3..e0c49b10 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_tracer_h/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_tracer_h/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/cowboy_websocket/index.html b/docs/en/cowboy/2.8/manual/cowboy_websocket/index.html index 643970e9..88679250 100644 --- a/docs/en/cowboy/2.8/manual/cowboy_websocket/index.html +++ b/docs/en/cowboy/2.8/manual/cowboy_websocket/index.html @@ -297,6 +297,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/http_status_codes/index.html b/docs/en/cowboy/2.8/manual/http_status_codes/index.html index a645cdb0..5e0ec259 100644 --- a/docs/en/cowboy/2.8/manual/http_status_codes/index.html +++ b/docs/en/cowboy/2.8/manual/http_status_codes/index.html @@ -181,6 +181,8 @@ + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.8/manual/index.html b/docs/en/cowboy/2.8/manual/index.html index e32692f0..259a1b79 100644 --- a/docs/en/cowboy/2.8/manual/index.html +++ b/docs/en/cowboy/2.8/manual/index.html @@ -176,6 +176,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/constraints/index.html b/docs/en/cowboy/2.9/guide/constraints/index.html index 13ca452b..a126d932 100644 --- a/docs/en/cowboy/2.9/guide/constraints/index.html +++ b/docs/en/cowboy/2.9/guide/constraints/index.html @@ -197,6 +197,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/cookies/index.html b/docs/en/cowboy/2.9/guide/cookies/index.html index 53acbd66..0ca3a1f8 100644 --- a/docs/en/cowboy/2.9/guide/cookies/index.html +++ b/docs/en/cowboy/2.9/guide/cookies/index.html @@ -214,6 +214,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/erlang_web/index.html b/docs/en/cowboy/2.9/guide/erlang_web/index.html index ba7a4e21..ea928ccf 100644 --- a/docs/en/cowboy/2.9/guide/erlang_web/index.html +++ b/docs/en/cowboy/2.9/guide/erlang_web/index.html @@ -163,6 +163,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/flow_diagram/index.html b/docs/en/cowboy/2.9/guide/flow_diagram/index.html index 9153e1e3..0612c37a 100644 --- a/docs/en/cowboy/2.9/guide/flow_diagram/index.html +++ b/docs/en/cowboy/2.9/guide/flow_diagram/index.html @@ -141,6 +141,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/getting_started/index.html b/docs/en/cowboy/2.9/guide/getting_started/index.html index b6e66e32..c6053ad8 100644 --- a/docs/en/cowboy/2.9/guide/getting_started/index.html +++ b/docs/en/cowboy/2.9/guide/getting_started/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/handlers/index.html b/docs/en/cowboy/2.9/guide/handlers/index.html index 2d230ae7..9fe8c294 100644 --- a/docs/en/cowboy/2.9/guide/handlers/index.html +++ b/docs/en/cowboy/2.9/guide/handlers/index.html @@ -168,6 +168,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/index.html b/docs/en/cowboy/2.9/guide/index.html index b9f69e61..97ba36cb 100644 --- a/docs/en/cowboy/2.9/guide/index.html +++ b/docs/en/cowboy/2.9/guide/index.html @@ -188,6 +188,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/introduction/index.html b/docs/en/cowboy/2.9/guide/introduction/index.html index 757b925b..cf95a812 100644 --- a/docs/en/cowboy/2.9/guide/introduction/index.html +++ b/docs/en/cowboy/2.9/guide/introduction/index.html @@ -151,6 +151,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/listeners/index.html b/docs/en/cowboy/2.9/guide/listeners/index.html index b8a67ed3..c30e5d49 100644 --- a/docs/en/cowboy/2.9/guide/listeners/index.html +++ b/docs/en/cowboy/2.9/guide/listeners/index.html @@ -181,6 +181,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/loop_handlers/index.html b/docs/en/cowboy/2.9/guide/loop_handlers/index.html index 95fc86a6..14daa42f 100644 --- a/docs/en/cowboy/2.9/guide/loop_handlers/index.html +++ b/docs/en/cowboy/2.9/guide/loop_handlers/index.html @@ -182,6 +182,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/middlewares/index.html b/docs/en/cowboy/2.9/guide/middlewares/index.html index 252595a6..4838a926 100644 --- a/docs/en/cowboy/2.9/guide/middlewares/index.html +++ b/docs/en/cowboy/2.9/guide/middlewares/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/migrating_from_1.0/index.html b/docs/en/cowboy/2.9/guide/migrating_from_1.0/index.html index 49622095..b82d796c 100644 --- a/docs/en/cowboy/2.9/guide/migrating_from_1.0/index.html +++ b/docs/en/cowboy/2.9/guide/migrating_from_1.0/index.html @@ -231,6 +231,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/migrating_from_2.0/index.html b/docs/en/cowboy/2.9/guide/migrating_from_2.0/index.html index 8c83635a..a2fa27a1 100644 --- a/docs/en/cowboy/2.9/guide/migrating_from_2.0/index.html +++ b/docs/en/cowboy/2.9/guide/migrating_from_2.0/index.html @@ -166,6 +166,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/migrating_from_2.1/index.html b/docs/en/cowboy/2.9/guide/migrating_from_2.1/index.html index 9e99de9f..ff8a624d 100644 --- a/docs/en/cowboy/2.9/guide/migrating_from_2.1/index.html +++ b/docs/en/cowboy/2.9/guide/migrating_from_2.1/index.html @@ -177,6 +177,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/migrating_from_2.2/index.html b/docs/en/cowboy/2.9/guide/migrating_from_2.2/index.html index 2473cf69..96579883 100644 --- a/docs/en/cowboy/2.9/guide/migrating_from_2.2/index.html +++ b/docs/en/cowboy/2.9/guide/migrating_from_2.2/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/migrating_from_2.3/index.html b/docs/en/cowboy/2.9/guide/migrating_from_2.3/index.html index f2472b4a..70818332 100644 --- a/docs/en/cowboy/2.9/guide/migrating_from_2.3/index.html +++ b/docs/en/cowboy/2.9/guide/migrating_from_2.3/index.html @@ -151,6 +151,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/migrating_from_2.4/index.html b/docs/en/cowboy/2.9/guide/migrating_from_2.4/index.html index ba53709b..eca7aebf 100644 --- a/docs/en/cowboy/2.9/guide/migrating_from_2.4/index.html +++ b/docs/en/cowboy/2.9/guide/migrating_from_2.4/index.html @@ -179,6 +179,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/migrating_from_2.5/index.html b/docs/en/cowboy/2.9/guide/migrating_from_2.5/index.html index 33071f34..3941bc32 100644 --- a/docs/en/cowboy/2.9/guide/migrating_from_2.5/index.html +++ b/docs/en/cowboy/2.9/guide/migrating_from_2.5/index.html @@ -194,6 +194,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/migrating_from_2.6/index.html b/docs/en/cowboy/2.9/guide/migrating_from_2.6/index.html index 4185a8ee..5f421e9e 100644 --- a/docs/en/cowboy/2.9/guide/migrating_from_2.6/index.html +++ b/docs/en/cowboy/2.9/guide/migrating_from_2.6/index.html @@ -215,6 +215,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/migrating_from_2.7/index.html b/docs/en/cowboy/2.9/guide/migrating_from_2.7/index.html index 1fb87f1d..55af26ac 100644 --- a/docs/en/cowboy/2.9/guide/migrating_from_2.7/index.html +++ b/docs/en/cowboy/2.9/guide/migrating_from_2.7/index.html @@ -171,6 +171,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/migrating_from_2.8/index.html b/docs/en/cowboy/2.9/guide/migrating_from_2.8/index.html index 305edfc5..3beff601 100644 --- a/docs/en/cowboy/2.9/guide/migrating_from_2.8/index.html +++ b/docs/en/cowboy/2.9/guide/migrating_from_2.8/index.html @@ -142,6 +142,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/modern_web/index.html b/docs/en/cowboy/2.9/guide/modern_web/index.html index c410f1c9..ef798467 100644 --- a/docs/en/cowboy/2.9/guide/modern_web/index.html +++ b/docs/en/cowboy/2.9/guide/modern_web/index.html @@ -145,6 +145,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/multipart/index.html b/docs/en/cowboy/2.9/guide/multipart/index.html index 74185786..3519e1ff 100644 --- a/docs/en/cowboy/2.9/guide/multipart/index.html +++ b/docs/en/cowboy/2.9/guide/multipart/index.html @@ -218,6 +218,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/performance/index.html b/docs/en/cowboy/2.9/guide/performance/index.html index d3c145ef..48084bcc 100644 --- a/docs/en/cowboy/2.9/guide/performance/index.html +++ b/docs/en/cowboy/2.9/guide/performance/index.html @@ -123,6 +123,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/req/index.html b/docs/en/cowboy/2.9/guide/req/index.html index 73702301..afe6ac9d 100644 --- a/docs/en/cowboy/2.9/guide/req/index.html +++ b/docs/en/cowboy/2.9/guide/req/index.html @@ -393,6 +393,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/req_body/index.html b/docs/en/cowboy/2.9/guide/req_body/index.html index 1134a0d8..68c478d5 100644 --- a/docs/en/cowboy/2.9/guide/req_body/index.html +++ b/docs/en/cowboy/2.9/guide/req_body/index.html @@ -204,6 +204,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/resource_design/index.html b/docs/en/cowboy/2.9/guide/resource_design/index.html index 17604ad5..8512f9fe 100644 --- a/docs/en/cowboy/2.9/guide/resource_design/index.html +++ b/docs/en/cowboy/2.9/guide/resource_design/index.html @@ -178,6 +178,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/resp/index.html b/docs/en/cowboy/2.9/guide/resp/index.html index ef21f90b..47a771e0 100644 --- a/docs/en/cowboy/2.9/guide/resp/index.html +++ b/docs/en/cowboy/2.9/guide/resp/index.html @@ -360,6 +360,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/rest_flowcharts/index.html b/docs/en/cowboy/2.9/guide/rest_flowcharts/index.html index 056703ae..7d472fd2 100644 --- a/docs/en/cowboy/2.9/guide/rest_flowcharts/index.html +++ b/docs/en/cowboy/2.9/guide/rest_flowcharts/index.html @@ -175,6 +175,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/rest_handlers/index.html b/docs/en/cowboy/2.9/guide/rest_handlers/index.html index d392e966..943479f8 100644 --- a/docs/en/cowboy/2.9/guide/rest_handlers/index.html +++ b/docs/en/cowboy/2.9/guide/rest_handlers/index.html @@ -276,6 +276,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/rest_principles/index.html b/docs/en/cowboy/2.9/guide/rest_principles/index.html index d6679c6a..2752e7c0 100644 --- a/docs/en/cowboy/2.9/guide/rest_principles/index.html +++ b/docs/en/cowboy/2.9/guide/rest_principles/index.html @@ -149,6 +149,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/routing/index.html b/docs/en/cowboy/2.9/guide/routing/index.html index 562b94a5..2bbc25dc 100644 --- a/docs/en/cowboy/2.9/guide/routing/index.html +++ b/docs/en/cowboy/2.9/guide/routing/index.html @@ -326,6 +326,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/specs/index.html b/docs/en/cowboy/2.9/guide/specs/index.html index 00fbe09f..e7488ff9 100644 --- a/docs/en/cowboy/2.9/guide/specs/index.html +++ b/docs/en/cowboy/2.9/guide/specs/index.html @@ -496,6 +496,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/static_files/index.html b/docs/en/cowboy/2.9/guide/static_files/index.html index dcec59fc..a0c21800 100644 --- a/docs/en/cowboy/2.9/guide/static_files/index.html +++ b/docs/en/cowboy/2.9/guide/static_files/index.html @@ -212,6 +212,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/streams/index.html b/docs/en/cowboy/2.9/guide/streams/index.html index ae4b8465..7dd426dc 100644 --- a/docs/en/cowboy/2.9/guide/streams/index.html +++ b/docs/en/cowboy/2.9/guide/streams/index.html @@ -136,6 +136,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/ws_handlers/index.html b/docs/en/cowboy/2.9/guide/ws_handlers/index.html index ebb425d0..a19d3ffc 100644 --- a/docs/en/cowboy/2.9/guide/ws_handlers/index.html +++ b/docs/en/cowboy/2.9/guide/ws_handlers/index.html @@ -301,6 +301,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/guide/ws_protocol/index.html b/docs/en/cowboy/2.9/guide/ws_protocol/index.html index f8c74640..487ec8ec 100644 --- a/docs/en/cowboy/2.9/guide/ws_protocol/index.html +++ b/docs/en/cowboy/2.9/guide/ws_protocol/index.html @@ -133,6 +133,8 @@ + <li><a href="/docs/en/cowboy/2.12/guide">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/guide">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.9/manual/cowboy.set_env/index.html index 1dd2d8ff..cb0882c3 100644 --- a/docs/en/cowboy/2.9/manual/cowboy.set_env/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy.set_env/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy.start_clear/index.html b/docs/en/cowboy/2.9/manual/cowboy.start_clear/index.html index 774758c4..1214d5ff 100644 --- a/docs/en/cowboy/2.9/manual/cowboy.start_clear/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy.start_clear/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy.start_tls/index.html b/docs/en/cowboy/2.9/manual/cowboy.start_tls/index.html index a0358125..7ed72bd2 100644 --- a/docs/en/cowboy/2.9/manual/cowboy.start_tls/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy.start_tls/index.html @@ -171,6 +171,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy.stop_listener/index.html b/docs/en/cowboy/2.9/manual/cowboy.stop_listener/index.html index 11425815..e33ce385 100644 --- a/docs/en/cowboy/2.9/manual/cowboy.stop_listener/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy.stop_listener/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy/index.html b/docs/en/cowboy/2.9/manual/cowboy/index.html index 885ad651..23413691 100644 --- a/docs/en/cowboy/2.9/manual/cowboy/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy/index.html @@ -165,6 +165,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_app/index.html b/docs/en/cowboy/2.9/manual/cowboy_app/index.html index 14bacc92..40b13eb2 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_app/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_app/index.html @@ -176,6 +176,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_compress_h/index.html b/docs/en/cowboy/2.9/manual/cowboy_compress_h/index.html index 0574047c..4a40fa94 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_compress_h/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_compress_h/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_constraints.int/index.html b/docs/en/cowboy/2.9/manual/cowboy_constraints.int/index.html index ed218deb..994e0231 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_constraints.int/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_constraints.int/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_constraints.nonempty/index.html b/docs/en/cowboy/2.9/manual/cowboy_constraints.nonempty/index.html index dc59270a..d5300224 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_constraints.nonempty/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_constraints.nonempty/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_constraints/index.html b/docs/en/cowboy/2.9/manual/cowboy_constraints/index.html index 2731dd8b..e168e743 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_constraints/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_constraints/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_handler.terminate/index.html b/docs/en/cowboy/2.9/manual/cowboy_handler.terminate/index.html index b5d06ea7..30cafb5f 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_handler.terminate/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_handler.terminate/index.html @@ -143,6 +143,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_handler/index.html b/docs/en/cowboy/2.9/manual/cowboy_handler/index.html index 3b8d69c7..02ad0411 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_handler/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_handler/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_http/index.html b/docs/en/cowboy/2.9/manual/cowboy_http/index.html index fc7cfbf4..62337eba 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_http/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_http/index.html @@ -235,6 +235,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_http2/index.html b/docs/en/cowboy/2.9/manual/cowboy_http2/index.html index a8c04b1d..fc19c515 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_http2/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_http2/index.html @@ -269,6 +269,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_loop/index.html b/docs/en/cowboy/2.9/manual/cowboy_loop/index.html index 0b06cc4d..ab6a6f51 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_loop/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_loop/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_metrics_h/index.html b/docs/en/cowboy/2.9/manual/cowboy_metrics_h/index.html index 35465e17..72853c33 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_metrics_h/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_metrics_h/index.html @@ -226,6 +226,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.9/manual/cowboy_middleware/index.html index 9dadb845..a92faa9c 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_middleware/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_middleware/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.binding/index.html index 2661adca..8d274614 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.binding/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.binding/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.bindings/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.bindings/index.html index 293fc8dc..f630e7cc 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.bindings/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.bindings/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.body_length/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.body_length/index.html index 3fb925e1..6792ac18 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.body_length/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.body_length/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.cast/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.cast/index.html index be27b109..af17aa01 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.cast/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.cast/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.cert/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.cert/index.html index 5a4e5880..53bb0efe 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.cert/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.cert/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.delete_resp_header/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.delete_resp_header/index.html index a383b062..b407a261 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.delete_resp_header/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.delete_resp_header/index.html @@ -134,6 +134,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.filter_cookies/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.filter_cookies/index.html index 115a6b21..1f7a828f 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.filter_cookies/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.filter_cookies/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.has_body/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.has_body/index.html index ec796cad..40d61617 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.has_body/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.has_body/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.has_resp_body/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.has_resp_body/index.html index 19448c0b..d2938a07 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.has_resp_body/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.has_resp_body/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.has_resp_header/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.has_resp_header/index.html index 7237e476..e53d0bfe 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.has_resp_header/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.has_resp_header/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.header/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.header/index.html index 6febf804..8f3edb2a 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.header/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.header/index.html @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.headers/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.headers/index.html index e063be3d..0c003a8d 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.headers/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.headers/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.host/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.host/index.html index 62d40f20..952839c0 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.host/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.host/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.host_info/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.host_info/index.html index e4c802d3..355d78fc 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.host_info/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.host_info/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.inform/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.inform/index.html index ba865ac9..424f9e8a 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.inform/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.inform/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.match_cookies/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.match_cookies/index.html index dfac758b..78ea48ac 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.match_cookies/index.html +++ b/docs/en/cowboy/2.9/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.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.match_qs/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.match_qs/index.html index 20d5cd4d..714af6db 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.match_qs/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.match_qs/index.html @@ -156,6 +156,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.method/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.method/index.html index 6c17e2b1..53277694 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.method/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.method/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.parse_cookies/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.parse_cookies/index.html index e89eb7e1..209e768d 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.parse_cookies/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.parse_cookies/index.html @@ -155,6 +155,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.parse_header/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.parse_header/index.html index 7e003a92..622ab803 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.parse_header/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.parse_header/index.html @@ -363,6 +363,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.parse_qs/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.parse_qs/index.html index 53e7e7f8..d7db7875 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.parse_qs/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.parse_qs/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.path/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.path/index.html index ad6353e1..bbed16f1 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.path/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.path/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.path_info/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.path_info/index.html index 4eb17bea..d578acbf 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.path_info/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.path_info/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.peer/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.peer/index.html index 154376ca..95379307 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.peer/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.peer/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.port/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.port/index.html index d31cf185..0acac1a1 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.port/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.port/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.push/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.push/index.html index 44dc27af..2d0fd90a 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.push/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.push/index.html @@ -163,6 +163,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.qs/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.qs/index.html index 98943910..419aed5f 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.qs/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.qs/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.read_and_match_urlencoded_body/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.read_and_match_urlencoded_body/index.html index 6b1f7646..1ff95f2e 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.read_and_match_urlencoded_body/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.read_and_match_urlencoded_body/index.html @@ -187,6 +187,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.read_body/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.read_body/index.html index ae66a86c..7a4a5ae6 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.read_body/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.read_body/index.html @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.read_part/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.read_part/index.html index 7f9df272..d6342155 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.read_part/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.read_part/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.read_part_body/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.read_part_body/index.html index 9fe1194a..62185217 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.read_part_body/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.read_part_body/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.read_urlencoded_body/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.read_urlencoded_body/index.html index 76183f80..e1ff29b7 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.read_urlencoded_body/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.read_urlencoded_body/index.html @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.reply/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.reply/index.html index 0212d200..5decd174 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.reply/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.reply/index.html @@ -175,6 +175,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.resp_header/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.resp_header/index.html index e4bf78f8..c1e3230c 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.resp_header/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.resp_header/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.resp_headers/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.resp_headers/index.html index 16094dd4..6867f781 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.resp_headers/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.resp_headers/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.scheme/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.scheme/index.html index 69de8efa..3509da3b 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.scheme/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.scheme/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_body/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_body/index.html index 5208851d..37880b87 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_body/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_body/index.html @@ -168,6 +168,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_cookie/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_cookie/index.html index 43baff18..d6b33673 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_cookie/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_cookie/index.html @@ -193,6 +193,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_header/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_header/index.html index 0b2cb1e0..23299c33 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_header/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_header/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_headers/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_headers/index.html index 860f7aae..6f6e1958 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_headers/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_headers/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.sock/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.sock/index.html index 27465cb1..31513603 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.sock/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.sock/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.stream_body/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.stream_body/index.html index cdff7318..5cadb07e 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.stream_body/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.stream_body/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.stream_events/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.stream_events/index.html index b5819ba4..12421b05 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.stream_events/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.stream_events/index.html @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.stream_reply/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.stream_reply/index.html index ce4f1b76..4cdaf826 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.stream_reply/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.stream_reply/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.stream_trailers/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.stream_trailers/index.html index c15437c7..39603e36 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.stream_trailers/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.stream_trailers/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.uri/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.uri/index.html index 64324068..04ecc9f2 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.uri/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.uri/index.html @@ -195,6 +195,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.version/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.version/index.html index e04907fe..feffa35e 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req.version/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req.version/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_req/index.html b/docs/en/cowboy/2.9/manual/cowboy_req/index.html index b33e0b5b..43dcaa6b 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_req/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_req/index.html @@ -317,6 +317,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_rest/index.html b/docs/en/cowboy/2.9/manual/cowboy_rest/index.html index 1ecc7c88..22d41e35 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_rest/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_rest/index.html @@ -601,6 +601,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_router.compile/index.html b/docs/en/cowboy/2.9/manual/cowboy_router.compile/index.html index cb2198a8..b8bc5237 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_router.compile/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_router.compile/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_router/index.html b/docs/en/cowboy/2.9/manual/cowboy_router/index.html index c30b31cc..a3a60e1a 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_router/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_router/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_static/index.html b/docs/en/cowboy/2.9/manual/cowboy_static/index.html index 0d5fb29c..e5282f22 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_static/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_static/index.html @@ -212,6 +212,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_stream/index.html b/docs/en/cowboy/2.9/manual/cowboy_stream/index.html index d90df313..7a561f46 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_stream/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_stream/index.html @@ -372,6 +372,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_stream_h/index.html b/docs/en/cowboy/2.9/manual/cowboy_stream_h/index.html index 42f22b90..703f72eb 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_stream_h/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_stream_h/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_tracer_h/index.html b/docs/en/cowboy/2.9/manual/cowboy_tracer_h/index.html index 68ec5d74..54a07553 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_tracer_h/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_tracer_h/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/cowboy_websocket/index.html b/docs/en/cowboy/2.9/manual/cowboy_websocket/index.html index 64cc1dc0..74711dfe 100644 --- a/docs/en/cowboy/2.9/manual/cowboy_websocket/index.html +++ b/docs/en/cowboy/2.9/manual/cowboy_websocket/index.html @@ -297,6 +297,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/http_status_codes/index.html b/docs/en/cowboy/2.9/manual/http_status_codes/index.html index c93826c5..480c9762 100644 --- a/docs/en/cowboy/2.9/manual/http_status_codes/index.html +++ b/docs/en/cowboy/2.9/manual/http_status_codes/index.html @@ -181,6 +181,8 @@ + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowboy/2.9/manual/index.html b/docs/en/cowboy/2.9/manual/index.html index daa8bc7c..c67ff306 100644 --- a/docs/en/cowboy/2.9/manual/index.html +++ b/docs/en/cowboy/2.9/manual/index.html @@ -176,6 +176,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> diff --git a/docs/en/cowlib/2.10/manual/cow_cookie.cookie/index.html b/docs/en/cowlib/2.10/manual/cow_cookie.cookie/index.html index 5925254e..edc0729f 100644 --- a/docs/en/cowlib/2.10/manual/cow_cookie.cookie/index.html +++ b/docs/en/cowlib/2.10/manual/cow_cookie.cookie/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.10/manual/cow_cookie.parse_cookie/index.html b/docs/en/cowlib/2.10/manual/cow_cookie.parse_cookie/index.html index 9e3fa364..3f1248a5 100644 --- a/docs/en/cowlib/2.10/manual/cow_cookie.parse_cookie/index.html +++ b/docs/en/cowlib/2.10/manual/cow_cookie.parse_cookie/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.10/manual/cow_cookie.parse_set_cookie/index.html b/docs/en/cowlib/2.10/manual/cow_cookie.parse_set_cookie/index.html index fff405bc..99dced1a 100644 --- a/docs/en/cowlib/2.10/manual/cow_cookie.parse_set_cookie/index.html +++ b/docs/en/cowlib/2.10/manual/cow_cookie.parse_set_cookie/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.10/manual/cow_cookie.setcookie/index.html b/docs/en/cowlib/2.10/manual/cow_cookie.setcookie/index.html index 5b2f4e29..94a4af5a 100644 --- a/docs/en/cowlib/2.10/manual/cow_cookie.setcookie/index.html +++ b/docs/en/cowlib/2.10/manual/cow_cookie.setcookie/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.10/manual/cow_cookie/index.html b/docs/en/cowlib/2.10/manual/cow_cookie/index.html index d303c1a1..c73f68f9 100644 --- a/docs/en/cowlib/2.10/manual/cow_cookie/index.html +++ b/docs/en/cowlib/2.10/manual/cow_cookie/index.html @@ -171,6 +171,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.10/manual/cowlib_app/index.html b/docs/en/cowlib/2.10/manual/cowlib_app/index.html index 19372b50..6a8e4978 100644 --- a/docs/en/cowlib/2.10/manual/cowlib_app/index.html +++ b/docs/en/cowlib/2.10/manual/cowlib_app/index.html @@ -118,6 +118,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.10/manual/index.html b/docs/en/cowlib/2.10/manual/index.html index 3abb5ea3..a4ee6e24 100644 --- a/docs/en/cowlib/2.10/manual/index.html +++ b/docs/en/cowlib/2.10/manual/index.html @@ -118,6 +118,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.11/manual/cow_cookie.cookie/index.html b/docs/en/cowlib/2.11/manual/cow_cookie.cookie/index.html index 50e13bf9..65e3683e 100644 --- a/docs/en/cowlib/2.11/manual/cow_cookie.cookie/index.html +++ b/docs/en/cowlib/2.11/manual/cow_cookie.cookie/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.11/manual/cow_cookie.parse_cookie/index.html b/docs/en/cowlib/2.11/manual/cow_cookie.parse_cookie/index.html index d7934f95..93952c6e 100644 --- a/docs/en/cowlib/2.11/manual/cow_cookie.parse_cookie/index.html +++ b/docs/en/cowlib/2.11/manual/cow_cookie.parse_cookie/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.11/manual/cow_cookie.parse_set_cookie/index.html b/docs/en/cowlib/2.11/manual/cow_cookie.parse_set_cookie/index.html index 55fa7054..46fd0e0d 100644 --- a/docs/en/cowlib/2.11/manual/cow_cookie.parse_set_cookie/index.html +++ b/docs/en/cowlib/2.11/manual/cow_cookie.parse_set_cookie/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.11/manual/cow_cookie.setcookie/index.html b/docs/en/cowlib/2.11/manual/cow_cookie.setcookie/index.html index 9341c205..787da708 100644 --- a/docs/en/cowlib/2.11/manual/cow_cookie.setcookie/index.html +++ b/docs/en/cowlib/2.11/manual/cow_cookie.setcookie/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.11/manual/cow_cookie/index.html b/docs/en/cowlib/2.11/manual/cow_cookie/index.html index 159e7beb..78253e03 100644 --- a/docs/en/cowlib/2.11/manual/cow_cookie/index.html +++ b/docs/en/cowlib/2.11/manual/cow_cookie/index.html @@ -171,6 +171,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.11/manual/cowlib_app/index.html b/docs/en/cowlib/2.11/manual/cowlib_app/index.html index 40f8e4f7..00461ecb 100644 --- a/docs/en/cowlib/2.11/manual/cowlib_app/index.html +++ b/docs/en/cowlib/2.11/manual/cowlib_app/index.html @@ -118,6 +118,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.11/manual/index.html b/docs/en/cowlib/2.11/manual/index.html index 59e6fd0e..a56be1ac 100644 --- a/docs/en/cowlib/2.11/manual/index.html +++ b/docs/en/cowlib/2.11/manual/index.html @@ -118,6 +118,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.12/manual/cow_cookie.cookie/index.html b/docs/en/cowlib/2.12/manual/cow_cookie.cookie/index.html index 3904769f..12eec5f4 100644 --- a/docs/en/cowlib/2.12/manual/cow_cookie.cookie/index.html +++ b/docs/en/cowlib/2.12/manual/cow_cookie.cookie/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.12/manual/cow_cookie.parse_cookie/index.html b/docs/en/cowlib/2.12/manual/cow_cookie.parse_cookie/index.html index 25699177..70cb2ea7 100644 --- a/docs/en/cowlib/2.12/manual/cow_cookie.parse_cookie/index.html +++ b/docs/en/cowlib/2.12/manual/cow_cookie.parse_cookie/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.12/manual/cow_cookie.parse_set_cookie/index.html b/docs/en/cowlib/2.12/manual/cow_cookie.parse_set_cookie/index.html index 352b4870..d6aa1628 100644 --- a/docs/en/cowlib/2.12/manual/cow_cookie.parse_set_cookie/index.html +++ b/docs/en/cowlib/2.12/manual/cow_cookie.parse_set_cookie/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.12/manual/cow_cookie.setcookie/index.html b/docs/en/cowlib/2.12/manual/cow_cookie.setcookie/index.html index 7594d4bb..ae5f2934 100644 --- a/docs/en/cowlib/2.12/manual/cow_cookie.setcookie/index.html +++ b/docs/en/cowlib/2.12/manual/cow_cookie.setcookie/index.html @@ -139,6 +139,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.12/manual/cow_cookie/index.html b/docs/en/cowlib/2.12/manual/cow_cookie/index.html index 0bef329c..34d95b89 100644 --- a/docs/en/cowlib/2.12/manual/cow_cookie/index.html +++ b/docs/en/cowlib/2.12/manual/cow_cookie/index.html @@ -173,6 +173,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.12/manual/cowlib_app/index.html b/docs/en/cowlib/2.12/manual/cowlib_app/index.html index f9f38f34..93fe8d0f 100644 --- a/docs/en/cowlib/2.12/manual/cowlib_app/index.html +++ b/docs/en/cowlib/2.12/manual/cowlib_app/index.html @@ -118,6 +118,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.12/manual/index.html b/docs/en/cowlib/2.12/manual/index.html index 6303f602..c7e853c6 100644 --- a/docs/en/cowlib/2.12/manual/index.html +++ b/docs/en/cowlib/2.12/manual/index.html @@ -118,6 +118,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.13/manual/cow_cookie.cookie/index.html b/docs/en/cowlib/2.13/manual/cow_cookie.cookie/index.html new file mode 100644 index 00000000..ddaab8eb --- /dev/null +++ b/docs/en/cowlib/2.13/manual/cow_cookie.cookie/index.html @@ -0,0 +1,189 @@ +<!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: cow_cookie: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=7" 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>cow_cookie:cookie(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cow_cookie:cookie - Generate a cookie header</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cookie</font></b>(<font color="#009900">Cookies</font>) <font color="#990000">-></font> <b><font color="#000000">iolist</font></b>() + +<font color="#009900">Cookies</font> <font color="#990000">::</font> [{<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>(), <font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>()}]</tt></pre> +</div></div> +<p>Generate a cookie header.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Cookies</dt> +<dd><p>A list of pairs of cookie name and value.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>An iolist with the generated cookie header value.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.9</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Generate a cookie header</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Cookie</font> <font color="#990000">=</font> <b><font color="#000000">cow_cookie:cookie</font></b>([{<font color="#990000"><<</font><font color="#FF0000">"sessionid"</font><font color="#990000">>></font>, <font color="#009900">ID</font>}])<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cow_cookie">cow_cookie(3)</a>, <a href="../cow_cookie.parse_cookie">cow_cookie:parse_cookie(3)</a>, <a href="../cow_cookie.parse_set_cookie">cow_cookie:parse_set_cookie(3)</a>, <a href="../cow_cookie.setcookie">cow_cookie:setcookie(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowlib + 2.13 + Function Reference + +</h3> + +<ul> + + + <li><a href="/docs/en/cowlib/2.13/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowlib/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowlib/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowlib/2.8/manual">2.8</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/cowlib/2.13/manual/cow_cookie.parse_cookie/index.html b/docs/en/cowlib/2.13/manual/cow_cookie.parse_cookie/index.html new file mode 100644 index 00000000..33884b47 --- /dev/null +++ b/docs/en/cowlib/2.13/manual/cow_cookie.parse_cookie/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: cow_cookie:parse_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=7" 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>cow_cookie:parse_cookie(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cow_cookie:parse_cookie - Parse a cookie header</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_cookie</font></b>(<font color="#009900">Cookie</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()) + <font color="#990000">-></font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Parse a cookie header.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Cookie</dt> +<dd><p>The cookie header value.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A list of cookie name/value pairs is returned on success.</p> +<p>An exception is thrown in the event of a parse error.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.9</strong>: Fixes to the parser may lead to potential incompatibilities. A cookie name starting with <code>$</code> is no longer ignored. A cookie without a <code>=</code> will be parsed as the value of the cookie named <code><<>></code> (empty name). +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Parse a cookie header</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">cow_cookie:parse_cookie</font></b>(<font color="#009900">CookieHd</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cow_cookie">cow_cookie(3)</a>, <a href="../cow_cookie.parse_set_cookie">cow_cookie:parse_set_cookie(3)</a>, <a href="../cow_cookie.cookie">cow_cookie:cookie(3)</a>, <a href="../cow_cookie.setcookie">cow_cookie:setcookie(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowlib + 2.13 + Function Reference + +</h3> + +<ul> + + + <li><a href="/docs/en/cowlib/2.13/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowlib/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowlib/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowlib/2.8/manual">2.8</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/cowlib/2.13/manual/cow_cookie.parse_set_cookie/index.html b/docs/en/cowlib/2.13/manual/cow_cookie.parse_set_cookie/index.html new file mode 100644 index 00000000..5382a0c7 --- /dev/null +++ b/docs/en/cowlib/2.13/manual/cow_cookie.parse_set_cookie/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: cow_cookie:parse_set_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=7" 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>cow_cookie:parse_set_cookie(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cow_cookie:parse_set_cookie - Parse a set-cookie header</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_set_cookie</font></b>(<font color="#009900">SetCookie</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Name</font>, <font color="#009900">Value</font>, <font color="#009900">Attrs</font>} | <font color="#FF6600">ignore</font> + +<font color="#009900">Name</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">Attrs</font> <font color="#990000">::</font> <b><font color="#000000">cow_cookie:cookie_attrs</font></b>()</tt></pre> +</div></div> +<p>Parse a set-cookie header.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>SetCookie</dt> +<dd><p>The set-cookie header value.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>An <code>ok</code> tuple with the cookie name, value and attributes is returned on success.</p> +<p>An atom <code>ignore</code> is returned when the cookie has both an empty name and an empty value, and must be ignored.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.9</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Parse a cookie header</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#0000FF">case</font></b> <b><font color="#000000">cow_cookie:parse_set_cookie</font></b>(<font color="#009900">SetCookieHd</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">ok</font>, <font color="#009900">Name</font>, <font color="#009900">Value</font>, <font color="#009900">Attrs</font>} <font color="#990000">-></font> + <b><font color="#000000">cookie_engine_set_cookie</font></b>(<font color="#009900">Name</font>, <font color="#009900">Value</font>, <font color="#009900">Attrs</font>); + <font color="#FF6600">ignore</font> <font color="#990000">-></font> + <b><font color="#000000">do_nothing</font></b>() +<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="../cow_cookie">cow_cookie(3)</a>, <a href="../cow_cookie.parse_cookie">cow_cookie:parse_cookie(3)</a>, <a href="../cow_cookie.cookie">cow_cookie:cookie(3)</a>, <a href="../cow_cookie.setcookie">cow_cookie:setcookie(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowlib + 2.13 + Function Reference + +</h3> + +<ul> + + + <li><a href="/docs/en/cowlib/2.13/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowlib/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowlib/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowlib/2.8/manual">2.8</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/cowlib/2.13/manual/cow_cookie.setcookie/index.html b/docs/en/cowlib/2.13/manual/cow_cookie.setcookie/index.html new file mode 100644 index 00000000..f36d1f5e --- /dev/null +++ b/docs/en/cowlib/2.13/manual/cow_cookie.setcookie/index.html @@ -0,0 +1,201 @@ +<!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: cow_cookie:setcookie(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=7" 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>cow_cookie:setcookie(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cow_cookie:setcookie - Generate a set-cookie header</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">setcookie</font></b>(<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>(), + <font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>(), + <font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">cow_cookie:cookie_opts</font></b>()) + <font color="#990000">-></font> <b><font color="#000000">iolist</font></b>()</tt></pre> +</div></div> +<p>Generate a set-cookie header.</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>Opts</dt> +<dd><p>Options added to the set-cookie header as attributes.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>An iolist with the generated set-cookie header value.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.12</strong>: The <code>Version</code> attribute is no longer generated. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Generate a set-cookie header</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">SetCookie</font> <font color="#990000">=</font> <b><font color="#000000">cow_cookie:setcookie</font></b>(<font color="#990000"><<</font><font color="#FF0000">"sessionid"</font><font color="#990000">>></font>, <font color="#009900">ID</font>, #{ + <font color="#0000FF">http_only</font> <font color="#990000">=></font> <font color="#000080">true</font>, + <font color="#0000FF">secure</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="../cow_cookie">cow_cookie(3)</a>, <a href="../cow_cookie.parse_cookie">cow_cookie:parse_cookie(3)</a>, <a href="../cow_cookie.parse_set_cookie">cow_cookie:parse_set_cookie(3)</a>, <a href="../cow_cookie.cookie">cow_cookie:cookie(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowlib + 2.13 + Function Reference + +</h3> + +<ul> + + + <li><a href="/docs/en/cowlib/2.13/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowlib/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowlib/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowlib/2.8/manual">2.8</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/cowlib/2.13/manual/cow_cookie/index.html b/docs/en/cowlib/2.13/manual/cow_cookie/index.html new file mode 100644 index 00000000..4a399900 --- /dev/null +++ b/docs/en/cowlib/2.13/manual/cow_cookie/index.html @@ -0,0 +1,235 @@ +<!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: cow_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=7" 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>cow_cookie(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cow_cookie - Cookies</p> +<h2 id="_description">Description</h2> +<p>The module <code>cow_cookie</code> provides functions for parsing and manipulating cookie headers.</p> +<h2 id="_exports">Exports</h2> +<ul><li><a href="../cow_cookie.parse_cookie">cow_cookie:parse_cookie(3)</a> - Parse a cookie header +</li> +<li><a href="../cow_cookie.parse_set_cookie">cow_cookie:parse_set_cookie(3)</a> - Parse a set-cookie header +</li> +<li><a href="../cow_cookie.cookie">cow_cookie:cookie(3)</a> - Generate a cookie header +</li> +<li><a href="../cow_cookie.setcookie">cow_cookie:setcookie(3)</a> - Generate a set-cookie header +</li> +</ul> +<h2 id="_types">Types</h2> +<h3 id="_cookie_attrs">cookie_attrs()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cookie_attrs</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">expires</font> <font color="#990000">=></font> <b><font color="#000000">calendar:datetime</font></b>(), + <font color="#0000FF">max_age</font> <font color="#990000">=></font> <b><font color="#000000">calendar:datetime</font></b>(), + <font color="#0000FF">domain</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), + <font color="#0000FF">path</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), + <font color="#0000FF">secure</font> <font color="#990000">=></font> <font color="#000080">true</font>, + <font color="#0000FF">http_only</font> <font color="#990000">=></font> <font color="#000080">true</font>, + <font color="#0000FF">same_site</font> <font color="#990000">=></font> <font color="#FF6600">default</font> | <font color="#FF6600">none</font> | <font color="#FF6600">strict</font> | <font color="#FF6600">lax</font> +}</tt></pre> +</div></div> +<p>Cookie attributes parsed from the set-cookie header. The attributes must be passed as-is to a cookie store engine for processing, along with the cookie name and value. More information about the attributes can be found in <a href="https://tools.ietf.org/html/rfc6265">RFC 6265</a>.</p> +<h3 id="_cookie_opts">cookie_opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cookie_opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">domain</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), + <font color="#0000FF">http_only</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">max_age</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">path</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), + <font color="#0000FF">same_site</font> <font color="#990000">=></font> <font color="#FF6600">default</font> | <font color="#FF6600">none</font> | <font color="#FF6600">strict</font> | <font color="#FF6600">lax</font>, + <font color="#0000FF">secure</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>() +}</tt></pre> +</div></div> +<p>Options for the set-cookie header. They are added to the header as attributes. More information about the options can be found in <a href="https://tools.ietf.org/html/rfc6265">RFC 6265</a>.</p> +<p>The following options are defined:</p> +<dl><dt>domain</dt> +<dd><p>Hosts to which the cookie will be sent. By default it will only be sent to the origin server.</p> +</dd> +<dt>http_only</dt> +<dd><p>Whether the cookie should be restricted to HTTP requests, or it should also be exposed to other APIs, for example Javascript. By default there are no restrictions.</p> +</dd> +<dt>max_age</dt> +<dd><p>Maximum lifetime of the cookie, in seconds. By default the cookie is kept for the duration of the session.</p> +</dd> +<dt>path</dt> +<dd><p>Path to which the cookie will be sent. By default it will be sent to the current "directory" of the effective request URI.</p> +</dd> +<dt>same_site</dt> +<dd><p>Whether the cookie should be sent along with cross-site requests. This attribute is currently non-standard but is in the process of being standardized. Please refer to the <a href="https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7">RFC 6265 (bis) draft</a> for details.</p> +<p>The default value for this attribute may vary depending on user agent and configuration. Browsers are known to be more strict over TCP compared to TLS.</p> +</dd> +<dt>secure</dt> +<dd><p>Whether the cookie should be sent only on secure channels (for example TLS). Note that this does not guarantee the integrity of the cookie, only its confidentiality during transfer. By default there are no restrictions.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.12</strong>: The <code>same_site</code> attribute and option may now be set to <code>default</code>. +</li> +<li><strong>2.10</strong>: The <code>same_site</code> attribute and option may now be set to <code>none</code>. +</li> +<li><strong>2.9</strong>: The <code>cookie_attrs</code> type was added. +</li> +<li><strong>1.0</strong>: Module introduced. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">cowlib(7)</a>, <a href="https://tools.ietf.org/html/rfc6265">RFC 6265</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowlib + 2.13 + Function Reference + +</h3> + +<ul> + + + <li><a href="/docs/en/cowlib/2.13/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowlib/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowlib/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowlib/2.8/manual">2.8</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/cowlib/2.13/manual/cowlib_app/index.html b/docs/en/cowlib/2.13/manual/cowlib_app/index.html new file mode 100644 index 00000000..a8eebd7c --- /dev/null +++ b/docs/en/cowlib/2.13/manual/cowlib_app/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: cowlib(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=7" 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>cowlib(7)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowlib - Support library for manipulating Web protocols</p> +<h2 id="_description">Description</h2> +<p>Cowlib provides libraries for parsing and building messages for various Web protocols, including HTTP/1.1, HTTP/2 and Websocket.</p> +<p>It is optimized for completeness rather than speed. No value is ignored, they are all returned.</p> +<h2 id="_modules">Modules</h2> +<ul><li><a href="../cow_cookie">cow_cookie(3)</a> - Cookies +</li> +</ul> +<h2 id="_dependencies">Dependencies</h2> +<ul><li>crypto - Crypto functions +</li> +</ul> +<p>All these applications must be started before the <code>cowlib</code> application. To start Cowlib and all dependencies at once:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">cowlib</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_environment">Environment</h2> +<p>The <code>cowlib</code> application does not define any application environment configuration parameters.</p> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy">cowboy(7)</a>, <a href="../gun">gun(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowlib + 2.13 + Function Reference + +</h3> + +<ul> + + + <li><a href="/docs/en/cowlib/2.13/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowlib/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowlib/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowlib/2.8/manual">2.8</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/cowlib/2.13/manual/index.html b/docs/en/cowlib/2.13/manual/index.html new file mode 100644 index 00000000..0c71d5b9 --- /dev/null +++ b/docs/en/cowlib/2.13/manual/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: Cowlib 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=7" 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>Cowlib Function Reference</span></h1> + +<h2 id="_name">Name</h2> +<p>cowlib - Support library for manipulating Web protocols</p> +<h2 id="_description">Description</h2> +<p>Cowlib provides libraries for parsing and building messages for various Web protocols, including HTTP/1.1, HTTP/2 and Websocket.</p> +<p>It is optimized for completeness rather than speed. No value is ignored, they are all returned.</p> +<h2 id="_modules">Modules</h2> +<ul><li><a href="cow_cookie">cow_cookie(3)</a> - Cookies +</li> +</ul> +<h2 id="_dependencies">Dependencies</h2> +<ul><li>crypto - Crypto functions +</li> +</ul> +<p>All these applications must be started before the <code>cowlib</code> application. To start Cowlib and all dependencies at once:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">cowlib</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_environment">Environment</h2> +<p>The <code>cowlib</code> application does not define any application environment configuration parameters.</p> +<h2 id="_see_also">See also</h2> +<p><a href="cowboy_app">cowboy(7)</a>, <a href="gun_app">gun(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowlib + 2.13 + Function Reference + +</h3> + +<ul> + + + <li><a href="/docs/en/cowlib/2.13/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowlib/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowlib/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowlib/2.8/manual">2.8</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/cowlib/2.8/manual/cow_cookie.parse_cookie/index.html b/docs/en/cowlib/2.8/manual/cow_cookie.parse_cookie/index.html index d861586e..25d0670f 100644 --- a/docs/en/cowlib/2.8/manual/cow_cookie.parse_cookie/index.html +++ b/docs/en/cowlib/2.8/manual/cow_cookie.parse_cookie/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.8/manual/cow_cookie.setcookie/index.html b/docs/en/cowlib/2.8/manual/cow_cookie.setcookie/index.html index fa95f06f..6388f74a 100644 --- a/docs/en/cowlib/2.8/manual/cow_cookie.setcookie/index.html +++ b/docs/en/cowlib/2.8/manual/cow_cookie.setcookie/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.8/manual/cow_cookie/index.html b/docs/en/cowlib/2.8/manual/cow_cookie/index.html index 06d5721b..30cd2984 100644 --- a/docs/en/cowlib/2.8/manual/cow_cookie/index.html +++ b/docs/en/cowlib/2.8/manual/cow_cookie/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.8/manual/cowlib_app/index.html b/docs/en/cowlib/2.8/manual/cowlib_app/index.html index 9474bb41..01c95e3e 100644 --- a/docs/en/cowlib/2.8/manual/cowlib_app/index.html +++ b/docs/en/cowlib/2.8/manual/cowlib_app/index.html @@ -118,6 +118,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.8/manual/index.html b/docs/en/cowlib/2.8/manual/index.html index 21e47a5a..1bda1855 100644 --- a/docs/en/cowlib/2.8/manual/index.html +++ b/docs/en/cowlib/2.8/manual/index.html @@ -118,6 +118,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.9/manual/cow_cookie.cookie/index.html b/docs/en/cowlib/2.9/manual/cow_cookie.cookie/index.html index 8bdaebca..7aaeb2db 100644 --- a/docs/en/cowlib/2.9/manual/cow_cookie.cookie/index.html +++ b/docs/en/cowlib/2.9/manual/cow_cookie.cookie/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.9/manual/cow_cookie.parse_cookie/index.html b/docs/en/cowlib/2.9/manual/cow_cookie.parse_cookie/index.html index 051056ca..e8cbae9f 100644 --- a/docs/en/cowlib/2.9/manual/cow_cookie.parse_cookie/index.html +++ b/docs/en/cowlib/2.9/manual/cow_cookie.parse_cookie/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.9/manual/cow_cookie.parse_set_cookie/index.html b/docs/en/cowlib/2.9/manual/cow_cookie.parse_set_cookie/index.html index bea78305..b81653db 100644 --- a/docs/en/cowlib/2.9/manual/cow_cookie.parse_set_cookie/index.html +++ b/docs/en/cowlib/2.9/manual/cow_cookie.parse_set_cookie/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.9/manual/cow_cookie.setcookie/index.html b/docs/en/cowlib/2.9/manual/cow_cookie.setcookie/index.html index 61360760..b8c9af99 100644 --- a/docs/en/cowlib/2.9/manual/cow_cookie.setcookie/index.html +++ b/docs/en/cowlib/2.9/manual/cow_cookie.setcookie/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.9/manual/cow_cookie/index.html b/docs/en/cowlib/2.9/manual/cow_cookie/index.html index c5919200..f0085793 100644 --- a/docs/en/cowlib/2.9/manual/cow_cookie/index.html +++ b/docs/en/cowlib/2.9/manual/cow_cookie/index.html @@ -168,6 +168,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.9/manual/cowlib_app/index.html b/docs/en/cowlib/2.9/manual/cowlib_app/index.html index 2dedccda..746623cb 100644 --- a/docs/en/cowlib/2.9/manual/cowlib_app/index.html +++ b/docs/en/cowlib/2.9/manual/cowlib_app/index.html @@ -118,6 +118,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/cowlib/2.9/manual/index.html b/docs/en/cowlib/2.9/manual/index.html index 1a987e7f..7ce83dca 100644 --- a/docs/en/cowlib/2.9/manual/index.html +++ b/docs/en/cowlib/2.9/manual/index.html @@ -118,6 +118,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/cowlib/2.13/manual">2.13</a></li> + <li><a href="/docs/en/cowlib/2.12/manual">2.12</a></li> <li><a href="/docs/en/cowlib/2.11/manual">2.11</a></li> diff --git a/docs/en/gun/1.0/guide/connect/index.html b/docs/en/gun/1.0/guide/connect/index.html index c057ba40..973f6954 100644 --- a/docs/en/gun/1.0/guide/connect/index.html +++ b/docs/en/gun/1.0/guide/connect/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.0/guide/http/index.html b/docs/en/gun/1.0/guide/http/index.html index 1d63a8b5..f160bd9d 100644 --- a/docs/en/gun/1.0/guide/http/index.html +++ b/docs/en/gun/1.0/guide/http/index.html @@ -390,6 +390,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.0/guide/index.html b/docs/en/gun/1.0/guide/index.html index 55223724..b797d9b7 100644 --- a/docs/en/gun/1.0/guide/index.html +++ b/docs/en/gun/1.0/guide/index.html @@ -109,6 +109,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.0/guide/introduction/index.html b/docs/en/gun/1.0/guide/introduction/index.html index 794e4f58..e7749cb1 100644 --- a/docs/en/gun/1.0/guide/introduction/index.html +++ b/docs/en/gun/1.0/guide/introduction/index.html @@ -142,6 +142,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.0/guide/protocols/index.html b/docs/en/gun/1.0/guide/protocols/index.html index 2453beda..c594cfb0 100644 --- a/docs/en/gun/1.0/guide/protocols/index.html +++ b/docs/en/gun/1.0/guide/protocols/index.html @@ -269,6 +269,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.0/guide/start/index.html b/docs/en/gun/1.0/guide/start/index.html index a835ef4b..b8e6b109 100644 --- a/docs/en/gun/1.0/guide/start/index.html +++ b/docs/en/gun/1.0/guide/start/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.0/guide/websocket/index.html b/docs/en/gun/1.0/guide/websocket/index.html index c7ff1bfa..3d2083a9 100644 --- a/docs/en/gun/1.0/guide/websocket/index.html +++ b/docs/en/gun/1.0/guide/websocket/index.html @@ -195,6 +195,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.await/index.html b/docs/en/gun/1.0/manual/gun.await/index.html index 38c00372..e90fec94 100644 --- a/docs/en/gun/1.0/manual/gun.await/index.html +++ b/docs/en/gun/1.0/manual/gun.await/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.await_body/index.html b/docs/en/gun/1.0/manual/gun.await_body/index.html index 988d540f..4cc9cab7 100644 --- a/docs/en/gun/1.0/manual/gun.await_body/index.html +++ b/docs/en/gun/1.0/manual/gun.await_body/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.await_up/index.html b/docs/en/gun/1.0/manual/gun.await_up/index.html index f3594eb0..bb3bd06e 100644 --- a/docs/en/gun/1.0/manual/gun.await_up/index.html +++ b/docs/en/gun/1.0/manual/gun.await_up/index.html @@ -151,6 +151,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.cancel/index.html b/docs/en/gun/1.0/manual/gun.cancel/index.html index ace61398..114b1e84 100644 --- a/docs/en/gun/1.0/manual/gun.cancel/index.html +++ b/docs/en/gun/1.0/manual/gun.cancel/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.close/index.html b/docs/en/gun/1.0/manual/gun.close/index.html index fecf6042..6e02e3c4 100644 --- a/docs/en/gun/1.0/manual/gun.close/index.html +++ b/docs/en/gun/1.0/manual/gun.close/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.data/index.html b/docs/en/gun/1.0/manual/gun.data/index.html index aec54299..f797f411 100644 --- a/docs/en/gun/1.0/manual/gun.data/index.html +++ b/docs/en/gun/1.0/manual/gun.data/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.delete/index.html b/docs/en/gun/1.0/manual/gun.delete/index.html index 4d3a979b..1ebe2473 100644 --- a/docs/en/gun/1.0/manual/gun.delete/index.html +++ b/docs/en/gun/1.0/manual/gun.delete/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.flush/index.html b/docs/en/gun/1.0/manual/gun.flush/index.html index 2d04bef9..a8c6d81c 100644 --- a/docs/en/gun/1.0/manual/gun.flush/index.html +++ b/docs/en/gun/1.0/manual/gun.flush/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.get/index.html b/docs/en/gun/1.0/manual/gun.get/index.html index 2b4f4c3c..7c05e2dc 100644 --- a/docs/en/gun/1.0/manual/gun.get/index.html +++ b/docs/en/gun/1.0/manual/gun.get/index.html @@ -160,6 +160,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.head/index.html b/docs/en/gun/1.0/manual/gun.head/index.html index 715169ec..7905d8da 100644 --- a/docs/en/gun/1.0/manual/gun.head/index.html +++ b/docs/en/gun/1.0/manual/gun.head/index.html @@ -162,6 +162,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.info/index.html b/docs/en/gun/1.0/manual/gun.info/index.html index 28a3cb4c..1574080b 100644 --- a/docs/en/gun/1.0/manual/gun.info/index.html +++ b/docs/en/gun/1.0/manual/gun.info/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.open/index.html b/docs/en/gun/1.0/manual/gun.open/index.html index 2af75b47..8964d71e 100644 --- a/docs/en/gun/1.0/manual/gun.open/index.html +++ b/docs/en/gun/1.0/manual/gun.open/index.html @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.open_unix/index.html b/docs/en/gun/1.0/manual/gun.open_unix/index.html index 7dbca0ba..56c54248 100644 --- a/docs/en/gun/1.0/manual/gun.open_unix/index.html +++ b/docs/en/gun/1.0/manual/gun.open_unix/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.options/index.html b/docs/en/gun/1.0/manual/gun.options/index.html index f920bb0e..863feed7 100644 --- a/docs/en/gun/1.0/manual/gun.options/index.html +++ b/docs/en/gun/1.0/manual/gun.options/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.patch/index.html b/docs/en/gun/1.0/manual/gun.patch/index.html index a3dc563c..faa86d7a 100644 --- a/docs/en/gun/1.0/manual/gun.patch/index.html +++ b/docs/en/gun/1.0/manual/gun.patch/index.html @@ -180,6 +180,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.post/index.html b/docs/en/gun/1.0/manual/gun.post/index.html index ba31f8e6..c7bb5f64 100644 --- a/docs/en/gun/1.0/manual/gun.post/index.html +++ b/docs/en/gun/1.0/manual/gun.post/index.html @@ -178,6 +178,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.put/index.html b/docs/en/gun/1.0/manual/gun.put/index.html index f9645b29..c7ae5ba8 100644 --- a/docs/en/gun/1.0/manual/gun.put/index.html +++ b/docs/en/gun/1.0/manual/gun.put/index.html @@ -178,6 +178,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.request/index.html b/docs/en/gun/1.0/manual/gun.request/index.html index 1daa1a23..0d73bf28 100644 --- a/docs/en/gun/1.0/manual/gun.request/index.html +++ b/docs/en/gun/1.0/manual/gun.request/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.ws_send/index.html b/docs/en/gun/1.0/manual/gun.ws_send/index.html index beb59ba0..6f7c575f 100644 --- a/docs/en/gun/1.0/manual/gun.ws_send/index.html +++ b/docs/en/gun/1.0/manual/gun.ws_send/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun.ws_upgrade/index.html b/docs/en/gun/1.0/manual/gun.ws_upgrade/index.html index 163261f3..11a6a3ad 100644 --- a/docs/en/gun/1.0/manual/gun.ws_upgrade/index.html +++ b/docs/en/gun/1.0/manual/gun.ws_upgrade/index.html @@ -170,6 +170,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun/index.html b/docs/en/gun/1.0/manual/gun/index.html index 8150357a..295daa52 100644 --- a/docs/en/gun/1.0/manual/gun/index.html +++ b/docs/en/gun/1.0/manual/gun/index.html @@ -308,6 +308,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun_app/index.html b/docs/en/gun/1.0/manual/gun_app/index.html index 94efcfb3..364069c8 100644 --- a/docs/en/gun/1.0/manual/gun_app/index.html +++ b/docs/en/gun/1.0/manual/gun_app/index.html @@ -122,6 +122,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun_data/index.html b/docs/en/gun/1.0/manual/gun_data/index.html index b837858e..bfd96bb5 100644 --- a/docs/en/gun/1.0/manual/gun_data/index.html +++ b/docs/en/gun/1.0/manual/gun_data/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun_down/index.html b/docs/en/gun/1.0/manual/gun_down/index.html index 9d16c942..df1ac7a6 100644 --- a/docs/en/gun/1.0/manual/gun_down/index.html +++ b/docs/en/gun/1.0/manual/gun_down/index.html @@ -152,6 +152,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun_error/index.html b/docs/en/gun/1.0/manual/gun_error/index.html index 0dd49d67..a01d149d 100644 --- a/docs/en/gun/1.0/manual/gun_error/index.html +++ b/docs/en/gun/1.0/manual/gun_error/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun_inform/index.html b/docs/en/gun/1.0/manual/gun_inform/index.html index 4e0d55c8..f0d01ed8 100644 --- a/docs/en/gun/1.0/manual/gun_inform/index.html +++ b/docs/en/gun/1.0/manual/gun_inform/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun_push/index.html b/docs/en/gun/1.0/manual/gun_push/index.html index 42652c60..f45e68de 100644 --- a/docs/en/gun/1.0/manual/gun_push/index.html +++ b/docs/en/gun/1.0/manual/gun_push/index.html @@ -165,6 +165,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun_response/index.html b/docs/en/gun/1.0/manual/gun_response/index.html index 59dce54b..ac02fefb 100644 --- a/docs/en/gun/1.0/manual/gun_response/index.html +++ b/docs/en/gun/1.0/manual/gun_response/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun_trailers/index.html b/docs/en/gun/1.0/manual/gun_trailers/index.html index 405ab7d8..a0efa6c2 100644 --- a/docs/en/gun/1.0/manual/gun_trailers/index.html +++ b/docs/en/gun/1.0/manual/gun_trailers/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun_up/index.html b/docs/en/gun/1.0/manual/gun_up/index.html index 8fe0cecf..3ad67af1 100644 --- a/docs/en/gun/1.0/manual/gun_up/index.html +++ b/docs/en/gun/1.0/manual/gun_up/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun_upgrade/index.html b/docs/en/gun/1.0/manual/gun_upgrade/index.html index e78961f2..b2974898 100644 --- a/docs/en/gun/1.0/manual/gun_upgrade/index.html +++ b/docs/en/gun/1.0/manual/gun_upgrade/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/gun_ws/index.html b/docs/en/gun/1.0/manual/gun_ws/index.html index 226a8dd6..47835d91 100644 --- a/docs/en/gun/1.0/manual/gun_ws/index.html +++ b/docs/en/gun/1.0/manual/gun_ws/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.0/manual/index.html b/docs/en/gun/1.0/manual/index.html index dd855506..68654b5c 100644 --- a/docs/en/gun/1.0/manual/index.html +++ b/docs/en/gun/1.0/manual/index.html @@ -122,6 +122,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/guide/connect/index.html b/docs/en/gun/1.1/guide/connect/index.html index 406da7b8..4f5519a7 100644 --- a/docs/en/gun/1.1/guide/connect/index.html +++ b/docs/en/gun/1.1/guide/connect/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.1/guide/http/index.html b/docs/en/gun/1.1/guide/http/index.html index 16ff0bf8..c9365d50 100644 --- a/docs/en/gun/1.1/guide/http/index.html +++ b/docs/en/gun/1.1/guide/http/index.html @@ -390,6 +390,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.1/guide/index.html b/docs/en/gun/1.1/guide/index.html index d2468d70..b18cb347 100644 --- a/docs/en/gun/1.1/guide/index.html +++ b/docs/en/gun/1.1/guide/index.html @@ -114,6 +114,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.1/guide/introduction/index.html b/docs/en/gun/1.1/guide/introduction/index.html index 06b9ae23..9410d163 100644 --- a/docs/en/gun/1.1/guide/introduction/index.html +++ b/docs/en/gun/1.1/guide/introduction/index.html @@ -142,6 +142,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.1/guide/migrating_from_1.0/index.html b/docs/en/gun/1.1/guide/migrating_from_1.0/index.html index 52808392..d9cd0f6e 100644 --- a/docs/en/gun/1.1/guide/migrating_from_1.0/index.html +++ b/docs/en/gun/1.1/guide/migrating_from_1.0/index.html @@ -127,6 +127,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.1/guide/protocols/index.html b/docs/en/gun/1.1/guide/protocols/index.html index 9bbd378d..d01e404a 100644 --- a/docs/en/gun/1.1/guide/protocols/index.html +++ b/docs/en/gun/1.1/guide/protocols/index.html @@ -269,6 +269,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.1/guide/start/index.html b/docs/en/gun/1.1/guide/start/index.html index 3456b4f3..65ec6c54 100644 --- a/docs/en/gun/1.1/guide/start/index.html +++ b/docs/en/gun/1.1/guide/start/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.1/guide/websocket/index.html b/docs/en/gun/1.1/guide/websocket/index.html index f74f5ff4..9247dfec 100644 --- a/docs/en/gun/1.1/guide/websocket/index.html +++ b/docs/en/gun/1.1/guide/websocket/index.html @@ -199,6 +199,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.await/index.html b/docs/en/gun/1.1/manual/gun.await/index.html index d9126ac9..651bb059 100644 --- a/docs/en/gun/1.1/manual/gun.await/index.html +++ b/docs/en/gun/1.1/manual/gun.await/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.await_body/index.html b/docs/en/gun/1.1/manual/gun.await_body/index.html index 660e4e45..8cf45022 100644 --- a/docs/en/gun/1.1/manual/gun.await_body/index.html +++ b/docs/en/gun/1.1/manual/gun.await_body/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.await_up/index.html b/docs/en/gun/1.1/manual/gun.await_up/index.html index 284432a3..82272568 100644 --- a/docs/en/gun/1.1/manual/gun.await_up/index.html +++ b/docs/en/gun/1.1/manual/gun.await_up/index.html @@ -151,6 +151,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.cancel/index.html b/docs/en/gun/1.1/manual/gun.cancel/index.html index e7b2cfba..8e9e20df 100644 --- a/docs/en/gun/1.1/manual/gun.cancel/index.html +++ b/docs/en/gun/1.1/manual/gun.cancel/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.close/index.html b/docs/en/gun/1.1/manual/gun.close/index.html index a0505db0..ddfdaec1 100644 --- a/docs/en/gun/1.1/manual/gun.close/index.html +++ b/docs/en/gun/1.1/manual/gun.close/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.data/index.html b/docs/en/gun/1.1/manual/gun.data/index.html index 9872bd74..f606872a 100644 --- a/docs/en/gun/1.1/manual/gun.data/index.html +++ b/docs/en/gun/1.1/manual/gun.data/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.delete/index.html b/docs/en/gun/1.1/manual/gun.delete/index.html index 1cc551b6..f0ea2f43 100644 --- a/docs/en/gun/1.1/manual/gun.delete/index.html +++ b/docs/en/gun/1.1/manual/gun.delete/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.flush/index.html b/docs/en/gun/1.1/manual/gun.flush/index.html index 8fced815..ac226bb2 100644 --- a/docs/en/gun/1.1/manual/gun.flush/index.html +++ b/docs/en/gun/1.1/manual/gun.flush/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.get/index.html b/docs/en/gun/1.1/manual/gun.get/index.html index e6062c13..29e1ce13 100644 --- a/docs/en/gun/1.1/manual/gun.get/index.html +++ b/docs/en/gun/1.1/manual/gun.get/index.html @@ -160,6 +160,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.head/index.html b/docs/en/gun/1.1/manual/gun.head/index.html index 3d41d703..a312d0b7 100644 --- a/docs/en/gun/1.1/manual/gun.head/index.html +++ b/docs/en/gun/1.1/manual/gun.head/index.html @@ -162,6 +162,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.info/index.html b/docs/en/gun/1.1/manual/gun.info/index.html index 8f467e78..8532e966 100644 --- a/docs/en/gun/1.1/manual/gun.info/index.html +++ b/docs/en/gun/1.1/manual/gun.info/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.open/index.html b/docs/en/gun/1.1/manual/gun.open/index.html index 6a9aa93d..e86ca70d 100644 --- a/docs/en/gun/1.1/manual/gun.open/index.html +++ b/docs/en/gun/1.1/manual/gun.open/index.html @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.open_unix/index.html b/docs/en/gun/1.1/manual/gun.open_unix/index.html index 8bb9430b..596c13e0 100644 --- a/docs/en/gun/1.1/manual/gun.open_unix/index.html +++ b/docs/en/gun/1.1/manual/gun.open_unix/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.options/index.html b/docs/en/gun/1.1/manual/gun.options/index.html index 8bfde262..abb09822 100644 --- a/docs/en/gun/1.1/manual/gun.options/index.html +++ b/docs/en/gun/1.1/manual/gun.options/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.patch/index.html b/docs/en/gun/1.1/manual/gun.patch/index.html index 3f68b750..f7d98c3c 100644 --- a/docs/en/gun/1.1/manual/gun.patch/index.html +++ b/docs/en/gun/1.1/manual/gun.patch/index.html @@ -180,6 +180,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.post/index.html b/docs/en/gun/1.1/manual/gun.post/index.html index f463441e..362b7973 100644 --- a/docs/en/gun/1.1/manual/gun.post/index.html +++ b/docs/en/gun/1.1/manual/gun.post/index.html @@ -178,6 +178,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.put/index.html b/docs/en/gun/1.1/manual/gun.put/index.html index c6248a73..6148b8d9 100644 --- a/docs/en/gun/1.1/manual/gun.put/index.html +++ b/docs/en/gun/1.1/manual/gun.put/index.html @@ -178,6 +178,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.request/index.html b/docs/en/gun/1.1/manual/gun.request/index.html index 456ffac2..3ff8675e 100644 --- a/docs/en/gun/1.1/manual/gun.request/index.html +++ b/docs/en/gun/1.1/manual/gun.request/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.ws_send/index.html b/docs/en/gun/1.1/manual/gun.ws_send/index.html index 3cc6ba28..be9bbd36 100644 --- a/docs/en/gun/1.1/manual/gun.ws_send/index.html +++ b/docs/en/gun/1.1/manual/gun.ws_send/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun.ws_upgrade/index.html b/docs/en/gun/1.1/manual/gun.ws_upgrade/index.html index 4e8b6367..e7c3a9ba 100644 --- a/docs/en/gun/1.1/manual/gun.ws_upgrade/index.html +++ b/docs/en/gun/1.1/manual/gun.ws_upgrade/index.html @@ -170,6 +170,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun/index.html b/docs/en/gun/1.1/manual/gun/index.html index 061c5d95..10c26dde 100644 --- a/docs/en/gun/1.1/manual/gun/index.html +++ b/docs/en/gun/1.1/manual/gun/index.html @@ -308,6 +308,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun_app/index.html b/docs/en/gun/1.1/manual/gun_app/index.html index 9454abf4..b3fe5ac7 100644 --- a/docs/en/gun/1.1/manual/gun_app/index.html +++ b/docs/en/gun/1.1/manual/gun_app/index.html @@ -122,6 +122,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun_data/index.html b/docs/en/gun/1.1/manual/gun_data/index.html index 3efa56e0..9fc5311a 100644 --- a/docs/en/gun/1.1/manual/gun_data/index.html +++ b/docs/en/gun/1.1/manual/gun_data/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun_down/index.html b/docs/en/gun/1.1/manual/gun_down/index.html index 470bcf6a..320c6c51 100644 --- a/docs/en/gun/1.1/manual/gun_down/index.html +++ b/docs/en/gun/1.1/manual/gun_down/index.html @@ -152,6 +152,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun_error/index.html b/docs/en/gun/1.1/manual/gun_error/index.html index 07f058fe..d6867d60 100644 --- a/docs/en/gun/1.1/manual/gun_error/index.html +++ b/docs/en/gun/1.1/manual/gun_error/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun_inform/index.html b/docs/en/gun/1.1/manual/gun_inform/index.html index 4f59db43..244103b7 100644 --- a/docs/en/gun/1.1/manual/gun_inform/index.html +++ b/docs/en/gun/1.1/manual/gun_inform/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun_push/index.html b/docs/en/gun/1.1/manual/gun_push/index.html index 5d15e40b..59f1fba7 100644 --- a/docs/en/gun/1.1/manual/gun_push/index.html +++ b/docs/en/gun/1.1/manual/gun_push/index.html @@ -165,6 +165,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun_response/index.html b/docs/en/gun/1.1/manual/gun_response/index.html index 90243f09..e4f84d91 100644 --- a/docs/en/gun/1.1/manual/gun_response/index.html +++ b/docs/en/gun/1.1/manual/gun_response/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun_trailers/index.html b/docs/en/gun/1.1/manual/gun_trailers/index.html index f485f8b0..f18010c1 100644 --- a/docs/en/gun/1.1/manual/gun_trailers/index.html +++ b/docs/en/gun/1.1/manual/gun_trailers/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun_up/index.html b/docs/en/gun/1.1/manual/gun_up/index.html index 3221ddc4..95ba7336 100644 --- a/docs/en/gun/1.1/manual/gun_up/index.html +++ b/docs/en/gun/1.1/manual/gun_up/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun_upgrade/index.html b/docs/en/gun/1.1/manual/gun_upgrade/index.html index 8bf68fbf..44b061cc 100644 --- a/docs/en/gun/1.1/manual/gun_upgrade/index.html +++ b/docs/en/gun/1.1/manual/gun_upgrade/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/gun_ws/index.html b/docs/en/gun/1.1/manual/gun_ws/index.html index 730a4afd..7e798393 100644 --- a/docs/en/gun/1.1/manual/gun_ws/index.html +++ b/docs/en/gun/1.1/manual/gun_ws/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.1/manual/index.html b/docs/en/gun/1.1/manual/index.html index 617e8915..3bb4e898 100644 --- a/docs/en/gun/1.1/manual/index.html +++ b/docs/en/gun/1.1/manual/index.html @@ -122,6 +122,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/guide/connect/index.html b/docs/en/gun/1.2/guide/connect/index.html index fbc2e247..c9f806ac 100644 --- a/docs/en/gun/1.2/guide/connect/index.html +++ b/docs/en/gun/1.2/guide/connect/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.2/guide/http/index.html b/docs/en/gun/1.2/guide/http/index.html index 86b58016..c300298c 100644 --- a/docs/en/gun/1.2/guide/http/index.html +++ b/docs/en/gun/1.2/guide/http/index.html @@ -390,6 +390,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.2/guide/index.html b/docs/en/gun/1.2/guide/index.html index d0d14bb3..8eebd780 100644 --- a/docs/en/gun/1.2/guide/index.html +++ b/docs/en/gun/1.2/guide/index.html @@ -116,6 +116,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.2/guide/introduction/index.html b/docs/en/gun/1.2/guide/introduction/index.html index 6c25c7fc..b9e64d9b 100644 --- a/docs/en/gun/1.2/guide/introduction/index.html +++ b/docs/en/gun/1.2/guide/introduction/index.html @@ -142,6 +142,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.2/guide/migrating_from_1.0/index.html b/docs/en/gun/1.2/guide/migrating_from_1.0/index.html index 3a9723a5..3cf21d25 100644 --- a/docs/en/gun/1.2/guide/migrating_from_1.0/index.html +++ b/docs/en/gun/1.2/guide/migrating_from_1.0/index.html @@ -127,6 +127,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.2/guide/migrating_from_1.1/index.html b/docs/en/gun/1.2/guide/migrating_from_1.1/index.html index 58b14aa2..b5e971ec 100644 --- a/docs/en/gun/1.2/guide/migrating_from_1.1/index.html +++ b/docs/en/gun/1.2/guide/migrating_from_1.1/index.html @@ -133,6 +133,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.2/guide/protocols/index.html b/docs/en/gun/1.2/guide/protocols/index.html index a6e420d7..1b2ffb5b 100644 --- a/docs/en/gun/1.2/guide/protocols/index.html +++ b/docs/en/gun/1.2/guide/protocols/index.html @@ -269,6 +269,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.2/guide/start/index.html b/docs/en/gun/1.2/guide/start/index.html index ced73698..1ea556c6 100644 --- a/docs/en/gun/1.2/guide/start/index.html +++ b/docs/en/gun/1.2/guide/start/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.2/guide/websocket/index.html b/docs/en/gun/1.2/guide/websocket/index.html index 0d2a3e89..fbfb8fe5 100644 --- a/docs/en/gun/1.2/guide/websocket/index.html +++ b/docs/en/gun/1.2/guide/websocket/index.html @@ -199,6 +199,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.await/index.html b/docs/en/gun/1.2/manual/gun.await/index.html index 8b704356..35bd4418 100644 --- a/docs/en/gun/1.2/manual/gun.await/index.html +++ b/docs/en/gun/1.2/manual/gun.await/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.await_body/index.html b/docs/en/gun/1.2/manual/gun.await_body/index.html index 0c209d4b..5dfeb05f 100644 --- a/docs/en/gun/1.2/manual/gun.await_body/index.html +++ b/docs/en/gun/1.2/manual/gun.await_body/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.await_up/index.html b/docs/en/gun/1.2/manual/gun.await_up/index.html index 653a0afe..e6e32889 100644 --- a/docs/en/gun/1.2/manual/gun.await_up/index.html +++ b/docs/en/gun/1.2/manual/gun.await_up/index.html @@ -151,6 +151,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.cancel/index.html b/docs/en/gun/1.2/manual/gun.cancel/index.html index 93d83c13..c971b5b5 100644 --- a/docs/en/gun/1.2/manual/gun.cancel/index.html +++ b/docs/en/gun/1.2/manual/gun.cancel/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.close/index.html b/docs/en/gun/1.2/manual/gun.close/index.html index f49cc4f1..a5f97a3d 100644 --- a/docs/en/gun/1.2/manual/gun.close/index.html +++ b/docs/en/gun/1.2/manual/gun.close/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.connect/index.html b/docs/en/gun/1.2/manual/gun.connect/index.html index 77c8f019..a8b9b363 100644 --- a/docs/en/gun/1.2/manual/gun.connect/index.html +++ b/docs/en/gun/1.2/manual/gun.connect/index.html @@ -190,6 +190,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.data/index.html b/docs/en/gun/1.2/manual/gun.data/index.html index 31b52b33..62d4d21c 100644 --- a/docs/en/gun/1.2/manual/gun.data/index.html +++ b/docs/en/gun/1.2/manual/gun.data/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.delete/index.html b/docs/en/gun/1.2/manual/gun.delete/index.html index 89019f53..59dd0ed6 100644 --- a/docs/en/gun/1.2/manual/gun.delete/index.html +++ b/docs/en/gun/1.2/manual/gun.delete/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.flush/index.html b/docs/en/gun/1.2/manual/gun.flush/index.html index 60e7bcc6..ef263146 100644 --- a/docs/en/gun/1.2/manual/gun.flush/index.html +++ b/docs/en/gun/1.2/manual/gun.flush/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.get/index.html b/docs/en/gun/1.2/manual/gun.get/index.html index 5fb2b40f..b38e5091 100644 --- a/docs/en/gun/1.2/manual/gun.get/index.html +++ b/docs/en/gun/1.2/manual/gun.get/index.html @@ -160,6 +160,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.head/index.html b/docs/en/gun/1.2/manual/gun.head/index.html index 01357bde..262e44eb 100644 --- a/docs/en/gun/1.2/manual/gun.head/index.html +++ b/docs/en/gun/1.2/manual/gun.head/index.html @@ -162,6 +162,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.info/index.html b/docs/en/gun/1.2/manual/gun.info/index.html index 75305b17..45f544ab 100644 --- a/docs/en/gun/1.2/manual/gun.info/index.html +++ b/docs/en/gun/1.2/manual/gun.info/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.open/index.html b/docs/en/gun/1.2/manual/gun.open/index.html index 12dff3a2..613f88d5 100644 --- a/docs/en/gun/1.2/manual/gun.open/index.html +++ b/docs/en/gun/1.2/manual/gun.open/index.html @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.open_unix/index.html b/docs/en/gun/1.2/manual/gun.open_unix/index.html index c320e5b7..43ba0d84 100644 --- a/docs/en/gun/1.2/manual/gun.open_unix/index.html +++ b/docs/en/gun/1.2/manual/gun.open_unix/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.options/index.html b/docs/en/gun/1.2/manual/gun.options/index.html index 8f2d8084..a58c6ecb 100644 --- a/docs/en/gun/1.2/manual/gun.options/index.html +++ b/docs/en/gun/1.2/manual/gun.options/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.patch/index.html b/docs/en/gun/1.2/manual/gun.patch/index.html index 8db854a5..3a1a72d1 100644 --- a/docs/en/gun/1.2/manual/gun.patch/index.html +++ b/docs/en/gun/1.2/manual/gun.patch/index.html @@ -180,6 +180,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.post/index.html b/docs/en/gun/1.2/manual/gun.post/index.html index 1f0029e9..336be965 100644 --- a/docs/en/gun/1.2/manual/gun.post/index.html +++ b/docs/en/gun/1.2/manual/gun.post/index.html @@ -178,6 +178,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.put/index.html b/docs/en/gun/1.2/manual/gun.put/index.html index a229eb3b..9d1a816a 100644 --- a/docs/en/gun/1.2/manual/gun.put/index.html +++ b/docs/en/gun/1.2/manual/gun.put/index.html @@ -178,6 +178,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.request/index.html b/docs/en/gun/1.2/manual/gun.request/index.html index 2a45d104..541e3865 100644 --- a/docs/en/gun/1.2/manual/gun.request/index.html +++ b/docs/en/gun/1.2/manual/gun.request/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.ws_send/index.html b/docs/en/gun/1.2/manual/gun.ws_send/index.html index f8ca9383..7aa0e504 100644 --- a/docs/en/gun/1.2/manual/gun.ws_send/index.html +++ b/docs/en/gun/1.2/manual/gun.ws_send/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun.ws_upgrade/index.html b/docs/en/gun/1.2/manual/gun.ws_upgrade/index.html index 38442659..d65ca896 100644 --- a/docs/en/gun/1.2/manual/gun.ws_upgrade/index.html +++ b/docs/en/gun/1.2/manual/gun.ws_upgrade/index.html @@ -170,6 +170,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun/index.html b/docs/en/gun/1.2/manual/gun/index.html index cde7ac5c..149a1391 100644 --- a/docs/en/gun/1.2/manual/gun/index.html +++ b/docs/en/gun/1.2/manual/gun/index.html @@ -356,6 +356,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun_app/index.html b/docs/en/gun/1.2/manual/gun_app/index.html index 8ed8d020..616b00f7 100644 --- a/docs/en/gun/1.2/manual/gun_app/index.html +++ b/docs/en/gun/1.2/manual/gun_app/index.html @@ -122,6 +122,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun_data/index.html b/docs/en/gun/1.2/manual/gun_data/index.html index 2bb6bb67..f3f0b3e8 100644 --- a/docs/en/gun/1.2/manual/gun_data/index.html +++ b/docs/en/gun/1.2/manual/gun_data/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun_down/index.html b/docs/en/gun/1.2/manual/gun_down/index.html index 43f573b1..df35f629 100644 --- a/docs/en/gun/1.2/manual/gun_down/index.html +++ b/docs/en/gun/1.2/manual/gun_down/index.html @@ -152,6 +152,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun_error/index.html b/docs/en/gun/1.2/manual/gun_error/index.html index b2c94cb0..01b7a02c 100644 --- a/docs/en/gun/1.2/manual/gun_error/index.html +++ b/docs/en/gun/1.2/manual/gun_error/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun_inform/index.html b/docs/en/gun/1.2/manual/gun_inform/index.html index 5a954ee5..d9636a71 100644 --- a/docs/en/gun/1.2/manual/gun_inform/index.html +++ b/docs/en/gun/1.2/manual/gun_inform/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun_push/index.html b/docs/en/gun/1.2/manual/gun_push/index.html index 2b4837c9..05e643cc 100644 --- a/docs/en/gun/1.2/manual/gun_push/index.html +++ b/docs/en/gun/1.2/manual/gun_push/index.html @@ -165,6 +165,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun_response/index.html b/docs/en/gun/1.2/manual/gun_response/index.html index e77c7cd0..79b03f29 100644 --- a/docs/en/gun/1.2/manual/gun_response/index.html +++ b/docs/en/gun/1.2/manual/gun_response/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun_trailers/index.html b/docs/en/gun/1.2/manual/gun_trailers/index.html index b21c463a..b8f01a5d 100644 --- a/docs/en/gun/1.2/manual/gun_trailers/index.html +++ b/docs/en/gun/1.2/manual/gun_trailers/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun_up/index.html b/docs/en/gun/1.2/manual/gun_up/index.html index d9031705..636e5d59 100644 --- a/docs/en/gun/1.2/manual/gun_up/index.html +++ b/docs/en/gun/1.2/manual/gun_up/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun_upgrade/index.html b/docs/en/gun/1.2/manual/gun_upgrade/index.html index eb30b5db..db941a54 100644 --- a/docs/en/gun/1.2/manual/gun_upgrade/index.html +++ b/docs/en/gun/1.2/manual/gun_upgrade/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/gun_ws/index.html b/docs/en/gun/1.2/manual/gun_ws/index.html index 7cab02fb..3b1b6511 100644 --- a/docs/en/gun/1.2/manual/gun_ws/index.html +++ b/docs/en/gun/1.2/manual/gun_ws/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.2/manual/index.html b/docs/en/gun/1.2/manual/index.html index 9d08e36a..88974967 100644 --- a/docs/en/gun/1.2/manual/index.html +++ b/docs/en/gun/1.2/manual/index.html @@ -122,6 +122,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/guide/connect/index.html b/docs/en/gun/1.3/guide/connect/index.html index 178f7c9a..4623177a 100644 --- a/docs/en/gun/1.3/guide/connect/index.html +++ b/docs/en/gun/1.3/guide/connect/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.3/guide/http/index.html b/docs/en/gun/1.3/guide/http/index.html index 9de2dfaf..4f34020e 100644 --- a/docs/en/gun/1.3/guide/http/index.html +++ b/docs/en/gun/1.3/guide/http/index.html @@ -390,6 +390,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.3/guide/index.html b/docs/en/gun/1.3/guide/index.html index 4d840ea5..22225274 100644 --- a/docs/en/gun/1.3/guide/index.html +++ b/docs/en/gun/1.3/guide/index.html @@ -120,6 +120,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.3/guide/introduction/index.html b/docs/en/gun/1.3/guide/introduction/index.html index 31ce9f05..7b8ee38e 100644 --- a/docs/en/gun/1.3/guide/introduction/index.html +++ b/docs/en/gun/1.3/guide/introduction/index.html @@ -142,6 +142,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.3/guide/migrating_from_1.0/index.html b/docs/en/gun/1.3/guide/migrating_from_1.0/index.html index 1215f965..89496439 100644 --- a/docs/en/gun/1.3/guide/migrating_from_1.0/index.html +++ b/docs/en/gun/1.3/guide/migrating_from_1.0/index.html @@ -127,6 +127,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.3/guide/migrating_from_1.1/index.html b/docs/en/gun/1.3/guide/migrating_from_1.1/index.html index 9b0bfbae..177bd479 100644 --- a/docs/en/gun/1.3/guide/migrating_from_1.1/index.html +++ b/docs/en/gun/1.3/guide/migrating_from_1.1/index.html @@ -133,6 +133,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.3/guide/migrating_from_1.2/index.html b/docs/en/gun/1.3/guide/migrating_from_1.2/index.html index 534f80b9..b57e792f 100644 --- a/docs/en/gun/1.3/guide/migrating_from_1.2/index.html +++ b/docs/en/gun/1.3/guide/migrating_from_1.2/index.html @@ -143,6 +143,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.3/guide/migrating_from_1.3/index.html b/docs/en/gun/1.3/guide/migrating_from_1.3/index.html index 09c92159..76cd092b 100644 --- a/docs/en/gun/1.3/guide/migrating_from_1.3/index.html +++ b/docs/en/gun/1.3/guide/migrating_from_1.3/index.html @@ -124,6 +124,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.3/guide/protocols/index.html b/docs/en/gun/1.3/guide/protocols/index.html index 32cc3e19..3434a21c 100644 --- a/docs/en/gun/1.3/guide/protocols/index.html +++ b/docs/en/gun/1.3/guide/protocols/index.html @@ -269,6 +269,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.3/guide/start/index.html b/docs/en/gun/1.3/guide/start/index.html index ffe60dc2..9ab8ce4e 100644 --- a/docs/en/gun/1.3/guide/start/index.html +++ b/docs/en/gun/1.3/guide/start/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.3/guide/websocket/index.html b/docs/en/gun/1.3/guide/websocket/index.html index 52ad70d3..28119678 100644 --- a/docs/en/gun/1.3/guide/websocket/index.html +++ b/docs/en/gun/1.3/guide/websocket/index.html @@ -209,6 +209,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.await/index.html b/docs/en/gun/1.3/manual/gun.await/index.html index 3635352d..1b152a50 100644 --- a/docs/en/gun/1.3/manual/gun.await/index.html +++ b/docs/en/gun/1.3/manual/gun.await/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.await_body/index.html b/docs/en/gun/1.3/manual/gun.await_body/index.html index 22f3a957..8d9254ae 100644 --- a/docs/en/gun/1.3/manual/gun.await_body/index.html +++ b/docs/en/gun/1.3/manual/gun.await_body/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.await_up/index.html b/docs/en/gun/1.3/manual/gun.await_up/index.html index d34e3b65..b30ce834 100644 --- a/docs/en/gun/1.3/manual/gun.await_up/index.html +++ b/docs/en/gun/1.3/manual/gun.await_up/index.html @@ -151,6 +151,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.cancel/index.html b/docs/en/gun/1.3/manual/gun.cancel/index.html index db0ad23a..8dd9b60d 100644 --- a/docs/en/gun/1.3/manual/gun.cancel/index.html +++ b/docs/en/gun/1.3/manual/gun.cancel/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.close/index.html b/docs/en/gun/1.3/manual/gun.close/index.html index 0623dbe8..ea4d8088 100644 --- a/docs/en/gun/1.3/manual/gun.close/index.html +++ b/docs/en/gun/1.3/manual/gun.close/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.connect/index.html b/docs/en/gun/1.3/manual/gun.connect/index.html index 1a96d2eb..6b5bff42 100644 --- a/docs/en/gun/1.3/manual/gun.connect/index.html +++ b/docs/en/gun/1.3/manual/gun.connect/index.html @@ -190,6 +190,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.data/index.html b/docs/en/gun/1.3/manual/gun.data/index.html index c7ad077d..c90288e6 100644 --- a/docs/en/gun/1.3/manual/gun.data/index.html +++ b/docs/en/gun/1.3/manual/gun.data/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.delete/index.html b/docs/en/gun/1.3/manual/gun.delete/index.html index 45086edd..2825f5f2 100644 --- a/docs/en/gun/1.3/manual/gun.delete/index.html +++ b/docs/en/gun/1.3/manual/gun.delete/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.flush/index.html b/docs/en/gun/1.3/manual/gun.flush/index.html index 001e627d..e7d3399c 100644 --- a/docs/en/gun/1.3/manual/gun.flush/index.html +++ b/docs/en/gun/1.3/manual/gun.flush/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.get/index.html b/docs/en/gun/1.3/manual/gun.get/index.html index 06a2cd32..7800e31f 100644 --- a/docs/en/gun/1.3/manual/gun.get/index.html +++ b/docs/en/gun/1.3/manual/gun.get/index.html @@ -160,6 +160,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.head/index.html b/docs/en/gun/1.3/manual/gun.head/index.html index ddce5ff9..7bf23809 100644 --- a/docs/en/gun/1.3/manual/gun.head/index.html +++ b/docs/en/gun/1.3/manual/gun.head/index.html @@ -162,6 +162,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.info/index.html b/docs/en/gun/1.3/manual/gun.info/index.html index b1e505d8..c50cbf21 100644 --- a/docs/en/gun/1.3/manual/gun.info/index.html +++ b/docs/en/gun/1.3/manual/gun.info/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.open/index.html b/docs/en/gun/1.3/manual/gun.open/index.html index 8052cd1c..a55d7b34 100644 --- a/docs/en/gun/1.3/manual/gun.open/index.html +++ b/docs/en/gun/1.3/manual/gun.open/index.html @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.open_unix/index.html b/docs/en/gun/1.3/manual/gun.open_unix/index.html index aaed5ffb..8f6d5f35 100644 --- a/docs/en/gun/1.3/manual/gun.open_unix/index.html +++ b/docs/en/gun/1.3/manual/gun.open_unix/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.options/index.html b/docs/en/gun/1.3/manual/gun.options/index.html index e549ca8a..6e17fbb8 100644 --- a/docs/en/gun/1.3/manual/gun.options/index.html +++ b/docs/en/gun/1.3/manual/gun.options/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.patch/index.html b/docs/en/gun/1.3/manual/gun.patch/index.html index 449c21ef..077f1116 100644 --- a/docs/en/gun/1.3/manual/gun.patch/index.html +++ b/docs/en/gun/1.3/manual/gun.patch/index.html @@ -180,6 +180,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.post/index.html b/docs/en/gun/1.3/manual/gun.post/index.html index e0252225..17c50bc1 100644 --- a/docs/en/gun/1.3/manual/gun.post/index.html +++ b/docs/en/gun/1.3/manual/gun.post/index.html @@ -178,6 +178,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.put/index.html b/docs/en/gun/1.3/manual/gun.put/index.html index e9f407d3..9974b335 100644 --- a/docs/en/gun/1.3/manual/gun.put/index.html +++ b/docs/en/gun/1.3/manual/gun.put/index.html @@ -178,6 +178,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.request/index.html b/docs/en/gun/1.3/manual/gun.request/index.html index fca9193c..49488969 100644 --- a/docs/en/gun/1.3/manual/gun.request/index.html +++ b/docs/en/gun/1.3/manual/gun.request/index.html @@ -164,6 +164,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.ws_send/index.html b/docs/en/gun/1.3/manual/gun.ws_send/index.html index 82ec08f7..11d0e8a4 100644 --- a/docs/en/gun/1.3/manual/gun.ws_send/index.html +++ b/docs/en/gun/1.3/manual/gun.ws_send/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun.ws_upgrade/index.html b/docs/en/gun/1.3/manual/gun.ws_upgrade/index.html index e5b9c4ac..d54d5e41 100644 --- a/docs/en/gun/1.3/manual/gun.ws_upgrade/index.html +++ b/docs/en/gun/1.3/manual/gun.ws_upgrade/index.html @@ -170,6 +170,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun/index.html b/docs/en/gun/1.3/manual/gun/index.html index 894b82c1..b70b2dce 100644 --- a/docs/en/gun/1.3/manual/gun/index.html +++ b/docs/en/gun/1.3/manual/gun/index.html @@ -362,6 +362,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun_app/index.html b/docs/en/gun/1.3/manual/gun_app/index.html index 5d6e218b..160f39ce 100644 --- a/docs/en/gun/1.3/manual/gun_app/index.html +++ b/docs/en/gun/1.3/manual/gun_app/index.html @@ -122,6 +122,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun_data/index.html b/docs/en/gun/1.3/manual/gun_data/index.html index b79f4b13..82b3f0d6 100644 --- a/docs/en/gun/1.3/manual/gun_data/index.html +++ b/docs/en/gun/1.3/manual/gun_data/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun_down/index.html b/docs/en/gun/1.3/manual/gun_down/index.html index 4d4072b3..1b13aff3 100644 --- a/docs/en/gun/1.3/manual/gun_down/index.html +++ b/docs/en/gun/1.3/manual/gun_down/index.html @@ -152,6 +152,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun_error/index.html b/docs/en/gun/1.3/manual/gun_error/index.html index cd1f8ec4..bb7c0154 100644 --- a/docs/en/gun/1.3/manual/gun_error/index.html +++ b/docs/en/gun/1.3/manual/gun_error/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun_inform/index.html b/docs/en/gun/1.3/manual/gun_inform/index.html index 14d31c47..84f5123a 100644 --- a/docs/en/gun/1.3/manual/gun_inform/index.html +++ b/docs/en/gun/1.3/manual/gun_inform/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun_push/index.html b/docs/en/gun/1.3/manual/gun_push/index.html index 47f926f6..29767245 100644 --- a/docs/en/gun/1.3/manual/gun_push/index.html +++ b/docs/en/gun/1.3/manual/gun_push/index.html @@ -165,6 +165,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun_response/index.html b/docs/en/gun/1.3/manual/gun_response/index.html index 74a6a136..0d242cca 100644 --- a/docs/en/gun/1.3/manual/gun_response/index.html +++ b/docs/en/gun/1.3/manual/gun_response/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun_trailers/index.html b/docs/en/gun/1.3/manual/gun_trailers/index.html index a07165cf..3ec374b6 100644 --- a/docs/en/gun/1.3/manual/gun_trailers/index.html +++ b/docs/en/gun/1.3/manual/gun_trailers/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun_up/index.html b/docs/en/gun/1.3/manual/gun_up/index.html index b9e66753..27942792 100644 --- a/docs/en/gun/1.3/manual/gun_up/index.html +++ b/docs/en/gun/1.3/manual/gun_up/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun_upgrade/index.html b/docs/en/gun/1.3/manual/gun_upgrade/index.html index b452c83b..6f550571 100644 --- a/docs/en/gun/1.3/manual/gun_upgrade/index.html +++ b/docs/en/gun/1.3/manual/gun_upgrade/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/gun_ws/index.html b/docs/en/gun/1.3/manual/gun_ws/index.html index dfd98510..a32074c3 100644 --- a/docs/en/gun/1.3/manual/gun_ws/index.html +++ b/docs/en/gun/1.3/manual/gun_ws/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/1.3/manual/index.html b/docs/en/gun/1.3/manual/index.html index 730f347f..c64239f4 100644 --- a/docs/en/gun/1.3/manual/index.html +++ b/docs/en/gun/1.3/manual/index.html @@ -122,6 +122,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/guide/connect/index.html b/docs/en/gun/2.0/guide/connect/index.html index ca76c021..a0eb61b9 100644 --- a/docs/en/gun/2.0/guide/connect/index.html +++ b/docs/en/gun/2.0/guide/connect/index.html @@ -216,6 +216,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/2.0/guide/http/index.html b/docs/en/gun/2.0/guide/http/index.html index bf50805a..1ba1fcf1 100644 --- a/docs/en/gun/2.0/guide/http/index.html +++ b/docs/en/gun/2.0/guide/http/index.html @@ -390,6 +390,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/2.0/guide/index.html b/docs/en/gun/2.0/guide/index.html index 19353a5f..af9d2e31 100644 --- a/docs/en/gun/2.0/guide/index.html +++ b/docs/en/gun/2.0/guide/index.html @@ -126,6 +126,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/2.0/guide/internals_tls_over_tls/index.html b/docs/en/gun/2.0/guide/internals_tls_over_tls/index.html index 0c672220..4f66ec05 100644 --- a/docs/en/gun/2.0/guide/internals_tls_over_tls/index.html +++ b/docs/en/gun/2.0/guide/internals_tls_over_tls/index.html @@ -160,6 +160,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/2.0/guide/introduction/index.html b/docs/en/gun/2.0/guide/introduction/index.html index be153533..7fa188bd 100644 --- a/docs/en/gun/2.0/guide/introduction/index.html +++ b/docs/en/gun/2.0/guide/introduction/index.html @@ -141,6 +141,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/2.0/guide/migrating_from_1.0/index.html b/docs/en/gun/2.0/guide/migrating_from_1.0/index.html index b3f3f3b3..8780c635 100644 --- a/docs/en/gun/2.0/guide/migrating_from_1.0/index.html +++ b/docs/en/gun/2.0/guide/migrating_from_1.0/index.html @@ -127,6 +127,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/2.0/guide/migrating_from_1.1/index.html b/docs/en/gun/2.0/guide/migrating_from_1.1/index.html index 564e5b3a..3eee31f0 100644 --- a/docs/en/gun/2.0/guide/migrating_from_1.1/index.html +++ b/docs/en/gun/2.0/guide/migrating_from_1.1/index.html @@ -133,6 +133,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/2.0/guide/migrating_from_1.2/index.html b/docs/en/gun/2.0/guide/migrating_from_1.2/index.html index ddaab2d4..8c5af4fe 100644 --- a/docs/en/gun/2.0/guide/migrating_from_1.2/index.html +++ b/docs/en/gun/2.0/guide/migrating_from_1.2/index.html @@ -143,6 +143,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/2.0/guide/migrating_from_1.3/index.html b/docs/en/gun/2.0/guide/migrating_from_1.3/index.html index e6d176d5..ed970fb3 100644 --- a/docs/en/gun/2.0/guide/migrating_from_1.3/index.html +++ b/docs/en/gun/2.0/guide/migrating_from_1.3/index.html @@ -275,6 +275,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/2.0/guide/migrating_from_2.0/index.html b/docs/en/gun/2.0/guide/migrating_from_2.0/index.html index 27ef9222..ba1b88a8 100644 --- a/docs/en/gun/2.0/guide/migrating_from_2.0/index.html +++ b/docs/en/gun/2.0/guide/migrating_from_2.0/index.html @@ -122,6 +122,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/2.0/guide/protocols/index.html b/docs/en/gun/2.0/guide/protocols/index.html index 135b734e..d27c2416 100644 --- a/docs/en/gun/2.0/guide/protocols/index.html +++ b/docs/en/gun/2.0/guide/protocols/index.html @@ -267,6 +267,8 @@ + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/2.0/guide/start/index.html b/docs/en/gun/2.0/guide/start/index.html index dcff2a51..62caeed4 100644 --- a/docs/en/gun/2.0/guide/start/index.html +++ b/docs/en/gun/2.0/guide/start/index.html @@ -144,6 +144,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/2.0/guide/websocket/index.html b/docs/en/gun/2.0/guide/websocket/index.html index f952ad39..49884142 100644 --- a/docs/en/gun/2.0/guide/websocket/index.html +++ b/docs/en/gun/2.0/guide/websocket/index.html @@ -202,6 +202,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.await/index.html b/docs/en/gun/2.0/manual/gun.await/index.html index d56eb283..1b55f001 100644 --- a/docs/en/gun/2.0/manual/gun.await/index.html +++ b/docs/en/gun/2.0/manual/gun.await/index.html @@ -194,6 +194,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.await_body/index.html b/docs/en/gun/2.0/manual/gun.await_body/index.html index 4713df20..b65ec566 100644 --- a/docs/en/gun/2.0/manual/gun.await_body/index.html +++ b/docs/en/gun/2.0/manual/gun.await_body/index.html @@ -162,6 +162,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.await_up/index.html b/docs/en/gun/2.0/manual/gun.await_up/index.html index 2c922837..9833b403 100644 --- a/docs/en/gun/2.0/manual/gun.await_up/index.html +++ b/docs/en/gun/2.0/manual/gun.await_up/index.html @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.cancel/index.html b/docs/en/gun/2.0/manual/gun.cancel/index.html index 971150a5..2fa4739e 100644 --- a/docs/en/gun/2.0/manual/gun.cancel/index.html +++ b/docs/en/gun/2.0/manual/gun.cancel/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.close/index.html b/docs/en/gun/2.0/manual/gun.close/index.html index 2295095a..9f1c2537 100644 --- a/docs/en/gun/2.0/manual/gun.close/index.html +++ b/docs/en/gun/2.0/manual/gun.close/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.connect/index.html b/docs/en/gun/2.0/manual/gun.connect/index.html index 555b0586..ff0f348f 100644 --- a/docs/en/gun/2.0/manual/gun.connect/index.html +++ b/docs/en/gun/2.0/manual/gun.connect/index.html @@ -190,6 +190,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.data/index.html b/docs/en/gun/2.0/manual/gun.data/index.html index f86e7921..944b87d8 100644 --- a/docs/en/gun/2.0/manual/gun.data/index.html +++ b/docs/en/gun/2.0/manual/gun.data/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.delete/index.html b/docs/en/gun/2.0/manual/gun.delete/index.html index a1979aa5..c2bd9841 100644 --- a/docs/en/gun/2.0/manual/gun.delete/index.html +++ b/docs/en/gun/2.0/manual/gun.delete/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.flush/index.html b/docs/en/gun/2.0/manual/gun.flush/index.html index 5ef4226c..bf3eaff1 100644 --- a/docs/en/gun/2.0/manual/gun.flush/index.html +++ b/docs/en/gun/2.0/manual/gun.flush/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.get/index.html b/docs/en/gun/2.0/manual/gun.get/index.html index a51367a7..853c11b1 100644 --- a/docs/en/gun/2.0/manual/gun.get/index.html +++ b/docs/en/gun/2.0/manual/gun.get/index.html @@ -160,6 +160,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.head/index.html b/docs/en/gun/2.0/manual/gun.head/index.html index e1c62c10..e9695a9c 100644 --- a/docs/en/gun/2.0/manual/gun.head/index.html +++ b/docs/en/gun/2.0/manual/gun.head/index.html @@ -162,6 +162,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.headers/index.html b/docs/en/gun/2.0/manual/gun.headers/index.html index 6103f749..34827382 100644 --- a/docs/en/gun/2.0/manual/gun.headers/index.html +++ b/docs/en/gun/2.0/manual/gun.headers/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.info/index.html b/docs/en/gun/2.0/manual/gun.info/index.html index 2eb09ca8..b3d58161 100644 --- a/docs/en/gun/2.0/manual/gun.info/index.html +++ b/docs/en/gun/2.0/manual/gun.info/index.html @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.open/index.html b/docs/en/gun/2.0/manual/gun.open/index.html index 554687b7..fa5b24b4 100644 --- a/docs/en/gun/2.0/manual/gun.open/index.html +++ b/docs/en/gun/2.0/manual/gun.open/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.open_unix/index.html b/docs/en/gun/2.0/manual/gun.open_unix/index.html index a9b3b33f..4cfedbef 100644 --- a/docs/en/gun/2.0/manual/gun.open_unix/index.html +++ b/docs/en/gun/2.0/manual/gun.open_unix/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.options/index.html b/docs/en/gun/2.0/manual/gun.options/index.html index f0cc5887..8dc5e332 100644 --- a/docs/en/gun/2.0/manual/gun.options/index.html +++ b/docs/en/gun/2.0/manual/gun.options/index.html @@ -157,6 +157,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.patch/index.html b/docs/en/gun/2.0/manual/gun.patch/index.html index 92457fa3..f84c6cb1 100644 --- a/docs/en/gun/2.0/manual/gun.patch/index.html +++ b/docs/en/gun/2.0/manual/gun.patch/index.html @@ -185,6 +185,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.post/index.html b/docs/en/gun/2.0/manual/gun.post/index.html index d1a5ed86..303070bc 100644 --- a/docs/en/gun/2.0/manual/gun.post/index.html +++ b/docs/en/gun/2.0/manual/gun.post/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.put/index.html b/docs/en/gun/2.0/manual/gun.put/index.html index 22479544..6ea87f72 100644 --- a/docs/en/gun/2.0/manual/gun.put/index.html +++ b/docs/en/gun/2.0/manual/gun.put/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.request/index.html b/docs/en/gun/2.0/manual/gun.request/index.html index c5afcbfc..5735195f 100644 --- a/docs/en/gun/2.0/manual/gun.request/index.html +++ b/docs/en/gun/2.0/manual/gun.request/index.html @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.set_owner/index.html b/docs/en/gun/2.0/manual/gun.set_owner/index.html index 7b1a078f..8463d0e7 100644 --- a/docs/en/gun/2.0/manual/gun.set_owner/index.html +++ b/docs/en/gun/2.0/manual/gun.set_owner/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.shutdown/index.html b/docs/en/gun/2.0/manual/gun.shutdown/index.html index 3f08ec1d..1c1211cf 100644 --- a/docs/en/gun/2.0/manual/gun.shutdown/index.html +++ b/docs/en/gun/2.0/manual/gun.shutdown/index.html @@ -139,6 +139,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.stream_info/index.html b/docs/en/gun/2.0/manual/gun.stream_info/index.html index 326aa677..bf2110b5 100644 --- a/docs/en/gun/2.0/manual/gun.stream_info/index.html +++ b/docs/en/gun/2.0/manual/gun.stream_info/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.update_flow/index.html b/docs/en/gun/2.0/manual/gun.update_flow/index.html index ffd97353..9fbd1efa 100644 --- a/docs/en/gun/2.0/manual/gun.update_flow/index.html +++ b/docs/en/gun/2.0/manual/gun.update_flow/index.html @@ -139,6 +139,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.ws_send/index.html b/docs/en/gun/2.0/manual/gun.ws_send/index.html index 5ba82e60..b3b5cd05 100644 --- a/docs/en/gun/2.0/manual/gun.ws_send/index.html +++ b/docs/en/gun/2.0/manual/gun.ws_send/index.html @@ -155,6 +155,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun.ws_upgrade/index.html b/docs/en/gun/2.0/manual/gun.ws_upgrade/index.html index 740809a5..de6756cf 100644 --- a/docs/en/gun/2.0/manual/gun.ws_upgrade/index.html +++ b/docs/en/gun/2.0/manual/gun.ws_upgrade/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun/index.html b/docs/en/gun/2.0/manual/gun/index.html index 4bbbe760..41dc02b9 100644 --- a/docs/en/gun/2.0/manual/gun/index.html +++ b/docs/en/gun/2.0/manual/gun/index.html @@ -597,6 +597,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_app/index.html b/docs/en/gun/2.0/manual/gun_app/index.html index 04adf1b2..e268812a 100644 --- a/docs/en/gun/2.0/manual/gun_app/index.html +++ b/docs/en/gun/2.0/manual/gun_app/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_cookies.domain_match/index.html b/docs/en/gun/2.0/manual/gun_cookies.domain_match/index.html index f0b12616..5b9fb769 100644 --- a/docs/en/gun/2.0/manual/gun_cookies.domain_match/index.html +++ b/docs/en/gun/2.0/manual/gun_cookies.domain_match/index.html @@ -134,6 +134,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_cookies.path_match/index.html b/docs/en/gun/2.0/manual/gun_cookies.path_match/index.html index 1d4222c7..9d53282d 100644 --- a/docs/en/gun/2.0/manual/gun_cookies.path_match/index.html +++ b/docs/en/gun/2.0/manual/gun_cookies.path_match/index.html @@ -134,6 +134,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_cookies/index.html b/docs/en/gun/2.0/manual/gun_cookies/index.html index 8c24282b..4d2595a2 100644 --- a/docs/en/gun/2.0/manual/gun_cookies/index.html +++ b/docs/en/gun/2.0/manual/gun_cookies/index.html @@ -233,6 +233,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_cookies_list/index.html b/docs/en/gun/2.0/manual/gun_cookies_list/index.html index 973b5c0d..a2e6d207 100644 --- a/docs/en/gun/2.0/manual/gun_cookies_list/index.html +++ b/docs/en/gun/2.0/manual/gun_cookies_list/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_data/index.html b/docs/en/gun/2.0/manual/gun_data/index.html index cc177d8c..b5fa189d 100644 --- a/docs/en/gun/2.0/manual/gun_data/index.html +++ b/docs/en/gun/2.0/manual/gun_data/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_down/index.html b/docs/en/gun/2.0/manual/gun_down/index.html index 5deecf4d..d2f1370f 100644 --- a/docs/en/gun/2.0/manual/gun_down/index.html +++ b/docs/en/gun/2.0/manual/gun_down/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_error/index.html b/docs/en/gun/2.0/manual/gun_error/index.html index c4b3ea03..b83d346a 100644 --- a/docs/en/gun/2.0/manual/gun_error/index.html +++ b/docs/en/gun/2.0/manual/gun_error/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_event/index.html b/docs/en/gun/2.0/manual/gun_event/index.html index 69f521df..bafd6e13 100644 --- a/docs/en/gun/2.0/manual/gun_event/index.html +++ b/docs/en/gun/2.0/manual/gun_event/index.html @@ -512,6 +512,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_inform/index.html b/docs/en/gun/2.0/manual/gun_inform/index.html index fa4c6348..bbc7e836 100644 --- a/docs/en/gun/2.0/manual/gun_inform/index.html +++ b/docs/en/gun/2.0/manual/gun_inform/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_push/index.html b/docs/en/gun/2.0/manual/gun_push/index.html index 51364fdc..f3930b05 100644 --- a/docs/en/gun/2.0/manual/gun_push/index.html +++ b/docs/en/gun/2.0/manual/gun_push/index.html @@ -165,6 +165,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_response/index.html b/docs/en/gun/2.0/manual/gun_response/index.html index 29e34041..086388d2 100644 --- a/docs/en/gun/2.0/manual/gun_response/index.html +++ b/docs/en/gun/2.0/manual/gun_response/index.html @@ -148,6 +148,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_trailers/index.html b/docs/en/gun/2.0/manual/gun_trailers/index.html index fda6a656..80b8f7c1 100644 --- a/docs/en/gun/2.0/manual/gun_trailers/index.html +++ b/docs/en/gun/2.0/manual/gun_trailers/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_tunnel_up/index.html b/docs/en/gun/2.0/manual/gun_tunnel_up/index.html index 9fcf952d..749945ea 100644 --- a/docs/en/gun/2.0/manual/gun_tunnel_up/index.html +++ b/docs/en/gun/2.0/manual/gun_tunnel_up/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_up/index.html b/docs/en/gun/2.0/manual/gun_up/index.html index fa87b7d7..8f37e7f5 100644 --- a/docs/en/gun/2.0/manual/gun_up/index.html +++ b/docs/en/gun/2.0/manual/gun_up/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_upgrade/index.html b/docs/en/gun/2.0/manual/gun_upgrade/index.html index 3fafdc45..52ad602a 100644 --- a/docs/en/gun/2.0/manual/gun_upgrade/index.html +++ b/docs/en/gun/2.0/manual/gun_upgrade/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_ws/index.html b/docs/en/gun/2.0/manual/gun_ws/index.html index 9cf3102b..10f21e2a 100644 --- a/docs/en/gun/2.0/manual/gun_ws/index.html +++ b/docs/en/gun/2.0/manual/gun_ws/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/gun_ws_protocol/index.html b/docs/en/gun/2.0/manual/gun_ws_protocol/index.html index 783fc4a8..31592f2c 100644 --- a/docs/en/gun/2.0/manual/gun_ws_protocol/index.html +++ b/docs/en/gun/2.0/manual/gun_ws_protocol/index.html @@ -171,6 +171,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.0/manual/index.html b/docs/en/gun/2.0/manual/index.html index b615bd35..cac11756 100644 --- a/docs/en/gun/2.0/manual/index.html +++ b/docs/en/gun/2.0/manual/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> diff --git a/docs/en/gun/2.1/guide/connect.asciidoc b/docs/en/gun/2.1/guide/connect.asciidoc new file mode 100644 index 00000000..08f8db29 --- /dev/null +++ b/docs/en/gun/2.1/guide/connect.asciidoc @@ -0,0 +1,166 @@ +[[connect]] +== Connection + +This chapter describes how to open, monitor and close +a connection using the Gun client. + +=== Gun connections + +Gun is designed with the HTTP/2 and Websocket protocols in mind. +They are built for long-running connections that allow concurrent +exchange of data, either in the form of request/responses for +HTTP/2 or in the form of messages for Websocket. + +A Gun connection is an Erlang process that manages a socket to +a remote endpoint. This Gun connection is owned by a user +process that is called the _owner_ of the connection, and is +managed by the supervision tree of the `gun` application. + +Any process can communicate with the Gun connection +by calling functions from the module `gun`. All functions +perform their respective operations asynchronously. The Gun +connection will send Erlang messages to the calling process +whenever needed. + +When the remote endpoint closes the connection, Gun attempts +to reconnect automatically. + +=== Opening a new connection + +The `gun:open/2,3` function must be used to open a connection. + +.Opening a connection to example.org on port 443 +[source,erlang] +---- +{ok, ConnPid} = gun:open("example.org", 443). +---- + +If the port given is 443, Gun will attempt to connect using +TLS. The protocol will be selected automatically using the +ALPN extension for TLS. By default Gun supports HTTP/2 +and HTTP/1.1 when connecting using TLS. + +For any other port, Gun will attempt to connect using +plain TCP and will use the HTTP/1.1 protocol. + +The transport and protocol used can be overriden via +options. The manual documents all available options. + +Options can be provided as a third argument, and take the +form of a map. + +.Opening a TLS connection to example.org on port 8443 +[source,erlang] +---- +{ok, ConnPid} = gun:open("example.org", 8443, #{transport => tls}). +---- + +When using TLS you may want to tweak the +http://erlang.org/doc/man/ssl_app.html#configuration[configuration] +for the `ssl` application, in particular the `session_lifetime` +and `session_cache_client_max` to limit the amount of memory +used for the TLS sessions cache. + +=== Waiting for the connection to be established + +When Gun successfully connects to the server, it sends a +`gun_up` message with the protocol that has been selected +for the connection. + +Gun provides the functions `gun:await_up/1,2,3` that wait +for the `gun_up` message. They can optionally take a monitor +reference and/or timeout value. If no monitor is provided, +one will be created for the duration of the function call. + +.Synchronous opening of a connection +[source,erlang] +---- +{ok, ConnPid} = gun:open("example.org", 443), +{ok, Protocol} = gun:await_up(ConnPid). +---- + +=== Handling connection loss + +When the connection is lost, Gun will send a `gun_down` +message indicating the current protocol, the reason the +connection was lost and two lists of stream references. + +The first list indicates open streams that _may_ have been +processed by the server. The second list indicates open +streams that the server did not process. + +=== Monitoring the connection process + +Because software errors are unavoidable, it is important to +detect when the Gun process crashes. It is also important +to detect when it exits normally. Erlang provides two ways +to do that: links and monitors. + +Gun leaves you the choice as to which one will be used. +However, if you use the `gun:await/2,3` or `gun:await_body/2,3` +functions, a monitor may be used for you to avoid getting +stuck waiting for a message that will never come. + +If you choose to monitor yourself you can do it on a permanent +basis rather than on every message you will receive, saving +resources. Indeed, the `gun:await/3,4` and `gun:await_body/3,4` +functions both accept a monitor argument if you have one already. + +.Monitoring the connection process +[source,erlang] +---- +{ok, ConnPid} = gun:open("example.org", 443). +MRef = monitor(process, ConnPid). +---- + +This monitor reference can be kept and used until the connection +process exits. + +.Handling `DOWN` messages +[source,erlang] +---- +receive + %% Receive Gun messages here... + {'DOWN', Mref, process, ConnPid, Reason} -> + error_logger:error_msg("Oops!"), + exit(Reason) +end. +---- + +What to do when you receive a `DOWN` message is entirely up to you. + +=== Closing the connection abruptly + +The connection can be stopped abruptly at any time by calling +the `gun:close/1` function. + +.Immediate closing of the connection +[source,erlang] +---- +gun:close(ConnPid). +---- + +The process is stopped immediately without having a chance to +perform the protocol's closing handshake, if any. + +//=== Closing the connection gracefully +// +//The connection can also be stopped gracefully by calling the +//`gun:shutdown/1` function. +// +//.Graceful shutdown of the connection +//[source,erlang] +//---- +//gun:shutdown(ConnPid). +//---- +// +//Gun will refuse any new requests or messages after you call +//this function. It will however continue to send you messages +//for existing streams until they are all completed. +// +//For example if you performed a GET request just before calling +//`gun:shutdown/1`, you will still receive the response before +//Gun closes the connection. +// +//If you set a monitor beforehand, you will receive a message +//when the connection has been closed. diff --git a/docs/en/gun/2.1/guide/connect/index.html b/docs/en/gun/2.1/guide/connect/index.html new file mode 100644 index 00000000..d307a4f0 --- /dev/null +++ b/docs/en/gun/2.1/guide/connect/index.html @@ -0,0 +1,278 @@ +<!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: Connection</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=7" 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>Connection</span></h1> + +<p>This chapter describes how to open, monitor and close a connection using the Gun client.</p> +<h2 id="_gun_connections">Gun connections</h2> +<p>Gun is designed with the HTTP/2 and Websocket protocols in mind. They are built for long-running connections that allow concurrent exchange of data, either in the form of request/responses for HTTP/2 or in the form of messages for Websocket.</p> +<p>A Gun connection is an Erlang process that manages a socket to a remote endpoint. This Gun connection is owned by a user process that is called the <em>owner</em> of the connection, and is managed by the supervision tree of the <code>gun</code> application.</p> +<p>Any process can communicate with the Gun connection by calling functions from the module <code>gun</code>. All functions perform their respective operations asynchronously. The Gun connection will send Erlang messages to the calling process whenever needed.</p> +<p>When the remote endpoint closes the connection, Gun attempts to reconnect automatically.</p> +<h2 id="_opening_a_new_connection">Opening a new connection</h2> +<p>The <code>gun:open/2,3</code> function must be used to open a connection.</p> +<div class="listingblock"><div class="title">Opening a connection to example.org on port 443</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>If the port given is 443, Gun will attempt to connect using TLS. The protocol will be selected automatically using the ALPN extension for TLS. By default Gun supports HTTP/2 and HTTP/1.1 when connecting using TLS.</p> +<p>For any other port, Gun will attempt to connect using plain TCP and will use the HTTP/1.1 protocol.</p> +<p>The transport and protocol used can be overriden via options. The manual documents all available options.</p> +<p>Options can be provided as a third argument, and take the form of a map.</p> +<div class="listingblock"><div class="title">Opening a TLS connection to example.org on port 8443</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">8443</font>, #{<font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tls</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<p>When using TLS you may want to tweak the <a href="http://erlang.org/doc/man/ssl_app.html#configuration">configuration</a> for the <code>ssl</code> application, in particular the <code>session_lifetime</code> and <code>session_cache_client_max</code> to limit the amount of memory used for the TLS sessions cache.</p> +<h2 id="_waiting_for_the_connection_to_be_established">Waiting for the connection to be established</h2> +<p>When Gun successfully connects to the server, it sends a <code>gun_up</code> message with the protocol that has been selected for the connection.</p> +<p>Gun provides the functions <code>gun:await_up/1,2,3</code> that wait for the <code>gun_up</code> message. They can optionally take a monitor reference and/or timeout value. If no monitor is provided, one will be created for the duration of the function call.</p> +<div class="listingblock"><div class="title">Synchronous opening of a connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>), +{<font color="#FF6600">ok</font>, <font color="#009900">Protocol</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_up</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_handling_connection_loss">Handling connection loss</h2> +<p>When the connection is lost, Gun will send a <code>gun_down</code> message indicating the current protocol, the reason the connection was lost and two lists of stream references.</p> +<p>The first list indicates open streams that <em>may</em> have been processed by the server. The second list indicates open streams that the server did not process.</p> +<h2 id="_monitoring_the_connection_process">Monitoring the connection process</h2> +<p>Because software errors are unavoidable, it is important to detect when the Gun process crashes. It is also important to detect when it exits normally. Erlang provides two ways to do that: links and monitors.</p> +<p>Gun leaves you the choice as to which one will be used. However, if you use the <code>gun:await/2,3</code> or <code>gun:await_body/2,3</code> functions, a monitor may be used for you to avoid getting stuck waiting for a message that will never come.</p> +<p>If you choose to monitor yourself you can do it on a permanent basis rather than on every message you will receive, saving resources. Indeed, the <code>gun:await/3,4</code> and <code>gun:await_body/3,4</code> functions both accept a monitor argument if you have one already.</p> +<div class="listingblock"><div class="title">Monitoring the connection process</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>)<font color="#990000">.</font> +<font color="#009900">MRef</font> <font color="#990000">=</font> <b><font color="#000000">monitor</font></b>(<b><font color="#000080">process</font></b>, <font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>This monitor reference can be kept and used until the connection process exits.</p> +<div class="listingblock"><div class="title">Handling `DOWN` messages</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#0000FF">receive</font></b> + <i><font color="#9A1900">%% Receive Gun messages here...</font></i> + {<font color="#FF6600">'DOWN'</font>, <font color="#009900">Mref</font>, <b><font color="#000080">process</font></b>, <font color="#009900">ConnPid</font>, <font color="#009900">Reason</font>} <font color="#990000">-></font> + <b><font color="#000000">error_logger:error_msg</font></b>(<font color="#FF0000">"Oops!"</font>), + <b><font color="#000080">exit</font></b>(<font color="#009900">Reason</font>) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>What to do when you receive a <code>DOWN</code> message is entirely up to you.</p> +<h2 id="_closing_the_connection_abruptly">Closing the connection abruptly</h2> +<p>The connection can be stopped abruptly at any time by calling the <code>gun:close/1</code> function.</p> +<div class="listingblock"><div class="title">Immediate closing of the connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:close</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The process is stopped immediately without having a chance to perform the protocol's closing handshake, if any.</p> +<!-- === Closing the connection gracefully--> +<!-- --> +<!-- The connection can also be stopped gracefully by calling the--> +<!-- `gun:shutdown/1` function.--> +<!-- --> +<!-- .Graceful shutdown of the connection--> +<!-- [source,erlang]--> +<!-- ------> +<!-- gun:shutdown(ConnPid).--> +<!-- ------> +<!-- --> +<!-- Gun will refuse any new requests or messages after you call--> +<!-- this function. It will however continue to send you messages--> +<!-- for existing streams until they are all completed.--> +<!-- --> +<!-- For example if you performed a GET request just before calling--> +<!-- `gun:shutdown/1`, you will still receive the response before--> +<!-- Gun closes the connection.--> +<!-- --> +<!-- If you set a monitor beforehand, you will receive a message--> +<!-- when the connection has been closed.--> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.1/guide/protocols/"> + Supported protocols + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.1/guide/http/"> + HTTP + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/guide/gun.sty b/docs/en/gun/2.1/guide/gun.sty new file mode 100644 index 00000000..d5e0d3be --- /dev/null +++ b/docs/en/gun/2.1/guide/gun.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/gun/2.1/guide/http.asciidoc b/docs/en/gun/2.1/guide/http.asciidoc new file mode 100644 index 00000000..51cb994f --- /dev/null +++ b/docs/en/gun/2.1/guide/http.asciidoc @@ -0,0 +1,387 @@ +[[http]] +== HTTP + +This chapter describes how to use the Gun client for +communicating with an HTTP/1.1 or HTTP/2 server. + +=== Streams + +Every time a request is initiated, Gun creates a _stream_. +A _stream reference_ uniquely identifies a set of request and +response and must be used to perform additional operations +with a stream or to identify its messages. + +Stream references use the Erlang _reference_ data type and +are therefore unique. + +Streams can be canceled at any time. This will stop any further +messages from being sent to the calling process. Depending on +its capabilities, the server will also be instructed to cancel +the request. + +Canceling a stream may result in Gun dropping the connection +temporarily, to avoid uploading or downloading data that will +not be used. + +.Cancelling a stream +[source,erlang] +---- +gun:cancel(ConnPid, StreamRef). +---- + +=== Sending requests + +Gun provides many convenient functions for performing common +operations, like GET, POST or DELETE. It also provides a +general purpose function in case you need other methods. + +The availability of these methods on the server can vary +depending on the software used but also on a per-resource +basis. + +Gun will automatically set a few headers depending on the +method used. For all methods however it will set the host +header if it has not been provided in the request arguments. + +This section focuses on the act of sending a request. The +handling of responses will be explained further on. + +==== GET and HEAD + +Use `gun:get/2,3,4` to request a resource. + +.GET "/organizations/ninenines" +[source,erlang] +---- +StreamRef = gun:get(ConnPid, "/organizations/ninenines"). +---- + +.GET "/organizations/ninenines" with custom headers +[source,erlang] +---- +StreamRef = gun:get(ConnPid, "/organizations/ninenines", [ + {<<"accept">>, "application/json"}, + {<<"user-agent">>, "revolver/1.0"} +]). +---- + +Note that the list of headers has the field name as a binary. +The field value is iodata, which is either a binary or an +iolist. + +Use `gun:head/2,3,4` if you don't need the response body. + +.HEAD "/organizations/ninenines" +[source,erlang] +---- +StreamRef = gun:head(ConnPid, "/organizations/ninenines"). +---- + +.HEAD "/organizations/ninenines" with custom headers +[source,erlang] +---- +StreamRef = gun:head(ConnPid, "/organizations/ninenines", [ + {<<"accept">>, "application/json"}, + {<<"user-agent">>, "revolver/1.0"} +]). +---- + +It is not possible to send a request body with a GET or HEAD +request. + +==== POST, PUT and PATCH + +HTTP defines three methods to create or update a resource. + +POST is generally used when the resource identifier (URI) isn't known +in advance when creating a resource. POST can also be used to +replace an existing resource, although PUT is more appropriate +in that situation. + +PUT creates or replaces a resource identified by the URI. + +PATCH provides instructions on how to modify the resource. + +Both POST and PUT send the entire resource representation in their +request body. The PATCH method can be used when this is not +desirable. The request body of a PATCH method may be a partial +representation or a list of instructions on how to update the +resource. + +The functions `gun:post/4,5`, `gun:put/4,5` and `gun:patch/4,5` +take a body as their fourth argument. These functions do +not require any body-specific header to be set, although +it is always recommended to set the content-type header. +Gun will set the other headers automatically. + +In this and the following examples in this section, `gun:post` +can be replaced by `gun:put` or `gun:patch` for performing +a PUT or PATCH request, respectively. + +.POST "/organizations/ninenines" +[source,erlang] +---- +Body = "{\"msg\": \"Hello world!\"}", +StreamRef = gun:post(ConnPid, "/organizations/ninenines", [ + {<<"content-type">>, "application/json"} +], Body). +---- + +The functions `gun:post/3,4`, `gun:put/3,4` and `gun:patch/3,4` +do not take a body in their arguments: the body must be +provided later on using the `gun:data/4` function. + +It is recommended to send the content-length header if you +know it in advance, although this is not required. If it +is not set, HTTP/1.1 will use the chunked transfer-encoding, +and HTTP/2 will continue normally as it is chunked by design. + +.POST "/organizations/ninenines" with delayed body +[source,erlang] +---- +Body = "{\"msg\": \"Hello world!\"}", +StreamRef = gun:post(ConnPid, "/organizations/ninenines", [ + {<<"content-length">>, integer_to_binary(length(Body))}, + {<<"content-type">>, "application/json"} +]), +gun:data(ConnPid, StreamRef, fin, Body). +---- + +The atom `fin` indicates this is the last chunk of data to +be sent. You can call the `gun:data/4` function as many +times as needed until you have sent the entire body. The +last call must use `fin` and all the previous calls must +use `nofin`. The last chunk may be empty. + +.Streaming the request body +[source,erlang] +---- +sendfile(ConnPid, StreamRef, Filepath) -> + {ok, IoDevice} = file:open(Filepath, [read, binary, raw]), + do_sendfile(ConnPid, StreamRef, IoDevice). + +do_sendfile(ConnPid, StreamRef, IoDevice) -> + case file:read(IoDevice, 8000) of + eof -> + gun:data(ConnPid, StreamRef, fin, <<>>), + file:close(IoDevice); + {ok, Bin} -> + gun:data(ConnPid, StreamRef, nofin, Bin), + do_sendfile(ConnPid, StreamRef, IoDevice) + end. +---- + +==== DELETE + +Use `gun:delete/2,3,4` to delete a resource. + +.DELETE "/organizations/ninenines" +[source,erlang] +---- +StreamRef = gun:delete(ConnPid, "/organizations/ninenines"). +---- + +.DELETE "/organizations/ninenines" with custom headers +[source,erlang] +---- +StreamRef = gun:delete(ConnPid, "/organizations/ninenines", [ + {<<"user-agent">>, "revolver/1.0"} +]). +---- + +==== OPTIONS + +Use `gun:options/2,3` to request information about a resource. + +.OPTIONS "/organizations/ninenines" +[source,erlang] +---- +StreamRef = gun:options(ConnPid, "/organizations/ninenines"). +---- + +.OPTIONS "/organizations/ninenines" with custom headers +[source,erlang] +---- +StreamRef = gun:options(ConnPid, "/organizations/ninenines", [ + {<<"user-agent">>, "revolver/1.0"} +]). +---- + +You can also use this function to request information about +the server itself. + +.OPTIONS "*" +[source,erlang] +---- +StreamRef = gun:options(ConnPid, "*"). +---- + +==== Requests with an arbitrary method + +The functions `gun:headers/4,5` or `gun:request/5,6` can be +used to send requests with a configurable method name. It is +mostly useful when you need a method that Gun does not +understand natively. + +.Example of a TRACE request +[source,erlang] +---- +gun:request(ConnPid, "TRACE", "/", [ + {<<"max-forwards">>, "30"} +], <<>>). +---- + +=== Processing responses + +All data received from the server is sent to the calling +process as a message. First a `gun_response` message is sent, +followed by zero or more `gun_data` messages. If something goes wrong, +a `gun_error` message is sent instead. + +The response message will inform you whether there will be +data messages following. If it contains `fin` there will be +no data messages. If it contains `nofin` then one or more data +messages will follow. + +When using HTTP/2 this value is sent with the frame and simply +passed on in the message. When using HTTP/1.1 however Gun must +guess whether data will follow by looking at the response headers. + +You can receive messages directly, or you can use the _await_ +functions to let Gun receive them for you. + +.Receiving a response using receive +[source,erlang] +---- +print_body(ConnPid, MRef) -> + StreamRef = gun:get(ConnPid, "/"), + receive + {gun_response, ConnPid, StreamRef, fin, Status, Headers} -> + no_data; + {gun_response, ConnPid, StreamRef, nofin, Status, Headers} -> + receive_data(ConnPid, MRef, StreamRef); + {'DOWN', MRef, process, ConnPid, Reason} -> + error_logger:error_msg("Oops!"), + exit(Reason) + after 1000 -> + exit(timeout) + end. + +receive_data(ConnPid, MRef, StreamRef) -> + receive + {gun_data, ConnPid, StreamRef, nofin, Data} -> + io:format("~s~n", [Data]), + receive_data(ConnPid, MRef, StreamRef); + {gun_data, ConnPid, StreamRef, fin, Data} -> + io:format("~s~n", [Data]); + {'DOWN', MRef, process, ConnPid, Reason} -> + error_logger:error_msg("Oops!"), + exit(Reason) + after 1000 -> + exit(timeout) + end. +---- + +While it may seem verbose, using messages like this has the +advantage of never locking your process, allowing you to +easily debug your code. It also allows you to start more than +one connection and concurrently perform queries on all of them +at the same time. + +You can also use Gun in a synchronous manner by using the _await_ +functions. + +The `gun:await/2,3,4` function will wait until it receives +a response to, a pushed resource related to, or data from +the given stream. + +When calling `gun:await/2,3` and not passing a monitor +reference, one is automatically created for you for the +duration of the call. + +The `gun:await_body/2,3,4` works similarly, but returns the +body received. Both functions can be combined to receive the +response and its body sequentially. + +.Receiving a response using await +[source,erlang] +---- +StreamRef = gun:get(ConnPid, "/"), +case gun:await(ConnPid, StreamRef) of + {response, fin, Status, Headers} -> + no_data; + {response, nofin, Status, Headers} -> + {ok, Body} = gun:await_body(ConnPid, StreamRef), + io:format("~s~n", [Body]) +end. +---- + +=== Handling streams pushed by the server + +The HTTP/2 protocol allows the server to push more than one +resource for every request. It will start sending those +extra resources before it starts sending the response itself, +so Gun will send you `gun_push` messages before `gun_response` +when that happens. + +You can safely choose to ignore `gun_push` messages, or +you can handle them. If you do, you can either receive the +messages directly or use _await_ functions. + +The `gun_push` message contains both the new stream reference +and the stream reference of the original request. + +.Receiving a pushed response using receive +[source,erlang] +---- +receive + {gun_push, ConnPid, OriginalStreamRef, PushedStreamRef, + Method, Host, Path, Headers} -> + enjoy() +end. +---- + +If you use the `gun:await/2,3,4` function, however, Gun +will use the original reference to identify the message but +will return a tuple that doesn't contain it. + +.Receiving a pushed response using await +[source,erlang] +---- +{push, PushedStreamRef, Method, URI, Headers} + = gun:await(ConnPid, OriginalStreamRef). +---- + +The `PushedStreamRef` variable can then be used with `gun:await/2,3,4` +and `gun:await_body/2,3,4`. + +=== Flushing unwanted messages + +Gun provides the function `gun:flush/1` to quickly get rid +of unwanted messages sitting in the process mailbox. You +can use it to get rid of all messages related to a connection, +or just the messages related to a stream. + +.Flush all messages from a Gun connection +[source,erlang] +---- +gun:flush(ConnPid). +---- + +.Flush all messages from a specific stream +[source,erlang] +---- +gun:flush(StreamRef). +---- + +=== Redirecting responses to a different process + +Gun allows you to specify which process will handle responses +to a request via the `reply_to` request option. + +.GET "/organizations/ninenines" to a different process +[source,erlang] +---- +StreamRef = gun:get(ConnPid, "/organizations/ninenines", [], + #{reply_to => Pid}). +---- diff --git a/docs/en/gun/2.1/guide/http/index.html b/docs/en/gun/2.1/guide/http/index.html new file mode 100644 index 00000000..435b1ee1 --- /dev/null +++ b/docs/en/gun/2.1/guide/http/index.html @@ -0,0 +1,452 @@ +<!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</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=7" 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</span></h1> + +<p>This chapter describes how to use the Gun client for communicating with an HTTP/1.1 or HTTP/2 server.</p> +<h2 id="_streams">Streams</h2> +<p>Every time a request is initiated, Gun creates a <em>stream</em>. A <em>stream reference</em> uniquely identifies a set of request and response and must be used to perform additional operations with a stream or to identify its messages.</p> +<p>Stream references use the Erlang <em>reference</em> data type and are therefore unique.</p> +<p>Streams can be canceled at any time. This will stop any further messages from being sent to the calling process. Depending on its capabilities, the server will also be instructed to cancel the request.</p> +<p>Canceling a stream may result in Gun dropping the connection temporarily, to avoid uploading or downloading data that will not be used.</p> +<div class="listingblock"><div class="title">Cancelling a stream</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:cancel</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_sending_requests">Sending requests</h2> +<p>Gun provides many convenient functions for performing common operations, like GET, POST or DELETE. It also provides a general purpose function in case you need other methods.</p> +<p>The availability of these methods on the server can vary depending on the software used but also on a per-resource basis.</p> +<p>Gun will automatically set a few headers depending on the method used. For all methods however it will set the host header if it has not been provided in the request arguments.</p> +<p>This section focuses on the act of sending a request. The handling of responses will be explained further on.</p> +<h4 id="_get_and_head">GET and HEAD</h4> +<p>Use <code>gun:get/2,3,4</code> to request a resource.</p> +<div class="listingblock"><div class="title">GET "/organizations/ninenines"</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">GET "/organizations/ninenines" with custom headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#FF0000">"application/json"</font>}, + {<font color="#990000"><<</font><font color="#FF0000">"user-agent"</font><font color="#990000">>></font>, <font color="#FF0000">"revolver/1.0"</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<p>Note that the list of headers has the field name as a binary. The field value is iodata, which is either a binary or an iolist.</p> +<p>Use <code>gun:head/2,3,4</code> if you don't need the response body.</p> +<div class="listingblock"><div class="title">HEAD "/organizations/ninenines"</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:head</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">HEAD "/organizations/ninenines" with custom headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:head</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#FF0000">"application/json"</font>}, + {<font color="#990000"><<</font><font color="#FF0000">"user-agent"</font><font color="#990000">>></font>, <font color="#FF0000">"revolver/1.0"</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<p>It is not possible to send a request body with a GET or HEAD request.</p> +<h4 id="_post__put_and_patch">POST, PUT and PATCH</h4> +<p>HTTP defines three methods to create or update a resource.</p> +<p>POST is generally used when the resource identifier (URI) isn't known in advance when creating a resource. POST can also be used to replace an existing resource, although PUT is more appropriate in that situation.</p> +<p>PUT creates or replaces a resource identified by the URI.</p> +<p>PATCH provides instructions on how to modify the resource.</p> +<p>Both POST and PUT send the entire resource representation in their request body. The PATCH method can be used when this is not desirable. The request body of a PATCH method may be a partial representation or a list of instructions on how to update the resource.</p> +<p>The functions <code>gun:post/4,5</code>, <code>gun:put/4,5</code> and <code>gun:patch/4,5</code> take a body as their fourth argument. These functions do not require any body-specific header to be set, although it is always recommended to set the content-type header. Gun will set the other headers automatically.</p> +<p>In this and the following examples in this section, <code>gun:post</code> can be replaced by <code>gun:put</code> or <code>gun:patch</code> for performing a PUT or PATCH request, respectively.</p> +<div class="listingblock"><div class="title">POST "/organizations/ninenines"</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Body</font> <font color="#990000">=</font> <font color="#FF0000">"{\"msg\": \"Hello world!\"}"</font>, +<font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:post</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#FF0000">"application/json"</font>} +], <font color="#009900">Body</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The functions <code>gun:post/3,4</code>, <code>gun:put/3,4</code> and <code>gun:patch/3,4</code> do not take a body in their arguments: the body must be provided later on using the <code>gun:data/4</code> function.</p> +<p>It is recommended to send the content-length header if you know it in advance, although this is not required. If it is not set, HTTP/1.1 will use the chunked transfer-encoding, and HTTP/2 will continue normally as it is chunked by design.</p> +<div class="listingblock"><div class="title">POST "/organizations/ninenines" with delayed body</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Body</font> <font color="#990000">=</font> <font color="#FF0000">"{\"msg\": \"Hello world!\"}"</font>, +<font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:post</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-length"</font><font color="#990000">>></font>, <b><font color="#000000">integer_to_binary</font></b>(<b><font color="#000080">length</font></b>(<font color="#009900">Body</font>))}, + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#FF0000">"application/json"</font>} +]), +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#009900">Body</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The atom <code>fin</code> indicates this is the last chunk of data to be sent. You can call the <code>gun:data/4</code> function as many times as needed until you have sent the entire body. The last call must use <code>fin</code> and all the previous calls must use <code>nofin</code>. The last chunk may be empty.</p> +<div class="listingblock"><div class="title">Streaming the request body</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">sendfile</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Filepath</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">IoDevice</font>} <font color="#990000">=</font> <b><font color="#000000">file:open</font></b>(<font color="#009900">Filepath</font>, [<font color="#FF6600">read</font>, <b><font color="#000080">binary</font></b>, <font color="#FF6600">raw</font>]), + <b><font color="#000000">do_sendfile</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IoDevice</font>)<font color="#990000">.</font> + +<b><font color="#000000">do_sendfile</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IoDevice</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">file:read</font></b>(<font color="#009900">IoDevice</font>, <font color="#993399">8000</font>) <b><font color="#0000FF">of</font></b> + <font color="#FF6600">eof</font> <font color="#990000">-></font> + <b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#990000"><<>></font>), + <b><font color="#000000">file:close</font></b>(<font color="#009900">IoDevice</font>); + {<font color="#FF6600">ok</font>, <font color="#009900">Bin</font>} <font color="#990000">-></font> + <b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Bin</font>), + <b><font color="#000000">do_sendfile</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IoDevice</font>) + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<h4 id="_delete">DELETE</h4> +<p>Use <code>gun:delete/2,3,4</code> to delete a resource.</p> +<div class="listingblock"><div class="title">DELETE "/organizations/ninenines"</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">DELETE "/organizations/ninenines" with custom headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"user-agent"</font><font color="#990000">>></font>, <font color="#FF0000">"revolver/1.0"</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<h4 id="_options">OPTIONS</h4> +<p>Use <code>gun:options/2,3</code> to request information about a resource.</p> +<div class="listingblock"><div class="title">OPTIONS "/organizations/ninenines"</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:options</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">OPTIONS "/organizations/ninenines" with custom headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:options</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"user-agent"</font><font color="#990000">>></font>, <font color="#FF0000">"revolver/1.0"</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<p>You can also use this function to request information about the server itself.</p> +<div class="listingblock"><div class="title">OPTIONS "*"</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:options</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"*"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h4 id="_requests_with_an_arbitrary_method">Requests with an arbitrary method</h4> +<p>The functions <code>gun:headers/4,5</code> or <code>gun:request/5,6</code> can be used to send requests with a configurable method name. It is mostly useful when you need a method that Gun does not understand natively.</p> +<div class="listingblock"><div class="title">Example of a TRACE request</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:request</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"TRACE"</font>, <font color="#FF0000">"/"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"max-forwards"</font><font color="#990000">>></font>, <font color="#FF0000">"30"</font>} +], <font color="#990000"><<>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_processing_responses">Processing responses</h2> +<p>All data received from the server is sent to the calling process as a message. First a <code>gun_response</code> message is sent, followed by zero or more <code>gun_data</code> messages. If something goes wrong, a <code>gun_error</code> message is sent instead.</p> +<p>The response message will inform you whether there will be data messages following. If it contains <code>fin</code> there will be no data messages. If it contains <code>nofin</code> then one or more data messages will follow.</p> +<p>When using HTTP/2 this value is sent with the frame and simply passed on in the message. When using HTTP/1.1 however Gun must guess whether data will follow by looking at the response headers.</p> +<p>You can receive messages directly, or you can use the <em>await</em> functions to let Gun receive them for you.</p> +<div class="listingblock"><div class="title">Receiving a response using receive</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">print_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">MRef</font>) <font color="#990000">-></font> + <font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/"</font>), + <b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_response</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + <font color="#FF6600">no_data</font>; + {<font color="#FF6600">gun_response</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + <b><font color="#000000">receive_data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">MRef</font>, <font color="#009900">StreamRef</font>); + {<font color="#FF6600">'DOWN'</font>, <font color="#009900">MRef</font>, <b><font color="#000080">process</font></b>, <font color="#009900">ConnPid</font>, <font color="#009900">Reason</font>} <font color="#990000">-></font> + <b><font color="#000000">error_logger:error_msg</font></b>(<font color="#FF0000">"Oops!"</font>), + <b><font color="#000080">exit</font></b>(<font color="#009900">Reason</font>) + <b><font color="#0000FF">after</font></b> <font color="#993399">1000</font> <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>(<font color="#FF6600">timeout</font>) + <b><font color="#0000FF">end</font></b><font color="#990000">.</font> + +<b><font color="#000000">receive_data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">MRef</font>, <font color="#009900">StreamRef</font>) <font color="#990000">-></font> + <b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_data</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Data</font>} <font color="#990000">-></font> + <b><font color="#000000">io:format</font></b>(<font color="#FF0000">"~s~n"</font>, [<font color="#009900">Data</font>]), + <b><font color="#000000">receive_data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">MRef</font>, <font color="#009900">StreamRef</font>); + {<font color="#FF6600">gun_data</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#009900">Data</font>} <font color="#990000">-></font> + <b><font color="#000000">io:format</font></b>(<font color="#FF0000">"~s~n"</font>, [<font color="#009900">Data</font>]); + {<font color="#FF6600">'DOWN'</font>, <font color="#009900">MRef</font>, <b><font color="#000080">process</font></b>, <font color="#009900">ConnPid</font>, <font color="#009900">Reason</font>} <font color="#990000">-></font> + <b><font color="#000000">error_logger:error_msg</font></b>(<font color="#FF0000">"Oops!"</font>), + <b><font color="#000080">exit</font></b>(<font color="#009900">Reason</font>) + <b><font color="#0000FF">after</font></b> <font color="#993399">1000</font> <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>(<font color="#FF6600">timeout</font>) + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>While it may seem verbose, using messages like this has the advantage of never locking your process, allowing you to easily debug your code. It also allows you to start more than one connection and concurrently perform queries on all of them at the same time.</p> +<p>You can also use Gun in a synchronous manner by using the <em>await</em> functions.</p> +<p>The <code>gun:await/2,3,4</code> function will wait until it receives a response to, a pushed resource related to, or data from the given stream.</p> +<p>When calling <code>gun:await/2,3</code> and not passing a monitor reference, one is automatically created for you for the duration of the call.</p> +<p>The <code>gun:await_body/2,3,4</code> works similarly, but returns the body received. Both functions can be combined to receive the response and its body sequentially.</p> +<div class="listingblock"><div class="title">Receiving a response using await</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/"</font>), +<b><font color="#0000FF">case</font></b> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">response</font>, <font color="#FF6600">fin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + <font color="#FF6600">no_data</font>; + {<font color="#FF6600">response</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">Body</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>), + <b><font color="#000000">io:format</font></b>(<font color="#FF0000">"~s~n"</font>, [<font color="#009900">Body</font>]) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_handling_streams_pushed_by_the_server">Handling streams pushed by the server</h2> +<p>The HTTP/2 protocol allows the server to push more than one resource for every request. It will start sending those extra resources before it starts sending the response itself, so Gun will send you <code>gun_push</code> messages before <code>gun_response</code> when that happens.</p> +<p>You can safely choose to ignore <code>gun_push</code> messages, or you can handle them. If you do, you can either receive the messages directly or use <em>await</em> functions.</p> +<p>The <code>gun_push</code> message contains both the new stream reference and the stream reference of the original request.</p> +<div class="listingblock"><div class="title">Receiving a pushed response using receive</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_push</font>, <font color="#009900">ConnPid</font>, <font color="#009900">OriginalStreamRef</font>, <font color="#009900">PushedStreamRef</font>, + <font color="#009900">Method</font>, <font color="#009900">Host</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + <b><font color="#000000">enjoy</font></b>() +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>If you use the <code>gun:await/2,3,4</code> function, however, Gun will use the original reference to identify the message but will return a tuple that doesn't contain it.</p> +<div class="listingblock"><div class="title">Receiving a pushed response using await</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">push</font>, <font color="#009900">PushedStreamRef</font>, <font color="#009900">Method</font>, <font color="#009900">URI</font>, <font color="#009900">Headers</font>} + <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">OriginalStreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The <code>PushedStreamRef</code> variable can then be used with <code>gun:await/2,3,4</code> and <code>gun:await_body/2,3,4</code>.</p> +<h2 id="_flushing_unwanted_messages">Flushing unwanted messages</h2> +<p>Gun provides the function <code>gun:flush/1</code> to quickly get rid of unwanted messages sitting in the process mailbox. You can use it to get rid of all messages related to a connection, or just the messages related to a stream.</p> +<div class="listingblock"><div class="title">Flush all messages from a Gun connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:flush</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Flush all messages from a specific stream</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:flush</font></b>(<font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_redirecting_responses_to_a_different_process">Redirecting responses to a different process</h2> +<p>Gun allows you to specify which process will handle responses to a request via the <code>reply_to</code> request option.</p> +<div class="listingblock"><div class="title">GET "/organizations/ninenines" to a different process</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [], + #{<font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">Pid</font>})<font color="#990000">.</font></tt></pre> +</div></div> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.1/guide/connect/"> + Connection + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.1/guide/websocket/"> + Websocket + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/guide/index.html b/docs/en/gun/2.1/guide/index.html new file mode 100644 index 00000000..4d5cfe6a --- /dev/null +++ b/docs/en/gun/2.1/guide/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: Gun 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=7" 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>Gun User Guide</span></h1> + +<h2 id="_interface">Interface</h2> +<ul><li><a href="introduction/">Introduction</a> +</li> +<li><a href="start/">Starting and stopping</a> +</li> +<li><a href="protocols/">Supported protocols</a> +</li> +<li><a href="connect/">Connection</a> +</li> +<li><a href="http/">Using HTTP</a> +</li> +<li><a href="websocket/">Using Websocket</a> +</li> +</ul> +<h2 id="_advanced">Advanced</h2> +<ul><li><a href="internals_tls_over_tls/">Internals: TLS over TLS</a> +</li> +</ul> +<h2 id="_additional_information">Additional information</h2> +<ul><li><a href="migrating_from_2.0/">Changes since Gun 2.0</a> +</li> +<li><a href="migrating_from_1.3/">Migrating from Gun 1.3 to 2.0</a> +</li> +<li><a href="migrating_from_1.2/">Migrating from Gun 1.2 to 1.3</a> +</li> +<li><a href="migrating_from_1.1/">Migrating from Gun 1.1 to 1.2</a> +</li> +<li><a href="migrating_from_1.0/">Migrating from Gun 1.0 to 1.1</a> +</li> +</ul> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/guide/internals_tls_over_tls.asciidoc b/docs/en/gun/2.1/guide/internals_tls_over_tls.asciidoc new file mode 100644 index 00000000..07e86698 --- /dev/null +++ b/docs/en/gun/2.1/guide/internals_tls_over_tls.asciidoc @@ -0,0 +1,177 @@ +== Internals: TLS over TLS + +The `ssl` application that comes with Erlang/OTP implements +TLS using an interface equivalent to the `gen_tcp` interface: +you get and manipulate a socket. The TLS encoding and +decoding is applied transparently to the data sent and +received. + +In order to have a TLS layer inside another TLS layer we +need a way to encode the data of the inner layer before +we pass it to the outer layer. We cannot do this with +a socket interface. Thankfully, the `ssl` application comes +with options that allow to transform an `sslsocket()` into +an encoder/decoder. + +The implementation is however a little convoluted as a +result. This chapter aims to give an overview of how it +all works under the hood. + +=== gun_tls_proxy + +The module `gun_tls_proxy` implements an intermediary process +that sits between the Gun process and the TLS process. It is +responsible for routing data from the Gun process to the TLS +process, and from the TLS process to the Gun process. + +In order to obtain the TLS encoded data the `cb_info` option +is given to the `ssl:connect/3` function. This replaces the +default TCP outer socket module with our own custom module. +Gun uses the `gun_tls_proxy_cb` module instead. This module +will forward all messages to the `gun_tls_proxy` process. + +The resulting operations looks like this: + +---- +Gun process <-> gun_tls_proxy <-> sslsocket() <-> gun_tls_proxy <-> "inner socket" +---- + +The "inner socket" is the socket for the Gun connection. +The `gun_tls_proxy` process decides where to send or +receive the data based on where it's coming from. This +is how it knows whether the data has been encoded/decoded +or not. + +Because the `ssl:connect/3` function call is blocking, +a temporary process is used while connecting. This is required +because the `gun_tls_proxy` needs to forward data even while +performing the TLS handshake, otherwise the `ssl:connect/3` +call will not complete. + +The result of the `ssl:connect/3` call is forward to the Gun +process, along with the negotiated protocols when the connection +was successful. + +The `gun_tls_proxy_cb` module does not actually implement +`{active,N}` as requested by the `ssl` application. Instead +it uses `{active,true}`. + +The behavior of the `gun_tls_proxy` process will vary depending +on whether the TLS over TLS is done connection-wide or only +stream-wide. + +=== Connection-wide TLS over TLS + +When used for the entire connection, the `gun_tls_proxy` process +will act like a real socket once connected. The only difference +is how the connection is performed. As mentioned earlier, the +result of the `ssl:connect/3` call is sent back to the Gun process. + +When doing TLS over TLS the processes will end up looking like +this: + +---- +Gun process <-> gun_tls_proxy <-> "inner socket" +---- + +The details of the interactions between `gun_tls_proxy` and +its associated `sslsocket()` have been removed in order to +better illustrate the concept. + +When adding another layer this becomes: + +---- +Gun process <-> gun_tls_proxy <-> gun_tls_proxy <-> sslsocket() +---- + +This is what is done when only HTTP/1.1 and SOCKS proxies are +involved. + +=== Stream-wide TLS over TLS + +The same cannot be done for HTTP/2 proxies. This is because the +HTTP/2 CONNECT method does not apply to the entire connection, +but only to a stream. The proxied data must be wrapped inside +a DATA frame. It cannot be sent directly. This is what must be +done: + +---- +Gun process -> gun_tls_proxy -> Gun process -> "inner socket" +---- + +The "inner socket" is the socket for the HTTP/2 connection. + +In order to tell Gun to continue processing the data, the +`handle_continue` mechanism is introduced. When `gun_tls_proxy` +has TLS encoded the data it sends it back to the Gun process, +wrapped in a `handle_continue` tuple. This tuple contains +enough information to figure out what stream the data belongs +to and what should be done next. Gun will therefore route the +data to the correct layer and continue sending it. + +This solution is also used for receiving data, except in the +reverse order. + +=== Routing to the right stream + +In order to know where to route the data, the `stream_ref` +had to be modified to contain all the references to the +individual streams. So if the tunnel is identified by +`StreamA` and a request on this tunnel is identified +by `StreamB`, then the stream is known as `[StreamA, StreamB]` +to the user. Gun then routes first to `StreamA`, a +tunnel, which continues routing to `StreamB`. + +A problem comes up if an intermediary is a SOCKS server, +for example in the following scenario: + +---- +HTTP/2 proxy <-> SOCKS proxy <-> HTTP/1.1 origin +---- + +The SOCKS protocol doesn't have a concept of stream, +therefore when we refer to request to the origin server +they are `[StreamA, StreamB]`, not `[StreamA, StreamB, StreamC]`. +This is a problem for routing encoded/decoded TLS data +to the SOCKS layer: we don't have a built-in way of referring +to the SOCKS layer. + +The solution is to have a separate `handle_continue_stream_ref` +value that assigns a reference to the SOCKS layers. Gun will +then be able to forward `handle_continue` message, and only +them, to the appropriate layer. + +Gun therefore has two different routing avenues, but the +mechanism remains the same otherwise. + +=== gun_tunnel + +In order to simplify the routing, the `gun_tunnel` module +was introduced. For each intermediary (including the original +CONNECT stream at the HTTP/2 layer) there is a `gun_tunnel` +module. + +Going back to the example above: + +---- +HTTP/2 proxy <-> SOCKS proxy <-> HTTP/1.1 origin +---- + +In this case the modules involved to handle the request +will be as follow: + +---- +gun_http2 <-> gun_tunnel <-> gun_tunnel <-> gun_http +---- + +The `gun_http2` module doesn't do any routing, it just +passes everything to the `gun_tunnel` module. The `gun_tunnel` +module will then do the routing, which involves removing +`StreamA` from `[StreamA, StreamB]` where appropriate. + +The `gun_tunnel` module also receives the TLS encoded/decoded +data and forwards it appropriately. When it comes to sending +data, it will return a `send` command that allows the previous +module to continue sending the data. The `gun_http2` module +will ultimately wrap the data to be sent in a DATA frame and +send it to the "inner socket". diff --git a/docs/en/gun/2.1/guide/internals_tls_over_tls/index.html b/docs/en/gun/2.1/guide/internals_tls_over_tls/index.html new file mode 100644 index 00000000..e62b3326 --- /dev/null +++ b/docs/en/gun/2.1/guide/internals_tls_over_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: Internals: TLS over TLS</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=7" 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>Internals: TLS over TLS</span></h1> + +<p>The <code>ssl</code> application that comes with Erlang/OTP implements TLS using an interface equivalent to the <code>gen_tcp</code> interface: you get and manipulate a socket. The TLS encoding and decoding is applied transparently to the data sent and received.</p> +<p>In order to have a TLS layer inside another TLS layer we need a way to encode the data of the inner layer before we pass it to the outer layer. We cannot do this with a socket interface. Thankfully, the <code>ssl</code> application comes with options that allow to transform an <code>sslsocket()</code> into an encoder/decoder.</p> +<p>The implementation is however a little convoluted as a result. This chapter aims to give an overview of how it all works under the hood.</p> +<h2 id="_gun_tls_proxy">gun_tls_proxy</h2> +<p>The module <code>gun_tls_proxy</code> implements an intermediary process that sits between the Gun process and the TLS process. It is responsible for routing data from the Gun process to the TLS process, and from the TLS process to the Gun process.</p> +<p>In order to obtain the TLS encoded data the <code>cb_info</code> option is given to the <code>ssl:connect/3</code> function. This replaces the default TCP outer socket module with our own custom module. Gun uses the <code>gun_tls_proxy_cb</code> module instead. This module will forward all messages to the <code>gun_tls_proxy</code> process.</p> +<p>The resulting operations looks like this:</p> +<div class="listingblock"><div class="content"><pre>Gun process <-> gun_tls_proxy <-> sslsocket() <-> gun_tls_proxy <-> "inner socket"</pre></div></div> +<p>The "inner socket" is the socket for the Gun connection. The <code>gun_tls_proxy</code> process decides where to send or receive the data based on where it's coming from. This is how it knows whether the data has been encoded/decoded or not.</p> +<p>Because the <code>ssl:connect/3</code> function call is blocking, a temporary process is used while connecting. This is required because the <code>gun_tls_proxy</code> needs to forward data even while performing the TLS handshake, otherwise the <code>ssl:connect/3</code> call will not complete.</p> +<p>The result of the <code>ssl:connect/3</code> call is forward to the Gun process, along with the negotiated protocols when the connection was successful.</p> +<p>The <code>gun_tls_proxy_cb</code> module does not actually implement <code>{active,N}</code> as requested by the <code>ssl</code> application. Instead it uses <code>{active,true}</code>.</p> +<p>The behavior of the <code>gun_tls_proxy</code> process will vary depending on whether the TLS over TLS is done connection-wide or only stream-wide.</p> +<h2 id="_connection_wide_tls_over_tls">Connection-wide TLS over TLS</h2> +<p>When used for the entire connection, the <code>gun_tls_proxy</code> process will act like a real socket once connected. The only difference is how the connection is performed. As mentioned earlier, the result of the <code>ssl:connect/3</code> call is sent back to the Gun process.</p> +<p>When doing TLS over TLS the processes will end up looking like this:</p> +<div class="listingblock"><div class="content"><pre>Gun process <-> gun_tls_proxy <-> "inner socket"</pre></div></div> +<p>The details of the interactions between <code>gun_tls_proxy</code> and its associated <code>sslsocket()</code> have been removed in order to better illustrate the concept.</p> +<p>When adding another layer this becomes:</p> +<div class="listingblock"><div class="content"><pre>Gun process <-> gun_tls_proxy <-> gun_tls_proxy <-> sslsocket()</pre></div></div> +<p>This is what is done when only HTTP/1.1 and SOCKS proxies are involved.</p> +<h2 id="_stream_wide_tls_over_tls">Stream-wide TLS over TLS</h2> +<p>The same cannot be done for HTTP/2 proxies. This is because the HTTP/2 CONNECT method does not apply to the entire connection, but only to a stream. The proxied data must be wrapped inside a DATA frame. It cannot be sent directly. This is what must be done:</p> +<div class="listingblock"><div class="content"><pre>Gun process -> gun_tls_proxy -> Gun process -> "inner socket"</pre></div></div> +<p>The "inner socket" is the socket for the HTTP/2 connection.</p> +<p>In order to tell Gun to continue processing the data, the <code>handle_continue</code> mechanism is introduced. When <code>gun_tls_proxy</code> has TLS encoded the data it sends it back to the Gun process, wrapped in a <code>handle_continue</code> tuple. This tuple contains enough information to figure out what stream the data belongs to and what should be done next. Gun will therefore route the data to the correct layer and continue sending it.</p> +<p>This solution is also used for receiving data, except in the reverse order.</p> +<h2 id="_routing_to_the_right_stream">Routing to the right stream</h2> +<p>In order to know where to route the data, the <code>stream_ref</code> had to be modified to contain all the references to the individual streams. So if the tunnel is identified by <code>StreamA</code> and a request on this tunnel is identified by <code>StreamB</code>, then the stream is known as <code>[StreamA, StreamB]</code> to the user. Gun then routes first to <code>StreamA</code>, a tunnel, which continues routing to <code>StreamB</code>.</p> +<p>A problem comes up if an intermediary is a SOCKS server, for example in the following scenario:</p> +<div class="listingblock"><div class="content"><pre>HTTP/2 proxy <-> SOCKS proxy <-> HTTP/1.1 origin</pre></div></div> +<p>The SOCKS protocol doesn't have a concept of stream, therefore when we refer to request to the origin server they are <code>[StreamA, StreamB]</code>, not <code>[StreamA, StreamB, StreamC]</code>. This is a problem for routing encoded/decoded TLS data to the SOCKS layer: we don't have a built-in way of referring to the SOCKS layer.</p> +<p>The solution is to have a separate <code>handle_continue_stream_ref</code> value that assigns a reference to the SOCKS layers. Gun will then be able to forward <code>handle_continue</code> message, and only them, to the appropriate layer.</p> +<p>Gun therefore has two different routing avenues, but the mechanism remains the same otherwise.</p> +<h2 id="_gun_tunnel">gun_tunnel</h2> +<p>In order to simplify the routing, the <code>gun_tunnel</code> module was introduced. For each intermediary (including the original CONNECT stream at the HTTP/2 layer) there is a <code>gun_tunnel</code> module.</p> +<p>Going back to the example above:</p> +<div class="listingblock"><div class="content"><pre>HTTP/2 proxy <-> SOCKS proxy <-> HTTP/1.1 origin</pre></div></div> +<p>In this case the modules involved to handle the request will be as follow:</p> +<div class="listingblock"><div class="content"><pre>gun_http2 <-> gun_tunnel <-> gun_tunnel <-> gun_http</pre></div></div> +<p>The <code>gun_http2</code> module doesn't do any routing, it just passes everything to the <code>gun_tunnel</code> module. The <code>gun_tunnel</code> module will then do the routing, which involves removing <code>StreamA</code> from <code>[StreamA, StreamB]</code> where appropriate.</p> +<p>The <code>gun_tunnel</code> module also receives the TLS encoded/decoded data and forwards it appropriately. When it comes to sending data, it will return a <code>send</code> command that allows the previous module to continue sending the data. The <code>gun_http2</code> module will ultimately wrap the data to be sent in a DATA frame and send it to the "inner socket".</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.1/guide/websocket/"> + Websocket + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_2.0/"> + Migrating from Gun 2.0 to 2.1 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/guide/introduction.asciidoc b/docs/en/gun/2.1/guide/introduction.asciidoc new file mode 100644 index 00000000..948dde95 --- /dev/null +++ b/docs/en/gun/2.1/guide/introduction.asciidoc @@ -0,0 +1,49 @@ +[[introduction]] +== Introduction + +Gun is an HTTP client for Erlang/OTP. + +Gun supports the HTTP/2, HTTP/1.1 and Websocket protocols. + +=== Prerequisites + +Knowledge of Erlang, but also of the HTTP/1.1, HTTP/2 and Websocket +protocols is required in order to read this guide. + +=== Supported platforms + +Gun is tested and supported on Linux, FreeBSD, Windows and OSX. + +Gun is developed for Erlang/OTP 22.0 and newer. + +=== License + +Gun uses the ISC License. + +---- +Copyright (c) 2013-2023, 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 + +Gun 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. Gun converts all the header names +to lowercase, including request headers provided by your application. diff --git a/docs/en/gun/2.1/guide/introduction/index.html b/docs/en/gun/2.1/guide/introduction/index.html new file mode 100644 index 00000000..b9fe742e --- /dev/null +++ b/docs/en/gun/2.1/guide/introduction/index.html @@ -0,0 +1,203 @@ +<!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=7" 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>Gun is an HTTP client for Erlang/OTP.</p> +<p>Gun supports the HTTP/2, HTTP/1.1 and Websocket protocols.</p> +<h2 id="_prerequisites">Prerequisites</h2> +<p>Knowledge of Erlang, but also of the HTTP/1.1, HTTP/2 and Websocket protocols is required in order to read this guide.</p> +<h2 id="_supported_platforms">Supported platforms</h2> +<p>Gun is tested and supported on Linux, FreeBSD, Windows and OSX.</p> +<p>Gun is developed for Erlang/OTP 22.0 and newer.</p> +<h2 id="_license">License</h2> +<p>Gun uses the ISC License.</p> +<div class="listingblock"><div class="content"><pre>Copyright (c) 2013-2023, 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>Gun 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. Gun converts all the header names to lowercase, including request headers provided by your application.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.1/guide/start/"> + Starting and stopping + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/guide/migrating_from_1.0.asciidoc b/docs/en/gun/2.1/guide/migrating_from_1.0.asciidoc new file mode 100644 index 00000000..3a11cfd3 --- /dev/null +++ b/docs/en/gun/2.1/guide/migrating_from_1.0.asciidoc @@ -0,0 +1,21 @@ +[appendix] +== Migrating from Gun 1.0 to 1.1 + +Gun 1.1 updates the Cowlib dependency to 2.5.1 and fixes a +few problems with experimental features. + +=== Features added + +* Update Cowlib to 2.5.1 + +=== Bugs fixed + +* A bug in the experimental `gun_sse_h` where lone id lines + were not propagated has been fixed by updating the Cowlib + dependency. + +* The status code was incorrectly given to the experimental + content handlers as a binary. It has been fixed an an + integer is now given as was intended. + +* A number of Dialyzer warnings have been fixed. diff --git a/docs/en/gun/2.1/guide/migrating_from_1.0/index.html b/docs/en/gun/2.1/guide/migrating_from_1.0/index.html new file mode 100644 index 00000000..4bd8a35b --- /dev/null +++ b/docs/en/gun/2.1/guide/migrating_from_1.0/index.html @@ -0,0 +1,189 @@ +<!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 Gun 1.0 to 1.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=7" 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 Gun 1.0 to 1.1</span></h1> + +<p>Gun 1.1 updates the Cowlib dependency to 2.5.1 and fixes a few problems with experimental features.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Update Cowlib to 2.5.1 +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>A bug in the experimental <code>gun_sse_h</code> where lone id lines were not propagated has been fixed by updating the Cowlib dependency. +</li> +<li>The status code was incorrectly given to the experimental content handlers as a binary. It has been fixed an an integer is now given as was intended. +</li> +<li>A number of Dialyzer warnings have been fixed. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.1/"> + Migrating from Gun 1.1 to 1.2 + </a> + + + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/guide/migrating_from_1.1.asciidoc b/docs/en/gun/2.1/guide/migrating_from_1.1.asciidoc new file mode 100644 index 00000000..7e0acf9d --- /dev/null +++ b/docs/en/gun/2.1/guide/migrating_from_1.1.asciidoc @@ -0,0 +1,28 @@ +[appendix] +== Migrating from Gun 1.1 to 1.2 + +Gun 1.2 adds support for the CONNECT request over HTTP/1.1 +connections. + +=== Features added + +* CONNECT requests can now be issued on HTTP/1.1 connections. + The tunneled connection can use any of the protocols Gun + supports: HTTP/1.1, HTTP/2 and Websocket over both TCP and + TLS transports. Note that Gun currently does not support + tunneling a TLS connection over a TLS connection due to + limitations in Erlang/OTP. + +* Gun supports sending multiple CONNECT requests, allowing + the tunnel to the origin server to go through multiple + proxies. + +* Gun supports sending CONNECT requests with authorization + credentials using the Basic authentication mechanism. + +* Update Cowlib to 2.6.0 + +=== Functions added + +* The functions `gun:connect/2,3,4` have been added. They can + be used to initiate CONNECT requests on HTTP/1.1 connections. diff --git a/docs/en/gun/2.1/guide/migrating_from_1.1/index.html b/docs/en/gun/2.1/guide/migrating_from_1.1/index.html new file mode 100644 index 00000000..25270e2d --- /dev/null +++ b/docs/en/gun/2.1/guide/migrating_from_1.1/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: Migrating from Gun 1.1 to 1.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=7" 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 Gun 1.1 to 1.2</span></h1> + +<p>Gun 1.2 adds support for the CONNECT request over HTTP/1.1 connections.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>CONNECT requests can now be issued on HTTP/1.1 connections. The tunneled connection can use any of the protocols Gun supports: HTTP/1.1, HTTP/2 and Websocket over both TCP and TLS transports. Note that Gun currently does not support tunneling a TLS connection over a TLS connection due to limitations in Erlang/OTP. +</li> +<li>Gun supports sending multiple CONNECT requests, allowing the tunnel to the origin server to go through multiple proxies. +</li> +<li>Gun supports sending CONNECT requests with authorization credentials using the Basic authentication mechanism. +</li> +<li>Update Cowlib to 2.6.0 +</li> +</ul> +<h2 id="_functions_added">Functions added</h2> +<ul><li>The functions <code>gun:connect/2,3,4</code> have been added. They can be used to initiate CONNECT requests on HTTP/1.1 connections. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.2/"> + Migrating from Gun 1.2 to 1.3 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.0/"> + Migrating from Gun 1.0 to 1.1 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/guide/migrating_from_1.2.asciidoc b/docs/en/gun/2.1/guide/migrating_from_1.2.asciidoc new file mode 100644 index 00000000..3b310920 --- /dev/null +++ b/docs/en/gun/2.1/guide/migrating_from_1.2.asciidoc @@ -0,0 +1,39 @@ +[appendix] +== Migrating from Gun 1.2 to 1.3 + +Gun 1.3 improves the support for CONNECT requests +introduced in the previous version and documents +Websocket protocol negotiation. + +=== Features added + +* The `protocols` CONNECT destination option has been added + as a replacement for the now deprecated `protocol` option. + +* Add built-in support for Websocket protocol negotiation + through the Websocket option `protocols`. The interface + of the handler module currently remains undocumented and + must be set to `gun_ws_h`. + +* Add the h2specd HTTP/2 test suite from the h2spec project. + +=== Bugs fixed + +* Fix connecting to HTTP/2 over TLS origin servers via + HTTP/1.1 CONNECT proxies. + +* Do not send the HTTP/1.1 keepalive while waiting for + a response to a CONNECT request. + +* Do not crash on HTTP/2 HEADERS frames with the + PRIORITY flag set. + +* Do not crash on HTTP/2 HEADERS frames when the + END_HEADERS flag is not set. + +* Do not crash on unknown HTTP/2 frame types. + +* Reject HTTP/2 WINDOW_UPDATE frames when they would + cause the window to overflow. + +* Send a GOAWAY frame on closing the HTTP/2 connection. diff --git a/docs/en/gun/2.1/guide/migrating_from_1.2/index.html b/docs/en/gun/2.1/guide/migrating_from_1.2/index.html new file mode 100644 index 00000000..b29a4fab --- /dev/null +++ b/docs/en/gun/2.1/guide/migrating_from_1.2/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: Migrating from Gun 1.2 to 1.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=7" 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 Gun 1.2 to 1.3</span></h1> + +<p>Gun 1.3 improves the support for CONNECT requests introduced in the previous version and documents Websocket protocol negotiation.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>The <code>protocols</code> CONNECT destination option has been added as a replacement for the now deprecated <code>protocol</code> option. +</li> +<li>Add built-in support for Websocket protocol negotiation through the Websocket option <code>protocols</code>. The interface of the handler module currently remains undocumented and must be set to <code>gun_ws_h</code>. +</li> +<li>Add the h2specd HTTP/2 test suite from the h2spec project. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>Fix connecting to HTTP/2 over TLS origin servers via HTTP/1.1 CONNECT proxies. +</li> +<li>Do not send the HTTP/1.1 keepalive while waiting for a response to a CONNECT request. +</li> +<li>Do not crash on HTTP/2 HEADERS frames with the PRIORITY flag set. +</li> +<li>Do not crash on HTTP/2 HEADERS frames when the END_HEADERS flag is not set. +</li> +<li>Do not crash on unknown HTTP/2 frame types. +</li> +<li>Reject HTTP/2 WINDOW_UPDATE frames when they would cause the window to overflow. +</li> +<li>Send a GOAWAY frame on closing the HTTP/2 connection. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.3/"> + Migrating from Gun 1.3 to 2.0 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.1/"> + Migrating from Gun 1.1 to 1.2 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/guide/migrating_from_1.3.asciidoc b/docs/en/gun/2.1/guide/migrating_from_1.3.asciidoc new file mode 100644 index 00000000..59f3381c --- /dev/null +++ b/docs/en/gun/2.1/guide/migrating_from_1.3.asciidoc @@ -0,0 +1,329 @@ +[appendix] +== Migrating from Gun 1.3 to 2.0 + +Gun 2.0 includes state of the art tunnel support. With +Gun 2.0 it is possible to make requests or data go through +any number of proxy endpoints using any combination of +TCP or TLS transports and HTTP/1.1, HTTP/2 or SOCKS5 +protocols. All combinations of the scenario Proxy1 -> +Proxy2 -> Origin are tested and known to work. + +Gun 2.0 adds many more features such as Websocket over +HTTP/2, a built-in cookie store, graceful shutdown, flow +control for data messages, event handlers and more. + +Gun 2.0 also introduces an experimental pool module that +automatically maintains connections and routes requests +to the right process, in a similar way as browsers do. + +Gun 2.0 greatly improves the HTTP/2 performance when it +comes to receiving large response bodies; and when receiving +response bodies from many separate requests concurrently. + +Gun now shares much of its HTTP/2 code with Cowboy, +including the HTTP/2 state machine. Numerous issues were +fixed as a result because the Cowboy implementation was +much more advanced. + +The Gun connection process is now implemented using `gen_statem`. + +Gun 2.0 requires Erlang/OTP 22.0 or greater. + +=== Features added + +* Cookie store support has been added. The `cookie_store` + option allows configuring the cookie store backend. + The `gun_cookies` module provides functions to help + implementing such a backend. Gun comes with the backend + `gun_cookies_list` which provides a per-connection, + non-persistent cookie store. The cookie store engine + implements the entire RFC6265bis draft algorithms except + the parts about non-HTTP cookies as no such interface is + provided; and the parts about SameSite as Gun has no + concept of "browsing context". + +* Graceful shutdown has been implemented. Graceful shutdown + can be initiated on the client side by calling the new + function `gun:shutdown/1` or when the owner process goes + away; or on the peer side via the connection: close HTTP/1.1 + header, the HTTP/2 GOAWAY frame or the Websocket close frame. + Gun will try to complete existing streams when possible; + other streams get canceled immediately. The `closing_timeout` + option controls how long we are willing to wait at most + before closing the connection. + +* Gun will better detect connection failures by checking the + return value from sending data to the socket. This applies + to all supported protocols. In addition, Gun now enables + `send_timeout_close` with a `send_timeout` value defaulting + to 15s. + +* Flow control has been added. It allows limiting the number + of data/Websocket messages Gun sends to the calling process. + Gun will stop reading from the socket or stop updating the + protocol's flow control window when applicable as well, to + apply some backpressure to the remote endpoint(s). It is + disabled by default and can be applied on a per-request + basis if necessary. + +* An event handler interface has been added providing access + to many internal Gun events. This can be used for a variety + of purposes including logging, tracing or otherwise + instrumenting a Gun connection. + +* In order to get separate events when connecting, the domain + lookup, connection and TLS handshakes are now performed + separately by Gun. As a result, there exists three separate + timeout options for each of the steps, and the transport + options had to be split into `tcp_opts` and `tls_opts`. + +* Gun now supports connecting through SOCKS proxies, + including secure SOCKS proxies. Both unauthenticated + and username/password authentication are supported. + +* Gun can connect through any number of HTTP, HTTPS, SOCKS + or secure SOCKS proxies, including SOCKS proxies + located after HTTP(S) proxies. The ultimate endpoint + may be using any protocol, including plain TCP, TLS, + HTTP/1.1 or HTTP/2. + +* When specifying which protocols to use, options can + now be provided specific to those protocols. It is + now possible to have separate HTTP options for an + HTTP proxy and the origin HTTP server, for example. + See the new `gun:protocols()` type for details. + +* Gun can now be used to send and receive raw data, + as if it was just a normal socket. This can be + useful when needing to connect through a number + of HTTP/Socks proxies, allowing the use of Gun's + great proxying capabilities (including TLS over TLS) + for any sort of protocols. This can also be useful + when performing HTTP/1.1 Upgrade to custom protocols. + +* Headers can now be provided as a map. + +* Header names may now be provided as binary, string or atom. + +* Gun now automatically lowercases provided header names. + +* Many HTTP/2 options have been added, allowing great + control over how Gun and the remote endpoint are + using the HTTP/2 connection. They can be used to + improve performance or lower the memory usage, for + example. + +* A new `keepalive_tolerance` option for HTTP/2 enables + closing the connection automatically when ping acks + are not received in a timely manner. It nicely + complements the `keepalive` option that makes Gun + send pings. + +* Gun now supports Websocket subprotocol negotiation + and the feature is fully documented and tested. + This can be used to create handlers that will + implement a protocol from within the Gun process itself. + The negotiation is enabled by setting the `protocols` + setting. The `default_protocol` and `user_opts` + settings are also useful. + +* It is now possible to send many Websocket frames in + a single `gun:ws_send/3` call. + +* Gun may now send Websocket ping frames automatically + at intervals determined by the `keepalive` option. It + is disabled by default. + +* A new `silence_pings` option can be set to `false` to + receive all ping and pong frames when using Websocket. + They are typically not needed and therefore silent by + default. + +* The `reply_to` option has been added to `gun:ws_upgrade/4`. + The option applies to both the response and subsequent + Websocket frames. + +* The `reply_to` option is also propagated to messages + following a CONNECT request when the protocol requested + is not HTTP. + +* A new option `retry_fun` can be used to implement + different backoff strategies when reconnecting. + +* A new option `supervise` can be used to start a Gun + connection without using Gun's supervisor. It defaults + to `true`. + +* Many improvements have been done to postpone or reject + requests and other operations while in the wrong state + (for example during state transitions when switching + protocols or connecting to proxies). + +* Update Cowlib to 2.12.0. + +=== Experimental features added + +* The `gun_pool` module was introduced. Its interface + is very similar to the `gun` module, but as it is an + experimental feature, it has not been documented yet. + The intent is to obtain feedback and document it in + an upcoming minor release. Pools are created for each + authority (host/port) and scope (user-defined value) + pairs and are resolved accordingly using the information + provided in the request and request options. Connections + may concurrently handle multiple requests/responses + from as many different processes as required. + +=== Features removed + +* Gun used to reject operations by processes that were not + the owner of the connection. This behavior has been removed. + In general the caller of a request or other operation will + receive the relevant messages unless the `reply_to` option + is used. + +* The `connect_destination()` option `protocol` has been + removed. It was previously deprecated in favor of `protocols`. + +* The `keepalive` timeout is now disabled by default + for HTTP/1.1 and HTTP/2. To be perfectly clear, this + is unrelated to the HTTP/1.1 keep-alive mechanism. + +=== Functions added + +* The function `gun:set_owner/2` has been added. It allows + changing the owner of a connection process. Only the current + owner can do this operation. + +* The function `gun:shutdown/1` has been added. It initiates + the graceful shutdown of the connection, followed by the + termination of the Gun process. + +* The function `gun:stream_info/2` has been added. It provides + information about a specific HTTP stream. + +=== Functions modified + +* The function `gun:info/1` now returns the owner of the + connection as well as the cookie store. + +* The functions `gun:await/2,3,4`, `gun:await_body/2,3,4` and + `gun:await_up/1,2,3` now distinguish the error types. They + can be a timeout, a connection error, a stream error or a + down error (when the Gun process exited while waiting). + +* The functions `gun:await/2,3,4` will now receive upgrades, + tunnel up and Websocket messages and return them. + +* Requests may now include the `tunnel` option to send the + request on a specific tunnel. + +* The functions `gun:request/4,5,6` have been replaced with + `gun:headers/4,5` and `gun:request/5,6`. This provides a + cleaner separation between requests that are followed by + a body and those that aren't. + +* The function `gun:ws_send/2` has been replaced with the + function `gun:ws_send/3`. The stream reference for the + corresponding Websocket upgrade request must now be given. + +=== Messages added + +* The `gun_tunnel_up` message has been added. + +=== Messages modified + +* The `gun_down` message no longer has its final element + documented as `UnprocessedStreams`. It never worked and + was always an empty list. + +=== Bugs fixed + +* *POTENTIAL SECURITY VULNERABILITY*: Fix transfer-encoding + precedence over content-length in responses. This bug may + contribute to a response smuggling security vulnerability + when Gun is used inside a proxy. + +* Gun will now better detect connection closes in some cases. + +* Gun will no longer send duplicate connection-wide `gun_error` + messages to the same process. + +* Gun no longer crashes when trying to upgrade to Websocket + over a connection restricted to HTTP/1.0. + +* The default value for the preferred protocols when using + CONNECT over TLS has been corrected. It was mistakenly not + enabling HTTP/2. + +* Protocol options provided for a tunnel destination were + sometimes ignored. This should no longer be the case. + +* Gun will no longer send an empty HTTP/2 DATA frame when + there is no request body. It was not necessary. + +* Gun will no longer error out when the owner process exits. + The error reason will now be a `shutdown` tuple instead. + +* The host header was set incorrectly during Websocket upgrades + when the host was configured with an IP address, resulting + in a crash. This has been corrected. + +* A completed stream could be found in the `gun_down` message when + the response contained a connection: close header. This is no + longer the case. + +* Hostnames can now be provided as atom as stated by the + documentation. + +* Gun will no longer attempt to send empty data chunks. When + using HTTP/1.1 chunked transfer-encoding this caused the + request body to end, even when `nofin` was given. + +* Gun now always retries connecting immediately when the + connection goes down. + +* The default port number for the HTTP and HTTPS schemes is + no longer sent in the host header. + +* An invalid stream reference was sent on failed Websocket + upgrade responses. This has been corrected. + +* HTTP/2 connection preface errors are now properly detected + and propagated in the `gun_down` message to the connection + owner as well as the exit reason of the Gun process. + +* HTTP/2 connection preface errors now provide a different + human readable error when the data received looks like an + HTTP/1.x response. + +* HTTP/2 connection errors were missing the human readable + reason in the `gun_error` message. This has been corrected. + +* Fix the host and :authority (pseudo-)headers when connecting + to an IPv6 address given as a tuple. They were lacking the + surrounding brackets. + +* Fix a crash in gun:info/1 when the socket was closed before + we call Transport:sockname/1. + +* Fix flushing by stream reference. When the `gun_inform` + message was flushed the function would switch to flushing + all messages from the pid instead of only messages from + the given stream. + +* Allow setting a custom SNI value. + +* Fix double sending of last chunk in HTTP/1.1 when Gun is + asked to send empty data before closing the stream. + +* Gun will now properly ignore parameters when the media + type is text/event-stream. + +* Avoid noisy crashes in the TLS over TLS code. + +* Gun will now include the StreamRef of Websocket streams + when sending `gun_down` messages. + +* Gun will no longer reject HTTP proxies that use HTTP/1.0 + for the version in their response. diff --git a/docs/en/gun/2.1/guide/migrating_from_1.3/index.html b/docs/en/gun/2.1/guide/migrating_from_1.3/index.html new file mode 100644 index 00000000..c2a6acd3 --- /dev/null +++ b/docs/en/gun/2.1/guide/migrating_from_1.3/index.html @@ -0,0 +1,337 @@ +<!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 Gun 1.3 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=7" 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 Gun 1.3 to 2.0</span></h1> + +<p>Gun 2.0 includes state of the art tunnel support. With Gun 2.0 it is possible to make requests or data go through any number of proxy endpoints using any combination of TCP or TLS transports and HTTP/1.1, HTTP/2 or SOCKS5 protocols. All combinations of the scenario Proxy1 -> Proxy2 -> Origin are tested and known to work.</p> +<p>Gun 2.0 adds many more features such as Websocket over HTTP/2, a built-in cookie store, graceful shutdown, flow control for data messages, event handlers and more.</p> +<p>Gun 2.0 also introduces an experimental pool module that automatically maintains connections and routes requests to the right process, in a similar way as browsers do.</p> +<p>Gun 2.0 greatly improves the HTTP/2 performance when it comes to receiving large response bodies; and when receiving response bodies from many separate requests concurrently.</p> +<p>Gun now shares much of its HTTP/2 code with Cowboy, including the HTTP/2 state machine. Numerous issues were fixed as a result because the Cowboy implementation was much more advanced.</p> +<p>The Gun connection process is now implemented using <code>gen_statem</code>.</p> +<p>Gun 2.0 requires Erlang/OTP 22.0 or greater.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Cookie store support has been added. The <code>cookie_store</code> option allows configuring the cookie store backend. The <code>gun_cookies</code> module provides functions to help implementing such a backend. Gun comes with the backend <code>gun_cookies_list</code> which provides a per-connection, non-persistent cookie store. The cookie store engine implements the entire RFC6265bis draft algorithms except the parts about non-HTTP cookies as no such interface is provided; and the parts about SameSite as Gun has no concept of "browsing context". +</li> +<li>Graceful shutdown has been implemented. Graceful shutdown can be initiated on the client side by calling the new function <code>gun:shutdown/1</code> or when the owner process goes away; or on the peer side via the connection: close HTTP/1.1 header, the HTTP/2 GOAWAY frame or the Websocket close frame. Gun will try to complete existing streams when possible; other streams get canceled immediately. The <code>closing_timeout</code> option controls how long we are willing to wait at most before closing the connection. +</li> +<li>Gun will better detect connection failures by checking the return value from sending data to the socket. This applies to all supported protocols. In addition, Gun now enables <code>send_timeout_close</code> with a <code>send_timeout</code> value defaulting to 15s. +</li> +<li>Flow control has been added. It allows limiting the number of data/Websocket messages Gun sends to the calling process. Gun will stop reading from the socket or stop updating the protocol's flow control window when applicable as well, to apply some backpressure to the remote endpoint(s). It is disabled by default and can be applied on a per-request basis if necessary. +</li> +<li>An event handler interface has been added providing access to many internal Gun events. This can be used for a variety of purposes including logging, tracing or otherwise instrumenting a Gun connection. +</li> +<li>In order to get separate events when connecting, the domain lookup, connection and TLS handshakes are now performed separately by Gun. As a result, there exists three separate timeout options for each of the steps, and the transport options had to be split into <code>tcp_opts</code> and <code>tls_opts</code>. +</li> +<li>Gun now supports connecting through SOCKS proxies, including secure SOCKS proxies. Both unauthenticated and username/password authentication are supported. +</li> +<li>Gun can connect through any number of HTTP, HTTPS, SOCKS or secure SOCKS proxies, including SOCKS proxies located after HTTP(S) proxies. The ultimate endpoint may be using any protocol, including plain TCP, TLS, HTTP/1.1 or HTTP/2. +</li> +<li>When specifying which protocols to use, options can now be provided specific to those protocols. It is now possible to have separate HTTP options for an HTTP proxy and the origin HTTP server, for example. See the new <code>gun:protocols()</code> type for details. +</li> +<li>Gun can now be used to send and receive raw data, as if it was just a normal socket. This can be useful when needing to connect through a number of HTTP/Socks proxies, allowing the use of Gun's great proxying capabilities (including TLS over TLS) for any sort of protocols. This can also be useful when performing HTTP/1.1 Upgrade to custom protocols. +</li> +<li>Headers can now be provided as a map. +</li> +<li>Header names may now be provided as binary, string or atom. +</li> +<li>Gun now automatically lowercases provided header names. +</li> +<li>Many HTTP/2 options have been added, allowing great control over how Gun and the remote endpoint are using the HTTP/2 connection. They can be used to improve performance or lower the memory usage, for example. +</li> +<li>A new <code>keepalive_tolerance</code> option for HTTP/2 enables closing the connection automatically when ping acks are not received in a timely manner. It nicely complements the <code>keepalive</code> option that makes Gun send pings. +</li> +<li>Gun now supports Websocket subprotocol negotiation and the feature is fully documented and tested. This can be used to create handlers that will implement a protocol from within the Gun process itself. The negotiation is enabled by setting the <code>protocols</code> setting. The <code>default_protocol</code> and <code>user_opts</code> settings are also useful. +</li> +<li>It is now possible to send many Websocket frames in a single <code>gun:ws_send/3</code> call. +</li> +<li>Gun may now send Websocket ping frames automatically at intervals determined by the <code>keepalive</code> option. It is disabled by default. +</li> +<li>A new <code>silence_pings</code> option can be set to <code>false</code> to receive all ping and pong frames when using Websocket. They are typically not needed and therefore silent by default. +</li> +<li>The <code>reply_to</code> option has been added to <code>gun:ws_upgrade/4</code>. The option applies to both the response and subsequent Websocket frames. +</li> +<li>The <code>reply_to</code> option is also propagated to messages following a CONNECT request when the protocol requested is not HTTP. +</li> +<li>A new option <code>retry_fun</code> can be used to implement different backoff strategies when reconnecting. +</li> +<li>A new option <code>supervise</code> can be used to start a Gun connection without using Gun's supervisor. It defaults to <code>true</code>. +</li> +<li>Many improvements have been done to postpone or reject requests and other operations while in the wrong state (for example during state transitions when switching protocols or connecting to proxies). +</li> +<li>Update Cowlib to 2.12.0. +</li> +</ul> +<h2 id="_experimental_features_added">Experimental features added</h2> +<ul><li>The <code>gun_pool</code> module was introduced. Its interface is very similar to the <code>gun</code> module, but as it is an experimental feature, it has not been documented yet. The intent is to obtain feedback and document it in an upcoming minor release. Pools are created for each authority (host/port) and scope (user-defined value) pairs and are resolved accordingly using the information provided in the request and request options. Connections may concurrently handle multiple requests/responses from as many different processes as required. +</li> +</ul> +<h2 id="_features_removed">Features removed</h2> +<ul><li>Gun used to reject operations by processes that were not the owner of the connection. This behavior has been removed. In general the caller of a request or other operation will receive the relevant messages unless the <code>reply_to</code> option is used. +</li> +<li>The <code>connect_destination()</code> option <code>protocol</code> has been removed. It was previously deprecated in favor of <code>protocols</code>. +</li> +<li>The <code>keepalive</code> timeout is now disabled by default for HTTP/1.1 and HTTP/2. To be perfectly clear, this is unrelated to the HTTP/1.1 keep-alive mechanism. +</li> +</ul> +<h2 id="_functions_added">Functions added</h2> +<ul><li>The function <code>gun:set_owner/2</code> has been added. It allows changing the owner of a connection process. Only the current owner can do this operation. +</li> +<li>The function <code>gun:shutdown/1</code> has been added. It initiates the graceful shutdown of the connection, followed by the termination of the Gun process. +</li> +<li>The function <code>gun:stream_info/2</code> has been added. It provides information about a specific HTTP stream. +</li> +</ul> +<h2 id="_functions_modified">Functions modified</h2> +<ul><li>The function <code>gun:info/1</code> now returns the owner of the connection as well as the cookie store. +</li> +<li>The functions <code>gun:await/2,3,4</code>, <code>gun:await_body/2,3,4</code> and <code>gun:await_up/1,2,3</code> now distinguish the error types. They can be a timeout, a connection error, a stream error or a down error (when the Gun process exited while waiting). +</li> +<li>The functions <code>gun:await/2,3,4</code> will now receive upgrades, tunnel up and Websocket messages and return them. +</li> +<li>Requests may now include the <code>tunnel</code> option to send the request on a specific tunnel. +</li> +<li>The functions <code>gun:request/4,5,6</code> have been replaced with <code>gun:headers/4,5</code> and <code>gun:request/5,6</code>. This provides a cleaner separation between requests that are followed by a body and those that aren't. +</li> +<li>The function <code>gun:ws_send/2</code> has been replaced with the function <code>gun:ws_send/3</code>. The stream reference for the corresponding Websocket upgrade request must now be given. +</li> +</ul> +<h2 id="_messages_added">Messages added</h2> +<ul><li>The <code>gun_tunnel_up</code> message has been added. +</li> +</ul> +<h2 id="_messages_modified">Messages modified</h2> +<ul><li>The <code>gun_down</code> message no longer has its final element documented as <code>UnprocessedStreams</code>. It never worked and was always an empty list. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li><strong>POTENTIAL SECURITY VULNERABILITY</strong>: Fix transfer-encoding precedence over content-length in responses. This bug may contribute to a response smuggling security vulnerability when Gun is used inside a proxy. +</li> +<li>Gun will now better detect connection closes in some cases. +</li> +<li>Gun will no longer send duplicate connection-wide <code>gun_error</code> messages to the same process. +</li> +<li>Gun no longer crashes when trying to upgrade to Websocket over a connection restricted to HTTP/1.0. +</li> +<li>The default value for the preferred protocols when using CONNECT over TLS has been corrected. It was mistakenly not enabling HTTP/2. +</li> +<li>Protocol options provided for a tunnel destination were sometimes ignored. This should no longer be the case. +</li> +<li>Gun will no longer send an empty HTTP/2 DATA frame when there is no request body. It was not necessary. +</li> +<li>Gun will no longer error out when the owner process exits. The error reason will now be a <code>shutdown</code> tuple instead. +</li> +<li>The host header was set incorrectly during Websocket upgrades when the host was configured with an IP address, resulting in a crash. This has been corrected. +</li> +<li>A completed stream could be found in the <code>gun_down</code> message when the response contained a connection: close header. This is no longer the case. +</li> +<li>Hostnames can now be provided as atom as stated by the documentation. +</li> +<li>Gun will no longer attempt to send empty data chunks. When using HTTP/1.1 chunked transfer-encoding this caused the request body to end, even when <code>nofin</code> was given. +</li> +<li>Gun now always retries connecting immediately when the connection goes down. +</li> +<li>The default port number for the HTTP and HTTPS schemes is no longer sent in the host header. +</li> +<li>An invalid stream reference was sent on failed Websocket upgrade responses. This has been corrected. +</li> +<li>HTTP/2 connection preface errors are now properly detected and propagated in the <code>gun_down</code> message to the connection owner as well as the exit reason of the Gun process. +</li> +<li>HTTP/2 connection preface errors now provide a different human readable error when the data received looks like an HTTP/1.x response. +</li> +<li>HTTP/2 connection errors were missing the human readable reason in the <code>gun_error</code> message. This has been corrected. +</li> +<li>Fix the host and :authority (pseudo-)headers when connecting to an IPv6 address given as a tuple. They were lacking the surrounding brackets. +</li> +<li>Fix a crash in gun:info/1 when the socket was closed before we call Transport:sockname/1. +</li> +<li>Fix flushing by stream reference. When the <code>gun_inform</code> message was flushed the function would switch to flushing all messages from the pid instead of only messages from the given stream. +</li> +<li>Allow setting a custom SNI value. +</li> +<li>Fix double sending of last chunk in HTTP/1.1 when Gun is asked to send empty data before closing the stream. +</li> +<li>Gun will now properly ignore parameters when the media type is text/event-stream. +</li> +<li>Avoid noisy crashes in the TLS over TLS code. +</li> +<li>Gun will now include the StreamRef of Websocket streams when sending <code>gun_down</code> messages. +</li> +<li>Gun will no longer reject HTTP proxies that use HTTP/1.0 for the version in their response. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_2.0/"> + Migrating from Gun 2.0 to 2.1 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.2/"> + Migrating from Gun 1.2 to 1.3 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/guide/migrating_from_2.0.asciidoc b/docs/en/gun/2.1/guide/migrating_from_2.0.asciidoc new file mode 100644 index 00000000..cfd64a8d --- /dev/null +++ b/docs/en/gun/2.1/guide/migrating_from_2.0.asciidoc @@ -0,0 +1,25 @@ +[appendix] +== Migrating from Gun 2.0 to 2.1 + +Gun 2.1 contains a small security improvement for +the HTTP/2 protocol, as well as includes a small +number of fixes and improvements. + +Gun 2.1 requires Erlang/OTP 22.0 or greater. + +=== Features added + +* A new HTTP/2 option `max_fragmented_header_block_size` has + been added to limit the size of header blocks that are + sent over multiple HEADERS and CONTINUATION frames. + +* Update Cowlib to 2.13.0. + +=== Bugs fixed + +* Gun will no longer configure the NPN TLS extension, + which has long been replaced by ALPN. NPN is not + compatible with TLS 1.3. + +* Gun will no longer crash when TLS connections close + very early in the connection's life time. diff --git a/docs/en/gun/2.1/guide/migrating_from_2.0/index.html b/docs/en/gun/2.1/guide/migrating_from_2.0/index.html new file mode 100644 index 00000000..b2883c28 --- /dev/null +++ b/docs/en/gun/2.1/guide/migrating_from_2.0/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: Migrating from Gun 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=7" 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 Gun 2.0 to 2.1</span></h1> + +<p>Gun 2.1 contains a small security improvement for the HTTP/2 protocol, as well as includes a small number of fixes and improvements.</p> +<p>Gun 2.1 requires Erlang/OTP 22.0 or greater.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>A new HTTP/2 option <code>max_fragmented_header_block_size</code> has been added to limit the size of header blocks that are sent over multiple HEADERS and CONTINUATION frames. +</li> +<li>Update Cowlib to 2.13.0. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>Gun will no longer configure the NPN TLS extension, which has long been replaced by ALPN. NPN is not compatible with TLS 1.3. +</li> +<li>Gun will no longer crash when TLS connections close very early in the connection's life time. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.1/guide/internals_tls_over_tls/"> + Internals: TLS over TLS + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.3/"> + Migrating from Gun 1.3 to 2.0 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/guide/protocols.asciidoc b/docs/en/gun/2.1/guide/protocols.asciidoc new file mode 100644 index 00000000..cd6de2cf --- /dev/null +++ b/docs/en/gun/2.1/guide/protocols.asciidoc @@ -0,0 +1,120 @@ +[[protocols]] +== Supported protocols + +This chapter describes the protocols supported and the +operations available to them. + +=== HTTP/1.1 + +HTTP/1.1 is a text request-response protocol. The client +sends a request, the server sends back a response. + +Gun provides convenience functions for performing GET, HEAD, +OPTIONS, POST, PATCH, PUT, and DELETE requests. All these +functions are aliases of `gun:headers/4,5` or `gun:request/5,6` +for the respective methods. Gun also provides a `gun:data/4` +function for streaming the request body. + +Gun will send a `gun_inform` message for every intermediate +informational responses received. They will always be sent +before the `gun_response` message. + +Gun will send a `gun_response` message for every response +received, followed by zero or more `gun_data` messages for +the response body, which is optionally terminated by a +`gun_trailers` message. If something goes wrong, a `gun_error` +will be sent instead. + +Gun provides convenience functions for dealing with messages. +The `gun:await/2,3,4` function waits for a response to the given +request, and the `gun:await_body/2,3,4` function for the +response body. The `gun:flush/1` function can be used to clear all +messages related to a request or a connection from the mailbox +of the calling process. + +The function `gun:cancel/2` can be used to silence the +response to a request previously sent if it is no longer +needed. When using HTTP/1.1 there is no multiplexing so +Gun will have to receive the response fully before any +other responses can be received. + +Finally, Gun can upgrade an HTTP/1.1 connection to Websocket. +It provides the `gun:ws_upgrade/2,3,4` function for that +purpose. A `gun_upgrade` message will be sent on success; +a `gun_response` message otherwise. + +=== HTTP/2 + +HTTP/2 is a binary protocol based on HTTP, compatible with +the HTTP semantics, that reduces the complexity of parsing +requests and responses, compresses the HTTP headers and +allows the server to push additional resources along with +the normal response to the original request. + +The HTTP/2 interface is very similar to HTTP/1.1, so this +section instead focuses on the differences in the interface +for the two protocols. + +Gun will send `gun_push` messages for every push received. +They will always be sent before the `gun_response` message. +They can be ignored safely if they are not needed, or they +can be canceled. + +The `gun:cancel/2` function will use the HTTP/2 stream +cancellation mechanism which allows Gun to inform the +server to stop sending a response for this particular +request, saving resources. + +=== Websocket + +Websocket is a binary protocol built on top of HTTP that +allows asynchronous concurrent communication between the +client and the server. A Websocket server can push data to +the client at any time. + +Once the Websocket connection is established over an HTTP/1.1 +connection, the only operation available on this connection +is sending Websocket frames using `gun:ws_send/3`. + +Gun will send a `gun_ws` message for every frame received. + +=== Summary + +The two following tables summarize the supported operations +and the messages Gun sends depending on the connection's +current protocol. + +.Supported operations per protocol +[cols="<,3*^",options="header"] +|=== +| Operation | HTTP/1.1 | HTTP/2 | Websocket +| delete | yes | yes | no +| get | yes | yes | no +| head | yes | yes | no +| options | yes | yes | no +| patch | yes | yes | no +| post | yes | yes | no +| put | yes | yes | no +| request | yes | yes | no +| data | yes | yes | no +| await | yes | yes | no +| await_body | yes | yes | no +| flush | yes | yes | no +| cancel | yes | yes | no +| ws_upgrade | yes | yes | no +| ws_send | no | no | yes +|=== + +.Messages sent per protocol +[cols="<,3*^",options="header"] +|=== +| Message | HTTP/1.1 | HTTP/2 | Websocket +| gun_push | no | yes | no +| gun_inform | yes | yes | no +| gun_response | yes | yes | no +| gun_data | yes | yes | no +| gun_trailers | yes | yes | no +| gun_error | yes | yes | yes +| gun_upgrade | yes | yes | no +| gun_ws | no | no | yes +|=== diff --git a/docs/en/gun/2.1/guide/protocols/index.html b/docs/en/gun/2.1/guide/protocols/index.html new file mode 100644 index 00000000..c0fb3a8a --- /dev/null +++ b/docs/en/gun/2.1/guide/protocols/index.html @@ -0,0 +1,329 @@ +<!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: Supported protocols</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=7" 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>Supported protocols</span></h1> + +<p>This chapter describes the protocols supported and the operations available to them.</p> +<h2 id="_http_1_1">HTTP/1.1</h2> +<p>HTTP/1.1 is a text request-response protocol. The client sends a request, the server sends back a response.</p> +<p>Gun provides convenience functions for performing GET, HEAD, OPTIONS, POST, PATCH, PUT, and DELETE requests. All these functions are aliases of <code>gun:headers/4,5</code> or <code>gun:request/5,6</code> for the respective methods. Gun also provides a <code>gun:data/4</code> function for streaming the request body.</p> +<p>Gun will send a <code>gun_inform</code> message for every intermediate informational responses received. They will always be sent before the <code>gun_response</code> message.</p> +<p>Gun will send a <code>gun_response</code> message for every response received, followed by zero or more <code>gun_data</code> messages for the response body, which is optionally terminated by a <code>gun_trailers</code> message. If something goes wrong, a <code>gun_error</code> will be sent instead.</p> +<p>Gun provides convenience functions for dealing with messages. The <code>gun:await/2,3,4</code> function waits for a response to the given request, and the <code>gun:await_body/2,3,4</code> function for the response body. The <code>gun:flush/1</code> function can be used to clear all messages related to a request or a connection from the mailbox of the calling process.</p> +<p>The function <code>gun:cancel/2</code> can be used to silence the response to a request previously sent if it is no longer needed. When using HTTP/1.1 there is no multiplexing so Gun will have to receive the response fully before any other responses can be received.</p> +<p>Finally, Gun can upgrade an HTTP/1.1 connection to Websocket. It provides the <code>gun:ws_upgrade/2,3,4</code> function for that purpose. A <code>gun_upgrade</code> message will be sent on success; a <code>gun_response</code> message otherwise.</p> +<h2 id="_http_2">HTTP/2</h2> +<p>HTTP/2 is a binary protocol based on HTTP, compatible with the HTTP semantics, that reduces the complexity of parsing requests and responses, compresses the HTTP headers and allows the server to push additional resources along with the normal response to the original request.</p> +<p>The HTTP/2 interface is very similar to HTTP/1.1, so this section instead focuses on the differences in the interface for the two protocols.</p> +<p>Gun will send <code>gun_push</code> messages for every push received. They will always be sent before the <code>gun_response</code> message. They can be ignored safely if they are not needed, or they can be canceled.</p> +<p>The <code>gun:cancel/2</code> function will use the HTTP/2 stream cancellation mechanism which allows Gun to inform the server to stop sending a response for this particular request, saving resources.</p> +<h2 id="_websocket">Websocket</h2> +<p>Websocket is a binary protocol built on top of HTTP that allows asynchronous concurrent communication between the client and the server. A Websocket server can push data to the client at any time.</p> +<p>Once the Websocket connection is established over an HTTP/1.1 connection, the only operation available on this connection is sending Websocket frames using <code>gun:ws_send/3</code>.</p> +<p>Gun will send a <code>gun_ws</code> message for every frame received.</p> +<h2 id="_summary">Summary</h2> +<p>The two following tables summarize the supported operations and the messages Gun sends depending on the connection's current protocol.</p> +<table rules="all" width="100%" frame="border" + cellspacing="0" cellpadding="4"> +<caption>Supported operations per protocol</caption><thead><tr><th>Operation</th> +<th>HTTP/1.1</th> +<th>HTTP/2</th> +<th>Websocket</th> +</tr></thead><tbody><tr><td>delete</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>get</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>head</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>options</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>patch</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>post</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>put</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>request</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>data</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>await</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>await_body</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>flush</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>cancel</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>ws_upgrade</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>ws_send</td> +<td>no</td> +<td>no</td> +<td>yes</td> +</tr> +</tbody></table> +<table rules="all" width="100%" frame="border" + cellspacing="0" cellpadding="4"> +<caption>Messages sent per protocol</caption><thead><tr><th>Message</th> +<th>HTTP/1.1</th> +<th>HTTP/2</th> +<th>Websocket</th> +</tr></thead><tbody><tr><td>gun_push</td> +<td>no</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>gun_inform</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>gun_response</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>gun_data</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>gun_trailers</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>gun_error</td> +<td>yes</td> +<td>yes</td> +<td>yes</td> +</tr> +<tr><td>gun_upgrade</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>gun_ws</td> +<td>no</td> +<td>no</td> +<td>yes</td> +</tr> +</tbody></table> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.1/guide/start/"> + Starting and stopping + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.1/guide/connect/"> + Connection + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/guide/start.asciidoc b/docs/en/gun/2.1/guide/start.asciidoc new file mode 100644 index 00000000..09720dca --- /dev/null +++ b/docs/en/gun/2.1/guide/start.asciidoc @@ -0,0 +1,43 @@ +[[start]] +== Starting and stopping + +This chapter describes how to start and stop the Gun application. + +=== Setting up + +Specify Gun as a dependency to your application in your favorite +build tool. + +With Erlang.mk this is done by adding `gun` to the `DEPS` variable +in your Makefile. + +.Adding Gun as an Erlang.mk dependency +[source,make] +---- +DEPS = gun +---- + +=== Starting + +Gun is an _OTP application_. It needs to be started before you can +use it. + +.Starting Gun in an Erlang shell +[source,erlang] +---- +1> application:ensure_all_started(gun). +{ok,[crypto,cowlib,asn1,public_key,ssl,gun]} +---- + +=== Stopping + +You can stop Gun using the `application:stop/1` function, however +only Gun will be stopped. This is the reverse of `application:start/1`. +The `application_ensure_all_started/1` function has no equivalent for +stopping all applications. + +.Stopping Gun +[source,erlang] +---- +application:stop(gun). +---- diff --git a/docs/en/gun/2.1/guide/start/index.html b/docs/en/gun/2.1/guide/start/index.html new file mode 100644 index 00000000..44e538b1 --- /dev/null +++ b/docs/en/gun/2.1/guide/start/index.html @@ -0,0 +1,206 @@ +<!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: Starting and stopping</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=7" 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>Starting and stopping</span></h1> + +<p>This chapter describes how to start and stop the Gun application.</p> +<h2 id="_setting_up">Setting up</h2> +<p>Specify Gun as a dependency to your application in your favorite build tool.</p> +<p>With Erlang.mk this is done by adding <code>gun</code> to the <code>DEPS</code> variable in your Makefile.</p> +<div class="listingblock"><div class="title">Adding Gun as an Erlang.mk dependency</div> +<div class="content">source-highlight: could not find a language definition for make +</div></div> +<h2 id="_starting">Starting</h2> +<p>Gun is an <em>OTP application</em>. It needs to be started before you can use it.</p> +<div class="listingblock"><div class="title">Starting Gun in an Erlang shell</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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> <b><font color="#000000">application:ensure_all_started</font></b>(<font color="#FF6600">gun</font>)<font color="#990000">.</font> +{<font color="#FF6600">ok</font>,[<font color="#FF6600">crypto</font>,<font color="#FF6600">cowlib</font>,<font color="#FF6600">asn1</font>,<font color="#FF6600">public_key</font>,<font color="#FF6600">ssl</font>,<font color="#FF6600">gun</font>]}</tt></pre> +</div></div> +<h2 id="_stopping">Stopping</h2> +<p>You can stop Gun using the <code>application:stop/1</code> function, however only Gun will be stopped. This is the reverse of <code>application:start/1</code>. The <code>application_ensure_all_started/1</code> function has no equivalent for stopping all applications.</p> +<div class="listingblock"><div class="title">Stopping Gun</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">application:stop</font></b>(<font color="#FF6600">gun</font>)<font color="#990000">.</font></tt></pre> +</div></div> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.1/guide/introduction/"> + Introduction + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.1/guide/protocols/"> + Supported protocols + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/guide/websocket.asciidoc b/docs/en/gun/2.1/guide/websocket.asciidoc new file mode 100644 index 00000000..ba06e2c7 --- /dev/null +++ b/docs/en/gun/2.1/guide/websocket.asciidoc @@ -0,0 +1,124 @@ +[[websocket]] +== Websocket + +This chapter describes how to use the Gun client for +communicating with a Websocket server. + +// @todo recovering from connection failure, reconnecting to Websocket etc. + +=== HTTP upgrade + +Websocket is a protocol built on top of HTTP. To use Websocket, +you must first request for the connection to be upgraded. Only +HTTP/1.1 connections can be upgraded to Websocket, so you might +need to restrict the protocol to HTTP/1.1 if you are planning +to use Websocket over TLS. + +You must use the `gun:ws_upgrade/2,3,4` function to upgrade +to Websocket. This function can be called anytime after connection, +so you can send HTTP requests before upgrading to Websocket. + +.Upgrade to Websocket +[source,erlang] +---- +gun:ws_upgrade(ConnPid, "/websocket"). +---- + +Gun will set all the necessary headers for performing the +Websocket upgrade, but you can specify additional headers +if needed. For example you can authenticate. + +.Upgrade to Websocket using HTTP authentication +[source,erlang] +---- +gun:ws_upgrade(ConnPid, "/websocket", [ + {<<"authorization">>, "Basic dXNlcm5hbWU6cGFzc3dvcmQ="} +]). +---- + +You can pass the Websocket options as part of the `gun:open/2,3` +call when opening the connection, or using the `gun:ws_upgrade/4`. +The fourth argument is those same options. + +Gun can negotiate the protocol to be used for the Websocket +connection. The `protocols` option can be given with a list +of protocols accepted and the corresponding handler module. +Note that the interface for handler modules is currently +undocumented and must be set to `gun_ws_h`. + +.Upgrade to Websocket with protocol negotiation +[source,erlang] +---- +StreamRef = gun:ws_upgrade(ConnPid, "/websocket", [] + #{protocols => [{<<"xmpp">>, gun_ws_h}]}). +---- + +The upgrade will fail if the server cannot satisfy the +protocol negotiation. + +When the upgrade succeeds, a `gun_upgrade` message is sent. +If the server does not understand Websocket or refused the +upgrade, a `gun_response` message is sent. If Gun couldn't +perform the upgrade due to an error (for example attempting +to upgrade to Websocket on an HTTP/1.0 connection) then a +`gun_error` message is sent. + +When the server does not understand Websocket, it may send +a meaningful response which should be processed. In the +following example we however ignore it: + +[source,erlang] +---- +receive + {gun_upgrade, ConnPid, StreamRef, [<<"websocket">>], Headers} -> + upgrade_success(ConnPid, StreamRef); + {gun_response, ConnPid, _, _, Status, Headers} -> + exit({ws_upgrade_failed, Status, Headers}); + {gun_error, ConnPid, StreamRef, Reason} -> + exit({ws_upgrade_failed, Reason}) + %% More clauses here as needed. +after 1000 -> + exit(timeout) +end. +---- + +=== Sending data + +Once the Websocket upgrade has completed successfully, you no +longer have access to functions for performing requests. You +can only send and receive Websocket messages. + +Use `gun:ws_send/3` to send messages to the server. + +.Send a text frame +[source,erlang] +---- +gun:ws_send(ConnPid, StreamRef, {text, "Hello!"}). +---- + +.Send a text frame, a binary frame and then close the connection +[source,erlang] +---- +gun:ws_send(ConnPid, StreamRef, [ + {text, "Hello!"}, + {binary, BinaryValue}, + close +]). +---- + +Note that if you send a close frame, Gun will close the connection +cleanly but may attempt to reconnect afterwards depending on the +`retry` configuration. + +=== Receiving data + +Gun sends an Erlang message to the owner process for every +Websocket message it receives. + +[source,erlang] +---- +receive + {gun_ws, ConnPid, StreamRef, Frame} -> + handle_frame(ConnPid, StreamRef, Frame) +end. +---- diff --git a/docs/en/gun/2.1/guide/websocket/index.html b/docs/en/gun/2.1/guide/websocket/index.html new file mode 100644 index 00000000..cf154726 --- /dev/null +++ b/docs/en/gun/2.1/guide/websocket/index.html @@ -0,0 +1,264 @@ +<!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</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=7" 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</span></h1> + +<p>This chapter describes how to use the Gun client for communicating with a Websocket server.</p> +<!-- @todo recovering from connection failure, reconnecting to Websocket etc.--> +<h2 id="_http_upgrade">HTTP upgrade</h2> +<p>Websocket is a protocol built on top of HTTP. To use Websocket, you must first request for the connection to be upgraded. Only HTTP/1.1 connections can be upgraded to Websocket, so you might need to restrict the protocol to HTTP/1.1 if you are planning to use Websocket over TLS.</p> +<p>You must use the <code>gun:ws_upgrade/2,3,4</code> function to upgrade to Websocket. This function can be called anytime after connection, so you can send HTTP requests before upgrading to Websocket.</p> +<div class="listingblock"><div class="title">Upgrade to Websocket</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/websocket"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Gun will set all the necessary headers for performing the Websocket upgrade, but you can specify additional headers if needed. For example you can authenticate.</p> +<div class="listingblock"><div class="title">Upgrade to Websocket using HTTP authentication</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/websocket"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"authorization"</font><font color="#990000">>></font>, <font color="#FF0000">"Basic dXNlcm5hbWU6cGFzc3dvcmQ="</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<p>You can pass the Websocket options as part of the <code>gun:open/2,3</code> call when opening the connection, or using the <code>gun:ws_upgrade/4</code>. The fourth argument is those same options.</p> +<p>Gun can negotiate the protocol to be used for the Websocket connection. The <code>protocols</code> option can be given with a list of protocols accepted and the corresponding handler module. Note that the interface for handler modules is currently undocumented and must be set to <code>gun_ws_h</code>.</p> +<div class="listingblock"><div class="title">Upgrade to Websocket with protocol negotiation</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/websocket"</font>, [] + #{<font color="#0000FF">protocols</font> <font color="#990000">=></font> [{<font color="#990000"><<</font><font color="#FF0000">"xmpp"</font><font color="#990000">>></font>, <font color="#FF6600">gun_ws_h</font>}]})<font color="#990000">.</font></tt></pre> +</div></div> +<p>The upgrade will fail if the server cannot satisfy the protocol negotiation.</p> +<p>When the upgrade succeeds, a <code>gun_upgrade</code> message is sent. If the server does not understand Websocket or refused the upgrade, a <code>gun_response</code> message is sent. If Gun couldn't perform the upgrade due to an error (for example attempting to upgrade to Websocket on an HTTP/1.0 connection) then a <code>gun_error</code> message is sent.</p> +<p>When the server does not understand Websocket, it may send a meaningful response which should be processed. In the following example we however ignore it:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_upgrade</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, [<font color="#990000"><<</font><font color="#FF0000">"websocket"</font><font color="#990000">>></font>], <font color="#009900">Headers</font>} <font color="#990000">-></font> + <b><font color="#000000">upgrade_success</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>); + {<font color="#FF6600">gun_response</font>, <font color="#009900">ConnPid</font>, <font color="#990000">_</font>, <font color="#990000">_</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>({<font color="#FF6600">ws_upgrade_failed</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>}); + {<font color="#FF6600">gun_error</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Reason</font>} <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>({<font color="#FF6600">ws_upgrade_failed</font>, <font color="#009900">Reason</font>}) + <i><font color="#9A1900">%% More clauses here as needed.</font></i> +<b><font color="#0000FF">after</font></b> <font color="#993399">1000</font> <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>(<font color="#FF6600">timeout</font>) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_sending_data">Sending data</h2> +<p>Once the Websocket upgrade has completed successfully, you no longer have access to functions for performing requests. You can only send and receive Websocket messages.</p> +<p>Use <code>gun:ws_send/3</code> to send messages to the server.</p> +<div class="listingblock"><div class="title">Send a text frame</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:ws_send</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, {<font color="#FF6600">text</font>, <font color="#FF0000">"Hello!"</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Send a text frame, a binary frame and then close the connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:ws_send</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, [ + {<font color="#FF6600">text</font>, <font color="#FF0000">"Hello!"</font>}, + {<b><font color="#000080">binary</font></b>, <font color="#009900">BinaryValue</font>}, + <font color="#FF6600">close</font> +])<font color="#990000">.</font></tt></pre> +</div></div> +<p>Note that if you send a close frame, Gun will close the connection cleanly but may attempt to reconnect afterwards depending on the <code>retry</code> configuration.</p> +<h2 id="_receiving_data">Receiving data</h2> +<p>Gun sends an Erlang message to the owner process for every Websocket message it receives.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_ws</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Frame</font>} <font color="#990000">-></font> + <b><font color="#000000">handle_frame</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Frame</font>) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.1/guide/http/"> + HTTP + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.1/guide/internals_tls_over_tls/"> + Internals: TLS over TLS + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.await/index.html b/docs/en/gun/2.1/manual/gun.await/index.html new file mode 100644 index 00000000..d0416b94 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.await/index.html @@ -0,0 +1,256 @@ +<!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: gun:await(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=7" 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>gun:await(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:await - Wait for a response</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>) + <font color="#990000">-></font> <b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> <b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>) + <font color="#990000">-></font> <b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> <font color="#009900">Result</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() +<font color="#009900">MonitorRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Timeout</font> <font color="#990000">::</font> <b><font color="#000000">timeout</font></b>() +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">tuple</font></b>() <font color="#990000">-</font> <font color="#FF6600">see</font> <font color="#FF6600">below</font></tt></pre> +</div></div> +<p>Wait for a response.</p> +<p>This function waits for a message from the given stream and returns it as a tuple. An error will be returned should the process fail or a relevant message is not received within the specified duration.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>Timeout</dt> +<dd><p>How long to wait for a message, in milliseconds.</p> +</dd> +<dt>MonitorRef</dt> +<dd><p>Monitor for the Gun connection process.</p> +<p>A monitor is automatically created for the duration of this call when one is not provided.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A number of different tuples can be returned. They correspond to the message of the same name and they contain the same elements minus the pid and stream reference. Error tuples may also be returned when a timeout or an error occur.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Result</font> <font color="#990000">::</font> {<font color="#FF6600">inform</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} + | {<font color="#FF6600">response</font>, <font color="#009900">IsFin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} + | {<font color="#FF6600">data</font>, <font color="#009900">IsFin</font>, <font color="#009900">Data</font>} + | {<font color="#FF6600">trailers</font>, <font color="#009900">Trailers</font>} + | {<font color="#FF6600">push</font>, <font color="#009900">NewStreamRef</font>, <font color="#009900">Method</font>, <font color="#009900">URI</font>, <font color="#009900">Headers</font>} + | {<font color="#FF6600">upgrade</font>, <font color="#009900">Protocols</font>, <font color="#009900">Headers</font>} + | {<font color="#FF6600">ws</font>, <font color="#009900">Frame</font>} + | {<font color="#FF6600">error</font>, <font color="#009900">Reason</font>} + +<font color="#009900">Reason</font> <font color="#990000">::</font> {<font color="#FF6600">stream_error</font> | <font color="#FF6600">connection_error</font> | <font color="#FF6600">down</font>, <b><font color="#000000">any</font></b>()} + | <font color="#FF6600">timeout</font></tt></pre> +</div></div> +<p>Because the messages and returned tuples are equivalent, please refer to the manual pages for each message for further information:</p> +<ul><li><a href="../gun_inform">gun_inform(3)</a> - Informational response +</li> +<li><a href="../gun_response">gun_response(3)</a> - Response +</li> +<li><a href="../gun_data">gun_data(3)</a> - Response body +</li> +<li><a href="../gun_trailers">gun_trailers(3)</a> - Response trailers +</li> +<li><a href="../gun_push">gun_push(3)</a> - Server-initiated push +</li> +<li><a href="../gun_upgrade">gun_upgrade(3)</a> - Successful protocol upgrade +</li> +<li><a href="../gun_ws">gun_ws(3)</a> - Websocket frame +</li> +</ul> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: <code>upgrade</code> and <code>ws</code> tuples can now be returned. +</li> +<li><strong>2.0</strong>: The error tuple type now includes the type of error. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Wait for a response</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/html;q=1.0, application/xml;q=0.1"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +{<font color="#FF6600">response</font>, <font color="#FF6600">nofin</font>, <font color="#993399">200</font>, <font color="#009900">_Headers</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font> +{<font color="#FF6600">data</font>, <font color="#FF6600">fin</font>, <font color="#990000"><<</font><font color="#FF0000">"Hello world!"</font><font color="#990000">>></font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.await_body/index.html b/docs/en/gun/2.1/manual/gun.await_body/index.html new file mode 100644 index 00000000..a7a272c4 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.await_body/index.html @@ -0,0 +1,224 @@ +<!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: gun:await_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=7" 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>gun:await_body(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:await_body - Wait for the complete response body</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>) + <font color="#990000">-></font> <b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> <b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>) + <font color="#990000">-></font> <b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Body</font>} | {<font color="#FF6600">ok</font>, <font color="#009900">Body</font>, <font color="#009900">Trailers</font>} | {<font color="#FF6600">error</font>, <font color="#009900">Reason</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() +<font color="#009900">MonitorRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Timeout</font> <font color="#990000">::</font> <b><font color="#000000">timeout</font></b>() +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">Trailers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}] +<font color="#009900">Reason</font> <font color="#990000">::</font> {<font color="#FF6600">stream_error</font> | <font color="#FF6600">connection_error</font> | <font color="#FF6600">down</font>, <b><font color="#000000">any</font></b>()} + | <font color="#FF6600">timeout</font></tt></pre> +</div></div> +<p>Wait for the complete response body.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>Timeout</dt> +<dd><p>How long to wait for each message, in milliseconds.</p> +</dd> +<dt>MonitorRef</dt> +<dd><p>Monitor for the Gun connection process.</p> +<p>A monitor is automatically created for the duration of this call when one is not provided.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The body is returned, possibly with trailers if the request contained a <code>te: trailers</code> header. Error tuples may also be returned when a timeout or an error occur.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The error tuple type now includes the type of error. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Wait for the complete response body</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/html;q=1.0, application/xml;q=0.1"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +{<font color="#FF6600">response</font>, <font color="#FF6600">nofin</font>, <font color="#993399">200</font>, <font color="#009900">_Headers</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font> +{<font color="#FF6600">ok</font>, <font color="#009900">_Body</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun.await">gun:await(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.await_up/index.html b/docs/en/gun/2.1/manual/gun.await_up/index.html new file mode 100644 index 00000000..dfeede14 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.await_up/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: gun:await_up(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=7" 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>gun:await_up(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:await_up - Wait for the connection to be up</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>) + <font color="#990000">-></font> <b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> <b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Timeout</font>) + <font color="#990000">-></font> <b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Protocol</font>} | {<font color="#FF6600">error</font>, <font color="#009900">Reason</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">MonitorRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Timeout</font> <font color="#990000">::</font> <b><font color="#000000">timeout</font></b>() +<font color="#009900">Protocol</font> <font color="#990000">::</font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> +<font color="#009900">Reason</font> <font color="#990000">::</font> {<font color="#FF6600">down</font>, <b><font color="#000000">any</font></b>()} | <font color="#FF6600">timeout</font></tt></pre> +</div></div> +<p>Wait for the connection to be up.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Timeout</dt> +<dd><p>How long to wait for, in milliseconds.</p> +</dd> +<dt>MonitorRef</dt> +<dd><p>Monitor for the Gun connection process.</p> +<p>A monitor is automatically created for the duration of this call when one is not provided.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The protocol selected for this connection. It can be used to determine the capabilities of the server. Error tuples may also be returned when a timeout or an error occur.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The error tuple type now includes the type of error. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Wait for the connection to be up</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>)<font color="#990000">.</font> +{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_up</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun_tunnel_up">gun_tunnel_up(3)</a>, <a href="../gun_up">gun_up(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.cancel/index.html b/docs/en/gun/2.1/manual/gun.cancel/index.html new file mode 100644 index 00000000..d0919037 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.cancel/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: gun:cancel(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=7" 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>gun:cancel(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:cancel - Cancel the given stream</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cancel</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>()</tt></pre> +</div></div> +<p>Cancel the given stream.</p> +<p>The behavior of this function depends on the protocol selected.</p> +<p>HTTP/1.1 does not support this feature. Gun will simply silence the stream and stop relaying messages. Gun may also decide to close the connection if the response body is too large, to avoid wasting time and bandwidth.</p> +<p>HTTP/2 allows cancelling streams at any time.</p> +<p>This function is asynchronous. Messages related to this stream may still be sent after the function returns.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned.</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">Cancel a stream</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:cancel</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun.stream_info">gun:stream_info(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.close/index.html b/docs/en/gun/2.1/manual/gun.close/index.html new file mode 100644 index 00000000..3c53c1ce --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.close/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: gun:close(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=7" 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>gun:close(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:close - Brutally close the connection</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">close</font></b>(<font color="#009900">ConnPid</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>()</tt></pre> +</div></div> +<p>Brutally close the connection.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned.</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">Close the connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">gun:close</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun.shutdown">gun:shutdown(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.connect/index.html b/docs/en/gun/2.1/manual/gun.connect/index.html new file mode 100644 index 00000000..63ffa96a --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.connect/index.html @@ -0,0 +1,252 @@ +<!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: gun:connect(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=7" 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>gun:connect(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:connect - Establish a tunnel to the origin server</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">connect</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Destination</font>) + <font color="#990000">-></font> <b><font color="#000000">connect</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Destination</font>, [], #{})<font color="#990000">.</font> + +<b><font color="#000000">connect</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Destination</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">connect</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Destination</font>, <font color="#009900">Headers</font>, #{})<font color="#990000">.</font> + +<b><font color="#000000">connect</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Destination</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Destination</font> <font color="#990000">::</font> <b><font color="#000000">gun:connect_destination</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>()</tt></pre> +</div></div> +<p>Establish a tunnel to the origin server.</p> +<p>This feature is currently only available for HTTP/1.1 connections. Upon successful completion of the CONNECT request a tunnel is established and subsequent requests will go through the tunnel.</p> +<p>Gun will not automatically re-issue the CONNECT request upon reconnection to the proxy server. The <code>gun_up</code> message can be used to know when the tunnel needs to be established again.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Destination</dt> +<dd><p>Destination of the CONNECT request.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.2</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Establish a tunnel</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"proxy.example.org"</font>, <font color="#993399">1080</font>), +{<font color="#FF6600">ok</font>, <font color="#FF6600">http</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_up</font></b>(<font color="#009900">ConnPid</font>), +<font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:connect</font></b>(<font color="#009900">ConnPid</font>, #{ + <font color="#0000FF">host</font> <font color="#990000">=></font> <font color="#FF0000">"origin-server.example.org"</font>, + <font color="#0000FF">port</font> <font color="#990000">=></font> <font color="#993399">80</font> +}), +{<font color="#FF6600">response</font>, <font color="#FF6600">fin</font>, <font color="#993399">200</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>), +<i><font color="#9A1900">%% Subsequent requests will be sent to origin-server.example.org.</font></i></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Establish a tunnel for a secure HTTP/2 connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"proxy.example.org"</font>, <font color="#993399">1080</font>), +{<font color="#FF6600">ok</font>, <font color="#FF6600">http</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_up</font></b>(<font color="#009900">ConnPid</font>), +<font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:connect</font></b>(<font color="#009900">ConnPid</font>, #{ + <font color="#0000FF">host</font> <font color="#990000">=></font> <font color="#FF0000">"origin-server.example.org"</font>, + <font color="#0000FF">port</font> <font color="#990000">=></font> <font color="#993399">443</font>, + <font color="#0000FF">protocols</font> <font color="#990000">=></font> [<font color="#FF6600">http2</font>], + <font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tls</font> +}), +{<font color="#FF6600">response</font>, <font color="#FF6600">fin</font>, <font color="#993399">200</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>), +<i><font color="#9A1900">%% Subsequent requests will be sent to origin-server.example.org.</font></i></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Establish a tunnel using proxy authorization</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"proxy.example.org"</font>, <font color="#993399">1080</font>), +{<font color="#FF6600">ok</font>, <font color="#FF6600">http</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_up</font></b>(<font color="#009900">ConnPid</font>), +<font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:connect</font></b>(<font color="#009900">ConnPid</font>, #{ + <font color="#0000FF">host</font> <font color="#990000">=></font> <font color="#FF0000">"origin-server.example.org"</font>, + <font color="#0000FF">port</font> <font color="#990000">=></font> <font color="#993399">80</font>, + <font color="#0000FF">username</font> <font color="#990000">=></font> <font color="#FF0000">"essen"</font>, + <font color="#0000FF">password</font> <font color="#990000">=></font> <font color="#FF0000">"myrealpasswordis"</font> +}), +{<font color="#FF6600">response</font>, <font color="#FF6600">fin</font>, <font color="#993399">200</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>), +<i><font color="#9A1900">%% Subsequent requests will be sent to origin-server.example.org.</font></i></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a>, <a href="../gun_up">gun_up(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.data/index.html b/docs/en/gun/2.1/manual/gun.data/index.html new file mode 100644 index 00000000..1b725aa3 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.data/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: gun:data(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=7" 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>gun:data(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:data - Stream the body of a request</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IsFin</font>, <font color="#009900">Data</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() +<font color="#009900">IsFin</font> <font color="#990000">::</font> <font color="#FF6600">fin</font> | <font color="#FF6600">nofin</font> +<font color="#009900">Data</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>()</tt></pre> +</div></div> +<p>Stream the body of a request.</p> +<p>This function can only be used if the original request had headers indicating that a body would be streamed.</p> +<p>All calls to this function must use the <code>nofin</code> flag except for the last which must use <code>fin</code> to indicate the end of the request body.</p> +<p>Empty data is allowed regardless of the value of <code>IsFin</code>. Gun may or may not send empty data chunks, however.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>IsFin</dt> +<dd><p>Whether this message terminates the request.</p> +</dd> +<dt>Data</dt> +<dd><p>All or part of the response body.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned.</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">Stream the body of a request</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:put</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/lang/fr_FR/hello"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">nofin</font>, <font color="#990000"><<</font><font color="#FF0000">"Bonjour !\n"</font><font color="#990000">>></font>)<font color="#990000">.</font> +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#990000"><<</font><font color="#FF0000">"Bonsoir !\n"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.headers">gun:headers(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.delete/index.html b/docs/en/gun/2.1/manual/gun.delete/index.html new file mode 100644 index 00000000..915871e0 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.delete/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: gun:delete(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=7" 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>gun:delete(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:delete - Delete a resource</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000000">delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, [], #{})<font color="#990000">.</font> + +<b><font color="#000000">delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>()</tt></pre> +</div></div> +<p>Delete a resource.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</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">Delete a resource</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/drafts/123"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Delete a resource with request options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/drafts/123"</font>, [], + #{<font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.flush/index.html b/docs/en/gun/2.1/manual/gun.flush/index.html new file mode 100644 index 00000000..74e0ea84 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.flush/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: gun:flush(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=7" 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>gun:flush(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:flush - Flush all messages related to a connection or a stream</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">flush</font></b>(<font color="#009900">ConnPid</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> +<b><font color="#000000">flush</font></b>(<font color="#009900">StreamRef</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>()</tt></pre> +</div></div> +<p>Flush all messages related to a connection or a stream.</p> +<h2 id="_arguments">Arguments</h2> +<p>Either of these arguments may be provided:</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned.</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">Flush all messages from a connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:flush</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Flush messages from a single stream</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:flush</font></b>(<font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.get/index.html b/docs/en/gun/2.1/manual/gun.get/index.html new file mode 100644 index 00000000..bcea3ddc --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.get/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: gun:get(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=7" 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>gun:get(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:get - Get a resource representation</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000080">get</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000080">get</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, [], #{})<font color="#990000">.</font> + +<b><font color="#000080">get</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000080">get</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000080">get</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>()</tt></pre> +</div></div> +<p>Get a resource representation.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</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">Get a resource representation</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/html;q=1.0, application/xml;q=0.1"</font><font color="#990000">>></font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Get a resource representation with request options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [], #{ + <font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font> +})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.head/index.html b/docs/en/gun/2.1/manual/gun.head/index.html new file mode 100644 index 00000000..7d140d48 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.head/index.html @@ -0,0 +1,224 @@ +<!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: gun:head(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=7" 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>gun:head(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:head - Get headers of a resource representation</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, [], #{})<font color="#990000">.</font> + +<b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>()</tt></pre> +</div></div> +<p>Get headers of a resource representation.</p> +<p>This function performs the same operation as <a href="../gun.get">gun:get(3)</a>, except the server will not send the resource representation, only the response's status code and headers.</p> +<p>While servers are supposed to send the same headers as for a GET request, they sometimes will not. For example the <code>content-length</code> header may be dropped from the response.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</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">Get headers of a resource representation</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:head</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/html;q=1.0, application/xml;q=0.1"</font><font color="#990000">>></font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Get headers of a resource representation with request options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:head</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [], #{ + <font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font> +})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:head(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.headers/index.html b/docs/en/gun/2.1/manual/gun.headers/index.html new file mode 100644 index 00000000..f3ec2e57 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.headers/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: gun: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=7" 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>gun:headers(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:headers - Initiate the given request</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">headers</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">headers</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Method</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>()</tt></pre> +</div></div> +<p>Initiate the given request.</p> +<p>This is a general purpose function that should only be used when other method-specific functions do not apply.</p> +<p>The function <code>headers/4,5</code> initiates a request but does not send the request body. It must be sent separately using <a href="../gun.data">gun:data(3)</a>.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Method</dt> +<dd><p>Method to be used for the request.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</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">Initiate a request</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:headers</font></b>(<font color="#009900">ConnPid</font>, <font color="#990000"><<</font><font color="#FF0000">"PUT"</font><font color="#990000">>></font>, + <font color="#FF0000">"/lang/fr_FR/hello"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>}])<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.info/index.html b/docs/en/gun/2.1/manual/gun.info/index.html new file mode 100644 index 00000000..b93a1820 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.info/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: gun: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=7" 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>gun:info(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:info - Obtain information about the connection</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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="#009900">ConnPid</font>) <font color="#990000">-></font> <font color="#009900">Info</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Info</font> <font color="#990000">::</font> #{ + <b><font color="#000080">owner</font></b> <font color="#990000">=></font> <b><font color="#000080">pid</font></b>(), + <font color="#0000FF">socket</font> <font color="#990000">=></font> <b><font color="#000000">inet:socket</font></b>() | <b><font color="#000000">ssl:sslsocket</font></b>(), + <font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tcp</font> | <font color="#FF6600">tls</font>, + <font color="#0000FF">protocol</font> <font color="#990000">=></font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> | <font color="#FF6600">ws</font>, + <font color="#0000FF">sock_ip</font> <font color="#990000">=></font> <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#0000FF">sock_port</font> <font color="#990000">=></font> <b><font color="#000000">inet:port_number</font></b>(), + <font color="#0000FF">origin_scheme</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>() | <font color="#000080">undefined</font>, + <font color="#0000FF">origin_host</font> <font color="#990000">=></font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#0000FF">origin_port</font> <font color="#990000">=></font> <b><font color="#000000">inet:port_number</font></b>(), + <font color="#0000FF">intermediaries</font> <font color="#990000">=></font> [<font color="#009900">Intermediary</font>], + <font color="#0000FF">cookie_store</font> <font color="#990000">=></font> <b><font color="#000000">gun_cookies:cookie_store</font></b>() +} +<font color="#009900">Intermediary</font> <font color="#990000">::</font> #{ + <font color="#0000FF">type</font> <font color="#990000">=></font> <font color="#FF6600">connect</font> | <font color="#FF6600">socks5</font>, + <font color="#0000FF">host</font> <font color="#990000">=></font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#0000FF">port</font> <font color="#990000">=></font> <b><font color="#000000">inet:port_number</font></b>(), + <font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tcp</font> | <font color="#FF6600">tls</font>, + <font color="#0000FF">protocol</font> <font color="#990000">=></font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> | <font color="#FF6600">raw</font> +}</tt></pre> +</div></div> +<p>Obtain information about the connection.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A map is returned containing various informations about the connection.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The values <code>owner</code>, <code>origin_scheme</code> and <code>cookie_store</code> were added. +</li> +<li><strong>1.3</strong>: The values <code>socket</code>, <code>transport</code>, <code>protocol</code>, <code>origin_host</code>, <code>origin_port</code> and <code>intermediaries</code> were added. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Obtain information about the connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Info</font> <font color="#990000">=</font> <b><font color="#000000">gun:info</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.open/index.html b/docs/en/gun/2.1/manual/gun.open/index.html new file mode 100644 index 00000000..2bd4d270 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.open/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: gun:open(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=7" 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>gun:open(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:open - Open a connection to the given host and port</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">open</font></b>(<font color="#009900">Host</font>, <font color="#009900">Port</font>) <font color="#990000">-></font> <b><font color="#000000">open</font></b>(<font color="#009900">Host</font>, <font color="#009900">Port</font>, #{}) +<b><font color="#000000">open</font></b>(<font color="#009900">Host</font>, <font color="#009900">Port</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <b><font color="#000080">pid</font></b>()} | {<font color="#FF6600">error</font>, <font color="#009900">Reason</font>} + +<font color="#009900">Host</font> <font color="#990000">::</font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>() +<font color="#009900">Port</font> <font color="#990000">::</font> <b><font color="#000000">inet:port_number</font></b>() +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">gun:opts</font></b>() +<font color="#009900">Reason</font> <font color="#990000">::</font> {<font color="#FF6600">options</font>, <font color="#009900">OptName</font>} + | {<font color="#FF6600">options</font>, {<font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> | <font color="#FF6600">ws</font>, <font color="#009900">OptName</font>}} + | <b><font color="#000000">any</font></b>() +<font color="#009900">OptName</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>()</tt></pre> +</div></div> +<p>Open a connection to the given host and port.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Host</dt> +<dd><p>Host or IP address to connect to.</p> +</dd> +<dt>Port</dt> +<dd><p>Port to connect to.</p> +</dd> +<dt>Opts</dt> +<dd><p>Options for this connection.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The pid of the newly created Gun process is returned. Note that this does not indicate that the connection has been successfully opened; the <a href="../gun_up">gun_up(3)</a> message will be sent for that.</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">Connect to a server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Connect to a server with custom options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>, + #{<font color="#0000FF">protocols</font> <font color="#990000">=></font> [<font color="#FF6600">http2</font>]})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Connect to a server using its IP address</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>({<font color="#993399">127</font>,<font color="#993399">0</font>,<font color="#993399">0</font>,<font color="#993399">1</font>}, <font color="#993399">443</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a>, <a href="../gun_tunnel_up">gun_tunnel_up(3)</a>, <a href="../gun_up">gun_up(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.open_unix/index.html b/docs/en/gun/2.1/manual/gun.open_unix/index.html new file mode 100644 index 00000000..b6604d9d --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.open_unix/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: gun:open_unix(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=7" 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>gun:open_unix(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:open_unix - Open a connection to the given Unix domain socket</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">open_unix</font></b>(<font color="#009900">SocketPath</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <b><font color="#000080">pid</font></b>()} | {<font color="#FF6600">error</font>, <font color="#009900">Reason</font>} + +<font color="#009900">SocketPath</font> <font color="#990000">::</font> <b><font color="#000000">string</font></b>() +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">gun:opts</font></b>() +<font color="#009900">Reason</font> <font color="#990000">::</font> {<font color="#FF6600">options</font>, <font color="#009900">OptName</font>} + | {<font color="#FF6600">options</font>, {<font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> | <font color="#FF6600">ws</font>, <font color="#009900">OptName</font>}} + | <b><font color="#000000">any</font></b>() +<font color="#009900">OptName</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>()</tt></pre> +</div></div> +<p>Open a connection to the given Unix domain socket.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>SocketPath</dt> +<dd><p>Path to the Unix domain socket to connect to.</p> +</dd> +<dt>Opts</dt> +<dd><p>Options for this connection.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The pid of the newly created Gun process is returned. Note that this does not indicate that the connection has been successfully opened; the <a href="../gun_up">gun_up(3)</a> message will be sent for that.</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">Connect to a server via a Unix domain socket</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open_unix</font></b>(<font color="#FF0000">"/var/run/dbus/system_bus_socket"</font>, #{})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Connect to a server via a Unix domain socket with custom options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open_unix</font></b>(<font color="#FF0000">"/var/run/dbus/system_bus_socket"</font>, + #{<font color="#0000FF">protocols</font> <font color="#990000">=></font> [<font color="#FF6600">http2</font>]})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a>, <a href="../gun_tunnel_up">gun_tunnel_up(3)</a>, <a href="../gun_up">gun_up(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.options/index.html b/docs/en/gun/2.1/manual/gun.options/index.html new file mode 100644 index 00000000..f2b4493a --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.options/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: gun:options(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=7" 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>gun:options(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:options - Query the capabilities of the server or a resource</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000000">options</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, [], #{})<font color="#990000">.</font> + +<b><font color="#000000">options</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">options</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">options</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>()</tt></pre> +</div></div> +<p>Query the capabilities of the server or a resource.</p> +<p>The special path <code>"*"</code> can be used to obtain information about the server as a whole. Any other path will return information about that resource specifically.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</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">Query the capabilities of the server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:options</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"*"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Query the capabilities of a resource</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:options</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.patch/index.html b/docs/en/gun/2.1/manual/gun.patch/index.html new file mode 100644 index 00000000..6c958e29 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.patch/index.html @@ -0,0 +1,247 @@ +<!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: gun:patch(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=7" 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>gun:patch(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:patch - Apply a set of changes to a resource</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>) + <font color="#990000">-></font> <b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, #{}) + +<b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>()</tt></pre> +</div></div> +<p>Apply a set of changes to a resource.</p> +<p>The behavior of this function varies depending on whether a body is provided.</p> +<p>The function <code>patch/3,4</code> does not send a body. It must be sent separately using <a href="../gun.data">gun:data(3)</a>.</p> +<p>The function <code>patch/4,5</code> sends the entire request, including the request body, immediately. It is therefore not possible to use <a href="../gun.data">gun:data(3)</a> after that. You should provide a content-type header. Gun will set the content-length header automatically.</p> +<p>The body sent in this request should be a patch document with instructions on how to update the resource.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>Body</dt> +<dd><p>Request body.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Implicit body detection has been removed. The body must now be provided either directly (even if empty) or using separate calls. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Patch a resource</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/users/1"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/json-patch+json"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Patch a resource in multiple calls</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/users/1"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/json-patch+json"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, + <font color="#990000"><<</font><font color="#FF0000">"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Patch a resource with request options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/users/1"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/json-patch+json"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]"</font><font color="#990000">>></font>, + #{<font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.post/index.html b/docs/en/gun/2.1/manual/gun.post/index.html new file mode 100644 index 00000000..6eb5ea1a --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.post/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: gun:post(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=7" 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>gun:post(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:post - Process the enclosed representation according to a resource's own semantics</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>) + <font color="#990000">-></font> <b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, #{}) + +<b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>()</tt></pre> +</div></div> +<p>Process the enclosed representation according to a resource's own semantics.</p> +<p>The behavior of this function varies depending on whether a body is provided.</p> +<p>The function <code>post/3,4</code> does not send a body. It must be sent separately using <a href="../gun.data">gun:data(3)</a>.</p> +<p>The function <code>post/4,5</code> sends the entire request, including the request body, immediately. It is therefore not possible to use <a href="../gun.data">gun:data(3)</a> after that. You should provide a content-type header. Gun will set the content-length header automatically.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>Body</dt> +<dd><p>Request body.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Implicit body detection has been removed. The body must now be provided either directly (even if empty) or using separate calls. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Post to a resource</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:post</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/search"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/x-www-form-urlencoded"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"q=nine%20nines"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Post to a resource in multiple calls</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:post</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/search"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/x-www-form-urlencoded"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#990000"><<</font><font color="#FF0000">"q=nine%20nines"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Post to a resource with request options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:post</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/search"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/x-www-form-urlencoded"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"q=nine%20nines"</font><font color="#990000">>></font>, + #{<font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.put/index.html b/docs/en/gun/2.1/manual/gun.put/index.html new file mode 100644 index 00000000..d5b54f00 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.put/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: gun:put(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=7" 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>gun:put(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:put - Create or replace a resource</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>) + <font color="#990000">-></font> <b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, #{}) + +<b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>()</tt></pre> +</div></div> +<p>Create or replace a resource.</p> +<p>The behavior of this function varies depending on whether a body is provided.</p> +<p>The function <code>put/3,4</code> does not send a body. It must be sent separately using <a href="../gun.data">gun:data(3)</a>.</p> +<p>The function <code>put/4,5</code> sends the entire request, including the request body, immediately. It is therefore not possible to use <a href="../gun.data">gun:data(3)</a> after that. You should provide a content-type header. Gun will set the content-length header automatically.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>Body</dt> +<dd><p>Request body.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Implicit body detection has been removed. The body must now be provided either directly (even if empty) or using separate calls. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Put a resource</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:put</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/lang/fr_FR/hello"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</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">"Bonjour !"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Put a resource in multiple calls</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:put</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/lang/fr_FR/hello"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#990000"><<</font><font color="#FF0000">"Bonjour !"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Put a resource with request options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:put</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/lang/fr_FR/hello"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</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">"Bonjour !"</font><font color="#990000">>></font>, + #{<font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.request/index.html b/docs/en/gun/2.1/manual/gun.request/index.html new file mode 100644 index 00000000..a5678fb6 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.request/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: gun:request(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=7" 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>gun:request(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:request - Perform the given request</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">request</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>) + <font color="#990000">-></font> <b><font color="#000000">request</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, #{}) + +<b><font color="#000000">request</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Method</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>()</tt></pre> +</div></div> +<p>Perform the given request.</p> +<p>This is a general purpose function that should only be used when other method-specific functions do not apply.</p> +<p>The function <code>request/5,6</code> sends the entire request, including the request body, immediately. It is therefore not possible to use <a href="../gun.data">gun:data(3)</a> after that. You should provide a content-type header. Gun will set the content-length header automatically.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Method</dt> +<dd><p>Method to be used for the request.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>Body</dt> +<dd><p>Request body.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Implicit body detection has been removed. The body must now be provided either directly (even if empty) or using <a href="../gun.headers">gun:headers(3)</a>. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Perform a request</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:request</font></b>(<font color="#009900">ConnPid</font>, <font color="#990000"><<</font><font color="#FF0000">"PUT"</font><font color="#990000">>></font>, + <font color="#FF0000">"/lang/fr_FR/hello"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</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">"Bonjour !"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.set_owner/index.html b/docs/en/gun/2.1/manual/gun.set_owner/index.html new file mode 100644 index 00000000..a8a0ce70 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.set_owner/index.html @@ -0,0 +1,197 @@ +<!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: gun:set_owner(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=7" 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>gun:set_owner(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:set_owner - Set a new owner for the connection</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">set_owner</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">OwnerPid</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">OwnerPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>()</tt></pre> +</div></div> +<p>Set a new owner for the connection.</p> +<p>Only the current owner of the connection can set a new owner.</p> +<p>Gun monitors the owner of the connection and automatically shuts down gracefully when the owner exits.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>OwnerPid</dt> +<dd><p>The pid of the new owner for the connection.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> 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">Set a new owner for the connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">gun:set_owner</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">OwnerPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun.shutdown">gun:shutdown(3)</a>, <a href="../gun.close">gun:close(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.shutdown/index.html b/docs/en/gun/2.1/manual/gun.shutdown/index.html new file mode 100644 index 00000000..6e4e0339 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.shutdown/index.html @@ -0,0 +1,201 @@ +<!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: gun:shutdown(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=7" 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>gun:shutdown(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:shutdown - Gracefully close the connection</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#000080">shutdown</font>(<font color="#009900">ConnPid</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>()</tt></pre> +</div></div> +<p>Gracefully close the connection.</p> +<p>Gun will wait for up to <code>closing_timeout</code> milliseconds before brutally closing the connection. The graceful shutdown mechanism varies between the different protocols:</p> +<ul><li>For HTTP/1.1 there is no such mechanism and Gun will close the connection once the current response is received. Any pipelined requests are immediately terminated. +</li> +<li>For HTTP/2 Gun will send a GOAWAY frame and wait for the existing streams to terminate. +</li> +<li>For Websocket Gun will send a close frame and wait for the server's close frame before closing the connection. +</li> +</ul> +<p>The function returns immediately. The connection may therefore still be up for some time after this call.</p> +<p>Gun will not attempt to reconnect once graceful shutdown has been initiated.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> 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">Gracefully shutdown the connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">gun:shutdown</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun.close">gun:close(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.stream_info/index.html b/docs/en/gun/2.1/manual/gun.stream_info/index.html new file mode 100644 index 00000000..d1bf25cc --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.stream_info/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: gun:stream_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=7" 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>gun:stream_info(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:stream_info - Obtain information about a stream</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">stream_info</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#000080">undefined</font> | <font color="#009900">Info</font>} | {<font color="#FF6600">error</font>, <font color="#FF6600">not_connected</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() +<font color="#009900">Info</font> <font color="#990000">::</font> #{ + <font color="#0000FF">ref</font> <font color="#990000">=></font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#0000FF">reply_to</font> <font color="#990000">=></font> <b><font color="#000080">pid</font></b>(), + <font color="#0000FF">state</font> <font color="#990000">=></font> <b><font color="#000080">running</font></b> | <font color="#FF6600">stopping</font>, + <font color="#0000FF">intermediaries</font> <font color="#990000">=></font> [<font color="#009900">Intermediary</font>], + <font color="#0000FF">tunnel</font> <font color="#990000">=></font> <font color="#009900">Tunnel</font> +} +<font color="#009900">Intermediary</font> <font color="#990000">::</font> #{ + <font color="#0000FF">type</font> <font color="#990000">=></font> <font color="#FF6600">connect</font> | <font color="#FF6600">socks5</font>, + <font color="#0000FF">host</font> <font color="#990000">=></font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#0000FF">port</font> <font color="#990000">=></font> <b><font color="#000000">inet:port_number</font></b>(), + <font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tcp</font> | <font color="#FF6600">tls</font>, + <font color="#0000FF">protocol</font> <font color="#990000">=></font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> | <font color="#FF6600">raw</font> +} +<font color="#009900">Tunnel</font> <font color="#990000">::</font> #{ + <font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tcp</font> | <font color="#FF6600">tls</font>, + <font color="#0000FF">protocol</font> <font color="#990000">=></font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> | <font color="#FF6600">raw</font>, + <font color="#0000FF">origin_scheme</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>() | <font color="#000080">undefined</font>, + <font color="#0000FF">origin_host</font> <font color="#990000">=></font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#0000FF">origin_port</font> <font color="#990000">=></font> <b><font color="#000000">inet:port_number</font></b>() +}</tt></pre> +</div></div> +<p>Obtain information about a stream.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A map is returned containing various informations about the stream.</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">Obtain information about a stream</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Info</font> <font color="#990000">=</font> <b><font color="#000000">gun:stream_info</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun.cancel">gun:cancel(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.update_flow/index.html b/docs/en/gun/2.1/manual/gun.update_flow/index.html new file mode 100644 index 00000000..5e54a109 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.update_flow/index.html @@ -0,0 +1,201 @@ +<!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: gun:update_flow(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=7" 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>gun:update_flow(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:update_flow - Update a stream's flow control value</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">update_flow</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Flow</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() +<font color="#009900">Flow</font> <font color="#990000">::</font> <b><font color="#000000">pos_integer</font></b>()</tt></pre> +</div></div> +<p>Update a stream's flow control value.</p> +<p>The flow value can only ever be incremented.</p> +<p>This function does nothing for streams that have flow control disabled (which is the default).</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>Flow</dt> +<dd><p>Flow control value increment.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> 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">Update a stream's flow control value</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:update_flow</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#993399">10</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.ws_send/index.html b/docs/en/gun/2.1/manual/gun.ws_send/index.html new file mode 100644 index 00000000..23fcf88e --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.ws_send/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: gun:ws_send(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=7" 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>gun:ws_send(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:ws_send - Send Websocket frames</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">ws_send</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Frames</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() +<font color="#009900">Frames</font> <font color="#990000">::</font> <font color="#009900">Frame</font> | [<font color="#009900">Frame</font>] +<font color="#009900">Frame</font> <font color="#990000">::</font> <font color="#FF6600">close</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">close</font> | <font color="#FF6600">ping</font> | <font color="#FF6600">pong</font>, <b><font color="#000000">iodata</font></b>()} + | {<font color="#FF6600">close</font>, <b><font color="#000000">non_neg_integer</font></b>(), <b><font color="#000000">iodata</font></b>()}</tt></pre> +</div></div> +<p>Send Websocket frames.</p> +<p>The connection must first be upgraded to Websocket using the function <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream that was upgraded to Websocket.</p> +</dd> +<dt>Frames</dt> +<dd><p>One or more Websocket frame(s).</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The mandatory <code>StreamRef</code> argument was added. +</li> +<li><strong>2.0</strong>: It is now possible to send multiple frames at once. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Send a single frame</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:ws_send</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, {<font color="#FF6600">text</font>, <font color="#990000"><<</font><font color="#FF0000">"Hello world!"</font><font color="#990000">>></font>})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Send many frames including a close frame</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:ws_send</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, [ + {<font color="#FF6600">text</font>, <font color="#990000"><<</font><font color="#FF0000">"See you later, world!"</font><font color="#990000">>></font>}, + <font color="#FF6600">close</font> +])<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>, <a href="../gun_upgrade">gun_upgrade(3)</a>, <a href="../gun_ws">gun_ws(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun.ws_upgrade/index.html b/docs/en/gun/2.1/manual/gun.ws_upgrade/index.html new file mode 100644 index 00000000..34c2cd6e --- /dev/null +++ b/docs/en/gun/2.1/manual/gun.ws_upgrade/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: gun:ws_upgrade(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=7" 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>gun:ws_upgrade(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:ws_upgrade - Upgrade to Websocket</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000000">ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, []) + +<b><font color="#000000">ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<b><font color="#000000">ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">WsOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">WsOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:ws_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>()</tt></pre> +</div></div> +<p>Upgrade to Websocket.</p> +<p>The behavior of this function depends on the protocol selected.</p> +<p>HTTP/1.1 cannot handle Websocket and HTTP requests concurrently. The upgrade, if successful, will result in the complete takeover of the connection. Any subsequent HTTP requests will be rejected.</p> +<p>Gun does not currently support Websocket over HTTP/2.</p> +<p>By default Gun will take the Websocket options from the connection's <code>ws_opts</code>.</p> +<p>Websocket subprotocol negotiation is enabled when the <code>protocols</code> option is given. It takes a subprotocol name and a module implementing the <a href="../gun_ws_protocol">gun_ws_protocol(3)</a> behavior.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>WsOpts</dt> +<dd><p>Configuration for the Websocket protocol.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</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">Upgrade to Websocket</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/ws"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"sec-websocket-protocol"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"chat"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +<b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_upgrade</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, [<font color="#990000"><<</font><font color="#FF0000">"websocket"</font><font color="#990000">>></font>], <font color="#990000">_</font>} <font color="#990000">-></font> + <font color="#FF6600">ok</font> +<b><font color="#0000FF">after</font></b> <font color="#993399">5000</font> <font color="#990000">-></font> + <b><font color="#000000">error</font></b>(<font color="#FF6600">timeout</font>) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Upgrade to Websocket with different options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/ws"</font>, [], #{ + <font color="#0000FF">compress</font> <font color="#990000">=></font> <font color="#000080">false</font> +})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Upgrade to Websocket with protocol negotiation</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/ws"</font>, [], #{ + <font color="#0000FF">protocols</font> <font color="#990000">=></font> [ + {<font color="#990000"><<</font><font color="#FF0000">"mqtt"</font><font color="#990000">>></font>, <font color="#FF6600">gun_ws_mqtt_h</font>}, + {<font color="#990000"><<</font><font color="#FF0000">"v12.stomp"</font><font color="#990000">>></font>, <font color="#FF6600">gun_ws_stomp_h</font>} + ] +})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.ws_send">gun:ws_send(3)</a>, <a href="../gun_upgrade">gun_upgrade(3)</a>, <a href="../gun_ws">gun_ws(3)</a>, <a href="../gun_ws_protocol">gun_ws_protocol(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun/index.html b/docs/en/gun/2.1/manual/gun/index.html new file mode 100644 index 00000000..db269a93 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun/index.html @@ -0,0 +1,662 @@ +<!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: gun(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=7" 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>gun(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun - Asynchronous HTTP client</p> +<h2 id="_description">Description</h2> +<p>The <code>gun</code> module provides an asynchronous interface for connecting and communicating with Web servers over HTTP, HTTP/2 or Websocket.</p> +<h2 id="_exports">Exports</h2> +<p>Connection:</p> +<ul><li><a href="../gun.open">gun:open(3)</a> - Open a connection to the given host and port +</li> +<li><a href="../gun.open_unix">gun:open_unix(3)</a> - Open a connection to the given Unix domain socket +</li> +<li><a href="../gun.set_owner">gun:set_owner(3)</a> - Set a new owner for the connection +</li> +<li><a href="../gun.shutdown">gun:shutdown(3)</a> - Gracefully close the connection +</li> +<li><a href="../gun.close">gun:close(3)</a> - Brutally close the connection +</li> +<li><a href="../gun.info">gun:info(3)</a> - Obtain information about the connection +</li> +</ul> +<p>Requests:</p> +<ul><li><a href="../gun.get">gun:get(3)</a> - Get a resource representation +</li> +<li><a href="../gun.head">gun:head(3)</a> - Get headers of a resource representation +</li> +<li><a href="../gun.options">gun:options(3)</a> - Query the capabilities of the server or a resource +</li> +<li><a href="../gun.patch">gun:patch(3)</a> - Apply a set of changes to a resource +</li> +<li><a href="../gun.post">gun:post(3)</a> - Process the enclosed representation according to a resource's own semantics +</li> +<li><a href="../gun.put">gun:put(3)</a> - Create or replace a resource +</li> +<li><a href="../gun.delete">gun:delete(3)</a> - Delete a resource +</li> +<li><a href="../gun.headers">gun:headers(3)</a> - Initiate the given request +</li> +<li><a href="../gun.request">gun:request(3)</a> - Perform the given request +</li> +<li><a href="../gun.data">gun:data(3)</a> - Stream the body of a request +</li> +</ul> +<p>Proxies:</p> +<ul><li><a href="../gun.connect">gun:connect(3)</a> - Establish a tunnel to the origin server +</li> +</ul> +<p>Messages:</p> +<ul><li><a href="../gun.await">gun:await(3)</a> - Wait for a response +</li> +<li><a href="../gun.await_body">gun:await_body(3)</a> - Wait for the complete response body +</li> +<li><a href="../gun.await_up">gun:await_up(3)</a> - Wait for the connection to be up +</li> +<li><a href="../gun.flush">gun:flush(3)</a> - Flush all messages related to a connection or a stream +</li> +</ul> +<p>Streams:</p> +<ul><li><a href="../gun.update_flow">gun:update_flow(3)</a> - Update a stream's flow control value +</li> +<li><a href="../gun.cancel">gun:cancel(3)</a> - Cancel the given stream +</li> +<li><a href="../gun.stream_info">gun:stream_info(3)</a> - Obtain information about a stream +</li> +</ul> +<p>Websocket:</p> +<ul><li><a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a> - Upgrade to Websocket +</li> +<li><a href="../gun.ws_send">gun:ws_send(3)</a> - Send Websocket frames +</li> +</ul> +<h2 id="_messages">Messages</h2> +<p>Gun will inform the calling process of events asynchronously by sending any of the following messages:</p> +<p>Connection:</p> +<ul><li><a href="../gun_up">gun_up(3)</a> - The connection is up +</li> +<li><a href="../gun_tunnel_up">gun_tunnel_up(3)</a> - The tunnel is up +</li> +<li><a href="../gun_down">gun_down(3)</a> - The connection is down +</li> +<li><a href="../gun_upgrade">gun_upgrade(3)</a> - Successful protocol upgrade +</li> +<li><a href="../gun_error">gun_error(3)</a> - Stream or connection-wide error +</li> +</ul> +<p>Responses:</p> +<ul><li><a href="../gun_push">gun_push(3)</a> - Server-initiated push +</li> +<li><a href="../gun_inform">gun_inform(3)</a> - Informational response +</li> +<li><a href="../gun_response">gun_response(3)</a> - Response +</li> +<li><a href="../gun_data">gun_data(3)</a> - Response body +</li> +<li><a href="../gun_trailers">gun_trailers(3)</a> - Response trailers +</li> +</ul> +<p>Websocket:</p> +<ul><li><a href="../gun_ws">gun_ws(3)</a> - Websocket frame +</li> +</ul> +<p>The response messages will be sent to the process that opened the connection by default. The <code>reply_to</code> request option can be used to redirect request-specific messages to a different process.</p> +<h2 id="_types">Types</h2> +<h3 id="_connect_destination">connect_destination()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">connect_destination</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">host</font> <font color="#990000">:=</font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#FF6600">port</font> <font color="#990000">:=</font> <b><font color="#000000">inet:port_number</font></b>(), + + <font color="#0000FF">username</font> <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>(), + <font color="#0000FF">password</font> <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>(), + <font color="#0000FF">protocols</font> <font color="#990000">=></font> <b><font color="#000000">protocols</font></b>(), + <font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tcp</font> | <font color="#FF6600">tls</font>, + + <font color="#0000FF">tls_opts</font> <font color="#990000">=></font> [<b><font color="#000000">ssl:tls_client_option</font></b>()], + <font color="#0000FF">tls_handshake_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>() +}</tt></pre> +</div></div> +<p>Destination of a CONNECT request.</p> +<p>The default value, if any, is given next to the option name:</p> +<dl><dt>host, port</dt> +<dd><p>Destination hostname and port number. Mandatory.</p> +<p>Upon successful completion of the CONNECT request, Gun will begin using these as the host and port of the origin server for subsequent requests.</p> +</dd> +<dt>username, password</dt> +<dd><p>Proxy authorization credentials. They are only sent when both options are provided.</p> +</dd> +<dt>protocols - see below</dt> +<dd><p>Ordered list of preferred protocols. Please refer to the <code>protocols()</code> type documentation for details.</p> +<p>Defaults to <code>[http]</code> when the transport is <code>tcp</code>, and <code>[http2, http]</code> when the transport is <code>tls</code>.</p> +</dd> +<dt>transport (tcp)</dt> +<dd><p>Transport that will be used for tunneled requests.</p> +</dd> +<dt>tls_opts ([])</dt> +<dd><p>Options to use for tunneled TLS connections.</p> +</dd> +<dt>tls_handshake_timeout (infinity)</dt> +<dd><p>Handshake timeout for tunneled TLS connections.</p> +</dd> +</dl> +<h3 id="_http_opts">http_opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">http_opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">closing_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">cookie_ignore_informational</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">flow</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <font color="#0000FF">keepalive</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">transform_header_name</font> <font color="#990000">=></font> <b><font color="#0000FF">fun</font></b>((<b><font color="#000080">binary</font></b>()) <font color="#990000">-></font> <b><font color="#000080">binary</font></b>()), + <font color="#0000FF">version</font> <font color="#990000">=></font> <font color="#FF6600">'HTTP/1.1'</font> | <font color="#FF6600">'HTTP/1.0'</font> +}</tt></pre> +</div></div> +<p>Configuration for the HTTP protocol.</p> +<p>The default value is given next to the option name:</p> +<!-- @todo Document content_handlers and gun_sse_h.--> +<dl><dt>closing_timeout (15000)</dt> +<dd><p>Time to wait before brutally closing the connection when a graceful shutdown was requested via a call to <a href="../gun.shutdown">gun:shutdown(3)</a>.</p> +</dd> +<dt>cookie_ignore_informational (false)</dt> +<dd><p>Whether cookies received inside informational responses (1xx status code) must be ignored.</p> +</dd> +<dt>flow - see below</dt> +<dd><p>The initial flow control value for all HTTP/1.1 streams. By default flow control is disabled.</p> +</dd> +<dt>keepalive (infinity)</dt> +<dd><p>Time between pings in milliseconds. Since the HTTP protocol has no standardized way to ping the server, Gun will simply send an empty line when the connection is idle. Gun only makes a best effort here as servers usually have configurable limits to drop idle connections. Disabled by default due to potential incompatibilities.</p> +</dd> +<dt>transform_header_name - see below</dt> +<dd><p>A function that will be applied to all header names before they are sent to the server. Gun assumes that all header names are in lower case. This function is useful if you, for example, need to re-case header names in the event that the server incorrectly considers the case of header names to be significant.</p> +</dd> +<dt>version (<code>'HTTP/1.1'</code>)</dt> +<dd><p>HTTP version to use.</p> +</dd> +</dl> +<h3 id="_http2_opts">http2_opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">http2_opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">closing_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">cookie_ignore_informational</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">flow</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <font color="#0000FF">keepalive</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">keepalive_tolerance</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + + <i><font color="#9A1900">%% HTTP/2 state machine configuration.</font></i> + <font color="#0000FF">connection_window_margin_size</font> <font color="#990000">=></font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font>, + <font color="#0000FF">connection_window_update_threshold</font> <font color="#990000">=></font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font>, + <font color="#0000FF">enable_connect_protocol</font> <font color="#990000">=></font> <b><font color="#000000">boolean</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_connection_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_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_fragmented_header_block_size</font> <font color="#990000">=></font> <font color="#993399">16384</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font>, + <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">max_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">preface_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">settings_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">stream_window_data_threshold</font> <font color="#990000">=></font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font>, + <font color="#0000FF">stream_window_margin_size</font> <font color="#990000">=></font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font>, + <font color="#0000FF">stream_window_update_threshold</font> <font color="#990000">=></font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font> +}</tt></pre> +</div></div> +<p>Configuration for the HTTP/2 protocol.</p> +<p>The default value is given next to the option name:</p> +<!-- @todo Document content_handlers and gun_sse_h.--> +<dl><dt>closing_timeout (15000)</dt> +<dd><p>Time to wait before brutally closing the connection when a graceful shutdown was requested either via a call to <a href="../gun.shutdown">gun:shutdown(3)</a> or by the server.</p> +</dd> +<dt>cookie_ignore_informational (false)</dt> +<dd><p>Whether cookies received inside informational responses (1xx status code) must be ignored.</p> +</dd> +<dt>flow - see below</dt> +<dd><p>The initial flow control value for all HTTP/2 streams. By default flow control is disabled.</p> +</dd> +<dt>keepalive (infinity)</dt> +<dd><p>Time between pings in milliseconds.</p> +</dd> +<dt>keepalive_tolerance - see below</dt> +<dd><p>The number of unacknowledged pings in flight that are tolerated before the connection is closed. By default this mechanism is disabled even if <code>keepalive</code> is enabled.</p> +</dd> +</dl> +<h3 id="_opts">opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">connect_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">cookie_store</font> <font color="#990000">=></font> <b><font color="#000000">gun_cookies:store</font></b>(), + <font color="#0000FF">domain_lookup_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">http_opts</font> <font color="#990000">=></font> <b><font color="#000000">http_opts</font></b>(), + <font color="#0000FF">http2_opts</font> <font color="#990000">=></font> <b><font color="#000000">http2_opts</font></b>(), + <font color="#0000FF">protocols</font> <font color="#990000">=></font> <b><font color="#000000">protocols</font></b>(), + <font color="#0000FF">retry</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">retry_fun</font> <font color="#990000">=></font> <b><font color="#0000FF">fun</font></b>(), + <font color="#0000FF">retry_timeout</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <font color="#0000FF">supervise</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">tcp_opts</font> <font color="#990000">=></font> [<b><font color="#000000">gen_tcp:connect_option</font></b>()], + <font color="#0000FF">tls_handshake_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">tls_opts</font> <font color="#990000">=></font> [<b><font color="#000000">ssl:tls_client_option</font></b>()], + <font color="#0000FF">trace</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tcp</font> | <font color="#FF6600">tls</font>, + <font color="#0000FF">ws_opts</font> <font color="#990000">=></font> <b><font color="#000000">ws_opts</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for the connection.</p> +<p>The default value is given next to the option name:</p> +<dl><dt>connect_timeout (infinity)</dt> +<dd><p>Connection timeout.</p> +</dd> +<dt>cookie_store - see below</dt> +<dd><p>The cookie store that Gun will use for this connection. When configured, Gun will query the store for cookies and include them in the request headers; and add cookies found in response headers to the store.</p> +<p>By default no cookie store will be used.</p> +</dd> +<dt>domain_lookup_timeout (infinity)</dt> +<dd><p>Domain lookup timeout.</p> +</dd> +<dt>http_opts (#{})</dt> +<dd><p>Options specific to the HTTP protocol.</p> +</dd> +<dt>http2_opts (#{})</dt> +<dd><p>Options specific to the HTTP/2 protocol.</p> +</dd> +<dt>protocols - see below</dt> +<dd><p>Ordered list of preferred protocols. Please refer to the <code>protocols()</code> type documentation for details.</p> +<p>Defaults to <code>[http]</code> when the transport is <code>tcp</code>, and <code>[http2, http]</code> when the transport is <code>tls</code>.</p> +</dd> +<dt>retry (5)</dt> +<dd><p>Number of times Gun will try to reconnect on failure before giving up.</p> +</dd> +<dt>retry_fun - see below</dt> +<dd><p>A fun that will be called before every reconnect attempt. It receives the current number of retries left and the Gun options. It returns the next number of retries left and the timeout to apply before reconnecting.</p> +</dd> +</dl> +<p>The default fun will remove one to the number of retries and set the timeout to the <code>retry_timeout</code> value.</p> +<p>The fun must be defined as follow:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#0000FF">fun</font></b> ((<b><font color="#000000">non_neg_integer</font></b>(), <b><font color="#000000">opts</font></b>()) <font color="#990000">-></font> #{ + <font color="#0000FF">retries</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">pos_integer</font></b>() +})</tt></pre> +</div></div> +<p>The fun will never be called when the <code>retry</code> option is set to 0. When this function returns 0 in the <code>retries</code> value, Gun will do one last reconnect attempt before giving up.</p> +<dl><dt>retry_timeout (5000)</dt> +<dd><p>Time between retries in milliseconds.</p> +</dd> +<dt>supervise (true)</dt> +<dd><p>Whether the Gun process should be started under the <code>gun_sup</code> supervisor. Set to <code>false</code> to use your own supervisor.</p> +</dd> +<dt>tcp_opts (DefaultOpts)</dt> +<dd><p>TCP options used when establishing the connection. By default Gun enables send timeouts with the options <code>[{send_timeout, 15000}, {send_timeout_close, true}]</code>.</p> +</dd> +<dt>tls_handshake_timeout (infinity)</dt> +<dd><p>TLS handshake timeout.</p> +</dd> +<dt>tls_opts ([])</dt> +<dd><p>TLS options used for the TLS handshake after the connection has been established, when the transport is set to <code>tls</code>.</p> +</dd> +<dt>trace (false)</dt> +<dd><p>Whether to enable <code>dbg</code> tracing of the connection process. Should only be used during debugging.</p> +</dd> +<dt>transport - see below</dt> +<dd><p>Whether to use TLS or plain TCP. The default varies depending on the port used. Port 443 defaults to <code>tls</code>. All other ports default to <code>tcp</code>.</p> +</dd> +<dt>ws_opts (#{})</dt> +<dd><p>Options specific to the Websocket protocol.</p> +</dd> +</dl> +<h3 id="_protocols">protocols()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Protocol</font> <font color="#990000">::</font> <font color="#FF6600">http</font> | {<font color="#FF6600">http</font>, <b><font color="#000000">http_opts</font></b>()} + | <font color="#FF6600">http2</font> | {<font color="#FF6600">http2</font>, <b><font color="#000000">http2_opts</font></b>()} + | <font color="#FF6600">raw</font> | {<font color="#FF6600">raw</font>, <b><font color="#000000">raw_opts</font></b>()} + | <font color="#FF6600">socks</font> | {<font color="#FF6600">socks</font>, <b><font color="#000000">socks_opts</font></b>()} + +<b><font color="#000000">protocols</font></b>() <font color="#990000">::</font> [<font color="#009900">Protocol</font>]</tt></pre> +</div></div> +<p>Ordered list of preferred protocols. When the transport is <code>tcp</code>, this list must contain exactly one protocol. When the transport is <code>tls</code>, this list must contain at least one protocol and will be used to negotiate a protocol via ALPN. When the server does not support ALPN then <code>http</code> will be used, except when the list of preferred protocols is set to only accept <code>socks</code>.</p> +<p>Defaults to <code>[http]</code> when the transport is <code>tcp</code>, and <code>[http2, http]</code> when the transport is <code>tls</code>.</p> +<h3 id="_raw_opts">raw_opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">raw_opts</font></b>() <font color="#990000">::</font> #{ +}</tt></pre> +</div></div> +<p>Configuration for the "raw" protocol.</p> +<!-- The default value is given next to the option name:--> +<h3 id="_req_headers">req_headers()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">req_headers</font></b>() <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>() | <b><font color="#000000">string</font></b>() | <b><font color="#000080">atom</font></b>(), <b><font color="#000000">iodata</font></b>()}] + | #{<b><font color="#000080">binary</font></b>() | <b><font color="#000000">string</font></b>() | <b><font color="#000080">atom</font></b>() <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>()}</tt></pre> +</div></div> +<p>Request headers.</p> +<h3 id="_req_opts">req_opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">req_opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">flow</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <font color="#0000FF">reply_to</font> <font color="#990000">=></font> <b><font color="#000080">pid</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for a particular request.</p> +<p>The default value is given next to the option name:</p> +<dl><dt>flow - see below</dt> +<dd><p>The initial flow control value for the stream. By default flow control is disabled.</p> +</dd> +<dt>reply_to (<code>self()</code>)</dt> +<dd><p>The pid of the process that will receive the response messages.</p> +</dd> +</dl> +<h3 id="_socks_opts">socks_opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">socks_opts</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">host</font> <font color="#990000">:=</font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#FF6600">port</font> <font color="#990000">:=</font> <b><font color="#000000">inet:port_number</font></b>(), + + <font color="#0000FF">auth</font> <font color="#990000">=></font> [{<font color="#FF6600">username_password</font>, <b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()} | <font color="#FF6600">none</font>], + <font color="#0000FF">protocols</font> <font color="#990000">=></font> <b><font color="#000000">protocols</font></b>(), + <font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tcp</font> | <font color="#FF6600">tls</font>, + <font color="#0000FF">version</font> <font color="#990000">=></font> <font color="#993399">5</font>, + + <font color="#0000FF">tls_opts</font> <font color="#990000">=></font> [<b><font color="#000000">ssl:tls_client_option</font></b>()], + <font color="#0000FF">tls_handshake_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for the Socks protocol.</p> +<p>The default value, if any, is given next to the option name:</p> +<dl><dt>host, port</dt> +<dd><p>Destination hostname and port number. Mandatory.</p> +<p>Upon successful completion of the Socks connection, Gun will begin using these as the host and port of the origin server for subsequent requests.</p> +</dd> +<dt>auth ([none])</dt> +<dd><p>Authentication methods Gun advertises to the Socks proxy.</p> +</dd> +<dt>protocols - see below</dt> +<dd><p>Ordered list of preferred protocols. Please refer to the <code>protocols()</code> type documentation for details.</p> +<p>Defaults to <code>[http]</code> when the transport is <code>tcp</code>, and <code>[http2, http]</code> when the transport is <code>tls</code>.</p> +</dd> +<dt>transport (tcp)</dt> +<dd><p>Transport that will be used for tunneled requests.</p> +</dd> +<dt>tls_opts ([])</dt> +<dd><p>Options to use for tunneled TLS connections.</p> +</dd> +<dt>tls_handshake_timeout (infinity)</dt> +<dd><p>Handshake timeout for tunneled TLS connections.</p> +</dd> +<dt>version (5)</dt> +<dd><p>Version of the Socks protocol to use.</p> +</dd> +</dl> +<h3 id="_stream_ref">stream_ref()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">stream_ref</font></b>() <font color="#990000">-</font> <font color="#FF6600">see</font> <font color="#FF6600">below</font></tt></pre> +</div></div> +<p>Unique identifier for a stream.</p> +<p>The exact type is considered to be an implementation detail.</p> +<h3 id="_ws_opts">ws_opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">ws_opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">closing_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">compress</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">default_protocol</font> <font color="#990000">=></font> <b><font color="#000000">module</font></b>(), + <font color="#0000FF">flow</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <font color="#0000FF">keepalive</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">protocols</font> <font color="#990000">=></font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000000">module</font></b>()}], + <font color="#0000FF">silence_pings</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">user_opts</font> <font color="#990000">=></font> <b><font color="#000000">any</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for the Websocket protocol.</p> +<p>The default value is given next to the option name:</p> +<dl><dt>closing_timeout (15000)</dt> +<dd><p>Time to wait before brutally closing the connection when a graceful shutdown was requested either via a call to <a href="../gun.shutdown">gun:shutdown(3)</a> or by the server.</p> +</dd> +<dt>compress (false)</dt> +<dd><p>Whether to enable permessage-deflate compression. This does not guarantee that compression will be used as it is the server that ultimately decides. Defaults to false.</p> +</dd> +<dt>default_protocol (gun_ws_h)</dt> +<dd><p>Default protocol module when no Websocket subprotocol is negotiated.</p> +</dd> +<dt>flow - see below</dt> +<dd><p>The initial flow control value for the Websocket connection. By default flow control is disabled.</p> +</dd> +<dt>keepalive (infinity)</dt> +<dd><p>Time between pings in milliseconds.</p> +</dd> +<dt>protocols ([])</dt> +<dd><p>A non-empty list enables Websocket protocol negotiation. The list of protocols will be sent in the sec-websocket-protocol request header. The given module must follow the <a href="../gun_ws_protocol">gun_ws_protocol(3)</a> interface. Gun comes with a default interface in <code>gun_ws_h</code> that may be reused for negotiated protocols.</p> +</dd> +<dt>silence_pings (true)</dt> +<dd><p>Whether the ping and pong frames should be sent to the user. In all cases Gun will automatically send a pong frame back when receiving a ping.</p> +</dd> +<dt>user_opts - see below</dt> +<dd><p>Additional options that are not in use by Gun unless a custom Websocket subprotocol is configured and negotiated. By default no user option is defined.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.1</strong>: The HTTP/2 option list was updated with new options. +</li> +<li><strong>2.0</strong>: The <code>default_protocol</code> and <code>user_opts</code> Websocket options were added. +</li> +<li><strong>2.0</strong>: The <code>stream_ref()</code> type was added. +</li> +<li><strong>2.0</strong>: The option <code>cookie_store</code> was added. It can be used to configure a cookie store that Gun will use automatically. A related option, <code>cookie_ignore_informational</code>, was added to both <code>http_opts()</code> and <code>http2_opts()</code>. +</li> +<li><strong>2.0</strong>: The types <code>protocols()</code> and <code>socks_opts()</code> have been added. Support for the Socks protocol has been added in every places where protocol selection is available. In addition it is now possible to specify separate HTTP options for the CONNECT proxy and the origin server. +</li> +<li><strong>2.0</strong>: The <code>connect_timeout</code> option has been split into three options: <code>domain_lookup_timeout</code>, <code>connect_timeout</code> and when applicable <code>tls_handshake_timeout</code>. +</li> +<li><strong>2.0</strong>: The option <code>retry_fun</code> was added. It can be used to implement different reconnect strategies. +</li> +<li><strong>2.0</strong>: The <code>transport_opts</code> option has been split into two options: <code>tcp_opts</code> and <code>tls_opts</code>. +</li> +<li><strong>2.0</strong>: Function <code>gun:update_flow/3</code> introduced. The <code>flow</code> option was added to request options and HTTP/1.1, HTTP/2 and Websocket options as well. +</li> +<li><strong>2.0</strong>: Introduce the type <code>req_headers()</code> and extend the types accepted for header names for greater interoperability. Header names are automatically lowercased as well. +</li> +<li><strong>2.0</strong>: Function <code>gun:headers/4,5</code> introduced. +</li> +<li><strong>2.0</strong>: The <code>keepalive</code> option is now set to <code>infinity</code> by default for all protocols. This means it is disabled. +</li> +<li><strong>2.0</strong>: Websocket options <code>keepalive</code> and <code>silence_pings</code> introduced. +</li> +<li><strong>2.0</strong>: Remove the <code>protocol</code> option from <code>connect_destination()</code>. +</li> +<li><strong>1.3</strong>: Add the CONNECT destination's <code>protocols</code> option and deprecate the previously introduced <code>protocol</code> option. +</li> +<li><strong>1.2</strong>: Introduce the type <code>connect_destination()</code>. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">gun(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_app/index.html b/docs/en/gun/2.1/manual/gun_app/index.html new file mode 100644 index 00000000..2a4f481b --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_app/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: gun(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=7" 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>gun(7)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP</p> +<h2 id="_description">Description</h2> +<p>Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols.</p> +<p>Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary.</p> +<h2 id="_modules">Modules</h2> +<ul><li><a href="../gun">gun(3)</a> - Asynchronous HTTP client +</li> +<li><a href="../gun_cookies">gun_cookies(3)</a> - Cookie store engine +</li> +<li><a href="../gun_cookies_list">gun_cookies_list(3)</a> - Cookie store backend: in-memory, per connection +</li> +<li><a href="../gun_event">gun_event(3)</a> - Events +</li> +<li><a href="../gun_ws_protocol">gun_ws_protocol(3)</a> - Websocket subprotocols +</li> +</ul> +<h2 id="_dependencies">Dependencies</h2> +<ul><li><a href="../cowlib">cowlib(7)</a> - Support library for manipulating Web protocols +</li> +<li>ssl - Secure communication over sockets +</li> +</ul> +<p>All these applications must be started before the <code>gun</code> application. To start Gun and all dependencies at once:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">gun</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_environment">Environment</h2> +<p>The <code>gun</code> application does not define any application environment configuration parameters.</p> +<h2 id="_see_also">See also</h2> +<p><a href="../cowlib">cowlib(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_cookies.domain_match/index.html b/docs/en/gun/2.1/manual/gun_cookies.domain_match/index.html new file mode 100644 index 00000000..2a3e7cba --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_cookies.domain_match/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: gun_cookies:domain_match(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=7" 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>gun_cookies:domain_match(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_cookies:domain_match - Cookie domain match</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">domain_match</font></b>(<font color="#009900">String</font>, <font color="#009900">DomainString</font>) <font color="#990000">-></font> <b><font color="#000000">boolean</font></b>() + +<font color="#009900">String</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">DomainString</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()</tt></pre> +</div></div> +<p>Cookie domain match.</p> +<p>This function can be used when implementing the <code>set_cookie_secure_match</code> callback of a cookie store.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>String</dt> +<dd><p>The string to match.</p> +</dd> +<dt>DomainString</dt> +<dd><p>The domain string that will be matched against.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>Returns <code>true</code> when <code>String</code> domain-matches <code>DomainString</code>, and <code>false</code> otherwise.</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">Perform a domain match</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Match</font> <font color="#990000">=</font> <b><font color="#000000">gun_cookies:domain_match</font></b>(<font color="#009900">Domain</font>, <font color="#009900">CookieDomain</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun_cookies">gun_cookies(3)</a>, <a href="../gun_cookies.path_match">gun_cookies:path_match(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_cookies.path_match/index.html b/docs/en/gun/2.1/manual/gun_cookies.path_match/index.html new file mode 100644 index 00000000..0df92805 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_cookies.path_match/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: gun_cookies:path_match(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=7" 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>gun_cookies:path_match(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_cookies:path_match - Cookie path match</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">path_match</font></b>(<font color="#009900">ReqPath</font>, <font color="#009900">CookiePath</font>) <font color="#990000">-></font> <b><font color="#000000">boolean</font></b>() + +<font color="#009900">ReqPath</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">CookiePath</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()</tt></pre> +</div></div> +<p>Cookie path match.</p> +<p>This function can be used when implementing the <code>set_cookie_secure_match</code> callback of a cookie store.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ReqPath</dt> +<dd><p>The request path to match.</p> +</dd> +<dt>CookiePath</dt> +<dd><p>The cookie path that will be matched against.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>Returns <code>true</code> when <code>ReqPath</code> path-matches <code>CookiePath</code>, and <code>false</code> otherwise.</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">Perform a path match</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Match</font> <font color="#990000">=</font> <b><font color="#000000">gun_cookies:path_match</font></b>(<font color="#009900">ReqPath</font>, <font color="#009900">CookiePath</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun_cookies">gun_cookies(3)</a>, <a href="../gun_cookies.domain_match">gun_cookies:domain_match(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_cookies/index.html b/docs/en/gun/2.1/manual/gun_cookies/index.html new file mode 100644 index 00000000..dcb1f43d --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_cookies/index.html @@ -0,0 +1,295 @@ +<!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: gun_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=7" 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>gun_cookies(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_cookies - Cookie store engine</p> +<h2 id="_description">Description</h2> +<p>The <code>gun_cookies</code> module implements a cookie store engine. It will be used by Gun when a cookie store is configured. It also defines the interface and provides functions used to implement cookie store backends.</p> +<h2 id="_callbacks">Callbacks</h2> +<p>Cookie store backends implement the following interface. Functions are organized by theme: initialization, querying, storing and garbage collecting:</p> +<h3 id="_init">init</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">Opts</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()) <font color="#990000">-></font> <b><font color="#000000">gun_cookies:store</font></b>()</tt></pre> +</div></div> +<p>Initialize the cookie store.</p> +<h3 id="_query">query</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#0000FF">query</font></b>(<font color="#009900">State</font>, <font color="#009900">URI</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, [<font color="#009900">Cookie</font>], <font color="#009900">State</font>} + +<font color="#009900">URI</font> <font color="#990000">::</font> <b><font color="#000000">uri_string:uri_map</font></b>() +<font color="#009900">Cookie</font> <font color="#990000">::</font> <b><font color="#000000">gun_cookies:cookie</font></b>() +<font color="#009900">State</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Query the store for the cookies for the given URI.</p> +<h3 id="_set_cookie_secure_match">set_cookie_secure_match</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">set_cookie_secure_match</font></b>(<font color="#009900">State</font>, <font color="#009900">Match</font>) <font color="#990000">-></font> <font color="#FF6600">match</font> | <font color="#FF6600">nomatch</font> + +<font color="#009900">State</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">Match</font> <font color="#990000">::</font> #{ + <font color="#FF6600">name</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), +<i><font color="#9A1900">% secure_only := true,</font></i> + <font color="#FF6600">domain</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), + <font color="#FF6600">path</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>() +}</tt></pre> +</div></div> +<p>Perform a secure match against cookies already in the store. This is part of the heuristics that the cookie store engine applies to decide whether the cookie must be stored.</p> +<p>The <code>secure_only</code> attribute is implied, it is not actually passed in the argument.</p> +<h3 id="_set_cookie_get_exact_match">set_cookie_get_exact_match</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">set_cookie_get_exact_match</font></b>(<font color="#009900">State</font>, <font color="#009900">Match</font>) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <b><font color="#000000">gun_cookies:cookie</font></b>(), <font color="#009900">State</font>} | <font color="#FF6600">error</font> + +<font color="#009900">State</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">Match</font> <font color="#990000">::</font> #{ + <font color="#FF6600">name</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), + <font color="#FF6600">domain</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), + <font color="#FF6600">host_only</font> <font color="#990000">:=</font> <b><font color="#000000">boolean</font></b>(), + <font color="#FF6600">path</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>() +}</tt></pre> +</div></div> +<p>Perform an exact match against cookies already in the store. This is part of the heuristics that the cookie store engine applies to decide whether the cookie must be stored.</p> +<p>When a cookie is found, it must be returned so that it gets updated. When nothing is found a new cookie will be stored.</p> +<h3 id="_store">store</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">store</font></b>(<font color="#009900">State</font>, <b><font color="#000000">gun_cookies:cookie</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">State</font>} | {<font color="#FF6600">error</font>, <b><font color="#000000">any</font></b>()} + +<font color="#009900">State</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Unconditionally store the cookie into the cookie store.</p> +<h3 id="_gc">gc</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gc</font></b>(<font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">State</font>} + +<font color="#009900">State</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Remove all cookies from the cookie store that are expired.</p> +<p>Other cookies may be removed as well, at the discretion of the cookie store. For example excess cookies may be removed to reduce the memory footprint.</p> +<h3 id="_session_gc">session_gc</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">session_gc</font></b>(<font color="#009900">State</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">State</font>} + +<font color="#009900">State</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Remove all cookies from the cookie store that have the <code>persistent</code> flag set to <code>false</code>.</p> +<h2 id="_exports">Exports</h2> +<ul><li><a href="../gun_cookies.domain_match">gun_cookies:domain_match(3)</a> - Cookie domain match +</li> +<li><a href="../gun_cookies.path_match">gun_cookies:path_match(3)</a> - Cookie path match +</li> +</ul> +<h2 id="_types">Types</h2> +<h3 id="_cookie">cookie()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cookie</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">name</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), + <font color="#FF6600">value</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), + <font color="#FF6600">domain</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), + <font color="#FF6600">path</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), + <font color="#FF6600">creation_time</font> <font color="#990000">:=</font> <b><font color="#000000">calendar:datetime</font></b>(), + <font color="#FF6600">last_access_time</font> <font color="#990000">:=</font> <b><font color="#000000">calendar:datetime</font></b>(), + <font color="#FF6600">expiry_time</font> <font color="#990000">:=</font> <b><font color="#000000">calendar:datetime</font></b>() | <font color="#FF6600">infinity</font>, + <font color="#FF6600">persistent</font> <font color="#990000">:=</font> <b><font color="#000000">boolean</font></b>(), + <font color="#FF6600">host_only</font> <font color="#990000">:=</font> <b><font color="#000000">boolean</font></b>(), + <font color="#FF6600">secure_only</font> <font color="#990000">:=</font> <b><font color="#000000">boolean</font></b>(), + <font color="#FF6600">http_only</font> <font color="#990000">:=</font> <b><font color="#000000">boolean</font></b>(), + <font color="#FF6600">same_site</font> <font color="#990000">:=</font> <font color="#FF6600">strict</font> | <font color="#FF6600">lax</font> | <font color="#FF6600">none</font> +}</tt></pre> +</div></div> +<p>A cookie.</p> +<p>This contains the cookie name, value, attributes and flags. This is the representation that the cookie store engine and Gun expects. Cookies do not have to be kept in this format in the cookie store backend.</p> +<h3 id="_store">store()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">store</font></b>() <font color="#990000">::</font> {<b><font color="#000000">module</font></b>(), <font color="#009900">StoreState</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>The cookie store.</p> +<p>This is a tuple containing the cookie store backend module and its current state.</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="..">gun(7)</a>, <a href="../gun_cookies_list">gun_cookies_list(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_cookies_list/index.html b/docs/en/gun/2.1/manual/gun_cookies_list/index.html new file mode 100644 index 00000000..adbf05d7 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_cookies_list/index.html @@ -0,0 +1,193 @@ +<!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: gun_cookies_list(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=7" 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>gun_cookies_list(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_cookies_list - Cookie store backend: in-memory, per connection</p> +<h2 id="_description">Description</h2> +<p>The <code>gun_cookies_list</code> module implements a cookie store backend that keeps all the cookie data in-memory and tied to a specific connection.</p> +<p>It is possible to implement a custom backend on top of <code>gun_cookies_list</code> in order to add persistence or sharing properties.</p> +<h2 id="_exports">Exports</h2> +<p>This module implements the callbacks defined in <a href="../gun_cookies">gun_cookies(3)</a>.</p> +<h2 id="_types">Types</h2> +<h3 id="_opts">opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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> #{ +}</tt></pre> +</div></div> +<p>Cookie store backend options.</p> +<p>There are currently no options available for this backend.</p> +<!-- The default value is given next to the option name:--> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Module introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Open a connection with a cookie store configured</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#009900">Host</font>, <font color="#009900">Port</font>, #{ + <font color="#0000FF">cookie_store</font> <font color="#990000">=></font> <b><font color="#000000">gun_cookies_list:init</font></b>(#{}) +})</tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="..">gun(7)</a>, <a href="../gun_cookies">gun_cookies(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_data/index.html b/docs/en/gun/2.1/manual/gun_data/index.html new file mode 100644 index 00000000..86e7f27d --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_data/index.html @@ -0,0 +1,208 @@ +<!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: gun_data(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=7" 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>gun_data(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_data - Response body</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_data</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IsFin</font>, <font color="#009900">Data</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() +<font color="#009900">IsFin</font> <font color="#990000">::</font> <font color="#FF6600">fin</font> | <font color="#FF6600">nofin</font> +<font color="#009900">Data</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()</tt></pre> +</div></div> +<p>Response body.</p> +<p>This message informs the relevant process that the server sent a all or part of the body for the response to the original request.</p> +<p>A data message is always preceded by a response message.</p> +<p>The response body may be terminated either by a data message with the flag <code>fin</code> set or by a <a href="../gun_trailers">gun_trailers(3)</a> message.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>IsFin</dt> +<dd><p>Whether this message terminates the response.</p> +</dd> +<dt>Data</dt> +<dd><p>All or part of the response body.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_data message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_data</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">_IsFin</font>, <font color="#009900">_Data</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_trailers">gun_trailers(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_down/index.html b/docs/en/gun/2.1/manual/gun_down/index.html new file mode 100644 index 00000000..2e6d84c7 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_down/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: gun_down(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=7" 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>gun_down(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_down - The connection is down</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_down</font>, <font color="#009900">ConnPid</font>, <font color="#009900">Protocol</font>, <font color="#009900">Reason</font>, <font color="#009900">KilledStreams</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Protocol</font> <font color="#990000">::</font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> | <font color="#FF6600">ws</font> +<font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">KilledStreams</font> <font color="#990000">::</font> [<b><font color="#000000">gun:stream_ref</font></b>()]</tt></pre> +</div></div> +<p>The connection is down.</p> +<p>This message informs the owner process that the connection was lost. Depending on the <code>retry</code> and <code>retry_timeout</code> options Gun may automatically attempt to reconnect.</p> +<p>When the connection goes back up, Gun will not attempt to retry requests. It will also not upgrade to Websocket automatically if that was the protocol in use when the connection was lost.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Protocol</dt> +<dd><p>The protocol that was selected for this connection or upgraded to during the course of the connection.</p> +</dd> +<dt>Reason</dt> +<dd><p>The reason for the loss of the connection.</p> +<p>It is present for debugging purposes only. You should not rely on this value to perform operations programmatically.</p> +</dd> +<dt>KilledStreams</dt> +<dd><p>List of streams that have been brutally terminated.</p> +<p>They are active streams that did not complete before the closing of the connection. Whether they can be retried safely depends on the protocol used and the idempotence property of the requests.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The last element of the message's tuple, <code>UnprocessedStreams</code> has been removed. +</li> +<li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_down message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_down</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_Protocol</font>, <font color="#009900">_Reason</font>, <font color="#009900">_Killed</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun_up">gun_up(3)</a>, <a href="../gun_tunnel_up">gun_tunnel_up(3)</a>, <a href="../gun_error">gun_error(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_error/index.html b/docs/en/gun/2.1/manual/gun_error/index.html new file mode 100644 index 00000000..c9a9bb9d --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_error/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: gun_error(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=7" 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>gun_error(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_error - Stream or connection-wide error</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_error</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Reason</font>} +{<font color="#FF6600">gun_error</font>, <font color="#009900">ConnPid</font>, <font color="#009900">Reason</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() +<font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Stream or connection-wide error.</p> +<p>These messages inform the relevant process that an error occurred. A reference is given when the error pertains to a specific stream. Connection-wide errors do not imply that the connection is no longer usable, they are used for all errors that are not specific to a stream.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream that resulted in an error.</p> +</dd> +<dt>Reason</dt> +<dd><p>The reason for the error.</p> +<p>It is present for debugging purposes only. You should not rely on this value to perform operations programmatically.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_error message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_error</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_Reason</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}; +<b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_error</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, <font color="#009900">_Reason</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun_up">gun_up(3)</a>, <a href="../gun_tunnel_up">gun_tunnel_up(3)</a>, <a href="../gun_down">gun_down(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_event/index.html b/docs/en/gun/2.1/manual/gun_event/index.html new file mode 100644 index 00000000..6a1e5381 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_event/index.html @@ -0,0 +1,574 @@ +<!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: gun_event(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=7" 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>gun_event(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_event - Events</p> +<h2 id="_description">Description</h2> +<p>The <code>gun_event</code> module provides the callback interface and types for implementing event handlers.</p> +<h2 id="_callbacks">Callbacks</h2> +<p>Event handlers implement the following interface. Because types are tied to specific events, they are documented alongside them. All event types are exported and can be referred to as <code>gun_event:Type()</code>.</p> +<p>The events are ordered by the order they are likely to be triggered, with the most frequent events listed first.</p> +<h3 id="_init">init</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">init_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">owner</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>(), + <font color="#FF6600">transport</font> <font color="#990000">:=</font> <font color="#FF6600">tcp</font> | <font color="#FF6600">tls</font>, + <font color="#FF6600">origin_scheme</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), + <font color="#FF6600">origin_host</font> <font color="#990000">:=</font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#FF6600">origin_port</font> <font color="#990000">:=</font> <b><font color="#000000">inet:port_number</font></b>(), + <font color="#FF6600">opts</font> <font color="#990000">:=</font> <b><font color="#000000">gun:opts</font></b>() +} + +<b><font color="#000000">init</font></b>(<b><font color="#000000">init_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun is initializing.</p> +<h3 id="_domain_lookup_start">domain_lookup_start</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">domain_lookup_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">host</font> <font color="#990000">:=</font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#FF6600">port</font> <font color="#990000">:=</font> <b><font color="#000000">inet:port_number</font></b>(), + <font color="#FF6600">tcp_opts</font> <font color="#990000">:=</font> [<b><font color="#000000">gen_tcp:connect_option</font></b>()], + <font color="#FF6600">timeout</font> <font color="#990000">:=</font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">lookup_info</font> <font color="#990000">=></font> <b><font color="#000000">gun_tcp:lookup_info</font></b>(), + <font color="#0000FF">error</font> <font color="#990000">=></font> <b><font color="#000000">any</font></b>() +} + +<b><font color="#000000">domain_lookup_start</font></b>(<b><font color="#000000">domain_lookup_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun is starting to resolve the host address.</p> +<p>The <code>lookup_info</code> and <code>error</code> keys are never set for this event.</p> +<h3 id="_domain_lookup_end">domain_lookup_end</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">domain_lookup_end</font></b>(<b><font color="#000000">domain_lookup_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has finished resolving the host address.</p> +<p>The <code>lookup_info</code> key is only set when the lookup is successful. The <code>error</code> key is set otherwise.</p> +<h3 id="_connect_start">connect_start</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">connect_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">lookup_info</font> <font color="#990000">:=</font> <b><font color="#000000">gun_tcp:lookup_info</font></b>(), + <font color="#FF6600">timeout</font> <font color="#990000">:=</font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">socket</font> <font color="#990000">=></font> <b><font color="#000000">inet:socket</font></b>(), + <font color="#0000FF">protocol</font> <font color="#990000">=></font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> | <font color="#FF6600">raw</font>, + <font color="#0000FF">error</font> <font color="#990000">=></font> <b><font color="#000000">any</font></b>() +} + +<b><font color="#000000">connect_start</font></b>(<b><font color="#000000">connect_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun is starting to connect to the host address and port.</p> +<p>The <code>socket</code>, <code>protocol</code> and <code>error</code> keys are never set for this event.</p> +<h3 id="_connect_end">connect_end</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">connect_end</font></b>(<b><font color="#000000">connect_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has finished connecting to the host address and port.</p> +<p>The <code>socket</code> key is set on connect success. The <code>error</code> key is set otherwise.</p> +<p>The <code>protocol</code> key is only set when the transport is <code>tcp</code> and the connection is successful. The protocol is only known in the <code>tls_handshake_end</code> event otherwise.</p> +<h3 id="_tls_handshake_start">tls_handshake_start</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">tls_handshake_event</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">stream_ref</font> <font color="#990000">=></font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#0000FF">reply_to</font> <font color="#990000">=></font> <b><font color="#000080">pid</font></b>(), + <font color="#FF6600">socket</font> <font color="#990000">:=</font> <b><font color="#000000">inet:socket</font></b>() | <b><font color="#000000">ssl:sslsocket</font></b>() | <b><font color="#000080">pid</font></b>(), <i><font color="#9A1900">%% The socket before/after will be different.</font></i> + <font color="#FF6600">tls_opts</font> <font color="#990000">:=</font> [<b><font color="#000000">ssl:tls_client_option</font></b>()], + <font color="#FF6600">timeout</font> <font color="#990000">:=</font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">protocol</font> <font color="#990000">=></font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> | <font color="#FF6600">raw</font>, + <font color="#0000FF">error</font> <font color="#990000">=></font> <b><font color="#000000">any</font></b>() +} + +<b><font color="#000000">tls_handshake_start</font></b>(<b><font color="#000000">tls_handshake_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has started a TLS handshake.</p> +<p>This and the <code>tls_handshake_end</code> event only occur when connecting to a TLS server or when upgrading the connection or a stream to use TLS, for example when using CONNECT or when connecting to a secure SOCKS server.</p> +<p>The <code>stream_ref</code> and <code>reply_to</code> keys are only set when the TLS handshake occurs as a result of a CONNECT request or inside an existing CONNECT tunnel.</p> +<p>The <code>protocol</code> and <code>error</code> keys are never set for this event.</p> +<h3 id="_tls_handshake_end">tls_handshake_end</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">tls_handshake_end</font></b>(<b><font color="#000000">tls_handshake_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has finished a TLS handshake.</p> +<p>The <code>protocol</code> key is set on TLS handshake success. The <code>error</code> key is set otherwise.</p> +<h3 id="_request_start">request_start</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">request_start_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">stream_ref</font> <font color="#990000">:=</font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">reply_to</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>(), + <font color="#FF6600">function</font> <font color="#990000">:=</font> <font color="#FF6600">headers</font> | <font color="#FF6600">request</font> | <font color="#FF6600">ws_upgrade</font> | <font color="#FF6600">connect</font>, + <font color="#FF6600">method</font> <font color="#990000">:=</font> <b><font color="#000000">iodata</font></b>(), + <font color="#0000FF">scheme</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), + <font color="#FF6600">authority</font> <font color="#990000">:=</font> <b><font color="#000000">iodata</font></b>(), + <font color="#0000FF">path</font> <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>(), + <font color="#FF6600">headers</font> <font color="#990000">:=</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000000">iodata</font></b>()}] +} + +<b><font color="#000000">request_start</font></b>(<b><font color="#000000">request_start_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun is starting to send a request.</p> +<p>The <code>scheme</code> and <code>path</code> keys are never set when the <code>function</code> is set to <code>connect</code>.</p> +<h3 id="_request_headers">request_headers</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">request_headers</font></b>(<b><font color="#000000">request_start_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has finished sending the request headers.</p> +<h3 id="_request_end">request_end</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">request_end_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">stream_ref</font> <font color="#990000">:=</font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">reply_to</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>() +} + +<b><font color="#000000">request_end</font></b>(<b><font color="#000000">request_end_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has finished sending the request.</p> +<h3 id="_push_promise_start">push_promise_start</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">push_promise_start_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">stream_ref</font> <font color="#990000">:=</font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">reply_to</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>() +} + +<b><font color="#000000">push_promise_start</font></b>(<b><font color="#000000">push_promise_start_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has begun receiving a promised request (server push).</p> +<h3 id="_push_promise_end">push_promise_end</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">push_promise_end_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">stream_ref</font> <font color="#990000">:=</font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">reply_to</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>(), + <font color="#0000FF">promised_stream_ref</font> <font color="#990000">=></font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">method</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), + <font color="#FF6600">uri</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), + <font color="#FF6600">headers</font> <font color="#990000">:=</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000000">iodata</font></b>()}] +} + +<b><font color="#000000">push_promise_end</font></b>(<b><font color="#000000">push_promise_end_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has finished receiving a promised request (server push). Promised requests never include a body.</p> +<p>Promised requests received during the graceful shutdown of the connection get canceled immediately.</p> +<!-- @todo The cancel event should probably trigger as well.--> +<h3 id="_response_start">response_start</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">response_start_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">stream_ref</font> <font color="#990000">:=</font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">reply_to</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>() +} + +<b><font color="#000000">response_start</font></b>(<b><font color="#000000">response_start_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has begun receiving a response.</p> +<h3 id="_response_inform">response_inform</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">response_headers_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">stream_ref</font> <font color="#990000">:=</font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">reply_to</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>(), + <font color="#FF6600">status</font> <font color="#990000">:=</font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#FF6600">headers</font> <font color="#990000">:=</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}] +} + +<b><font color="#000000">response_inform</font></b>(<b><font color="#000000">response_headers_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has received an informational response (1xx status code).</p> +<p>A <code>status</code> with value 101 indicates that the response has concluded as the stream will be upgraded to a new protocol.</p> +<h3 id="_response_headers">response_headers</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">response_headers</font></b>(<b><font color="#000000">response_headers_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has finished receiving response headers.</p> +<h3 id="_response_trailers">response_trailers</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">response_trailers_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">stream_ref</font> <font color="#990000">:=</font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">reply_to</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>(), + <font color="#FF6600">headers</font> <font color="#990000">:=</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}] +} + +<b><font color="#000000">response_trailers</font></b>(<b><font color="#000000">response_trailers_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has received response trailers.</p> +<h3 id="_response_end">response_end</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">response_end_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">stream_ref</font> <font color="#990000">:=</font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">reply_to</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>() +} + +<b><font color="#000000">response_end</font></b>(<b><font color="#000000">response_end_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has finished receiving a response.</p> +<h3 id="_ws_upgrade">ws_upgrade</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">ws_upgrade_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">stream_ref</font> <font color="#990000">:=</font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">reply_to</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>(), + <font color="#FF6600">opts</font> <font color="#990000">:=</font> <b><font color="#000000">gun:ws_opts</font></b>() +} + +<b><font color="#000000">ws_upgrade</font></b>(<b><font color="#000000">ws_upgrade_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>A Websocket upgrade was requested.</p> +<p>Success is indicated by a response (101 informational if HTTP/1.1, 2xx if HTTP/2) followed by a <code>protocol_changed</code> event.</p> +<h3 id="_ws_recv_frame_start">ws_recv_frame_start</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">ws_recv_frame_start_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">stream_ref</font> <font color="#990000">:=</font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">reply_to</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>(), + <font color="#FF6600">frag_state</font> <font color="#990000">:=</font> <b><font color="#000000">cow_ws:frag_state</font></b>(), + <font color="#FF6600">extensions</font> <font color="#990000">:=</font> <b><font color="#000000">cow_ws:extensions</font></b>() +} + +<b><font color="#000000">ws_recv_frame_start</font></b>(<b><font color="#000000">ws_recv_frame_start_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has begun receiving a Websocket frame.</p> +<h3 id="_ws_recv_frame_header">ws_recv_frame_header</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">ws_recv_frame_header_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">stream_ref</font> <font color="#990000">:=</font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">reply_to</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>(), + <font color="#FF6600">frag_state</font> <font color="#990000">:=</font> <b><font color="#000000">cow_ws:frag_state</font></b>(), + <font color="#FF6600">extensions</font> <font color="#990000">:=</font> <b><font color="#000000">cow_ws:extensions</font></b>(), + <font color="#FF6600">type</font> <font color="#990000">:=</font> <b><font color="#000000">cow_ws:frame_type</font></b>(), + <font color="#FF6600">rsv</font> <font color="#990000">:=</font> <b><font color="#000000">cow_ws:rsv</font></b>(), + <font color="#FF6600">len</font> <font color="#990000">:=</font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#FF6600">mask_key</font> <font color="#990000">:=</font> <b><font color="#000000">cow_ws:mask_key</font></b>() +} + +<b><font color="#000000">ws_recv_frame_header</font></b>(<b><font color="#000000">ws_recv_frame_header_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has received the header part of a Websocket frame.</p> +<p>It will be immediately be followed by the frame's payload.</p> +<h3 id="_ws_recv_frame_end">ws_recv_frame_end</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">ws_recv_frame_end_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">stream_ref</font> <font color="#990000">:=</font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">reply_to</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>(), + <font color="#FF6600">extensions</font> <font color="#990000">:=</font> <b><font color="#000000">cow_ws:extensions</font></b>(), + <font color="#FF6600">close_code</font> <font color="#990000">:=</font> <font color="#000080">undefined</font> | <b><font color="#000000">cow_ws:close_code</font></b>(), + <font color="#FF6600">payload</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>() +} + +<b><font color="#000000">ws_recv_frame_end</font></b>(<b><font color="#000000">ws_recv_frame_end_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has finished receiving a Websocket frame.</p> +<h3 id="_ws_send_frame_start">ws_send_frame_start</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">ws_send_frame_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">stream_ref</font> <font color="#990000">:=</font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">reply_to</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>(), + <font color="#FF6600">extensions</font> <font color="#990000">:=</font> <b><font color="#000000">cow_ws:extensions</font></b>(), + <font color="#FF6600">frame</font> <font color="#990000">:=</font> <b><font color="#000000">gun:ws_frame</font></b>() +} + +<b><font color="#000000">ws_send_frame_start</font></b>(<b><font color="#000000">ws_send_frame_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has started sending a Websocket frame.</p> +<h3 id="_ws_send_frame_end">ws_send_frame_end</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">ws_send_frame_end</font></b>(<b><font color="#000000">ws_send_frame_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has finished sending a Websocket frame.</p> +<h3 id="_protocol_changed">protocol_changed</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">protocol_changed_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">stream_ref</font> <font color="#990000">:=</font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">protocol</font> <font color="#990000">:=</font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> | <font color="#FF6600">raw</font> | <font color="#FF6600">ws</font> +} + +<b><font color="#000000">protocol_changed</font></b>(<b><font color="#000000">protocol_changed_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>The protocol has changed for either the entire Gun connection or for a specific stream.</p> +<p>The <code>stream_ref</code> key is only set when the protocol has changed for a specific stream or inside a CONNECT tunnel.</p> +<p>This event occurs during successful Websocket upgrades, as a result of successful CONNECT requests or after a SOCKS tunnel was successfully established.</p> +<h3 id="_origin_changed">origin_changed</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">origin_changed_event</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">stream_ref</font> <font color="#990000">=></font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">type</font> <font color="#990000">:=</font> <font color="#FF6600">connect</font> | <font color="#FF6600">socks5</font>, + <font color="#FF6600">origin_scheme</font> <font color="#990000">:=</font> <b><font color="#000080">binary</font></b>(), + <font color="#FF6600">origin_host</font> <font color="#990000">:=</font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#FF6600">origin_port</font> <font color="#990000">:=</font> <b><font color="#000000">inet:port_number</font></b>() +} + +<b><font color="#000000">origin_changed</font></b>(<b><font color="#000000">origin_changed_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>The origin server has changed for either the Gun connection or for a specific stream.</p> +<p>The <code>stream_ref</code> key is only set when the origin has changed for a specific stream or inside a CONNECT tunnel.</p> +<h3 id="_cancel">cancel</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cancel_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">stream_ref</font> <font color="#990000">:=</font> <b><font color="#000000">gun:stream_ref</font></b>(), + <font color="#FF6600">reply_to</font> <font color="#990000">:=</font> <b><font color="#000080">pid</font></b>(), + <font color="#FF6600">endpoint</font> <font color="#990000">:=</font> <font color="#FF6600">local</font> | <font color="#FF6600">remote</font>, + <font color="#FF6600">reason</font> <font color="#990000">:=</font> <b><font color="#000080">atom</font></b>() +} + +<b><font color="#000000">cancel</font></b>(<b><font color="#000000">cancel_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>A stream has been canceled.</p> +<p>HTTP/1.1 streams can't be canceled at the protocol level. In this case Gun will silence the stream for the user but events may still occur.</p> +<p>HTTP/2 streams can be canceled both by the client and the server. Events may still occur for a short time after the stream has been canceled.</p> +<h3 id="_disconnect">disconnect</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">disconnect_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">reason</font> <font color="#990000">:=</font> <b><font color="#000080">normal</font></b> | <font color="#FF6600">closed</font> | {<font color="#FF6600">error</font>, <b><font color="#000000">any</font></b>()} +} + +<b><font color="#000000">disconnect</font></b>(<b><font color="#000000">disconnect_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun has been disconnected from the server.</p> +<h3 id="_terminate">terminate</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">terminate_event</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">state</font> <font color="#990000">:=</font> <font color="#FF6600">not_connected</font> + | <font color="#FF6600">domain_lookup</font> | <font color="#FF6600">connecting</font> | <font color="#FF6600">initial_tls_handshake</font> | <font color="#FF6600">tls_handshake</font> + | <font color="#FF6600">connected</font> | <font color="#FF6600">connected_data_only</font> | <font color="#FF6600">connected_ws_only</font>, + <font color="#FF6600">reason</font> <font color="#990000">:=</font> <b><font color="#000080">normal</font></b> | <font color="#000080">shutdown</font> | {<font color="#000080">shutdown</font>, <b><font color="#000000">any</font></b>()} | <b><font color="#000000">any</font></b>() +} + +<b><font color="#000000">terminate</font></b>(<b><font color="#000000">terminate_event</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font></tt></pre> +</div></div> +<p>Gun is terminating.</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="..">gun(7)</a>, <a href="../gun">gun(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_inform/index.html b/docs/en/gun/2.1/manual/gun_inform/index.html new file mode 100644 index 00000000..18f50ce3 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_inform/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: gun_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=7" 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>gun_inform(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_inform - Informational response</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_inform</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() +<font color="#009900">Status</font> <font color="#990000">::</font> <font color="#993399">100</font><font color="#990000">..</font><font color="#993399">199</font> +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Informational response.</p> +<p>This message informs the relevant process that the server sent an informational response to the original request.</p> +<p>Informational responses are only intermediate responses and provide no guarantees as to what the final response will be. An informational response always precedes the response to the original request.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>Status</dt> +<dd><p>Status code for the informational response.</p> +</dd> +<dt>Headers</dt> +<dd><p>Headers sent with the informational response.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_inform message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_inform</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">_Status</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun_response">gun_response(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_push/index.html b/docs/en/gun/2.1/manual/gun_push/index.html new file mode 100644 index 00000000..fb9e5ff5 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_push/index.html @@ -0,0 +1,227 @@ +<!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: gun_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=7" 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>gun_push(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_push - Server-initiated push</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_push</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">NewStreamRef</font>, <font color="#009900">Method</font>, <font color="#009900">URI</font>, <font color="#009900">Headers</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() +<font color="#009900">NewStreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() +<font color="#009900">Method</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">URI</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Server-initiated push.</p> +<p>This message informs the relevant process that the server is pushing a resource related to the effective target URI of the original request.</p> +<p>A server-initiated push message always precedes the response to the original request.</p> +<p>This message will not be sent when using the HTTP/1.1 protocol because it lacks the concept of server-initiated push.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>NewStreamRef</dt> +<dd><p>Identifier of the stream being pushed.</p> +</dd> +<dt>Method</dt> +<dd><p>Method of the equivalent HTTP request.</p> +</dd> +<dt>URI</dt> +<dd><p>URI of the resource being pushed.</p> +</dd> +<dt>Headers</dt> +<dd><p>Headers of the equivalent HTTP request.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_push message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_push</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">_NewStreamRef</font>, <font color="#009900">_Method</font>, <font color="#009900">_URI</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Cancel an unwanted push</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_push</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">NewStreamRef</font>, <font color="#009900">_Method</font>, <font color="#009900">_URI</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <b><font color="#000000">gun:cancel</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">NewStreamRef</font>), + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.cancel">gun:cancel(3)</a>, <a href="../gun_response">gun_response(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_response/index.html b/docs/en/gun/2.1/manual/gun_response/index.html new file mode 100644 index 00000000..6a8ca517 --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_response/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: gun_response(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=7" 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>gun_response(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_response - Response</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_response</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IsFin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() +<font color="#009900">IsFin</font> <font color="#990000">::</font> <font color="#FF6600">fin</font> | <font color="#FF6600">nofin</font> +<font color="#009900">Status</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Response.</p> +<p>This message informs the relevant process that the server sent a response to the original request.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>IsFin</dt> +<dd><p>Whether this message terminates the response.</p> +</dd> +<dt>Status</dt> +<dd><p>Status code for the response.</p> +</dd> +<dt>Headers</dt> +<dd><p>Headers sent with the response.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_response message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_response</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">_IsFin</font>, <font color="#009900">_Status</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_push">gun_push(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_trailers/index.html b/docs/en/gun/2.1/manual/gun_trailers/index.html new file mode 100644 index 00000000..69a60bab --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_trailers/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: gun_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=7" 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>gun_trailers(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_trailers - Response trailers</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_trailers</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Headers</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Response trailers.</p> +<p>This message informs the relevant process that the server sent response trailers for the response to the original request.</p> +<p>A trailers message terminates the response.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>Headers</dt> +<dd><p>Trailing headers sent after the response body.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_trailers message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_trailers</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_tunnel_up/index.html b/docs/en/gun/2.1/manual/gun_tunnel_up/index.html new file mode 100644 index 00000000..da47b88c --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_tunnel_up/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: gun_tunnel_up(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=7" 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>gun_tunnel_up(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_tunnel_up - The tunnel is up</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_tunnel_up</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Protocol</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() | <font color="#000080">undefined</font> +<font color="#009900">Protocol</font> <font color="#990000">::</font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font></tt></pre> +</div></div> +<p>The tunnel is up.</p> +<p>This message informs the owner/calling process that the connection completed through the SOCKS or CONNECT proxy.</p> +<p>If Gun is configured to connect to another SOCKS server, then the connection is not usable yet. One or more <a href="../gun_tunnel_up">gun_tunnel_up(3)</a> messages will follow.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>The stream reference the tunnel is running on, or <code>undefined</code> if there are no underlying stream.</p> +</dd> +<dt>Protocol</dt> +<dd><p>The protocol selected for this connection. It can be used to determine the capabilities of the server.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_tunnel_up message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_tunnel_up</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, <font color="#009900">_Protocol</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a>, <a href="../gun_up">gun_up(3)</a>, <a href="../gun_down">gun_down(3)</a>, <a href="../gun_error">gun_error(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_up/index.html b/docs/en/gun/2.1/manual/gun_up/index.html new file mode 100644 index 00000000..c4d90ecb --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_up/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: gun_up(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=7" 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>gun_up(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_up - The connection is up</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_up</font>, <font color="#009900">ConnPid</font>, <font color="#009900">Protocol</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Protocol</font> <font color="#990000">::</font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">raw</font> | <font color="#FF6600">socks</font></tt></pre> +</div></div> +<p>The connection is up.</p> +<p>This message informs the owner process that the connection or reconnection completed.</p> +<p>If Gun is configured to connect to a Socks server, then the connection is not usable yet. One or more <a href="../gun_tunnel_up">gun_tunnel_up(3)</a> messages will follow.</p> +<p>Otherwise, Gun will start processing the messages it received while waiting for the connection to be up. If this is a reconnection, then this may not be desirable for all requests. Those requests should be cancelled when the connection goes down, and any subsequent messages ignored.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Protocol</dt> +<dd><p>The protocol selected for this connection. It can be used to determine the capabilities of the server.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_up message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_up</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_Protocol</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a>, <a href="../gun_tunnel_up">gun_tunnel_up(3)</a>, <a href="../gun_down">gun_down(3)</a>, <a href="../gun_error">gun_error(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_upgrade/index.html b/docs/en/gun/2.1/manual/gun_upgrade/index.html new file mode 100644 index 00000000..0bdb8adc --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_upgrade/index.html @@ -0,0 +1,208 @@ +<!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: gun_upgrade(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=7" 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>gun_upgrade(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_upgrade - Successful protocol upgrade</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_upgrade</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Protocols</font>, <font color="#009900">Headers</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() +<font color="#009900">Protocols</font> <font color="#990000">::</font> [<font color="#990000"><<</font><font color="#FF0000">"websocket"</font><font color="#990000">>></font>] +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Successful protocol upgrade.</p> +<p>This message informs the relevant process that the server accepted to upgrade to one or more protocols given in the original request.</p> +<p>The exact semantics of this message depend on the original protocol. HTTP/1.1 upgrades apply to the entire connection. HTTP/2 uses a different mechanism which allows switching specific streams to a different protocol.</p> +<p>Gun currently only supports upgrading HTTP/1.1 connections to the Websocket protocol.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream that resulted in an upgrade.</p> +</dd> +<dt>Protocols</dt> +<dd><p>List of protocols this stream was upgraded to.</p> +</dd> +<dt>Headers</dt> +<dd><p>Headers sent with the upgrade response.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_upgrade message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_upgrade</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">_Protocols</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>, <a href="../gun.ws_send">gun:ws_send(3)</a>, <a href="../gun_ws">gun_ws(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_ws/index.html b/docs/en/gun/2.1/manual/gun_ws/index.html new file mode 100644 index 00000000..5d6fd65b --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_ws/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: gun_ws(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=7" 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>gun_ws(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_ws - Websocket frame</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_ws</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Frame</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000000">gun:stream_ref</font></b>() +<font color="#009900">Frame</font> <font color="#990000">::</font> <font color="#FF6600">close</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">close</font>, <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">close</font>, <b><font color="#000000">non_neg_integer</font></b>(), <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">ping</font> | <font color="#FF6600">pong</font>, <b><font color="#000080">binary</font></b>()}</tt></pre> +</div></div> +<p>Websocket frame.</p> +<p>This message informs the relevant process that the server sent the enclosed frame.</p> +<p>This message can only be sent on streams that were upgraded to the Websocket protocol.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream that was upgraded to Websocket.</p> +</dd> +<dt>Frame</dt> +<dd><p>The Websocket frame in question.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Depending on the option <code>silence_pings</code>, ping and pong frames may be sent as well. +</li> +<li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_ws message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_ws</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, <font color="#009900">_Frame</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>, <a href="../gun.ws_send">gun:ws_send(3)</a>, <a href="../gun_upgrade">gun_upgrade(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/gun_ws_protocol/index.html b/docs/en/gun/2.1/manual/gun_ws_protocol/index.html new file mode 100644 index 00000000..07d5daff --- /dev/null +++ b/docs/en/gun/2.1/manual/gun_ws_protocol/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: gun_ws_protocol(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=7" 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>gun_ws_protocol(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_ws_protocol - Websocket subprotocols</p> +<h2 id="_description">Description</h2> +<p>The <code>gun_ws_protocol</code> module provides the callback interface and types for implementing Websocket subprotocols.</p> +<h2 id="_callbacks">Callbacks</h2> +<p>Websocket subprotocols implement the following interface.</p> +<h3 id="_init">init</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">ReplyTo</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Headers</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">State</font>} + +<font color="#009900">ReplyTo</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">cow_http:headers</font></b>() +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">gun:ws_opts</font></b>() +<font color="#009900">State</font> <font color="#990000">::</font> <b><font color="#000000">protocol_state</font></b>()</tt></pre> +</div></div> +<p>Initialize the Websocket protocol.</p> +<dl><dt>ReplyTo</dt> +<dd><p>The pid of the process that owns the stream and to which messages will be sent to.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>The reference for the stream. Must be sent in messages to distinguish between different streams.</p> +</dd> +<dt>Headers</dt> +<dd><p>Headers that were sent in the response establishing the Websocket connection.</p> +</dd> +<dt>Opts</dt> +<dd><p>Websocket options. Custom options can be provided in the <code>user_opts</code> key.</p> +</dd> +<dt>State</dt> +<dd><p>State for the protocol.</p> +</dd> +</dl> +<h3 id="_handle">handle</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">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">FlowDec</font>, <font color="#009900">State</font>} + +<font color="#009900">Frame</font> <font color="#990000">::</font> <b><font color="#000000">cow_ws:frame</font></b>() +<font color="#009900">State</font> <font color="#990000">::</font> <b><font color="#000000">protocol_state</font></b>() +<font color="#009900">FlowDec</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>()</tt></pre> +</div></div> +<p>Handle a Websocket frame.</p> +<p>This callback may receive fragmented frames depending on the protocol and may need to rebuild the full frame to process it.</p> +<dl><dt>Frame</dt> +<dd><p>Websocket frame.</p> +</dd> +<dt>State</dt> +<dd><p>State for the protocol.</p> +</dd> +<dt>FlowDec</dt> +<dd><p>How many messages were sent. Used to update the flow control state when the feature is enabled.</p> +</dd> +</dl> +<h2 id="_types">Types</h2> +<h3 id="_protocol_state">protocol_state()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">protocol_state</font></b>() <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>State for the protocol.</p> +<p>As this part of the implementation of the protocol the type may differ between different Websocket protocol modules.</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="..">gun(7)</a>, <a href="../gun">gun(3)</a>, <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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/gun/2.1/manual/index.html b/docs/en/gun/2.1/manual/index.html new file mode 100644 index 00000000..60aff555 --- /dev/null +++ b/docs/en/gun/2.1/manual/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: Gun 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=7" 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>Gun Function Reference</span></h1> + +<h2 id="_name">Name</h2> +<p>gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP</p> +<h2 id="_description">Description</h2> +<p>Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols.</p> +<p>Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary.</p> +<h2 id="_modules">Modules</h2> +<ul><li><a href="gun">gun(3)</a> - Asynchronous HTTP client +</li> +<li><a href="gun_cookies">gun_cookies(3)</a> - Cookie store engine +</li> +<li><a href="gun_cookies_list">gun_cookies_list(3)</a> - Cookie store backend: in-memory, per connection +</li> +<li><a href="gun_event">gun_event(3)</a> - Events +</li> +<li><a href="gun_ws_protocol">gun_ws_protocol(3)</a> - Websocket subprotocols +</li> +</ul> +<h2 id="_dependencies">Dependencies</h2> +<ul><li><a href="cowlib_app">cowlib(7)</a> - Support library for manipulating Web protocols +</li> +<li>ssl - Secure communication over sockets +</li> +</ul> +<p>All these applications must be started before the <code>gun</code> application. To start Gun and all dependencies at once:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +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">gun</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_environment">Environment</h2> +<p>The <code>gun</code> application does not define any application environment configuration parameters.</p> +<h2 id="_see_also">See also</h2> +<p><a href="cowlib_app">cowlib(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.1 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.1/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</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 1084308a..c6717d87 100644 --- a/docs/index.html +++ b/docs/index.html @@ -68,6 +68,13 @@ <ul> + <li><a href="/docs/en/cowboy/2.12/guide">Cowboy 2.12 User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.12/manual">Cowboy 2.12 Function Reference</a></li> + + + <li><a href="/docs/en/cowboy/2.11/guide">Cowboy 2.11 User Guide</a></li> @@ -119,6 +126,11 @@ + <li><a href="/docs/en/cowlib/2.13/manual">Cowlib 2.13 Function Reference</a></li> + + + + <li><a href="/docs/en/cowlib/2.12/manual">Cowlib 2.12 Function Reference</a></li> @@ -157,6 +169,13 @@ <ul> + <li><a href="/docs/en/gun/2.1/guide">Gun 2.1 User Guide</a></li> + + + <li><a href="/docs/en/gun/2.1/manual">Gun 2.1 Function Reference</a></li> + + + <li><a href="/docs/en/gun/2.0/guide">Gun 2.0 User Guide</a></li> diff --git a/docs/index.xml b/docs/index.xml index 5b79e91e..45dda94c 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -87,6 +87,21 @@ Copyright (c) 2013-2023, Loïc Hoguin &lt;[email protected]&gt; Permiss <item> <title>Introduction</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/introduction/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/introduction/</guid> + <description>Gun is an HTTP client for Erlang/OTP. +Gun supports the HTTP/2, HTTP/1.1 and Websocket protocols. +Prerequisites Knowledge of Erlang, but also of the HTTP/1.1, HTTP/2 and Websocket protocols is required in order to read this guide. +Supported platforms Gun is tested and supported on Linux, FreeBSD, Windows and OSX. +Gun is developed for Erlang/OTP 22.0 and newer. +License Gun uses the ISC License. +Copyright (c) 2013-2023, Loïc Hoguin &lt;[email protected]&gt; 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.</description> + </item> + + <item> + <title>Introduction</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/introduction/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -169,6 +184,17 @@ HTTP/2 HTTP/2 is the most efficient protocol for consuming Web services. It enab <item> <title>The modern Web</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/modern_web/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -233,6 +259,16 @@ The Web is concurrent When you access a website there is little concurrency invo <item> <title>Erlang and the Web</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/erlang_web/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -382,6 +418,18 @@ Adding Gun as an Erlang.mk dependency source-highlight: could not find a languag </item> <item> + <title>Starting and stopping</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/start/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/start/</guid> + <description>This chapter describes how to start and stop the Gun application. +Setting up Specify Gun as a dependency to your application in your favorite build tool. +With Erlang.mk this is done by adding gun to the DEPS variable in your Makefile. +Adding Gun as an Erlang.mk dependency source-highlight: could not find a language definition for make Starting Gun is an OTP application. It needs to be started before you can use it.</description> + </item> + + <item> <title>Supported protocols</title> <link>https://ninenines.eu/docs/en/gun/1.0/guide/protocols/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -442,6 +490,18 @@ Gun will send a gun_inform message for every intermediate informational response </item> <item> + <title>Supported protocols</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/protocols/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/protocols/</guid> + <description>This chapter describes the protocols supported and the operations available to them. +HTTP/1.1 HTTP/1.1 is a text request-response protocol. The client sends a request, the server sends back a response. +Gun provides convenience functions for performing GET, HEAD, OPTIONS, POST, PATCH, PUT, and DELETE requests. All these functions are aliases of gun:headers/4,5 or gun:request/5,6 for the respective methods. Gun also provides a gun:data/4 function for streaming the request body. +Gun will send a gun_inform message for every intermediate informational responses received.</description> + </item> + + <item> <title>Introduction</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/introduction/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -467,6 +527,18 @@ Cowboy is a high quality project. It has a small code base, is very efficient (b <item> <title>Introduction</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/introduction/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>Introduction</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/introduction/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -634,6 +706,17 @@ A Gun connection is an Erlang process that manages a socket to a remote endpoint </item> <item> + <title>Connection</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/connect/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/connect/</guid> + <description>This chapter describes how to open, monitor and close a connection using the Gun client. +Gun connections Gun is designed with the HTTP/2 and Websocket protocols in mind. They are built for long-running connections that allow concurrent exchange of data, either in the form of request/responses for HTTP/2 or in the form of messages for Websocket. +A Gun connection is an Erlang process that manages a socket to a remote endpoint.</description> + </item> + + <item> <title>Protocols</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/protocols/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -705,6 +788,16 @@ This chapter walks you through all the steps of setting up Cowboy, writing your <item> <title>Getting started</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/getting_started/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -804,6 +897,18 @@ Streams can be canceled at any time.</description> </item> <item> + <title>HTTP</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/http/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/http/</guid> + <description>This chapter describes how to use the Gun client for communicating with an HTTP/1.1 or HTTP/2 server. +Streams Every time a request is initiated, Gun creates a stream. A stream reference uniquely identifies a set of request and response and must be used to perform additional operations with a stream or to identify its messages. +Stream references use the Erlang reference data type and are therefore unique. +Streams can be canceled at any time.</description> + </item> + + <item> <title>Embedded mode</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/embedded/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -879,6 +984,18 @@ After Ranch accepts a new connection, whether it is an HTTP/1.</description> <item> <title>Flow diagram</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/flow_diagram/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -981,6 +1098,17 @@ You must use the gun:ws_upgrade/2,3,4 function to upgrade to Websocket.</descrip </item> <item> + <title>Websocket</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/websocket/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/websocket/</guid> + <description>This chapter describes how to use the Gun client for communicating with a Websocket server. +HTTP upgrade Websocket is a protocol built on top of HTTP. To use Websocket, you must first request for the connection to be upgraded. Only HTTP/1.1 connections can be upgraded to Websocket, so you might need to restrict the protocol to HTTP/1.1 if you are planning to use Websocket over TLS. +You must use the gun:ws_upgrade/2,3,4 function to upgrade to Websocket.</description> + </item> + + <item> <title>Writing parsers</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/parsers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1057,6 +1185,16 @@ In order to have a TLS layer inside another TLS layer we need a way to encode th </item> <item> + <title>Internals: TLS over TLS</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/internals_tls_over_tls/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/internals_tls_over_tls/</guid> + <description>The ssl application that comes with Erlang/OTP implements TLS using an interface equivalent to the gen_tcp interface: you get and manipulate a socket. The TLS encoding and decoding is applied transparently to the data sent and received. +In order to have a TLS layer inside another TLS layer we need a way to encode the data of the inner layer before we pass it to the outer layer. We cannot do this with a socket interface.</description> + </item> + + <item> <title>Migrating from Gun 1.0 to 1.1</title> <link>https://ninenines.eu/docs/en/gun/1.1/guide/migrating_from_1.0/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1100,6 +1238,17 @@ Cowboy provides two types of listeners: one listening for clear TCP connections, <item> <title>Listeners</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/listeners/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>Listeners</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/listeners/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1218,6 +1367,18 @@ If no configured host matches the request URI, a 400 response is returned. Othe <item> <title>Routing</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/routing/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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. +Cowboy routes requests using the following algorithm: +If no configured host matches the request URI, a 400 response is returned. Otherwise, the first configured host that matches the request URI will be used. Only the paths configured for this host will be considered. If none of the configured paths found in the previous step match the request URI, a 404 response is returned.</description> + </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> @@ -1346,6 +1507,17 @@ It also fixes parsing of RST_STREAM frames to properly handle frames that have a </item> <item> + <title>Migrating from Gun 2.0 to 2.1</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_2.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_2.0/</guid> + <description>Gun 2.1 contains a small security improvement for the HTTP/2 protocol, as well as includes a small number of fixes and improvements. +Gun 2.1 requires Erlang/OTP 22.0 or greater. +Features added A new HTTP/2 option max_fragmented_header_block_size has been added to limit the size of header blocks that are sent over multiple HEADERS and CONTINUATION frames. Update Cowlib to 2.13.0. Bugs fixed Gun will no longer configure the NPN TLS extension, which has long been replaced by ALPN.</description> + </item> + + <item> <title>Constraints</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/constraints/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1371,6 +1543,18 @@ A field can take the form of an atom field, a tuple with constraints {field, Con <item> <title>Constraints</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/constraints/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>Constraints</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/constraints/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1505,6 +1689,19 @@ init(Req, State) -&gt; {ok, Req, State}. Despite sending no reply, a 204 No <item> <title>Handlers</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/handlers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>Handlers</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/handlers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1566,6 +1763,16 @@ Gun 2.0 adds many more features such as Websocket over HTTP/2, a built-in cookie </item> <item> + <title>Migrating from Gun 1.3 to 2.0</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.3/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.3/</guid> + <description>Gun 2.0 includes state of the art tunnel support. With Gun 2.0 it is possible to make requests or data go through any number of proxy endpoints using any combination of TCP or TLS transports and HTTP/1.1, HTTP/2 or SOCKS5 protocols. All combinations of the scenario Proxy1 -&gt; Proxy2 -&gt; Origin are tested and known to work. +Gun 2.0 adds many more features such as Websocket over HTTP/2, a built-in cookie store, graceful shutdown, flow control for data messages, event handlers and more.</description> + </item> + + <item> <title>Migrating from Ranch 1.7 to Ranch 2.0</title> <link>https://ninenines.eu/docs/en/ranch/2.0/guide/migrating_from_1.7/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1642,6 +1849,16 @@ Loop handlers are used for requests where a response might not be immediately av <item> <title>Loop handlers</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/loop_handlers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -1701,6 +1918,16 @@ Features added The protocols CONNECT destination option has been added as a repl </item> <item> + <title>Migrating from Gun 1.2 to 1.3</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.2/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.2/</guid> + <description>Gun 1.3 improves the support for CONNECT requests introduced in the previous version and documents Websocket protocol negotiation. +Features added The protocols CONNECT destination option has been added as a replacement for the now deprecated protocol option. Add built-in support for Websocket protocol negotiation through the Websocket option protocols. The interface of the handler module currently remains undocumented and must be set to gun_ws_h. Add the h2specd HTTP/2 test suite from the h2spec project.</description> + </item> + + <item> <title>Static files</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/static_files/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1724,6 +1951,17 @@ The static handler can serve either one file or all files from a given directory <item> <title>Static files</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/static_files/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -1831,6 +2069,16 @@ Features added CONNECT requests can now be issued on HTTP/1.1 connections. The t </item> <item> + <title>Migrating from Gun 1.1 to 1.2</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.1/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.1/</guid> + <description>Gun 1.2 adds support for the CONNECT request over HTTP/1.1 connections. +Features added CONNECT requests can now be issued on HTTP/1.1 connections. The tunneled connection can use any of the protocols Gun supports: HTTP/1.1, HTTP/2 and Websocket over both TCP and TLS transports. Note that Gun currently does not support tunneling a TLS connection over a TLS connection due to limitations in Erlang/OTP. Gun supports sending multiple CONNECT requests, allowing the tunnel to the origin server to go through multiple proxies.</description> + </item> + + <item> <title>The Req object</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/req/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1854,6 +2102,17 @@ The Req object is the subject of a few different chapters. In this chapter we wi <item> <title>The Req object</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/req/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -1976,6 +2235,18 @@ You are not required to read it, however. If a body is present and was not read, <item> <title>Reading the request body</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/req_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2033,6 +2304,16 @@ Features added Update Cowlib to 2.5.1 Bugs fixed A bug in the experimental gun </item> <item> + <title>Migrating from Gun 1.0 to 1.1</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.0/</guid> + <description>Gun 1.1 updates the Cowlib dependency to 2.5.1 and fixes a few problems with experimental features. +Features added Update Cowlib to 2.5.1 Bugs fixed A bug in the experimental gun_sse_h where lone id lines were not propagated has been fixed by updating the Cowlib dependency. The status code was incorrectly given to the experimental content handlers as a binary. It has been fixed an an integer is now given as was intended.</description> + </item> + + <item> <title>Sending a response</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/resp/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2058,6 +2339,18 @@ While only one response is allowed for every request, HTTP/2 introduced a mechan <item> <title>Sending a response</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/resp/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2167,6 +2460,16 @@ Cookies are a name/value store where the names and values are stored in plain te <item> <title>Using cookies</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/cookies/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2229,6 +2532,17 @@ In the context of HTTP, multipart is most often used with the multipart/form-dat <item> <title>Multipart requests</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/multipart/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2305,6 +2619,17 @@ We will first attempt to define REST and will look at what it means in the conte <item> <title>REST principles</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/rest_principles/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2373,6 +2698,18 @@ init(Req, State) -&gt; {cowboy_rest, Req, State}.</description> <item> <title>REST handlers</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/rest_handlers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2443,6 +2780,17 @@ All paths start with the &quot;Start&quot; diagram, and all paths exclud <item> <title>REST flowcharts</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/rest_flowcharts/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2507,6 +2855,16 @@ The service Can the service become unavailable, and when it does, can we detect <item> <title>Designing a resource handler</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/resource_design/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2569,6 +2927,17 @@ Websocket connections are fully asynchronous, unlike HTTP/1.1 (synchronous) and <item> <title>The Websocket protocol</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/ws_protocol/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2633,6 +3002,16 @@ As Websocket connections are established through the HTTP/1.1 upgrade mechanism, <item> <title>Websocket handlers</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/ws_handlers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2695,6 +3074,17 @@ All versions of HTTP allow clients to initiate streams. HTTP/2 is the only one a <item> <title>Streams</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/streams/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>Streams</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/streams/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2761,6 +3151,17 @@ Cowboy will execute all middlewares in the given order, unless one of them decid <item> <title>Middlewares</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/middlewares/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>Middlewares</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/middlewares/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2847,6 +3248,16 @@ One process per connection The first version of Cowboy featured a single process <item> <title>Performance</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/performance/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/guide/performance/</guid> + <description>This chapter describes the performance characteristics of Cowboy and offers suggestions to get the most performance out of your application. +One process per connection The first version of Cowboy featured a single process per connection, whereas the current version of Cowboy features one process per connection plus one process per request. This has a negative impact on performance, but is necessary in order to provide a common interface for both HTTP/1.</description> + </item> + + <item> + <title>Performance</title> <link>https://ninenines.eu/docs/en/cowboy/2.8/guide/performance/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2877,6 +3288,17 @@ Cowboy is now using GitHub Actions for CI. The main reason for the move is to re </item> <item> + <title>Migrating from Cowboy 2.11 to 2.12</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.11/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.11/</guid> + <description>Cowboy 2.12 contains a small security improvement for the HTTP/2 protocol. +Cowboy 2.12 requires Erlang/OTP 24.0 or greater. +Features added A new HTTP/2 option max_fragmented_header_block_size has been added to limit the size of header blocks that are sent over multiple HEADERS and CONTINUATION frames. Update Cowlib to 2.13.0. </description> + </item> + + <item> <title>Migrating from Cowboy 2.7 to 2.8</title> <link>https://ninenines.eu/docs/en/cowboy/2.8/guide/migrating_from_2.7/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2961,6 +3383,17 @@ Cowboy 2.9 also contains a small number of tweaks and bug fixes.</description> </item> <item> + <title>Migrating from Cowboy 2.10 to 2.11</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.10/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.10/</guid> + <description>Cowboy 2.11 contains a variety of new features and bug fixes. Nearly all previously experimental features are now marked as stable, including Websocket over HTTP/2. Included is a fix for an HTTP/2 protocol CVE. +Cowboy 2.11 requires Erlang/OTP 24.0 or greater. +Cowboy is now using GitHub Actions for CI. The main reason for the move is to reduce costs by no longer having to self-host CI runners. The downside is that GitHub runners are less reliable and timing dependent tests are now more likely to fail.</description> + </item> + + <item> <title>Migrating from Cowboy 2.9 to 2.10</title> <link>https://ninenines.eu/docs/en/cowboy/2.11/guide/migrating_from_2.9/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3033,6 +3466,17 @@ Cowboy 2.9 also contains a small number of tweaks and bug fixes.</description> </item> <item> + <title>Migrating from Cowboy 2.9 to 2.10</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.9/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.9/</guid> + <description>Cowboy 2.10 is a maintenance release adding support for Erlang/OTP 26. The main change is a Cowlib update to fix a compilation error that only occurs starting from OTP 26. +Cowboy 2.10 requires Erlang/OTP 22.0 or greater. +Features added Add support for Default value of SameSite cookie attribute. Add support for the stale-* cache-control directives from RFC 5861. Update Cowlib to 2.12.1. Bugs fixed Fix a compilation error in Cowlib when using Erlang/OTP 26.</description> + </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> @@ -3093,6 +3537,17 @@ Cowboy 2.8 also contains a small number of tweaks and bug fixes. Cowboy 2.8 is t </item> <item> + <title>Migrating from Cowboy 2.8 to 2.9</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.8/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.8/</guid> + <description>Cowboy 2.9 implements graceful shutdown of connection processes for both HTTP/1.1 and HTTP/2 connections. +Cowboy 2.9 is the first release to support the much awaited Erlang/OTP 24 out of the box. While users that were using Ranch 2.0 already were ready for OTP 24, the Ranch version used by Cowboy out of the box was not compatible and had to be updated. +Cowboy 2.9 also contains a small number of tweaks and bug fixes.</description> + </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> @@ -3153,6 +3608,16 @@ Features added Add support for the PROXY protocol header. It can be enabled via </item> <item> + <title>Migrating from Cowboy 2.7 to 2.8</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.7/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.7/</guid> + <description>Cowboy 2.8 contains many optimizations for all protocols. HTTP/1.1 has received the largest improvements and Cowboy will now be able to handle noticeably more requests. Thanks to the folks at Stressgrid for helping identify that the performance was lower than it should have been and for benchmarking my many changes and experiments. +Cowboy 2.8 also contains a small number of tweaks and bug fixes. Cowboy 2.8 is the first Cowboy release, ever, to be consistently green on all tested platforms.</description> + </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> @@ -3214,6 +3679,15 @@ Features added Add support for the PROXY protocol header. It can be enabled via </item> <item> + <title>Migrating from Cowboy 2.6 to 2.7</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.6/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.6/</guid> + <description>Cowboy 2.7 improves the HTTP/2 code with optimizations around the sending of DATA and WINDOW_UPDATE frames; graceful shutdown of the connection when the client is going away; and rate limiting mechanisms. New options and mechanisms have also been added to control the amount of memory Cowboy ends up using with both HTTP/1.1 and HTTP/2. Much, but not all, of this work was done to address HTTP/2 CVEs about potential denial of service.</description> + </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> @@ -3274,6 +3748,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.12/guide/migrating_from_2.5/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -3336,6 +3821,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.12/guide/migrating_from_2.4/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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.6/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3397,6 +3892,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.12/guide/migrating_from_2.3/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>HTTP and other specifications</title> <link>https://ninenines.eu/docs/en/cowboy/2.8/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3438,6 +3943,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.12/guide/migrating_from_2.2/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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.9/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3469,6 +3984,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.12/guide/migrating_from_2.1/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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.10/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3490,6 +4015,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.12/guide/migrating_from_2.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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.11/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3500,6 +4035,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.12/guide/migrating_from_1.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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.12/guide/specs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>cow_cookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.10/manual/cow_cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3534,6 +4090,17 @@ Exports cow_cookie:parse_cookie(3) - Parse a cookie header cow_cookie:parse_set <item> <title>cow_cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie/</guid> + <description>Name cow_cookie - Cookies +Description The module cow_cookie provides functions for parsing and manipulating cookie headers. +Exports cow_cookie:parse_cookie(3) - Parse a cookie header cow_cookie:parse_set_cookie(3) - Parse a set-cookie header cow_cookie:cookie(3) - Generate a cookie header cow_cookie:setcookie(3) - Generate a set-cookie header Types cookie_attrs() cookie_attrs() :: #{ expires =&gt; calendar:datetime(), max_age =&gt; calendar:datetime(), domain =&gt; binary(), path =&gt; binary(), secure =&gt; true, http_only =&gt; true, same_site =&gt; default | none | strict | lax } Cookie attributes parsed from the set-cookie header.</description> + </item> + + <item> + <title>cow_cookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3595,6 +4162,19 @@ Changelog 2.9: Function introduced. Examples Generate a cookie header Cookie = <item> <title>cow_cookie:cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.cookie/</guid> + <description>Name cow_cookie:cookie - Generate a cookie header +Description cookie(Cookies) -&gt; iolist() Cookies :: [{Name :: iodata(), Value :: iodata()}] Generate a cookie header. +Arguments Cookies A list of pairs of cookie name and value. + Return value An iolist with the generated cookie header value. +Changelog 2.9: Function introduced. Examples Generate a cookie header Cookie = cow_cookie:cookie([{&lt;&lt;"sessionid"&gt;&gt;, ID}]). See also cow_cookie(3), cow_cookie:parse_cookie(3), cow_cookie:parse_set_cookie(3), cow_cookie:setcookie(3)</description> + </item> + + <item> + <title>cow_cookie:cookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.9/manual/cow_cookie.cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3650,6 +4230,20 @@ Changelog 2.9: Fixes to the parser may lead to potential incompatibilities. A co <item> <title>cow_cookie:parse_cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.parse_cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.parse_cookie/</guid> + <description>Name cow_cookie:parse_cookie - Parse a cookie header +Description parse_cookie(Cookie :: binary()) -&gt; [{binary(), binary()}] Parse a cookie header. +Arguments Cookie The cookie header value. + Return value A list of cookie name/value pairs is returned on success. +An exception is thrown in the event of a parse error. +Changelog 2.9: Fixes to the parser may lead to potential incompatibilities. A cookie name starting with $ is no longer ignored.</description> + </item> + + <item> + <title>cow_cookie:parse_cookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie.parse_cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3717,6 +4311,19 @@ An atom ignore is returned when the cookie has both an empty name and an empty v <item> <title>cow_cookie:parse_set_cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.parse_set_cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.parse_set_cookie/</guid> + <description>Name cow_cookie:parse_set_cookie - Parse a set-cookie header +Description parse_set_cookie(SetCookie :: binary()) -&gt; {ok, Name, Value, Attrs} | ignore Name :: binary() Value :: binary() Attrs :: cow_cookie:cookie_attrs() Parse a set-cookie header. +Arguments SetCookie The set-cookie header value. + Return value An ok tuple with the cookie name, value and attributes is returned on success. +An atom ignore is returned when the cookie has both an empty name and an empty value, and must be ignored.</description> + </item> + + <item> + <title>cow_cookie:parse_set_cookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.9/manual/cow_cookie.parse_set_cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3775,6 +4382,21 @@ Changelog 2.12: The Version attribute is no longer generated. 1.0: Function int <item> <title>cow_cookie:setcookie(3)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.setcookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.setcookie/</guid> + <description>Name cow_cookie:setcookie - Generate a set-cookie header +Description setcookie(Name :: iodata(), Value :: iodata(), Opts :: cow_cookie:cookie_opts()) -&gt; iolist() Generate a set-cookie header. +Arguments Name Cookie name. + Value Cookie value. + Opts Options added to the set-cookie header as attributes. + Return value An iolist with the generated set-cookie header value. +Changelog 2.12: The Version attribute is no longer generated. 1.0: Function introduced. Examples Generate a set-cookie header SetCookie = cow_cookie:setcookie(&lt;&lt;"</description> + </item> + + <item> + <title>cow_cookie:setcookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie.setcookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3831,6 +4453,19 @@ cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_ro <item> <title>Cowboy Function Reference</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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 Function Reference</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3901,6 +4536,15 @@ cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_ro <item> <title>Cowboy User Guide</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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 Performance Additional information Migrating from Cowboy 2.</description> + </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> @@ -3959,6 +4603,17 @@ Exports cowboy:start_clear(3) - Listen for connections using plain TCP cowboy:s <item> <title>cowboy(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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:get_env(3) - Retrieve a listener&apos;s environment value 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(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4029,6 +4684,19 @@ cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_ro <item> <title>cowboy(7)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_app/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -4093,6 +4761,19 @@ The name of the listener is the first argument given to the cowboy:start_clear(3 </item> <item> + <title>cowboy:get_env(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.get_env/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.get_env/</guid> + <description>Name cowboy:get_env - Retrieve a listener&apos;s environment value +Description get_env(Name :: ranch:ref(), Key :: atom()) -&gt; any() get_env(Name :: ranch:ref(), Key :: atom(), Default :: any()) -&gt; any() Retrieve an environment value for a previously started listener. +This function may crash when the key is missing from the environment and a default value is not provided. +Arguments Name The name of the listener to access. +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.</description> + </item> + + <item> <title>cowboy:set_env(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/manual/cowboy.set_env/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4120,6 +4801,19 @@ Arguments Name The name of the listener to update.</description> <item> <title>cowboy:set_env(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.set_env/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -4196,6 +4890,18 @@ Arguments Name The listener name is used to refer to this listener in future cal <item> <title>cowboy:start_clear(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.start_clear/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -4268,6 +4974,18 @@ Arguments Name The listener name is used to refer to this listener in future cal <item> <title>cowboy:start_tls(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.start_tls/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -4346,6 +5064,21 @@ The {error, not_found} tuple is returned when the listener does not exist.</desc <item> <title>cowboy:stop_listener(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.stop_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -4428,6 +5161,17 @@ Normal responses will only be compressed when their size is lower than the confi <item> <title>cowboy_compress_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_compress_h/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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 or that have an etag header defined. +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_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> @@ -4498,6 +5242,19 @@ cowboy_constraints:int(3) - Integer constraint cowboy_constraints:nonempty(3) - <item> <title>cowboy_constraints(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_constraints/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -4576,6 +5333,19 @@ int(format_error, Error) -&gt; HumanReadable Error :: {not_an_integer, Bin | <item> <title>cowboy_constraints:int(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_constraints.int/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -4656,6 +5426,20 @@ Arguments Arguments vary depending on the operation. Constraint functions always <item> <title>cowboy_constraints:nonempty(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_constraints.nonempty/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -4723,6 +5507,18 @@ This stream handler always adds a field to the Req object with the name content_ </item> <item> + <title>cowboy_decompress_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_decompress_h/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_decompress_h/</guid> + <description>Name cowboy_decompress_h - Decompress stream handler +Description The module cowboy_decompress_h decompresses request bodies automatically when the server supports it. +The only compression algorithm currently supported is the gzip algorithm. Another limitation is that decompression is only attempted when gzip is the only content-encoding in the request. +This stream handler always adds a field to the Req object with the name content_decoded which is treated as a list of decoded content-encoding values.</description> + </item> + + <item> <title>cowboy_handler(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/manual/cowboy_handler/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4748,6 +5544,18 @@ This module also defines a callback interface for handling HTTP requests.</descr <item> <title>cowboy_handler(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_handler/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -4824,6 +5632,20 @@ It is possible to remove fields from the Req object to save memory when the hand <item> <title>cowboy_handler:terminate(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_handler.terminate/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -4902,6 +5724,17 @@ Options opts() :: #{ active_n =&gt; pos_integer(), chunked =&gt; boolean <item> <title>cowboy_http(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_http/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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() :: #{ active_n =&gt; pos_integer(), chunked =&gt; boolean(), connection_type =&gt; worker | supervisor, http10_keepalive =&gt; boolean(), idle_timeout =&gt; timeout(), inactivity_timeout =&gt; timeout(), initial_stream_flow_size =&gt; non_neg_integer(), linger_timeout =&gt; timeout(), logger =&gt; module(), 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(), reset_idle_timeout_on_send =&gt; boolean(), sendfile =&gt; boolean(), stream_handlers =&gt; [module()] } Configuration for the HTTP/1.</description> + </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> @@ -4968,6 +5801,17 @@ Options opts() :: #{ active_n =&gt; pos_integer(), connection_type =&gt; <item> <title>cowboy_http2(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_http2/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_http2/</guid> + <description>Name cowboy_http2 - HTTP/2 +Description The module cowboy_http2 implements HTTP/2 as a Ranch protocol. +Options opts() :: #{ active_n =&gt; pos_integer(), connection_type =&gt; worker | supervisor, connection_window_margin_size =&gt; 0..16#7fffffff, connection_window_update_threshold =&gt; 0..16#7fffffff, enable_connect_protocol =&gt; boolean(), goaway_initial_timeout =&gt; timeout(), goaway_complete_timeout =&gt; timeout(), idle_timeout =&gt; timeout(), inactivity_timeout =&gt; timeout(), initial_connection_window_size =&gt; 65535..16#7fffffff, initial_stream_window_size =&gt; 0..16#7fffffff, linger_timeout =&gt; timeout(), logger =&gt; module(), max_concurrent_streams =&gt; non_neg_integer() | infinity, max_connection_buffer_size =&gt; non_neg_integer(), max_connection_window_size =&gt; 0..16#7fffffff, max_decode_table_size =&gt; non_neg_integer(), max_encode_table_size =&gt; non_neg_integer(), max_fragmented_header_block_size =&gt; 16384.</description> + </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> @@ -5038,6 +5882,19 @@ Loop until receiving a specific message, then send a response and stop execution <item> <title>cowboy_loop(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_loop/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -5112,6 +5969,17 @@ Types metrics() metrics() :: #{ %% The identifier for this listener. ref := ranc <item> <title>cowboy_metrics_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_metrics_h/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_metrics_h/</guid> + <description>Name cowboy_metrics_h - Metrics stream handler +Description The module cowboy_metrics_h gathers metrics and other information about a stream. It then calls the configured callback with this data. +Types metrics() metrics() :: #{ %% The identifier for this listener. ref := ranch:ref(), %% The pid for this connection. pid := pid(), %% The streamid also indicates the total number of requests on %% this connection (StreamID div 2 + 1). streamid := cowboy_stream:streamid(), %% The terminate reason is always useful.</description> + </item> + + <item> + <title>cowboy_metrics_h(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_metrics_h/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5171,6 +6039,19 @@ execute(Req, Env) -&gt; {ok, Req, Env} | {suspend, module(), atom(), [any()] <item> <title>cowboy_middleware(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_middleware/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -5247,6 +6128,18 @@ Type Name pattern Return type access no verb, parse_*, match_* Value question h <item> <title>cowboy_req(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -5323,6 +6216,20 @@ Arguments Name Desired binding name as an atom. <item> <title>cowboy_req:binding(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.binding/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -5405,6 +6312,19 @@ Changelog 2.0: Only the values are returned, they are no longer wrapped in a tup <item> <title>cowboy_req:bindings(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.bindings/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -5483,6 +6403,19 @@ Arguments Req The Req object. <item> <title>cowboy_req:body_length(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.body_length/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -5565,6 +6498,21 @@ Changelog 2.7: Function introduced. Examples Read the body using auto mode rea <item> <title>cowboy_req:cast(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.cast/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.cast/</guid> + <description>Name cowboy_req:cast - Cast a stream handler event +Description cast(Event :: any(), Req :: cowboy_req:req()) -&gt; ok Cast a stream handler event. +The event will be passed to stream handlers through the info/3 callback. +Arguments Event The event to be sent to stream handlers. + Req The Req object. + Return value The atom ok is always returned. It can be safely ignored. +Changelog 2.7: Function introduced. Examples Read the body using auto mode read_body_auto_async(Req) -&gt; read_body_auto_async(Req, make_ref(), &lt;&lt;&gt;&gt;).</description> + </item> + + <item> + <title>cowboy_req:cast(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_req.cast/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5634,6 +6582,18 @@ Using the default configuration this function will always return undefined. You <item> <title>cowboy_req:cert(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.cert/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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}, {certfile, "path/to/cert.pem"}, {verify, verify_peer} ], #{ env =&gt; #{dispatch =&gt; Dispatch} }).</description> + </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> @@ -5710,6 +6670,20 @@ Arguments Name Header name as a lowercase binary string. <item> <title>cowboy_req:delete_resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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: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> @@ -5790,6 +6764,18 @@ Malformed cookies are unfortunately fairly common due to the string-based interf <item> <title>cowboy_req:filter_cookies(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.filter_cookies/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.filter_cookies/</guid> + <description>Name cowboy_req:filter_cookies - Filter cookie headers +Description filter_cookies(Names, Req) -&gt; Req Names :: [atom() | binary()] Filter cookie headers. +This function is meant to be used before attempting to parse or match cookies in order to remove cookies that are not relevant and are potentially malformed. Because Cowboy by default crashes on malformed cookies, this function allows processing requests that would otherwise result in a 400 error. +Malformed cookies are unfortunately fairly common due to the string-based interface provided by browsers and this function provides a middle ground between Cowboy&apos;s strict behavior and chaotic real world use cases.</description> + </item> + + <item> + <title>cowboy_req:filter_cookies(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_req.filter_cookies/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5852,6 +6838,19 @@ Changelog 1.0: Function introduced. Examples Ensure the request has a body tru <item> <title>cowboy_req:has_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.has_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -5932,6 +6931,20 @@ Changelog 1.0: Function introduced. Examples Check whether a body has been set <item> <title>cowboy_req:has_resp_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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_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> @@ -6012,6 +7025,18 @@ Arguments Name Header name as a lowercase binary string.</description> <item> <title>cowboy_req:has_resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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: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> @@ -6084,6 +7109,18 @@ Headers can also be obtained using pattern matching:</description> <item> <title>cowboy_req:header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -6160,6 +7197,20 @@ Changelog 2.0: Only the headers are returned, they are no longer wrapped in a tu <item> <title>cowboy_req:headers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.headers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -6244,6 +7295,20 @@ Changelog 2.0: Only the host name is returned, it is no longer wrapped in a tupl <item> <title>cowboy_req:host(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.host/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -6328,6 +7393,20 @@ Changelog 2.0: Only the tokens are returned, they are no longer wrapped in a tup <item> <title>cowboy_req:host_info(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.host_info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -6408,6 +7487,18 @@ Any number of informational responses can be sent as long as they are sent befor <item> <title>cowboy_req:inform(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.inform/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -6478,6 +7569,17 @@ Cowboy will only return the cookie values specified in the fields list, and igno <item> <title>cowboy_req:match_cookies(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.match_cookies/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -6544,6 +7646,17 @@ Cowboy will only return the query string values specified in the fields list, an <item> <title>cowboy_req:match_qs(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.match_qs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -6616,6 +7729,20 @@ Changelog 2.0: Only the method is returned, it is no longer wrapped in a tuple.< <item> <title>cowboy_req:method(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.method/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -6698,6 +7825,19 @@ This function will crash on invalid cookie data. Because invalid cookies are fai <item> <title>cowboy_req:parse_cookies(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.parse_cookies/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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 or empty, [] is returned. +This function will crash on invalid cookie data. Because invalid cookies are fairly common when dealing with browsers (because of the string interface that the Javascript API provides), it is recommended to filter the cookie header value before attempting to parse it.</description> + </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> @@ -6776,6 +7916,18 @@ The type of the parsed value varies depending on the header.</description> <item> <title>cowboy_req:parse_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.parse_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -6848,6 +8000,18 @@ Arguments Req The Req object. <item> <title>cowboy_req:parse_qs(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.parse_qs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -6924,6 +8088,20 @@ Changelog 2.0: Only the path is returned, it is no longer wrapped in a tuple.</d <item> <title>cowboy_req:path(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.path/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -7008,6 +8186,20 @@ Changelog 2.0: Only the tokens are returned, they are no longer wrapped in a tup <item> <title>cowboy_req:path_info(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.path_info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -7092,6 +8284,20 @@ The peer is not necessarily the client&apos;s IP address and port. It is the <item> <title>cowboy_req:peer(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.peer/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -7174,6 +8380,19 @@ The port number can also be obtained using pattern matching: <item> <title>cowboy_req:port(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.port/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -7248,6 +8467,17 @@ Cowboy handles push requests the same way as if they came from the client, inclu <item> <title>cowboy_req:push(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.push/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -7320,6 +8550,20 @@ Changelog 2.0: Only the query string is returned, it is no longer wrapped in a t <item> <title>cowboy_req:qs(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.qs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -7398,6 +8642,17 @@ This function reads the request body and parses it as application/x-www-form-url <item> <title>cowboy_req:read_and_match_urlencoded_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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_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> @@ -7464,6 +8719,17 @@ This function reads a chunk of the request body. A more tuple is returned when m <item> <title>cowboy_req:read_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.read_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -7530,6 +8796,17 @@ This function reads the request body and parses it as multipart. Each parts of a <item> <title>cowboy_req:read_part(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.read_part/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -7596,6 +8873,17 @@ This function reads the request body and parses it as multipart. Each parts of a <item> <title>cowboy_req:read_part_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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_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> @@ -7664,6 +8952,18 @@ The urlencoded media type is used by Web browsers when submitting HTML forms usi <item> <title>cowboy_req:read_urlencoded_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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: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> @@ -7734,6 +9034,17 @@ The header names must be given as lowercase binary strings. While header names a <item> <title>cowboy_req:reply(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.reply/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -7802,6 +9113,18 @@ The header name must be given as a lowercase binary string. While header names a <item> <title>cowboy_req:resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.resp_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -7876,6 +9199,19 @@ Changelog 2.0: Function introduced. Examples Get all response headers Headers <item> <title>cowboy_req:resp_headers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.resp_headers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -7958,6 +9294,21 @@ Changelog 2.0: Function introduced.</description> <item> <title>cowboy_req:scheme(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.scheme/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -8042,6 +9393,18 @@ This function can also be used to remove a response body that was set previously <item> <title>cowboy_req:set_resp_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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_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> @@ -8118,6 +9481,20 @@ Arguments Name Cookie name. <item> <title>cowboy_req:set_resp_cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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_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> @@ -8198,6 +9575,18 @@ Cowboy does not allow duplicate header names.</description> <item> <title>cowboy_req:set_resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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_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> @@ -8270,6 +9659,18 @@ Cowboy does not allow duplicate header names. Headers set by this function may b <item> <title>cowboy_req:set_resp_headers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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: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> @@ -8346,6 +9747,20 @@ Changelog 2.1: Function introduced. Examples Get the socket&apos;s IP addr <item> <title>cowboy_req:sock(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.sock/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -8426,6 +9841,18 @@ The second argument indicates if this call is the final call. Use the nofin valu <item> <title>cowboy_req:stream_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.stream_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -8496,6 +9923,17 @@ This function should only be used for text/event-stream responses when using ser <item> <title>cowboy_req:stream_events(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.stream_events/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -8564,6 +10002,18 @@ Cowboy does not allow duplicate header names. Headers set by this function may o <item> <title>cowboy_req:stream_reply(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.stream_reply/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -8636,6 +10086,18 @@ You must list all field names sent in trailers in the trailer header, otherwise <item> <title>cowboy_req:stream_trailers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.stream_trailers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -8706,6 +10168,17 @@ By default Cowboy will build a URI using the components found in the request.</d <item> <title>cowboy_req:uri(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.uri/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -8778,6 +10251,20 @@ Changelog 2.0: Only the version is returned, it is no longer wrapped in a tuple. <item> <title>cowboy_req:version(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.version/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -8860,6 +10347,19 @@ init(Req, State) -&gt; {cowboy_rest, Req, State} Callback(Req, State) -& <item> <title>cowboy_rest(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_rest/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -8934,6 +10434,17 @@ The router takes the dispatch rules as input from the middleware environment. Di <item> <title>cowboy_router(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_router/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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. The environment can contain the rules directly or a tuple {persistent_term, Key}, in which case Cowboy will call persistent_term:get(Key) to retrieve the dispatch rules.</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> @@ -9008,6 +10519,20 @@ Changelog 1.0: Function introduced. Examples Compile routes and start a listen <item> <title>cowboy_router:compile(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_router.compile/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -9088,6 +10613,18 @@ Options opts() :: {priv_file, App, Path} | {priv_file, App, Path, Extra} | {file <item> <title>cowboy_static(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_static/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -9162,6 +10699,19 @@ Extra care must be taken when implementing stream handlers to ensure compatibili <item> <title>cowboy_stream(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -9225,6 +10775,18 @@ Arguments StreamID The stream ID.</description> </item> <item> + <title>cowboy_stream:data(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.data/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.data/</guid> + <description>Name cowboy_stream:data - Handle data for a stream +Description data(StreamID, IsFin, Data, State) -&gt; {Commands, State} StreamID :: cowboy_stream:stream_id() IsFin :: cowboy_stream:fin() Data :: binary() Commands :: cowboy_stream:commands() State - opaque Handle data for a stream. +This function should be called by all stream handlers. It will propagate data to the next configured stream handler. Handlers do not have to propagate data that has been fully handled. +Arguments StreamID The stream ID.</description> + </item> + + <item> <title>cowboy_stream:early_error(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.11/manual/cowboy_stream.early_error/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9238,6 +10800,19 @@ Arguments StreamID The stream ID. </item> <item> + <title>cowboy_stream:early_error(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.early_error/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.early_error/</guid> + <description>Name cowboy_stream:early_error - Handle an early error for a stream +Description early_error(StreamID, Reason, PartialReq, Resp, Opts) -&gt; Resp StreamID :: cowboy_stream:stream_id() Reason :: cowboy_stream:reason() PartialReq :: cowboy_stream:partial_req() Resp :: cowboy_stream:resp_command() Opts :: cowboy:opts() Handle an early error for a stream. +This function should be called by all stream handlers. It will propagate the early error to the next configured stream handler. +Arguments StreamID The stream ID. + Reason Reason for termination.</description> + </item> + + <item> <title>cowboy_stream:info(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.11/manual/cowboy_stream.info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9250,6 +10825,18 @@ Arguments StreamID The stream ID.</description> </item> <item> + <title>cowboy_stream:info(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.info/</guid> + <description>Name cowboy_stream:info - Handle a message for a stream +Description info(StreamID, Info, State) -&gt; {Commands, State} StreamID :: cowboy_stream:stream_id() Info :: any() Commands :: cowboy_stream:commands() State - opaque Handle a message for a stream. +This function should be called by all stream handlers. It will propagate the event to the next configured stream handler. Handlers do not have to propagate events that have been fully handled. +Arguments StreamID The stream ID.</description> + </item> + + <item> <title>cowboy_stream:init(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.11/manual/cowboy_stream.init/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9265,6 +10852,21 @@ Arguments StreamID The stream ID. </item> <item> + <title>cowboy_stream:init(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.init/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.init/</guid> + <description>Name cowboy_stream:init - Initialize a stream +Description init(StreamID, Req, Opts) -&gt; {Commands, State} StreamID :: cowboy_stream:stream_id() Req :: cowboy_req:req() Opts :: cowboy:opts() Commands :: cowboy_stream:commands() State - opaque Initialize a stream. +This function must be called by all stream handlers. It will initialize the next configured stream handler. +Arguments StreamID The stream ID. + Req The Req object. + Opts The protocol options. + Commands The commands to be executed.</description> + </item> + + <item> <title>cowboy_stream:terminate(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.11/manual/cowboy_stream.terminate/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9280,6 +10882,21 @@ Arguments StreamID The stream ID. </item> <item> + <title>cowboy_stream:terminate(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.terminate/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.terminate/</guid> + <description>Name cowboy_stream:terminate - Terminate a stream +Description terminate(StreamID, Reason, State) -&gt; ok StreamID :: cowboy_stream:stream_id() Reason :: cowboy_stream:reason() State - opaque Terminate a stream. +This function must be called by all stream handlers. It will terminate the next configured stream handler. +Arguments StreamID The stream ID. + Reason Reason for termination. + State The state for the next stream handler. + Return value The atom ok is always returned.</description> + </item> + + <item> <title>cowboy_stream_h(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/manual/cowboy_stream_h/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9305,6 +10922,18 @@ The default value is given next to the option name:</description> <item> <title>cowboy_stream_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream_h/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -9375,6 +11004,17 @@ Options opts() :: #{ tracer_callback =&gt; Callback, tracer_flags =&gt; <item> <title>cowboy_tracer_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_tracer_h/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_tracer_h/</guid> + <description>Name cowboy_tracer_h - Tracer stream handler +Description The module cowboy_tracer_h can be used to conditionally trace streams based on information found in the request. Trace messages are given to the configured callback. +Options opts() :: #{ tracer_callback =&gt; Callback, tracer_flags =&gt; [atom()], tracer_match_specs =&gt; [MatchSpec] } Callback :: fun((init | terminate | tuple(), State) -&gt; State) MatchSpec :: MatchPredicate | {method, binary()} | {host, binary()} | {path, binary()} | {path_start, binary()} | {header, binary()} | {header, binary(), binary()} | {peer_ip, inet:ip_address()} MatchPredicate :: fun((cowboy_stream:streamid(), cowboy_req:req(), cowboy:opts()) -&gt; boolean()) } Configuration for the tracer stream handler.</description> + </item> + + <item> + <title>cowboy_tracer_h(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_tracer_h/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9432,6 +11072,18 @@ init(Req, State) -&gt; {cowboy_websocket, Req, State} | {cowboy_websocket, R <item> <title>cowboy_websocket(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_websocket/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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()} Info :: any() CallResult :: {commands(), State} | {commands(), State, hibernate} | Deprecated Deprecated :: {ok, State} | {ok, State, hibernate} | {reply, OutFrame | [OutFrame], State} | {reply, OutFrame | [OutFrame], State, hibernate} | {stop, State} OutFrame :: cow_ws:frame() %% see types below 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>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> @@ -9516,6 +11168,18 @@ Modules cow_cookie(3) - Cookies Dependencies crypto - Crypto functions All t <item> <title>Cowlib Function Reference</title> + <link>https://ninenines.eu/docs/en/cowlib/2.13/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.13/manual/</guid> + <description>Name cowlib - Support library for manipulating Web protocols +Description Cowlib provides libraries for parsing and building messages for various Web protocols, including HTTP/1.1, HTTP/2 and Websocket. +It is optimized for completeness rather than speed. No value is ignored, they are all returned. +Modules cow_cookie(3) - Cookies Dependencies crypto - Crypto functions All these applications must be started before the cowlib application. To start Cowlib and all dependencies at once:</description> + </item> + + <item> + <title>Cowlib Function Reference</title> <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9576,6 +11240,18 @@ Modules cow_cookie(3) - Cookies Dependencies crypto - Crypto functions All t <item> <title>cowlib(7)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.13/manual/cowlib_app/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.13/manual/cowlib_app/</guid> + <description>Name cowlib - Support library for manipulating Web protocols +Description Cowlib provides libraries for parsing and building messages for various Web protocols, including HTTP/1.1, HTTP/2 and Websocket. +It is optimized for completeness rather than speed. No value is ignored, they are all returned. +Modules cow_cookie(3) - Cookies Dependencies crypto - Crypto functions All these applications must be started before the cowlib application. To start Cowlib and all dependencies at once:</description> + </item> + + <item> + <title>cowlib(7)</title> <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/cowlib_app/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9659,6 +11335,18 @@ Modules gun(3) - Asynchronous HTTP client gun_cookies(3) - Cookie store engine </item> <item> + <title>Gun Function Reference</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/</guid> + <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP +Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. +Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary. +Modules gun(3) - Asynchronous HTTP client gun_cookies(3) - Cookie store engine gun_cookies_list(3) - Cookie store backend: in-memory, per connection gun_event(3) - Events gun_ws_protocol(3) - Websocket subprotocols Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description> + </item> + + <item> <title>Gun User Guide</title> <link>https://ninenines.eu/docs/en/gun/1.0/guide/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9704,6 +11392,15 @@ Modules gun(3) - Asynchronous HTTP client gun_cookies(3) - Cookie store engine </item> <item> + <title>Gun User Guide</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/</guid> + <description>Interface Introduction Starting and stopping Supported protocols Connection Using HTTP Using Websocket Advanced Internals: TLS over TLS Additional information Changes since Gun 2.0 Migrating from Gun 1.3 to 2.0 Migrating from Gun 1.2 to 1.3 Migrating from Gun 1.1 to 1.2 Migrating from Gun 1.0 to 1.1 </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> @@ -9764,6 +11461,18 @@ gun:open(3) - Open a connection to the given host and port gun:open_unix(3) - O </item> <item> + <title>gun(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun/</guid> + <description>Name gun - Asynchronous HTTP client +Description The gun module provides an asynchronous interface for connecting and communicating with Web servers over HTTP, HTTP/2 or Websocket. +Exports Connection: +gun:open(3) - Open a connection to the given host and port gun:open_unix(3) - Open a connection to the given Unix domain socket gun:set_owner(3) - Set a new owner for the connection gun:shutdown(3) - Gracefully close the connection gun:close(3) - Brutally close the connection gun:info(3) - Obtain information about the connection Requests:</description> + </item> + + <item> <title>gun(7)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_app/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9824,6 +11533,18 @@ Modules gun(3) - Asynchronous HTTP client gun_cookies(3) - Cookie store engine </item> <item> + <title>gun(7)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_app/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_app/</guid> + <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP +Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. +Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary. +Modules gun(3) - Asynchronous HTTP client gun_cookies(3) - Cookie store engine gun_cookies_list(3) - Cookie store backend: in-memory, per connection gun_event(3) - Events gun_ws_protocol(3) - Websocket subprotocols Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description> + </item> + + <item> <title>gun:await(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.await/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9879,6 +11600,17 @@ This function waits for a message from the given stream and returns it as a tupl </item> <item> + <title>gun:await(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.await/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.await/</guid> + <description>Name gun:await - Wait for a response +Description await(ConnPid, StreamRef) -&gt; await(ConnPid, StreamRef, 5000, MonitorRef) await(ConnPid, StreamRef, MonitorRef) -&gt; await(ConnPid, StreamRef, 5000, MonitorRef) await(ConnPid, StreamRef, Timeout) -&gt; await(ConnPid, StreamRef, Timeout, MonitorRef) await(ConnPid, StreamRef, Timeout, MonitorRef) -&gt; Result ConnPid :: pid() StreamRef :: gun:stream_ref() MonitorRef :: reference() Timeout :: timeout() Result :: tuple() - see below Wait for a response. +This function waits for a message from the given stream and returns it as a tuple.</description> + </item> + + <item> <title>gun:await_body(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.await_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9929,6 +11661,16 @@ Description await_body(ConnPid, StreamRef) -&gt; await_body(ConnPid, StreamR </item> <item> + <title>gun:await_body(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.await_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.await_body/</guid> + <description>Name gun:await_body - Wait for the complete response body +Description await_body(ConnPid, StreamRef) -&gt; await_body(ConnPid, StreamRef, 5000, MonitorRef) await_body(ConnPid, StreamRef, MonitorRef) -&gt; await_body(ConnPid, StreamRef, 5000, MonitorRef) await_body(ConnPid, StreamRef, Timeout) -&gt; await_body(ConnPid, StreamRef, Timeout, MonitorRef) await_body(ConnPid, StreamRef, Timeout, MonitorRef) -&gt; {ok, Body} | {ok, Body, Trailers} | {error, Reason} ConnPid :: pid() StreamRef :: gun:stream_ref() MonitorRef :: reference() Timeout :: timeout() Body :: binary() Trailers :: [{binary(), binary()}] Reason :: {stream_error | connection_error | down, any()} | timeout Wait for the complete response body.</description> + </item> + + <item> <title>gun:await_up(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.await_up/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9984,6 +11726,17 @@ Arguments ConnPid The pid of the Gun connection process.</description> </item> <item> + <title>gun:await_up(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.await_up/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.await_up/</guid> + <description>Name gun:await_up - Wait for the connection to be up +Description await_up(ConnPid) -&gt; await_up(ConnPid, 5000, MonitorRef) await_up(ConnPid, MonitorRef) -&gt; await_up(ConnPid, 5000, MonitorRef) await_up(ConnPid, Timeout) -&gt; await_up(ConnPid, Timeout, MonitorRef) await_up(ConnPid, Timeout, MonitorRef) -&gt; {ok, Protocol} | {error, Reason} ConnPid :: pid() MonitorRef :: reference() Timeout :: timeout() Protocol :: http | http2 | socks Reason :: {down, any()} | timeout Wait for the connection to be up. +Arguments ConnPid The pid of the Gun connection process.</description> + </item> + + <item> <title>gun:cancel(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.cancel/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10044,6 +11797,18 @@ HTTP/1.1 does not support this feature. Gun will simply silence the stream and s </item> <item> + <title>gun:cancel(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.cancel/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.cancel/</guid> + <description>Name gun:cancel - Cancel the given stream +Description cancel(ConnPid, StreamRef) -&gt; ok ConnPid :: pid() StreamRef :: gun:stream_ref() Cancel the given stream. +The behavior of this function depends on the protocol selected. +HTTP/1.1 does not support this feature. Gun will simply silence the stream and stop relaying messages. Gun may also decide to close the connection if the response body is too large, to avoid wasting time and bandwidth.</description> + </item> + + <item> <title>gun:close(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.close/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10109,6 +11874,19 @@ Changelog 1.0: Function introduced. Examples Close the connection ok = gun:clo </item> <item> + <title>gun:close(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.close/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.close/</guid> + <description>Name gun:close - Brutally close the connection +Description close(ConnPid) -&gt; ok ConnPid :: pid() Brutally close the connection. +Arguments ConnPid The pid of the Gun connection process. + Return value The atom ok is returned. +Changelog 1.0: Function introduced. Examples Close the connection ok = gun:close(ConnPid). See also gun(3), gun:open(3), gun:open_unix(3), gun:shutdown(3)</description> + </item> + + <item> <title>gun:connect(3)</title> <link>https://ninenines.eu/docs/en/gun/1.2/manual/gun.connect/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10142,6 +11920,17 @@ This feature is currently only available for HTTP/1.1 connections. Upon successf </item> <item> + <title>gun:connect(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.connect/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.connect/</guid> + <description>Name gun:connect - Establish a tunnel to the origin server +Description connect(ConnPid, Destination) -&gt; connect(ConnPid, Destination, [], #{}). connect(ConnPid, Destination, Headers) -&gt; connect(ConnPid, Destination, Headers, #{}). connect(ConnPid, Destination, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Destination :: gun:connect_destination() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Establish a tunnel to the origin server. +This feature is currently only available for HTTP/1.1 connections. Upon successful completion of the CONNECT request a tunnel is established and subsequent requests will go through the tunnel.</description> + </item> + + <item> <title>gun:data(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.data/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10202,6 +11991,18 @@ All calls to this function must use the nofin flag except for the last which mus </item> <item> + <title>gun:data(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.data/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.data/</guid> + <description>Name gun:data - Stream the body of a request +Description data(ConnPid, StreamRef, IsFin, Data) -&gt; ok ConnPid :: pid() StreamRef :: gun:stream_ref() IsFin :: fin | nofin Data :: iodata() Stream the body of a request. +This function can only be used if the original request had headers indicating that a body would be streamed. +All calls to this function must use the nofin flag except for the last which must use fin to indicate the end of the request body.</description> + </item> + + <item> <title>gun:delete(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.delete/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10272,6 +12073,20 @@ Arguments ConnPid The pid of the Gun connection process. </item> <item> + <title>gun:delete(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.delete/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.delete/</guid> + <description>Name gun:delete - Delete a resource +Description delete(ConnPid, Path) -&gt; delete(ConnPid, Path, [], #{}). delete(ConnPid, Path, Headers) -&gt; delete(ConnPid, Path, Headers, #{}) delete(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Delete a resource. +Arguments ConnPid The pid of the Gun connection process. + Path Path to the resource. + Headers Additional request headers. + ReqOpts Request options.</description> + </item> + + <item> <title>gun:flush(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.flush/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10342,6 +12157,20 @@ ConnPid The pid of the Gun connection process. </item> <item> + <title>gun:flush(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.flush/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.flush/</guid> + <description>Name gun:flush - Flush all messages related to a connection or a stream +Description flush(ConnPid) -&gt; ok flush(StreamRef) -&gt; ok ConnPid :: pid() StreamRef :: gun:stream_ref() Flush all messages related to a connection or a stream. +Arguments Either of these arguments may be provided: +ConnPid The pid of the Gun connection process. + StreamRef Identifier of the stream for the original request. + Return value The atom ok is returned.</description> + </item> + + <item> <title>gun:get(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.get/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10408,6 +12237,20 @@ Arguments ConnPid The pid of the Gun connection process. </item> <item> + <title>gun:get(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.get/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.get/</guid> + <description>Name gun:get - Get a resource representation +Description get(ConnPid, Path) -&gt; get(ConnPid, Path, [], #{}). get(ConnPid, Path, Headers) -&gt; get(ConnPid, Path, Headers, #{}) get(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Get a resource representation. +Arguments ConnPid The pid of the Gun connection process. + Path Path to the resource. + Headers Additional request headers. + ReqOpts Request options.</description> + </item> + + <item> <title>gun:head(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.head/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10463,6 +12306,17 @@ This function performs the same operation as gun:get(3), except the server will </item> <item> + <title>gun:head(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.head/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.head/</guid> + <description>Name gun:head - Get headers of a resource representation +Description head(ConnPid, Path) -&gt; head(ConnPid, Path, [], #{}). head(ConnPid, Path, Headers) -&gt; head(ConnPid, Path, Headers, #{}) head(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Get headers of a resource representation. +This function performs the same operation as gun:get(3), except the server will not send the resource representation, only the response&apos;s status code and headers.</description> + </item> + + <item> <title>gun:headers(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.headers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10475,6 +12329,18 @@ The function headers/4,5 initiates a request but does not send the request body. </item> <item> + <title>gun:headers(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.headers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.headers/</guid> + <description>Name gun:headers - Initiate the given request +Description headers(ConnPid, Method, Path, Headers) -&gt; headers(ConnPid, Method, Path, Headers, #{}) headers(ConnPid, Method, Path, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Method :: binary() Path :: iodata() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Initiate the given request. +This is a general purpose function that should only be used when other method-specific functions do not apply. +The function headers/4,5 initiates a request but does not send the request body.</description> + </item> + + <item> <title>gun:info(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10534,6 +12400,16 @@ Description info(ConnPid) -&gt; Info ConnPid :: pid() Info :: #{ owner =& </item> <item> + <title>gun:info(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.info/</guid> + <description>Name gun:info - Obtain information about the connection +Description info(ConnPid) -&gt; Info ConnPid :: pid() Info :: #{ owner =&gt; pid(), socket =&gt; inet:socket() | ssl:sslsocket(), transport =&gt; tcp | tls, protocol =&gt; http | http2 | socks | ws, sock_ip =&gt; inet:ip_address(), sock_port =&gt; inet:port_number(), origin_scheme =&gt; binary() | undefined, origin_host =&gt; inet:hostname() | inet:ip_address(), origin_port =&gt; inet:port_number(), intermediaries =&gt; [Intermediary], cookie_store =&gt; gun_cookies:cookie_store() } Intermediary :: #{ type =&gt; connect | socks5, host =&gt; inet:hostname() | inet:ip_address(), port =&gt; inet:port_number(), transport =&gt; tcp | tls, protocol =&gt; http | http2 | socks | raw } Obtain information about the connection.</description> + </item> + + <item> <title>gun:open(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.open/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10597,6 +12473,17 @@ Arguments Host Host or IP address to connect to.</description> </item> <item> + <title>gun:open(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.open/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.open/</guid> + <description>Name gun:open - Open a connection to the given host and port +Description open(Host, Port) -&gt; open(Host, Port, #{}) open(Host, Port, Opts) -&gt; {ok, pid()} | {error, Reason} Host :: inet:hostname() | inet:ip_address() Port :: inet:port_number() Opts :: gun:opts() Reason :: {options, OptName} | {options, {http | http2 | socks | ws, OptName}} | any() OptName :: atom() Open a connection to the given host and port. +Arguments Host Host or IP address to connect to.</description> + </item> + + <item> <title>gun:open_unix(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.open_unix/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10661,6 +12548,18 @@ Arguments SocketPath Path to the Unix domain socket to connect to. </item> <item> + <title>gun:open_unix(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.open_unix/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.open_unix/</guid> + <description>Name gun:open_unix - Open a connection to the given Unix domain socket +Description open_unix(SocketPath, Opts) -&gt; {ok, pid()} | {error, Reason} SocketPath :: string() Opts :: gun:opts() Reason :: {options, OptName} | {options, {http | http2 | socks | ws, OptName}} | any() OptName :: atom() Open a connection to the given Unix domain socket. +Arguments SocketPath Path to the Unix domain socket to connect to. + Opts Options for this connection.</description> + </item> + + <item> <title>gun:options(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.options/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10716,6 +12615,17 @@ The special path &quot;*&quot; can be used to obtain information about t </item> <item> + <title>gun:options(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.options/</guid> + <description>Name gun:options - Query the capabilities of the server or a resource +Description options(ConnPid, Path) -&gt; options(ConnPid, Path, [], #{}). options(ConnPid, Path, Headers) -&gt; options(ConnPid, Path, Headers, #{}) options(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Query the capabilities of the server or a resource. +The special path &quot;*&quot; can be used to obtain information about the server as a whole.</description> + </item> + + <item> <title>gun:patch(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.patch/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10770,6 +12680,16 @@ Description patch(ConnPid, Path, Headers) -&gt; patch(ConnPid, Path, Headers </item> <item> + <title>gun:patch(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.patch/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.patch/</guid> + <description>Name gun:patch - Apply a set of changes to a resource +Description patch(ConnPid, Path, Headers) -&gt; patch(ConnPid, Path, Headers, #{}) patch(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef patch(ConnPid, Path, Headers, Body) -&gt; patch(ConnPid, Path, Headers, Body, #{}) patch(ConnPid, Path, Headers, Body, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() Body :: iodata() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Apply a set of changes to a resource.</description> + </item> + + <item> <title>gun:post(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.post/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10824,6 +12744,16 @@ Description post(ConnPid, Path, Headers) -&gt; post(ConnPid, Path, Headers, </item> <item> + <title>gun:post(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.post/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.post/</guid> + <description>Name gun:post - Process the enclosed representation according to a resource&apos;s own semantics +Description post(ConnPid, Path, Headers) -&gt; post(ConnPid, Path, Headers, #{}) post(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef post(ConnPid, Path, Headers, Body) -&gt; post(ConnPid, Path, Headers, Body, #{}) post(ConnPid, Path, Headers, Body, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() Body :: iodata() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Process the enclosed representation according to a resource&apos;s own semantics.</description> + </item> + + <item> <title>gun:put(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.put/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10883,6 +12813,17 @@ The behavior of this function varies depending on whether a body is provided.</d </item> <item> + <title>gun:put(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.put/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.put/</guid> + <description>Name gun:put - Create or replace a resource +Description put(ConnPid, Path, Headers) -&gt; put(ConnPid, Path, Headers, #{}) put(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef put(ConnPid, Path, Headers, Body) -&gt; put(ConnPid, Path, Headers, Body, #{}) put(ConnPid, Path, Headers, Body, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() Body :: iodata() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Create or replace a resource. +The behavior of this function varies depending on whether a body is provided.</description> + </item> + + <item> <title>gun:request(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.request/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10938,6 +12879,17 @@ This is a general purpose function that should only be used when other method-sp </item> <item> + <title>gun:request(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.request/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.request/</guid> + <description>Name gun:request - Perform the given request +Description request(ConnPid, Method, Path, Headers, Body) -&gt; request(ConnPid, Method, Path, Headers, Body, #{}) request(ConnPid, Method, Path, Headers, Body, ReqOpts) -&gt; StreamRef ConnPid :: pid() Method :: binary() Path :: iodata() Headers :: gun:req_headers() Body :: iodata() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Perform the given request. +This is a general purpose function that should only be used when other method-specific functions do not apply.</description> + </item> + + <item> <title>gun:set_owner(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.set_owner/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10952,6 +12904,20 @@ Arguments ConnPid The pid of the Gun connection process. </item> <item> + <title>gun:set_owner(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.set_owner/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.set_owner/</guid> + <description>Name gun:set_owner - Set a new owner for the connection +Description set_owner(ConnPid, OwnerPid) -&gt; ok ConnPid :: pid() OwnerPid :: pid() Set a new owner for the connection. +Only the current owner of the connection can set a new owner. +Gun monitors the owner of the connection and automatically shuts down gracefully when the owner exits. +Arguments ConnPid The pid of the Gun connection process. + OwnerPid The pid of the new owner for the connection.</description> + </item> + + <item> <title>gun:shutdown(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.shutdown/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10964,6 +12930,18 @@ For HTTP/1.1 there is no such mechanism and Gun will close the connection once t </item> <item> + <title>gun:shutdown(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.shutdown/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.shutdown/</guid> + <description>Name gun:shutdown - Gracefully close the connection +Description shutdown(ConnPid) -&gt; ok ConnPid :: pid() Gracefully close the connection. +Gun will wait for up to closing_timeout milliseconds before brutally closing the connection. The graceful shutdown mechanism varies between the different protocols: +For HTTP/1.1 there is no such mechanism and Gun will close the connection once the current response is received. Any pipelined requests are immediately terminated. For HTTP/2 Gun will send a GOAWAY frame and wait for the existing streams to terminate.</description> + </item> + + <item> <title>gun:stream_info(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.stream_info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10974,6 +12952,16 @@ Description stream_info(ConnPid, StreamRef) -&gt; {ok, undefined | Info} | { </item> <item> + <title>gun:stream_info(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.stream_info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.stream_info/</guid> + <description>Name gun:stream_info - Obtain information about a stream +Description stream_info(ConnPid, StreamRef) -&gt; {ok, undefined | Info} | {error, not_connected} ConnPid :: pid() StreamRef :: gun:stream_ref() Info :: #{ ref =&gt; gun:stream_ref(), reply_to =&gt; pid(), state =&gt; running | stopping, intermediaries =&gt; [Intermediary], tunnel =&gt; Tunnel } Intermediary :: #{ type =&gt; connect | socks5, host =&gt; inet:hostname() | inet:ip_address(), port =&gt; inet:port_number(), transport =&gt; tcp | tls, protocol =&gt; http | http2 | socks | raw } Tunnel :: #{ transport =&gt; tcp | tls, protocol =&gt; http | http2 | socks | raw, origin_scheme =&gt; binary() | undefined, origin_host =&gt; inet:hostname() | inet:ip_address(), origin_port =&gt; inet:port_number() } Obtain information about a stream.</description> + </item> + + <item> <title>gun:update_flow(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.update_flow/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10988,6 +12976,20 @@ Arguments ConnPid The pid of the Gun connection process. </item> <item> + <title>gun:update_flow(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.update_flow/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.update_flow/</guid> + <description>Name gun:update_flow - Update a stream&apos;s flow control value +Description update_flow(ConnPid, StreamRef, Flow) -&gt; ok ConnPid :: pid() StreamRef :: gun:stream_ref() Flow :: pos_integer() Update a stream&apos;s flow control value. +The flow value can only ever be incremented. +This function does nothing for streams that have flow control disabled (which is the default). +Arguments ConnPid The pid of the Gun connection process. + StreamRef Identifier of the stream for the original request.</description> + </item> + + <item> <title>gun:ws_send(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.ws_send/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11052,6 +13054,18 @@ Arguments ConnPid The pid of the Gun connection process.</description> </item> <item> + <title>gun:ws_send(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.ws_send/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.ws_send/</guid> + <description>Name gun:ws_send - Send Websocket frames +Description ws_send(ConnPid, StreamRef, Frames) -&gt; ok ConnPid :: pid() StreamRef :: gun:stream_ref() Frames :: Frame | [Frame] Frame :: close | ping | pong | {text | binary | close | ping | pong, iodata()} | {close, non_neg_integer(), iodata()} Send Websocket frames. +The connection must first be upgraded to Websocket using the function gun:ws_upgrade(3). +Arguments ConnPid The pid of the Gun connection process.</description> + </item> + + <item> <title>gun:ws_upgrade(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.ws_upgrade/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11112,6 +13126,18 @@ HTTP/1.1 cannot handle Websocket and HTTP requests concurrently. The upgrade, if </item> <item> + <title>gun:ws_upgrade(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.ws_upgrade/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.ws_upgrade/</guid> + <description>Name gun:ws_upgrade - Upgrade to Websocket +Description ws_upgrade(ConnPid, Path) -&gt; ws_upgrade(ConnPid, Path, []) ws_upgrade(ConnPid, Path, Headers) -&gt; StreamRef ws_upgrade(ConnPid, Path, Headers, WsOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() WsOpts :: gun:ws_opts() StreamRef :: gun:stream_ref() Upgrade to Websocket. +The behavior of this function depends on the protocol selected. +HTTP/1.1 cannot handle Websocket and HTTP requests concurrently. The upgrade, if successful, will result in the complete takeover of the connection.</description> + </item> + + <item> <title>gun_cookies(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_cookies/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11124,6 +13150,18 @@ init init(Opts :: any()) -&gt; gun_cookies:store() Initialize the cookie st </item> <item> + <title>gun_cookies(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies/</guid> + <description>Name gun_cookies - Cookie store engine +Description The gun_cookies module implements a cookie store engine. It will be used by Gun when a cookie store is configured. It also defines the interface and provides functions used to implement cookie store backends. +Callbacks Cookie store backends implement the following interface. Functions are organized by theme: initialization, querying, storing and garbage collecting: +init init(Opts :: any()) -&gt; gun_cookies:store() Initialize the cookie store.</description> + </item> + + <item> <title>gun_cookies:domain_match(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_cookies.domain_match/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11139,6 +13177,21 @@ Changelog 2.0: Function introduced. Examples Perform a domain match Match = gu </item> <item> + <title>gun_cookies:domain_match(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies.domain_match/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies.domain_match/</guid> + <description>Name gun_cookies:domain_match - Cookie domain match +Description domain_match(String, DomainString) -&gt; boolean() String :: binary() DomainString :: binary() Cookie domain match. +This function can be used when implementing the set_cookie_secure_match callback of a cookie store. +Arguments String The string to match. + DomainString The domain string that will be matched against. + Return value Returns true when String domain-matches DomainString, and false otherwise. +Changelog 2.0: Function introduced. Examples Perform a domain match Match = gun_cookies:domain_match(Domain, CookieDomain).</description> + </item> + + <item> <title>gun_cookies:path_match(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_cookies.path_match/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11154,6 +13207,21 @@ Changelog 2.0: Function introduced. Examples Perform a path match Match = gun_ </item> <item> + <title>gun_cookies:path_match(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies.path_match/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies.path_match/</guid> + <description>Name gun_cookies:path_match - Cookie path match +Description path_match(ReqPath, CookiePath) -&gt; boolean() ReqPath :: binary() CookiePath :: binary() Cookie path match. +This function can be used when implementing the set_cookie_secure_match callback of a cookie store. +Arguments ReqPath The request path to match. + CookiePath The cookie path that will be matched against. + Return value Returns true when ReqPath path-matches CookiePath, and false otherwise. +Changelog 2.0: Function introduced. Examples Perform a path match Match = gun_cookies:path_match(ReqPath, CookiePath).</description> + </item> + + <item> <title>gun_cookies_list(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_cookies_list/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11167,6 +13235,19 @@ Types opts() opts() :: #{ } Cookie store backend options.</description> </item> <item> + <title>gun_cookies_list(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies_list/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies_list/</guid> + <description>Name gun_cookies_list - Cookie store backend: in-memory, per connection +Description The gun_cookies_list module implements a cookie store backend that keeps all the cookie data in-memory and tied to a specific connection. +It is possible to implement a custom backend on top of gun_cookies_list in order to add persistence or sharing properties. +Exports This module implements the callbacks defined in gun_cookies(3). +Types opts() opts() :: #{ } Cookie store backend options.</description> + </item> + + <item> <title>gun_data(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_data/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11232,6 +13313,19 @@ The response body may be terminated either by a data message with the flag fin s </item> <item> + <title>gun_data(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_data/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_data/</guid> + <description>Name gun_data - Response body +Description {gun_data, ConnPid, StreamRef, IsFin, Data} ConnPid :: pid() StreamRef :: gun:stream_ref() IsFin :: fin | nofin Data :: binary() Response body. +This message informs the relevant process that the server sent a all or part of the body for the response to the original request. +A data message is always preceded by a response message. +The response body may be terminated either by a data message with the flag fin set or by a gun_trailers(3) message.</description> + </item> + + <item> <title>gun_down(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_down/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11292,6 +13386,18 @@ When the connection goes back up, Gun will not attempt to retry requests.</descr </item> <item> + <title>gun_down(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_down/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_down/</guid> + <description>Name gun_down - The connection is down +Description {gun_down, ConnPid, Protocol, Reason, KilledStreams} ConnPid :: pid() Protocol :: http | http2 | socks | ws Reason :: any() KilledStreams :: [gun:stream_ref()] The connection is down. +This message informs the owner process that the connection was lost. Depending on the retry and retry_timeout options Gun may automatically attempt to reconnect. +When the connection goes back up, Gun will not attempt to retry requests.</description> + </item> + + <item> <title>gun_error(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_error/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11347,6 +13453,17 @@ These messages inform the relevant process that an error occurred. A reference i </item> <item> + <title>gun_error(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_error/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_error/</guid> + <description>Name gun_error - Stream or connection-wide error +Description {gun_error, ConnPid, StreamRef, Reason} {gun_error, ConnPid, Reason} ConnPid :: pid() StreamRef :: gun:stream_ref() Reason :: any() Stream or connection-wide error. +These messages inform the relevant process that an error occurred. A reference is given when the error pertains to a specific stream. Connection-wide errors do not imply that the connection is no longer usable, they are used for all errors that are not specific to a stream.</description> + </item> + + <item> <title>gun_event(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_event/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11360,6 +13477,19 @@ init init_event() :: #{ owner := pid(), transport := tcp | tls, origin_scheme := </item> <item> + <title>gun_event(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_event/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_event/</guid> + <description>Name gun_event - Events +Description The gun_event module provides the callback interface and types for implementing event handlers. +Callbacks Event handlers implement the following interface. Because types are tied to specific events, they are documented alongside them. All event types are exported and can be referred to as gun_event:Type(). +The events are ordered by the order they are likely to be triggered, with the most frequent events listed first. +init init_event() :: #{ owner := pid(), transport := tcp | tls, origin_scheme := binary(), origin_host := inet:hostname() | inet:ip_address(), origin_port := inet:port_number(), opts := gun:opts() } init(init_event(), State) -&gt; State Gun is initializing.</description> + </item> + + <item> <title>gun_inform(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_inform/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11420,6 +13550,18 @@ Informational responses are only intermediate responses and provide no guarantee </item> <item> + <title>gun_inform(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_inform/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_inform/</guid> + <description>Name gun_inform - Informational response +Description {gun_inform, ConnPid, StreamRef, Status, Headers} ConnPid :: pid() StreamRef :: gun:stream_ref() Status :: 100..199 Headers :: [{binary(), binary()}] Informational response. +This message informs the relevant process that the server sent an informational response to the original request. +Informational responses are only intermediate responses and provide no guarantees as to what the final response will be. An informational response always precedes the response to the original request.</description> + </item> + + <item> <title>gun_push(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_push/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11480,6 +13622,18 @@ A server-initiated push message always precedes the response to the original req </item> <item> + <title>gun_push(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_push/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_push/</guid> + <description>Name gun_push - Server-initiated push +Description {gun_push, ConnPid, StreamRef, NewStreamRef, Method, URI, Headers} ConnPid :: pid() StreamRef :: gun:stream_ref() NewStreamRef :: gun:stream_ref() Method :: binary() URI :: binary() Headers :: [{binary(), binary()}] Server-initiated push. +This message informs the relevant process that the server is pushing a resource related to the effective target URI of the original request. +A server-initiated push message always precedes the response to the original request.</description> + </item> + + <item> <title>gun_response(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_response/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11550,6 +13704,20 @@ Elements ConnPid The pid of the Gun connection process. </item> <item> + <title>gun_response(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_response/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_response/</guid> + <description>Name gun_response - Response +Description {gun_response, ConnPid, StreamRef, IsFin, Status, Headers} ConnPid :: pid() StreamRef :: gun:stream_ref() IsFin :: fin | nofin Status :: non_neg_integer() Headers :: [{binary(), binary()}] Response. +This message informs the relevant process that the server sent a response to the original request. +Elements ConnPid The pid of the Gun connection process. + StreamRef Identifier of the stream for the original request. + IsFin Whether this message terminates the response.</description> + </item> + + <item> <title>gun_trailers(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_trailers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11625,6 +13793,21 @@ Elements ConnPid The pid of the Gun connection process. </item> <item> + <title>gun_trailers(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_trailers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_trailers/</guid> + <description>Name gun_trailers - Response trailers +Description {gun_trailers, ConnPid, StreamRef, Headers} ConnPid :: pid() StreamRef :: gun:stream_ref() Headers :: [{binary(), binary()}] Response trailers. +This message informs the relevant process that the server sent response trailers for the response to the original request. +A trailers message terminates the response. +Elements ConnPid The pid of the Gun connection process. + StreamRef Identifier of the stream for the original request. + Headers Trailing headers sent after the response body.</description> + </item> + + <item> <title>gun_tunnel_up(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_tunnel_up/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11637,6 +13820,18 @@ If Gun is configured to connect to another SOCKS server, then the connection is </item> <item> + <title>gun_tunnel_up(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_tunnel_up/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_tunnel_up/</guid> + <description>Name gun_tunnel_up - The tunnel is up +Description {gun_tunnel_up, ConnPid, StreamRef, Protocol} ConnPid :: pid() StreamRef :: gun:stream_ref() | undefined Protocol :: http | http2 | socks The tunnel is up. +This message informs the owner/calling process that the connection completed through the SOCKS or CONNECT proxy. +If Gun is configured to connect to another SOCKS server, then the connection is not usable yet. One or more gun_tunnel_up(3) messages will follow.</description> + </item> + + <item> <title>gun_up(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_up/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11698,6 +13893,19 @@ Otherwise, Gun will start processing the messages it received while waiting for </item> <item> + <title>gun_up(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_up/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_up/</guid> + <description>Name gun_up - The connection is up +Description {gun_up, ConnPid, Protocol} ConnPid :: pid() Protocol :: http | http2 | raw | socks The connection is up. +This message informs the owner process that the connection or reconnection completed. +If Gun is configured to connect to a Socks server, then the connection is not usable yet. One or more gun_tunnel_up(3) messages will follow. +Otherwise, Gun will start processing the messages it received while waiting for the connection to be up.</description> + </item> + + <item> <title>gun_upgrade(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_upgrade/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11758,6 +13966,18 @@ The exact semantics of this message depend on the original protocol. HTTP/1.1 up </item> <item> + <title>gun_upgrade(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_upgrade/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_upgrade/</guid> + <description>Name gun_upgrade - Successful protocol upgrade +Description {gun_upgrade, ConnPid, StreamRef, Protocols, Headers} ConnPid :: pid() StreamRef :: gun:stream_ref() Protocols :: [&lt;&lt;"websocket"&gt;&gt;] Headers :: [{binary(), binary()}] Successful protocol upgrade. +This message informs the relevant process that the server accepted to upgrade to one or more protocols given in the original request. +The exact semantics of this message depend on the original protocol. HTTP/1.1 upgrades apply to the entire connection. HTTP/2 uses a different mechanism which allows switching specific streams to a different protocol.</description> + </item> + + <item> <title>gun_ws(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_ws/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11822,6 +14042,18 @@ This message can only be sent on streams that were upgraded to the Websocket pro </item> <item> + <title>gun_ws(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_ws/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_ws/</guid> + <description>Name gun_ws - Websocket frame +Description {gun_ws, ConnPid, StreamRef, Frame} ConnPid :: pid() StreamRef :: gun:stream_ref() Frame :: close | ping | pong | {text | binary | close, binary()} | {close, non_neg_integer(), binary()} | {ping | pong, binary()} Websocket frame. +This message informs the relevant process that the server sent the enclosed frame. +This message can only be sent on streams that were upgraded to the Websocket protocol.</description> + </item> + + <item> <title>gun_ws_protocol(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_ws_protocol/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11835,6 +14067,19 @@ ReplyTo The pid of the process that owns the stream and to which messages will b </item> <item> + <title>gun_ws_protocol(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_ws_protocol/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_ws_protocol/</guid> + <description>Name gun_ws_protocol - Websocket subprotocols +Description The gun_ws_protocol module provides the callback interface and types for implementing Websocket subprotocols. +Callbacks Websocket subprotocols implement the following interface. +init init(ReplyTo, StreamRef, Headers, Opts) -&gt; {ok, State} ReplyTo :: pid() StreamRef :: reference() Headers :: cow_http:headers() Opts :: gun:ws_opts() State :: protocol_state() Initialize the Websocket protocol. +ReplyTo The pid of the process that owns the stream and to which messages will be sent to.</description> + </item> + + <item> <title>HTTP status codes(7)</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/manual/http_status_codes/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11858,6 +14103,17 @@ Description This chapter aims to list all HTTP status codes that Cowboy may retu <item> <title>HTTP status codes(7)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/http_status_codes/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> diff --git a/donate/index.html b/donate/index.html index 88ccd98e..d744e333 100644 --- a/donate/index.html +++ b/donate/index.html @@ -813,6 +813,108 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <h3 id="_like_my_work__donate">Like my work? Donate!</h3> <p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> <form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> @@ -2548,6 +2650,280 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + </div> </div> </div> diff --git a/erlanger-playbook/index.html b/erlanger-playbook/index.html index dc98327c..aed3c62b 100644 --- a/erlanger-playbook/index.html +++ b/erlanger-playbook/index.html @@ -853,6 +853,108 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <h3 id="_like_my_work__donate">Like my work? Donate!</h3> <p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> <form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> @@ -2588,6 +2690,280 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + </div> </div> </div> @@ -112,10 +112,10 @@ <a class="btn btn-large" href="https://github.com/ninenines/cowboy">Source Code</a> - <a class="btn btn-large" href="/docs/en/cowboy/2.11/guide/">User Guide</a> + <a class="btn btn-large" href="/docs/en/cowboy/2.12/guide/">User Guide</a> - <a class="btn btn-large" href="/docs/en/cowboy/2.11/manual/">Manual</a> + <a class="btn btn-large" href="/docs/en/cowboy/2.12/manual/">Manual</a> </p> @@ -135,7 +135,7 @@ <a class="btn btn-large" href="https://github.com/ninenines/cowlib">Source Code</a> - <a class="btn btn-large" href="/docs/en/cowlib/2.12/manual/">Manual</a> + <a class="btn btn-large" href="/docs/en/cowlib/2.13/manual/">Manual</a> </p> @@ -174,10 +174,10 @@ <a class="btn btn-large" href="https://github.com/ninenines/gun">Source Code</a> - <a class="btn btn-large" href="/docs/en/gun/2.0/guide/">User Guide</a> + <a class="btn btn-large" href="/docs/en/gun/2.1/guide/">User Guide</a> - <a class="btn btn-large" href="/docs/en/gun/2.0/manual/">Manual</a> + <a class="btn btn-large" href="/docs/en/gun/2.1/manual/">Manual</a> </p> @@ -953,6 +953,108 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <p>Reward my work via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a> and<br/>GitHub will double the funds I receive!</p> @@ -2672,6 +2774,280 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + </div></div> </div> @@ -88,6 +88,21 @@ Copyright (c) 2013-2023, Loïc Hoguin &lt;[email protected]&gt; Permiss <item> <title>Introduction</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/introduction/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/introduction/</guid> + <description>Gun is an HTTP client for Erlang/OTP. +Gun supports the HTTP/2, HTTP/1.1 and Websocket protocols. +Prerequisites Knowledge of Erlang, but also of the HTTP/1.1, HTTP/2 and Websocket protocols is required in order to read this guide. +Supported platforms Gun is tested and supported on Linux, FreeBSD, Windows and OSX. +Gun is developed for Erlang/OTP 22.0 and newer. +License Gun uses the ISC License. +Copyright (c) 2013-2023, Loïc Hoguin &lt;[email protected]&gt; 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.</description> + </item> + + <item> + <title>Introduction</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/introduction/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -170,6 +185,17 @@ HTTP/2 HTTP/2 is the most efficient protocol for consuming Web services. It enab <item> <title>The modern Web</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/modern_web/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -234,6 +260,16 @@ The Web is concurrent When you access a website there is little concurrency invo <item> <title>Erlang and the Web</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/erlang_web/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -383,6 +419,18 @@ Adding Gun as an Erlang.mk dependency source-highlight: could not find a languag </item> <item> + <title>Starting and stopping</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/start/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/start/</guid> + <description>This chapter describes how to start and stop the Gun application. +Setting up Specify Gun as a dependency to your application in your favorite build tool. +With Erlang.mk this is done by adding gun to the DEPS variable in your Makefile. +Adding Gun as an Erlang.mk dependency source-highlight: could not find a language definition for make Starting Gun is an OTP application. It needs to be started before you can use it.</description> + </item> + + <item> <title>Supported protocols</title> <link>https://ninenines.eu/docs/en/gun/1.0/guide/protocols/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -443,6 +491,18 @@ Gun will send a gun_inform message for every intermediate informational response </item> <item> + <title>Supported protocols</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/protocols/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/protocols/</guid> + <description>This chapter describes the protocols supported and the operations available to them. +HTTP/1.1 HTTP/1.1 is a text request-response protocol. The client sends a request, the server sends back a response. +Gun provides convenience functions for performing GET, HEAD, OPTIONS, POST, PATCH, PUT, and DELETE requests. All these functions are aliases of gun:headers/4,5 or gun:request/5,6 for the respective methods. Gun also provides a gun:data/4 function for streaming the request body. +Gun will send a gun_inform message for every intermediate informational responses received.</description> + </item> + + <item> <title>Introduction</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/introduction/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -468,6 +528,18 @@ Cowboy is a high quality project. It has a small code base, is very efficient (b <item> <title>Introduction</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/introduction/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>Introduction</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/introduction/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -635,6 +707,17 @@ A Gun connection is an Erlang process that manages a socket to a remote endpoint </item> <item> + <title>Connection</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/connect/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/connect/</guid> + <description>This chapter describes how to open, monitor and close a connection using the Gun client. +Gun connections Gun is designed with the HTTP/2 and Websocket protocols in mind. They are built for long-running connections that allow concurrent exchange of data, either in the form of request/responses for HTTP/2 or in the form of messages for Websocket. +A Gun connection is an Erlang process that manages a socket to a remote endpoint.</description> + </item> + + <item> <title>Protocols</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/protocols/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -706,6 +789,16 @@ This chapter walks you through all the steps of setting up Cowboy, writing your <item> <title>Getting started</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/getting_started/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -805,6 +898,18 @@ Streams can be canceled at any time.</description> </item> <item> + <title>HTTP</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/http/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/http/</guid> + <description>This chapter describes how to use the Gun client for communicating with an HTTP/1.1 or HTTP/2 server. +Streams Every time a request is initiated, Gun creates a stream. A stream reference uniquely identifies a set of request and response and must be used to perform additional operations with a stream or to identify its messages. +Stream references use the Erlang reference data type and are therefore unique. +Streams can be canceled at any time.</description> + </item> + + <item> <title>Embedded mode</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/embedded/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -880,6 +985,18 @@ After Ranch accepts a new connection, whether it is an HTTP/1.</description> <item> <title>Flow diagram</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/flow_diagram/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -982,6 +1099,17 @@ You must use the gun:ws_upgrade/2,3,4 function to upgrade to Websocket.</descrip </item> <item> + <title>Websocket</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/websocket/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/websocket/</guid> + <description>This chapter describes how to use the Gun client for communicating with a Websocket server. +HTTP upgrade Websocket is a protocol built on top of HTTP. To use Websocket, you must first request for the connection to be upgraded. Only HTTP/1.1 connections can be upgraded to Websocket, so you might need to restrict the protocol to HTTP/1.1 if you are planning to use Websocket over TLS. +You must use the gun:ws_upgrade/2,3,4 function to upgrade to Websocket.</description> + </item> + + <item> <title>Writing parsers</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/parsers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1058,6 +1186,16 @@ In order to have a TLS layer inside another TLS layer we need a way to encode th </item> <item> + <title>Internals: TLS over TLS</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/internals_tls_over_tls/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/internals_tls_over_tls/</guid> + <description>The ssl application that comes with Erlang/OTP implements TLS using an interface equivalent to the gen_tcp interface: you get and manipulate a socket. The TLS encoding and decoding is applied transparently to the data sent and received. +In order to have a TLS layer inside another TLS layer we need a way to encode the data of the inner layer before we pass it to the outer layer. We cannot do this with a socket interface.</description> + </item> + + <item> <title>Migrating from Gun 1.0 to 1.1</title> <link>https://ninenines.eu/docs/en/gun/1.1/guide/migrating_from_1.0/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1101,6 +1239,17 @@ Cowboy provides two types of listeners: one listening for clear TCP connections, <item> <title>Listeners</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/listeners/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>Listeners</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/listeners/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1219,6 +1368,18 @@ If no configured host matches the request URI, a 400 response is returned. Othe <item> <title>Routing</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/routing/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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. +Cowboy routes requests using the following algorithm: +If no configured host matches the request URI, a 400 response is returned. Otherwise, the first configured host that matches the request URI will be used. Only the paths configured for this host will be considered. If none of the configured paths found in the previous step match the request URI, a 404 response is returned.</description> + </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> @@ -1347,6 +1508,17 @@ It also fixes parsing of RST_STREAM frames to properly handle frames that have a </item> <item> + <title>Migrating from Gun 2.0 to 2.1</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_2.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_2.0/</guid> + <description>Gun 2.1 contains a small security improvement for the HTTP/2 protocol, as well as includes a small number of fixes and improvements. +Gun 2.1 requires Erlang/OTP 22.0 or greater. +Features added A new HTTP/2 option max_fragmented_header_block_size has been added to limit the size of header blocks that are sent over multiple HEADERS and CONTINUATION frames. Update Cowlib to 2.13.0. Bugs fixed Gun will no longer configure the NPN TLS extension, which has long been replaced by ALPN.</description> + </item> + + <item> <title>Constraints</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/constraints/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1372,6 +1544,18 @@ A field can take the form of an atom field, a tuple with constraints {field, Con <item> <title>Constraints</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/constraints/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>Constraints</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/constraints/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1506,6 +1690,19 @@ init(Req, State) -&gt; {ok, Req, State}. Despite sending no reply, a 204 No <item> <title>Handlers</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/handlers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>Handlers</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/handlers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1567,6 +1764,16 @@ Gun 2.0 adds many more features such as Websocket over HTTP/2, a built-in cookie </item> <item> + <title>Migrating from Gun 1.3 to 2.0</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.3/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.3/</guid> + <description>Gun 2.0 includes state of the art tunnel support. With Gun 2.0 it is possible to make requests or data go through any number of proxy endpoints using any combination of TCP or TLS transports and HTTP/1.1, HTTP/2 or SOCKS5 protocols. All combinations of the scenario Proxy1 -&gt; Proxy2 -&gt; Origin are tested and known to work. +Gun 2.0 adds many more features such as Websocket over HTTP/2, a built-in cookie store, graceful shutdown, flow control for data messages, event handlers and more.</description> + </item> + + <item> <title>Migrating from Ranch 1.7 to Ranch 2.0</title> <link>https://ninenines.eu/docs/en/ranch/2.0/guide/migrating_from_1.7/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1643,6 +1850,16 @@ Loop handlers are used for requests where a response might not be immediately av <item> <title>Loop handlers</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/loop_handlers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -1702,6 +1919,16 @@ Features added The protocols CONNECT destination option has been added as a repl </item> <item> + <title>Migrating from Gun 1.2 to 1.3</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.2/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.2/</guid> + <description>Gun 1.3 improves the support for CONNECT requests introduced in the previous version and documents Websocket protocol negotiation. +Features added The protocols CONNECT destination option has been added as a replacement for the now deprecated protocol option. Add built-in support for Websocket protocol negotiation through the Websocket option protocols. The interface of the handler module currently remains undocumented and must be set to gun_ws_h. Add the h2specd HTTP/2 test suite from the h2spec project.</description> + </item> + + <item> <title>Static files</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/static_files/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1725,6 +1952,17 @@ The static handler can serve either one file or all files from a given directory <item> <title>Static files</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/static_files/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -1832,6 +2070,16 @@ Features added CONNECT requests can now be issued on HTTP/1.1 connections. The t </item> <item> + <title>Migrating from Gun 1.1 to 1.2</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.1/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.1/</guid> + <description>Gun 1.2 adds support for the CONNECT request over HTTP/1.1 connections. +Features added CONNECT requests can now be issued on HTTP/1.1 connections. The tunneled connection can use any of the protocols Gun supports: HTTP/1.1, HTTP/2 and Websocket over both TCP and TLS transports. Note that Gun currently does not support tunneling a TLS connection over a TLS connection due to limitations in Erlang/OTP. Gun supports sending multiple CONNECT requests, allowing the tunnel to the origin server to go through multiple proxies.</description> + </item> + + <item> <title>The Req object</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/req/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1855,6 +2103,17 @@ The Req object is the subject of a few different chapters. In this chapter we wi <item> <title>The Req object</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/req/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -1977,6 +2236,18 @@ You are not required to read it, however. If a body is present and was not read, <item> <title>Reading the request body</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/req_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2034,6 +2305,16 @@ Features added Update Cowlib to 2.5.1 Bugs fixed A bug in the experimental gun </item> <item> + <title>Migrating from Gun 1.0 to 1.1</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.0/</guid> + <description>Gun 1.1 updates the Cowlib dependency to 2.5.1 and fixes a few problems with experimental features. +Features added Update Cowlib to 2.5.1 Bugs fixed A bug in the experimental gun_sse_h where lone id lines were not propagated has been fixed by updating the Cowlib dependency. The status code was incorrectly given to the experimental content handlers as a binary. It has been fixed an an integer is now given as was intended.</description> + </item> + + <item> <title>Sending a response</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/resp/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2059,6 +2340,18 @@ While only one response is allowed for every request, HTTP/2 introduced a mechan <item> <title>Sending a response</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/resp/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2168,6 +2461,16 @@ Cookies are a name/value store where the names and values are stored in plain te <item> <title>Using cookies</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/cookies/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2230,6 +2533,17 @@ In the context of HTTP, multipart is most often used with the multipart/form-dat <item> <title>Multipart requests</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/multipart/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2306,6 +2620,17 @@ We will first attempt to define REST and will look at what it means in the conte <item> <title>REST principles</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/rest_principles/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2374,6 +2699,18 @@ init(Req, State) -&gt; {cowboy_rest, Req, State}.</description> <item> <title>REST handlers</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/rest_handlers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2444,6 +2781,17 @@ All paths start with the &quot;Start&quot; diagram, and all paths exclud <item> <title>REST flowcharts</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/rest_flowcharts/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2508,6 +2856,16 @@ The service Can the service become unavailable, and when it does, can we detect <item> <title>Designing a resource handler</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/resource_design/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2570,6 +2928,17 @@ Websocket connections are fully asynchronous, unlike HTTP/1.1 (synchronous) and <item> <title>The Websocket protocol</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/ws_protocol/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2634,6 +3003,16 @@ As Websocket connections are established through the HTTP/1.1 upgrade mechanism, <item> <title>Websocket handlers</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/ws_handlers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -2696,6 +3075,17 @@ All versions of HTTP allow clients to initiate streams. HTTP/2 is the only one a <item> <title>Streams</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/streams/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>Streams</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/streams/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2762,6 +3152,17 @@ Cowboy will execute all middlewares in the given order, unless one of them decid <item> <title>Middlewares</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/middlewares/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>Middlewares</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/middlewares/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2848,6 +3249,16 @@ One process per connection The first version of Cowboy featured a single process <item> <title>Performance</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/performance/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/guide/performance/</guid> + <description>This chapter describes the performance characteristics of Cowboy and offers suggestions to get the most performance out of your application. +One process per connection The first version of Cowboy featured a single process per connection, whereas the current version of Cowboy features one process per connection plus one process per request. This has a negative impact on performance, but is necessary in order to provide a common interface for both HTTP/1.</description> + </item> + + <item> + <title>Performance</title> <link>https://ninenines.eu/docs/en/cowboy/2.8/guide/performance/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2878,6 +3289,17 @@ Cowboy is now using GitHub Actions for CI. The main reason for the move is to re </item> <item> + <title>Migrating from Cowboy 2.11 to 2.12</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.11/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.11/</guid> + <description>Cowboy 2.12 contains a small security improvement for the HTTP/2 protocol. +Cowboy 2.12 requires Erlang/OTP 24.0 or greater. +Features added A new HTTP/2 option max_fragmented_header_block_size has been added to limit the size of header blocks that are sent over multiple HEADERS and CONTINUATION frames. Update Cowlib to 2.13.0. </description> + </item> + + <item> <title>Migrating from Cowboy 2.7 to 2.8</title> <link>https://ninenines.eu/docs/en/cowboy/2.8/guide/migrating_from_2.7/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2962,6 +3384,17 @@ Cowboy 2.9 also contains a small number of tweaks and bug fixes.</description> </item> <item> + <title>Migrating from Cowboy 2.10 to 2.11</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.10/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.10/</guid> + <description>Cowboy 2.11 contains a variety of new features and bug fixes. Nearly all previously experimental features are now marked as stable, including Websocket over HTTP/2. Included is a fix for an HTTP/2 protocol CVE. +Cowboy 2.11 requires Erlang/OTP 24.0 or greater. +Cowboy is now using GitHub Actions for CI. The main reason for the move is to reduce costs by no longer having to self-host CI runners. The downside is that GitHub runners are less reliable and timing dependent tests are now more likely to fail.</description> + </item> + + <item> <title>Migrating from Cowboy 2.9 to 2.10</title> <link>https://ninenines.eu/docs/en/cowboy/2.11/guide/migrating_from_2.9/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3034,6 +3467,17 @@ Cowboy 2.9 also contains a small number of tweaks and bug fixes.</description> </item> <item> + <title>Migrating from Cowboy 2.9 to 2.10</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.9/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.9/</guid> + <description>Cowboy 2.10 is a maintenance release adding support for Erlang/OTP 26. The main change is a Cowlib update to fix a compilation error that only occurs starting from OTP 26. +Cowboy 2.10 requires Erlang/OTP 22.0 or greater. +Features added Add support for Default value of SameSite cookie attribute. Add support for the stale-* cache-control directives from RFC 5861. Update Cowlib to 2.12.1. Bugs fixed Fix a compilation error in Cowlib when using Erlang/OTP 26.</description> + </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> @@ -3094,6 +3538,17 @@ Cowboy 2.8 also contains a small number of tweaks and bug fixes. Cowboy 2.8 is t </item> <item> + <title>Migrating from Cowboy 2.8 to 2.9</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.8/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.8/</guid> + <description>Cowboy 2.9 implements graceful shutdown of connection processes for both HTTP/1.1 and HTTP/2 connections. +Cowboy 2.9 is the first release to support the much awaited Erlang/OTP 24 out of the box. While users that were using Ranch 2.0 already were ready for OTP 24, the Ranch version used by Cowboy out of the box was not compatible and had to be updated. +Cowboy 2.9 also contains a small number of tweaks and bug fixes.</description> + </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> @@ -3154,6 +3609,16 @@ Features added Add support for the PROXY protocol header. It can be enabled via </item> <item> + <title>Migrating from Cowboy 2.7 to 2.8</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.7/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.7/</guid> + <description>Cowboy 2.8 contains many optimizations for all protocols. HTTP/1.1 has received the largest improvements and Cowboy will now be able to handle noticeably more requests. Thanks to the folks at Stressgrid for helping identify that the performance was lower than it should have been and for benchmarking my many changes and experiments. +Cowboy 2.8 also contains a small number of tweaks and bug fixes. Cowboy 2.8 is the first Cowboy release, ever, to be consistently green on all tested platforms.</description> + </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> @@ -3215,6 +3680,15 @@ Features added Add support for the PROXY protocol header. It can be enabled via </item> <item> + <title>Migrating from Cowboy 2.6 to 2.7</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.6/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.6/</guid> + <description>Cowboy 2.7 improves the HTTP/2 code with optimizations around the sending of DATA and WINDOW_UPDATE frames; graceful shutdown of the connection when the client is going away; and rate limiting mechanisms. New options and mechanisms have also been added to control the amount of memory Cowboy ends up using with both HTTP/1.1 and HTTP/2. Much, but not all, of this work was done to address HTTP/2 CVEs about potential denial of service.</description> + </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> @@ -3275,6 +3749,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.12/guide/migrating_from_2.5/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> @@ -3337,6 +3822,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.12/guide/migrating_from_2.4/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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.6/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3398,6 +3893,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.12/guide/migrating_from_2.3/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>HTTP and other specifications</title> <link>https://ninenines.eu/docs/en/cowboy/2.8/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3439,6 +3944,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.12/guide/migrating_from_2.2/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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.9/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3470,6 +3985,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.12/guide/migrating_from_2.1/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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.10/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3491,6 +4016,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.12/guide/migrating_from_2.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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.11/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3501,6 +4036,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.12/guide/migrating_from_1.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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.12/guide/specs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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 2.11</title> <link>https://ninenines.eu/articles/cowboy-2.11.0/</link> <pubDate>Mon, 29 Jan 2024 07:00:00 +0100</pubDate> @@ -4239,6 +4795,17 @@ Exports cow_cookie:parse_cookie(3) - Parse a cookie header cow_cookie:parse_set <item> <title>cow_cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie/</guid> + <description>Name cow_cookie - Cookies +Description The module cow_cookie provides functions for parsing and manipulating cookie headers. +Exports cow_cookie:parse_cookie(3) - Parse a cookie header cow_cookie:parse_set_cookie(3) - Parse a set-cookie header cow_cookie:cookie(3) - Generate a cookie header cow_cookie:setcookie(3) - Generate a set-cookie header Types cookie_attrs() cookie_attrs() :: #{ expires =&gt; calendar:datetime(), max_age =&gt; calendar:datetime(), domain =&gt; binary(), path =&gt; binary(), secure =&gt; true, http_only =&gt; true, same_site =&gt; default | none | strict | lax } Cookie attributes parsed from the set-cookie header.</description> + </item> + + <item> + <title>cow_cookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4300,6 +4867,19 @@ Changelog 2.9: Function introduced. Examples Generate a cookie header Cookie = <item> <title>cow_cookie:cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.cookie/</guid> + <description>Name cow_cookie:cookie - Generate a cookie header +Description cookie(Cookies) -&gt; iolist() Cookies :: [{Name :: iodata(), Value :: iodata()}] Generate a cookie header. +Arguments Cookies A list of pairs of cookie name and value. + Return value An iolist with the generated cookie header value. +Changelog 2.9: Function introduced. Examples Generate a cookie header Cookie = cow_cookie:cookie([{&lt;&lt;"sessionid"&gt;&gt;, ID}]). See also cow_cookie(3), cow_cookie:parse_cookie(3), cow_cookie:parse_set_cookie(3), cow_cookie:setcookie(3)</description> + </item> + + <item> + <title>cow_cookie:cookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.9/manual/cow_cookie.cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4355,6 +4935,20 @@ Changelog 2.9: Fixes to the parser may lead to potential incompatibilities. A co <item> <title>cow_cookie:parse_cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.parse_cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.parse_cookie/</guid> + <description>Name cow_cookie:parse_cookie - Parse a cookie header +Description parse_cookie(Cookie :: binary()) -&gt; [{binary(), binary()}] Parse a cookie header. +Arguments Cookie The cookie header value. + Return value A list of cookie name/value pairs is returned on success. +An exception is thrown in the event of a parse error. +Changelog 2.9: Fixes to the parser may lead to potential incompatibilities. A cookie name starting with $ is no longer ignored.</description> + </item> + + <item> + <title>cow_cookie:parse_cookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie.parse_cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4422,6 +5016,19 @@ An atom ignore is returned when the cookie has both an empty name and an empty v <item> <title>cow_cookie:parse_set_cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.parse_set_cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.parse_set_cookie/</guid> + <description>Name cow_cookie:parse_set_cookie - Parse a set-cookie header +Description parse_set_cookie(SetCookie :: binary()) -&gt; {ok, Name, Value, Attrs} | ignore Name :: binary() Value :: binary() Attrs :: cow_cookie:cookie_attrs() Parse a set-cookie header. +Arguments SetCookie The set-cookie header value. + Return value An ok tuple with the cookie name, value and attributes is returned on success. +An atom ignore is returned when the cookie has both an empty name and an empty value, and must be ignored.</description> + </item> + + <item> + <title>cow_cookie:parse_set_cookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.9/manual/cow_cookie.parse_set_cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4480,6 +5087,21 @@ Changelog 2.12: The Version attribute is no longer generated. 1.0: Function int <item> <title>cow_cookie:setcookie(3)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.setcookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.setcookie/</guid> + <description>Name cow_cookie:setcookie - Generate a set-cookie header +Description setcookie(Name :: iodata(), Value :: iodata(), Opts :: cow_cookie:cookie_opts()) -&gt; iolist() Generate a set-cookie header. +Arguments Name Cookie name. + Value Cookie value. + Opts Options added to the set-cookie header as attributes. + Return value An iolist with the generated set-cookie header value. +Changelog 2.12: The Version attribute is no longer generated. 1.0: Function introduced. Examples Generate a set-cookie header SetCookie = cow_cookie:setcookie(&lt;&lt;"</description> + </item> + + <item> + <title>cow_cookie:setcookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie.setcookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4536,6 +5158,19 @@ cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_ro <item> <title>Cowboy Function Reference</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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 Function Reference</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4606,6 +5241,15 @@ cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_ro <item> <title>Cowboy User Guide</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/guide/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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 Performance Additional information Migrating from Cowboy 2.</description> + </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> @@ -4664,6 +5308,17 @@ Exports cowboy:start_clear(3) - Listen for connections using plain TCP cowboy:s <item> <title>cowboy(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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:get_env(3) - Retrieve a listener&apos;s environment value 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(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4734,6 +5389,19 @@ cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_ro <item> <title>cowboy(7)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_app/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -4798,6 +5466,19 @@ The name of the listener is the first argument given to the cowboy:start_clear(3 </item> <item> + <title>cowboy:get_env(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.get_env/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.get_env/</guid> + <description>Name cowboy:get_env - Retrieve a listener&apos;s environment value +Description get_env(Name :: ranch:ref(), Key :: atom()) -&gt; any() get_env(Name :: ranch:ref(), Key :: atom(), Default :: any()) -&gt; any() Retrieve an environment value for a previously started listener. +This function may crash when the key is missing from the environment and a default value is not provided. +Arguments Name The name of the listener to access. +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.</description> + </item> + + <item> <title>cowboy:set_env(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/manual/cowboy.set_env/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4825,6 +5506,19 @@ Arguments Name The name of the listener to update.</description> <item> <title>cowboy:set_env(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.set_env/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -4901,6 +5595,18 @@ Arguments Name The listener name is used to refer to this listener in future cal <item> <title>cowboy:start_clear(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.start_clear/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -4973,6 +5679,18 @@ Arguments Name The listener name is used to refer to this listener in future cal <item> <title>cowboy:start_tls(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.start_tls/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -5051,6 +5769,21 @@ The {error, not_found} tuple is returned when the listener does not exist.</desc <item> <title>cowboy:stop_listener(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.stop_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -5133,6 +5866,17 @@ Normal responses will only be compressed when their size is lower than the confi <item> <title>cowboy_compress_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_compress_h/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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 or that have an etag header defined. +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_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> @@ -5203,6 +5947,19 @@ cowboy_constraints:int(3) - Integer constraint cowboy_constraints:nonempty(3) - <item> <title>cowboy_constraints(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_constraints/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -5281,6 +6038,19 @@ int(format_error, Error) -&gt; HumanReadable Error :: {not_an_integer, Bin | <item> <title>cowboy_constraints:int(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_constraints.int/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -5361,6 +6131,20 @@ Arguments Arguments vary depending on the operation. Constraint functions always <item> <title>cowboy_constraints:nonempty(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_constraints.nonempty/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -5428,6 +6212,18 @@ This stream handler always adds a field to the Req object with the name content_ </item> <item> + <title>cowboy_decompress_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_decompress_h/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_decompress_h/</guid> + <description>Name cowboy_decompress_h - Decompress stream handler +Description The module cowboy_decompress_h decompresses request bodies automatically when the server supports it. +The only compression algorithm currently supported is the gzip algorithm. Another limitation is that decompression is only attempted when gzip is the only content-encoding in the request. +This stream handler always adds a field to the Req object with the name content_decoded which is treated as a list of decoded content-encoding values.</description> + </item> + + <item> <title>cowboy_handler(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/manual/cowboy_handler/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5453,6 +6249,18 @@ This module also defines a callback interface for handling HTTP requests.</descr <item> <title>cowboy_handler(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_handler/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -5529,6 +6337,20 @@ It is possible to remove fields from the Req object to save memory when the hand <item> <title>cowboy_handler:terminate(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_handler.terminate/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -5607,6 +6429,17 @@ Options opts() :: #{ active_n =&gt; pos_integer(), chunked =&gt; boolean <item> <title>cowboy_http(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_http/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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() :: #{ active_n =&gt; pos_integer(), chunked =&gt; boolean(), connection_type =&gt; worker | supervisor, http10_keepalive =&gt; boolean(), idle_timeout =&gt; timeout(), inactivity_timeout =&gt; timeout(), initial_stream_flow_size =&gt; non_neg_integer(), linger_timeout =&gt; timeout(), logger =&gt; module(), 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(), reset_idle_timeout_on_send =&gt; boolean(), sendfile =&gt; boolean(), stream_handlers =&gt; [module()] } Configuration for the HTTP/1.</description> + </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> @@ -5673,6 +6506,17 @@ Options opts() :: #{ active_n =&gt; pos_integer(), connection_type =&gt; <item> <title>cowboy_http2(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_http2/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_http2/</guid> + <description>Name cowboy_http2 - HTTP/2 +Description The module cowboy_http2 implements HTTP/2 as a Ranch protocol. +Options opts() :: #{ active_n =&gt; pos_integer(), connection_type =&gt; worker | supervisor, connection_window_margin_size =&gt; 0..16#7fffffff, connection_window_update_threshold =&gt; 0..16#7fffffff, enable_connect_protocol =&gt; boolean(), goaway_initial_timeout =&gt; timeout(), goaway_complete_timeout =&gt; timeout(), idle_timeout =&gt; timeout(), inactivity_timeout =&gt; timeout(), initial_connection_window_size =&gt; 65535..16#7fffffff, initial_stream_window_size =&gt; 0..16#7fffffff, linger_timeout =&gt; timeout(), logger =&gt; module(), max_concurrent_streams =&gt; non_neg_integer() | infinity, max_connection_buffer_size =&gt; non_neg_integer(), max_connection_window_size =&gt; 0..16#7fffffff, max_decode_table_size =&gt; non_neg_integer(), max_encode_table_size =&gt; non_neg_integer(), max_fragmented_header_block_size =&gt; 16384.</description> + </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> @@ -5743,6 +6587,19 @@ Loop until receiving a specific message, then send a response and stop execution <item> <title>cowboy_loop(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_loop/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -5817,6 +6674,17 @@ Types metrics() metrics() :: #{ %% The identifier for this listener. ref := ranc <item> <title>cowboy_metrics_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_metrics_h/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_metrics_h/</guid> + <description>Name cowboy_metrics_h - Metrics stream handler +Description The module cowboy_metrics_h gathers metrics and other information about a stream. It then calls the configured callback with this data. +Types metrics() metrics() :: #{ %% The identifier for this listener. ref := ranch:ref(), %% The pid for this connection. pid := pid(), %% The streamid also indicates the total number of requests on %% this connection (StreamID div 2 + 1). streamid := cowboy_stream:streamid(), %% The terminate reason is always useful.</description> + </item> + + <item> + <title>cowboy_metrics_h(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_metrics_h/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5876,6 +6744,19 @@ execute(Req, Env) -&gt; {ok, Req, Env} | {suspend, module(), atom(), [any()] <item> <title>cowboy_middleware(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_middleware/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -5952,6 +6833,18 @@ Type Name pattern Return type access no verb, parse_*, match_* Value question h <item> <title>cowboy_req(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -6028,6 +6921,20 @@ Arguments Name Desired binding name as an atom. <item> <title>cowboy_req:binding(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.binding/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -6110,6 +7017,19 @@ Changelog 2.0: Only the values are returned, they are no longer wrapped in a tup <item> <title>cowboy_req:bindings(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.bindings/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -6188,6 +7108,19 @@ Arguments Req The Req object. <item> <title>cowboy_req:body_length(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.body_length/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -6270,6 +7203,21 @@ Changelog 2.7: Function introduced. Examples Read the body using auto mode rea <item> <title>cowboy_req:cast(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.cast/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.cast/</guid> + <description>Name cowboy_req:cast - Cast a stream handler event +Description cast(Event :: any(), Req :: cowboy_req:req()) -&gt; ok Cast a stream handler event. +The event will be passed to stream handlers through the info/3 callback. +Arguments Event The event to be sent to stream handlers. + Req The Req object. + Return value The atom ok is always returned. It can be safely ignored. +Changelog 2.7: Function introduced. Examples Read the body using auto mode read_body_auto_async(Req) -&gt; read_body_auto_async(Req, make_ref(), &lt;&lt;&gt;&gt;).</description> + </item> + + <item> + <title>cowboy_req:cast(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_req.cast/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6339,6 +7287,18 @@ Using the default configuration this function will always return undefined. You <item> <title>cowboy_req:cert(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.cert/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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}, {certfile, "path/to/cert.pem"}, {verify, verify_peer} ], #{ env =&gt; #{dispatch =&gt; Dispatch} }).</description> + </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> @@ -6415,6 +7375,20 @@ Arguments Name Header name as a lowercase binary string. <item> <title>cowboy_req:delete_resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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: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> @@ -6495,6 +7469,18 @@ Malformed cookies are unfortunately fairly common due to the string-based interf <item> <title>cowboy_req:filter_cookies(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.filter_cookies/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.filter_cookies/</guid> + <description>Name cowboy_req:filter_cookies - Filter cookie headers +Description filter_cookies(Names, Req) -&gt; Req Names :: [atom() | binary()] Filter cookie headers. +This function is meant to be used before attempting to parse or match cookies in order to remove cookies that are not relevant and are potentially malformed. Because Cowboy by default crashes on malformed cookies, this function allows processing requests that would otherwise result in a 400 error. +Malformed cookies are unfortunately fairly common due to the string-based interface provided by browsers and this function provides a middle ground between Cowboy&apos;s strict behavior and chaotic real world use cases.</description> + </item> + + <item> + <title>cowboy_req:filter_cookies(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_req.filter_cookies/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6557,6 +7543,19 @@ Changelog 1.0: Function introduced. Examples Ensure the request has a body tru <item> <title>cowboy_req:has_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.has_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -6637,6 +7636,20 @@ Changelog 1.0: Function introduced. Examples Check whether a body has been set <item> <title>cowboy_req:has_resp_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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_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> @@ -6717,6 +7730,18 @@ Arguments Name Header name as a lowercase binary string.</description> <item> <title>cowboy_req:has_resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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: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> @@ -6789,6 +7814,18 @@ Headers can also be obtained using pattern matching:</description> <item> <title>cowboy_req:header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -6865,6 +7902,20 @@ Changelog 2.0: Only the headers are returned, they are no longer wrapped in a tu <item> <title>cowboy_req:headers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.headers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -6949,6 +8000,20 @@ Changelog 2.0: Only the host name is returned, it is no longer wrapped in a tupl <item> <title>cowboy_req:host(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.host/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -7033,6 +8098,20 @@ Changelog 2.0: Only the tokens are returned, they are no longer wrapped in a tup <item> <title>cowboy_req:host_info(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.host_info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -7113,6 +8192,18 @@ Any number of informational responses can be sent as long as they are sent befor <item> <title>cowboy_req:inform(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.inform/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -7183,6 +8274,17 @@ Cowboy will only return the cookie values specified in the fields list, and igno <item> <title>cowboy_req:match_cookies(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.match_cookies/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -7249,6 +8351,17 @@ Cowboy will only return the query string values specified in the fields list, an <item> <title>cowboy_req:match_qs(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.match_qs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -7321,6 +8434,20 @@ Changelog 2.0: Only the method is returned, it is no longer wrapped in a tuple.< <item> <title>cowboy_req:method(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.method/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -7403,6 +8530,19 @@ This function will crash on invalid cookie data. Because invalid cookies are fai <item> <title>cowboy_req:parse_cookies(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.parse_cookies/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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 or empty, [] is returned. +This function will crash on invalid cookie data. Because invalid cookies are fairly common when dealing with browsers (because of the string interface that the Javascript API provides), it is recommended to filter the cookie header value before attempting to parse it.</description> + </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> @@ -7481,6 +8621,18 @@ The type of the parsed value varies depending on the header.</description> <item> <title>cowboy_req:parse_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.parse_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -7553,6 +8705,18 @@ Arguments Req The Req object. <item> <title>cowboy_req:parse_qs(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.parse_qs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -7629,6 +8793,20 @@ Changelog 2.0: Only the path is returned, it is no longer wrapped in a tuple.</d <item> <title>cowboy_req:path(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.path/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -7713,6 +8891,20 @@ Changelog 2.0: Only the tokens are returned, they are no longer wrapped in a tup <item> <title>cowboy_req:path_info(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.path_info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -7797,6 +8989,20 @@ The peer is not necessarily the client&apos;s IP address and port. It is the <item> <title>cowboy_req:peer(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.peer/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -7879,6 +9085,19 @@ The port number can also be obtained using pattern matching: <item> <title>cowboy_req:port(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.port/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -7953,6 +9172,17 @@ Cowboy handles push requests the same way as if they came from the client, inclu <item> <title>cowboy_req:push(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.push/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -8025,6 +9255,20 @@ Changelog 2.0: Only the query string is returned, it is no longer wrapped in a t <item> <title>cowboy_req:qs(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.qs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -8103,6 +9347,17 @@ This function reads the request body and parses it as application/x-www-form-url <item> <title>cowboy_req:read_and_match_urlencoded_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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_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> @@ -8169,6 +9424,17 @@ This function reads a chunk of the request body. A more tuple is returned when m <item> <title>cowboy_req:read_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.read_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -8235,6 +9501,17 @@ This function reads the request body and parses it as multipart. Each parts of a <item> <title>cowboy_req:read_part(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.read_part/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -8301,6 +9578,17 @@ This function reads the request body and parses it as multipart. Each parts of a <item> <title>cowboy_req:read_part_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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_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> @@ -8369,6 +9657,18 @@ The urlencoded media type is used by Web browsers when submitting HTML forms usi <item> <title>cowboy_req:read_urlencoded_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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: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> @@ -8439,6 +9739,17 @@ The header names must be given as lowercase binary strings. While header names a <item> <title>cowboy_req:reply(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.reply/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -8507,6 +9818,18 @@ The header name must be given as a lowercase binary string. While header names a <item> <title>cowboy_req:resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.resp_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -8581,6 +9904,19 @@ Changelog 2.0: Function introduced. Examples Get all response headers Headers <item> <title>cowboy_req:resp_headers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.resp_headers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -8663,6 +9999,21 @@ Changelog 2.0: Function introduced.</description> <item> <title>cowboy_req:scheme(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.scheme/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -8747,6 +10098,18 @@ This function can also be used to remove a response body that was set previously <item> <title>cowboy_req:set_resp_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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_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> @@ -8823,6 +10186,20 @@ Arguments Name Cookie name. <item> <title>cowboy_req:set_resp_cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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_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> @@ -8903,6 +10280,18 @@ Cowboy does not allow duplicate header names.</description> <item> <title>cowboy_req:set_resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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_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> @@ -8975,6 +10364,18 @@ Cowboy does not allow duplicate header names. Headers set by this function may b <item> <title>cowboy_req:set_resp_headers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/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.12/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: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> @@ -9051,6 +10452,20 @@ Changelog 2.1: Function introduced. Examples Get the socket&apos;s IP addr <item> <title>cowboy_req:sock(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.sock/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -9131,6 +10546,18 @@ The second argument indicates if this call is the final call. Use the nofin valu <item> <title>cowboy_req:stream_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.stream_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -9201,6 +10628,17 @@ This function should only be used for text/event-stream responses when using ser <item> <title>cowboy_req:stream_events(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.stream_events/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -9269,6 +10707,18 @@ Cowboy does not allow duplicate header names. Headers set by this function may o <item> <title>cowboy_req:stream_reply(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.stream_reply/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -9341,6 +10791,18 @@ You must list all field names sent in trailers in the trailer header, otherwise <item> <title>cowboy_req:stream_trailers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.stream_trailers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -9411,6 +10873,17 @@ By default Cowboy will build a URI using the components found in the request.</d <item> <title>cowboy_req:uri(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.uri/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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: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> @@ -9483,6 +10956,20 @@ Changelog 2.0: Only the version is returned, it is no longer wrapped in a tuple. <item> <title>cowboy_req:version(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.version/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -9565,6 +11052,19 @@ init(Req, State) -&gt; {cowboy_rest, Req, State} Callback(Req, State) -& <item> <title>cowboy_rest(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_rest/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -9639,6 +11139,17 @@ The router takes the dispatch rules as input from the middleware environment. Di <item> <title>cowboy_router(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_router/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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. The environment can contain the rules directly or a tuple {persistent_term, Key}, in which case Cowboy will call persistent_term:get(Key) to retrieve the dispatch rules.</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> @@ -9713,6 +11224,20 @@ Changelog 1.0: Function introduced. Examples Compile routes and start a listen <item> <title>cowboy_router:compile(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_router.compile/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -9793,6 +11318,18 @@ Options opts() :: {priv_file, App, Path} | {priv_file, App, Path, Extra} | {file <item> <title>cowboy_static(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_static/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -9867,6 +11404,19 @@ Extra care must be taken when implementing stream handlers to ensure compatibili <item> <title>cowboy_stream(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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(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> @@ -9930,6 +11480,18 @@ Arguments StreamID The stream ID.</description> </item> <item> + <title>cowboy_stream:data(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.data/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.data/</guid> + <description>Name cowboy_stream:data - Handle data for a stream +Description data(StreamID, IsFin, Data, State) -&gt; {Commands, State} StreamID :: cowboy_stream:stream_id() IsFin :: cowboy_stream:fin() Data :: binary() Commands :: cowboy_stream:commands() State - opaque Handle data for a stream. +This function should be called by all stream handlers. It will propagate data to the next configured stream handler. Handlers do not have to propagate data that has been fully handled. +Arguments StreamID The stream ID.</description> + </item> + + <item> <title>cowboy_stream:early_error(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.11/manual/cowboy_stream.early_error/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9943,6 +11505,19 @@ Arguments StreamID The stream ID. </item> <item> + <title>cowboy_stream:early_error(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.early_error/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.early_error/</guid> + <description>Name cowboy_stream:early_error - Handle an early error for a stream +Description early_error(StreamID, Reason, PartialReq, Resp, Opts) -&gt; Resp StreamID :: cowboy_stream:stream_id() Reason :: cowboy_stream:reason() PartialReq :: cowboy_stream:partial_req() Resp :: cowboy_stream:resp_command() Opts :: cowboy:opts() Handle an early error for a stream. +This function should be called by all stream handlers. It will propagate the early error to the next configured stream handler. +Arguments StreamID The stream ID. + Reason Reason for termination.</description> + </item> + + <item> <title>cowboy_stream:info(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.11/manual/cowboy_stream.info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9955,6 +11530,18 @@ Arguments StreamID The stream ID.</description> </item> <item> + <title>cowboy_stream:info(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.info/</guid> + <description>Name cowboy_stream:info - Handle a message for a stream +Description info(StreamID, Info, State) -&gt; {Commands, State} StreamID :: cowboy_stream:stream_id() Info :: any() Commands :: cowboy_stream:commands() State - opaque Handle a message for a stream. +This function should be called by all stream handlers. It will propagate the event to the next configured stream handler. Handlers do not have to propagate events that have been fully handled. +Arguments StreamID The stream ID.</description> + </item> + + <item> <title>cowboy_stream:init(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.11/manual/cowboy_stream.init/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9970,6 +11557,21 @@ Arguments StreamID The stream ID. </item> <item> + <title>cowboy_stream:init(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.init/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.init/</guid> + <description>Name cowboy_stream:init - Initialize a stream +Description init(StreamID, Req, Opts) -&gt; {Commands, State} StreamID :: cowboy_stream:stream_id() Req :: cowboy_req:req() Opts :: cowboy:opts() Commands :: cowboy_stream:commands() State - opaque Initialize a stream. +This function must be called by all stream handlers. It will initialize the next configured stream handler. +Arguments StreamID The stream ID. + Req The Req object. + Opts The protocol options. + Commands The commands to be executed.</description> + </item> + + <item> <title>cowboy_stream:terminate(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.11/manual/cowboy_stream.terminate/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9985,6 +11587,21 @@ Arguments StreamID The stream ID. </item> <item> + <title>cowboy_stream:terminate(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.terminate/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.terminate/</guid> + <description>Name cowboy_stream:terminate - Terminate a stream +Description terminate(StreamID, Reason, State) -&gt; ok StreamID :: cowboy_stream:stream_id() Reason :: cowboy_stream:reason() State - opaque Terminate a stream. +This function must be called by all stream handlers. It will terminate the next configured stream handler. +Arguments StreamID The stream ID. + Reason Reason for termination. + State The state for the next stream handler. + Return value The atom ok is always returned.</description> + </item> + + <item> <title>cowboy_stream_h(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/manual/cowboy_stream_h/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10010,6 +11627,18 @@ The default value is given next to the option name:</description> <item> <title>cowboy_stream_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream_h/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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_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> @@ -10080,6 +11709,17 @@ Options opts() :: #{ tracer_callback =&gt; Callback, tracer_flags =&gt; <item> <title>cowboy_tracer_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_tracer_h/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_tracer_h/</guid> + <description>Name cowboy_tracer_h - Tracer stream handler +Description The module cowboy_tracer_h can be used to conditionally trace streams based on information found in the request. Trace messages are given to the configured callback. +Options opts() :: #{ tracer_callback =&gt; Callback, tracer_flags =&gt; [atom()], tracer_match_specs =&gt; [MatchSpec] } Callback :: fun((init | terminate | tuple(), State) -&gt; State) MatchSpec :: MatchPredicate | {method, binary()} | {host, binary()} | {path, binary()} | {path_start, binary()} | {header, binary()} | {header, binary(), binary()} | {peer_ip, inet:ip_address()} MatchPredicate :: fun((cowboy_stream:streamid(), cowboy_req:req(), cowboy:opts()) -&gt; boolean()) } Configuration for the tracer stream handler.</description> + </item> + + <item> + <title>cowboy_tracer_h(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_tracer_h/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10137,6 +11777,18 @@ init(Req, State) -&gt; {cowboy_websocket, Req, State} | {cowboy_websocket, R <item> <title>cowboy_websocket(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_websocket/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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()} Info :: any() CallResult :: {commands(), State} | {commands(), State, hibernate} | Deprecated Deprecated :: {ok, State} | {ok, State, hibernate} | {reply, OutFrame | [OutFrame], State} | {reply, OutFrame | [OutFrame], State, hibernate} | {stop, State} OutFrame :: cow_ws:frame() %% see types below 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>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> @@ -10221,6 +11873,18 @@ Modules cow_cookie(3) - Cookies Dependencies crypto - Crypto functions All t <item> <title>Cowlib Function Reference</title> + <link>https://ninenines.eu/docs/en/cowlib/2.13/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.13/manual/</guid> + <description>Name cowlib - Support library for manipulating Web protocols +Description Cowlib provides libraries for parsing and building messages for various Web protocols, including HTTP/1.1, HTTP/2 and Websocket. +It is optimized for completeness rather than speed. No value is ignored, they are all returned. +Modules cow_cookie(3) - Cookies Dependencies crypto - Crypto functions All these applications must be started before the cowlib application. To start Cowlib and all dependencies at once:</description> + </item> + + <item> + <title>Cowlib Function Reference</title> <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10281,6 +11945,18 @@ Modules cow_cookie(3) - Cookies Dependencies crypto - Crypto functions All t <item> <title>cowlib(7)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.13/manual/cowlib_app/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.13/manual/cowlib_app/</guid> + <description>Name cowlib - Support library for manipulating Web protocols +Description Cowlib provides libraries for parsing and building messages for various Web protocols, including HTTP/1.1, HTTP/2 and Websocket. +It is optimized for completeness rather than speed. No value is ignored, they are all returned. +Modules cow_cookie(3) - Cookies Dependencies crypto - Crypto functions All these applications must be started before the cowlib application. To start Cowlib and all dependencies at once:</description> + </item> + + <item> + <title>cowlib(7)</title> <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/cowlib_app/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10364,6 +12040,18 @@ Modules gun(3) - Asynchronous HTTP client gun_cookies(3) - Cookie store engine </item> <item> + <title>Gun Function Reference</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/</guid> + <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP +Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. +Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary. +Modules gun(3) - Asynchronous HTTP client gun_cookies(3) - Cookie store engine gun_cookies_list(3) - Cookie store backend: in-memory, per connection gun_event(3) - Events gun_ws_protocol(3) - Websocket subprotocols Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description> + </item> + + <item> <title>Gun User Guide</title> <link>https://ninenines.eu/docs/en/gun/1.0/guide/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10409,6 +12097,15 @@ Modules gun(3) - Asynchronous HTTP client gun_cookies(3) - Cookie store engine </item> <item> + <title>Gun User Guide</title> + <link>https://ninenines.eu/docs/en/gun/2.1/guide/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/guide/</guid> + <description>Interface Introduction Starting and stopping Supported protocols Connection Using HTTP Using Websocket Advanced Internals: TLS over TLS Additional information Changes since Gun 2.0 Migrating from Gun 1.3 to 2.0 Migrating from Gun 1.2 to 1.3 Migrating from Gun 1.1 to 1.2 Migrating from Gun 1.0 to 1.1 </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> @@ -10469,6 +12166,18 @@ gun:open(3) - Open a connection to the given host and port gun:open_unix(3) - O </item> <item> + <title>gun(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun/</guid> + <description>Name gun - Asynchronous HTTP client +Description The gun module provides an asynchronous interface for connecting and communicating with Web servers over HTTP, HTTP/2 or Websocket. +Exports Connection: +gun:open(3) - Open a connection to the given host and port gun:open_unix(3) - Open a connection to the given Unix domain socket gun:set_owner(3) - Set a new owner for the connection gun:shutdown(3) - Gracefully close the connection gun:close(3) - Brutally close the connection gun:info(3) - Obtain information about the connection Requests:</description> + </item> + + <item> <title>gun(7)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_app/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10529,6 +12238,18 @@ Modules gun(3) - Asynchronous HTTP client gun_cookies(3) - Cookie store engine </item> <item> + <title>gun(7)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_app/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_app/</guid> + <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP +Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. +Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary. +Modules gun(3) - Asynchronous HTTP client gun_cookies(3) - Cookie store engine gun_cookies_list(3) - Cookie store backend: in-memory, per connection gun_event(3) - Events gun_ws_protocol(3) - Websocket subprotocols Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description> + </item> + + <item> <title>gun:await(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.await/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10584,6 +12305,17 @@ This function waits for a message from the given stream and returns it as a tupl </item> <item> + <title>gun:await(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.await/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.await/</guid> + <description>Name gun:await - Wait for a response +Description await(ConnPid, StreamRef) -&gt; await(ConnPid, StreamRef, 5000, MonitorRef) await(ConnPid, StreamRef, MonitorRef) -&gt; await(ConnPid, StreamRef, 5000, MonitorRef) await(ConnPid, StreamRef, Timeout) -&gt; await(ConnPid, StreamRef, Timeout, MonitorRef) await(ConnPid, StreamRef, Timeout, MonitorRef) -&gt; Result ConnPid :: pid() StreamRef :: gun:stream_ref() MonitorRef :: reference() Timeout :: timeout() Result :: tuple() - see below Wait for a response. +This function waits for a message from the given stream and returns it as a tuple.</description> + </item> + + <item> <title>gun:await_body(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.await_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10634,6 +12366,16 @@ Description await_body(ConnPid, StreamRef) -&gt; await_body(ConnPid, StreamR </item> <item> + <title>gun:await_body(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.await_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.await_body/</guid> + <description>Name gun:await_body - Wait for the complete response body +Description await_body(ConnPid, StreamRef) -&gt; await_body(ConnPid, StreamRef, 5000, MonitorRef) await_body(ConnPid, StreamRef, MonitorRef) -&gt; await_body(ConnPid, StreamRef, 5000, MonitorRef) await_body(ConnPid, StreamRef, Timeout) -&gt; await_body(ConnPid, StreamRef, Timeout, MonitorRef) await_body(ConnPid, StreamRef, Timeout, MonitorRef) -&gt; {ok, Body} | {ok, Body, Trailers} | {error, Reason} ConnPid :: pid() StreamRef :: gun:stream_ref() MonitorRef :: reference() Timeout :: timeout() Body :: binary() Trailers :: [{binary(), binary()}] Reason :: {stream_error | connection_error | down, any()} | timeout Wait for the complete response body.</description> + </item> + + <item> <title>gun:await_up(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.await_up/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10689,6 +12431,17 @@ Arguments ConnPid The pid of the Gun connection process.</description> </item> <item> + <title>gun:await_up(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.await_up/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.await_up/</guid> + <description>Name gun:await_up - Wait for the connection to be up +Description await_up(ConnPid) -&gt; await_up(ConnPid, 5000, MonitorRef) await_up(ConnPid, MonitorRef) -&gt; await_up(ConnPid, 5000, MonitorRef) await_up(ConnPid, Timeout) -&gt; await_up(ConnPid, Timeout, MonitorRef) await_up(ConnPid, Timeout, MonitorRef) -&gt; {ok, Protocol} | {error, Reason} ConnPid :: pid() MonitorRef :: reference() Timeout :: timeout() Protocol :: http | http2 | socks Reason :: {down, any()} | timeout Wait for the connection to be up. +Arguments ConnPid The pid of the Gun connection process.</description> + </item> + + <item> <title>gun:cancel(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.cancel/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10749,6 +12502,18 @@ HTTP/1.1 does not support this feature. Gun will simply silence the stream and s </item> <item> + <title>gun:cancel(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.cancel/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.cancel/</guid> + <description>Name gun:cancel - Cancel the given stream +Description cancel(ConnPid, StreamRef) -&gt; ok ConnPid :: pid() StreamRef :: gun:stream_ref() Cancel the given stream. +The behavior of this function depends on the protocol selected. +HTTP/1.1 does not support this feature. Gun will simply silence the stream and stop relaying messages. Gun may also decide to close the connection if the response body is too large, to avoid wasting time and bandwidth.</description> + </item> + + <item> <title>gun:close(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.close/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10814,6 +12579,19 @@ Changelog 1.0: Function introduced. Examples Close the connection ok = gun:clo </item> <item> + <title>gun:close(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.close/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.close/</guid> + <description>Name gun:close - Brutally close the connection +Description close(ConnPid) -&gt; ok ConnPid :: pid() Brutally close the connection. +Arguments ConnPid The pid of the Gun connection process. + Return value The atom ok is returned. +Changelog 1.0: Function introduced. Examples Close the connection ok = gun:close(ConnPid). See also gun(3), gun:open(3), gun:open_unix(3), gun:shutdown(3)</description> + </item> + + <item> <title>gun:connect(3)</title> <link>https://ninenines.eu/docs/en/gun/1.2/manual/gun.connect/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10847,6 +12625,17 @@ This feature is currently only available for HTTP/1.1 connections. Upon successf </item> <item> + <title>gun:connect(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.connect/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.connect/</guid> + <description>Name gun:connect - Establish a tunnel to the origin server +Description connect(ConnPid, Destination) -&gt; connect(ConnPid, Destination, [], #{}). connect(ConnPid, Destination, Headers) -&gt; connect(ConnPid, Destination, Headers, #{}). connect(ConnPid, Destination, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Destination :: gun:connect_destination() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Establish a tunnel to the origin server. +This feature is currently only available for HTTP/1.1 connections. Upon successful completion of the CONNECT request a tunnel is established and subsequent requests will go through the tunnel.</description> + </item> + + <item> <title>gun:data(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.data/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10907,6 +12696,18 @@ All calls to this function must use the nofin flag except for the last which mus </item> <item> + <title>gun:data(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.data/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.data/</guid> + <description>Name gun:data - Stream the body of a request +Description data(ConnPid, StreamRef, IsFin, Data) -&gt; ok ConnPid :: pid() StreamRef :: gun:stream_ref() IsFin :: fin | nofin Data :: iodata() Stream the body of a request. +This function can only be used if the original request had headers indicating that a body would be streamed. +All calls to this function must use the nofin flag except for the last which must use fin to indicate the end of the request body.</description> + </item> + + <item> <title>gun:delete(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.delete/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10977,6 +12778,20 @@ Arguments ConnPid The pid of the Gun connection process. </item> <item> + <title>gun:delete(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.delete/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.delete/</guid> + <description>Name gun:delete - Delete a resource +Description delete(ConnPid, Path) -&gt; delete(ConnPid, Path, [], #{}). delete(ConnPid, Path, Headers) -&gt; delete(ConnPid, Path, Headers, #{}) delete(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Delete a resource. +Arguments ConnPid The pid of the Gun connection process. + Path Path to the resource. + Headers Additional request headers. + ReqOpts Request options.</description> + </item> + + <item> <title>gun:flush(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.flush/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11047,6 +12862,20 @@ ConnPid The pid of the Gun connection process. </item> <item> + <title>gun:flush(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.flush/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.flush/</guid> + <description>Name gun:flush - Flush all messages related to a connection or a stream +Description flush(ConnPid) -&gt; ok flush(StreamRef) -&gt; ok ConnPid :: pid() StreamRef :: gun:stream_ref() Flush all messages related to a connection or a stream. +Arguments Either of these arguments may be provided: +ConnPid The pid of the Gun connection process. + StreamRef Identifier of the stream for the original request. + Return value The atom ok is returned.</description> + </item> + + <item> <title>gun:get(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.get/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11113,6 +12942,20 @@ Arguments ConnPid The pid of the Gun connection process. </item> <item> + <title>gun:get(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.get/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.get/</guid> + <description>Name gun:get - Get a resource representation +Description get(ConnPid, Path) -&gt; get(ConnPid, Path, [], #{}). get(ConnPid, Path, Headers) -&gt; get(ConnPid, Path, Headers, #{}) get(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Get a resource representation. +Arguments ConnPid The pid of the Gun connection process. + Path Path to the resource. + Headers Additional request headers. + ReqOpts Request options.</description> + </item> + + <item> <title>gun:head(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.head/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11168,6 +13011,17 @@ This function performs the same operation as gun:get(3), except the server will </item> <item> + <title>gun:head(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.head/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.head/</guid> + <description>Name gun:head - Get headers of a resource representation +Description head(ConnPid, Path) -&gt; head(ConnPid, Path, [], #{}). head(ConnPid, Path, Headers) -&gt; head(ConnPid, Path, Headers, #{}) head(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Get headers of a resource representation. +This function performs the same operation as gun:get(3), except the server will not send the resource representation, only the response&apos;s status code and headers.</description> + </item> + + <item> <title>gun:headers(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.headers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11180,6 +13034,18 @@ The function headers/4,5 initiates a request but does not send the request body. </item> <item> + <title>gun:headers(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.headers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.headers/</guid> + <description>Name gun:headers - Initiate the given request +Description headers(ConnPid, Method, Path, Headers) -&gt; headers(ConnPid, Method, Path, Headers, #{}) headers(ConnPid, Method, Path, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Method :: binary() Path :: iodata() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Initiate the given request. +This is a general purpose function that should only be used when other method-specific functions do not apply. +The function headers/4,5 initiates a request but does not send the request body.</description> + </item> + + <item> <title>gun:info(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11239,6 +13105,16 @@ Description info(ConnPid) -&gt; Info ConnPid :: pid() Info :: #{ owner =& </item> <item> + <title>gun:info(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.info/</guid> + <description>Name gun:info - Obtain information about the connection +Description info(ConnPid) -&gt; Info ConnPid :: pid() Info :: #{ owner =&gt; pid(), socket =&gt; inet:socket() | ssl:sslsocket(), transport =&gt; tcp | tls, protocol =&gt; http | http2 | socks | ws, sock_ip =&gt; inet:ip_address(), sock_port =&gt; inet:port_number(), origin_scheme =&gt; binary() | undefined, origin_host =&gt; inet:hostname() | inet:ip_address(), origin_port =&gt; inet:port_number(), intermediaries =&gt; [Intermediary], cookie_store =&gt; gun_cookies:cookie_store() } Intermediary :: #{ type =&gt; connect | socks5, host =&gt; inet:hostname() | inet:ip_address(), port =&gt; inet:port_number(), transport =&gt; tcp | tls, protocol =&gt; http | http2 | socks | raw } Obtain information about the connection.</description> + </item> + + <item> <title>gun:open(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.open/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11302,6 +13178,17 @@ Arguments Host Host or IP address to connect to.</description> </item> <item> + <title>gun:open(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.open/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.open/</guid> + <description>Name gun:open - Open a connection to the given host and port +Description open(Host, Port) -&gt; open(Host, Port, #{}) open(Host, Port, Opts) -&gt; {ok, pid()} | {error, Reason} Host :: inet:hostname() | inet:ip_address() Port :: inet:port_number() Opts :: gun:opts() Reason :: {options, OptName} | {options, {http | http2 | socks | ws, OptName}} | any() OptName :: atom() Open a connection to the given host and port. +Arguments Host Host or IP address to connect to.</description> + </item> + + <item> <title>gun:open_unix(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.open_unix/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11366,6 +13253,18 @@ Arguments SocketPath Path to the Unix domain socket to connect to. </item> <item> + <title>gun:open_unix(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.open_unix/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.open_unix/</guid> + <description>Name gun:open_unix - Open a connection to the given Unix domain socket +Description open_unix(SocketPath, Opts) -&gt; {ok, pid()} | {error, Reason} SocketPath :: string() Opts :: gun:opts() Reason :: {options, OptName} | {options, {http | http2 | socks | ws, OptName}} | any() OptName :: atom() Open a connection to the given Unix domain socket. +Arguments SocketPath Path to the Unix domain socket to connect to. + Opts Options for this connection.</description> + </item> + + <item> <title>gun:options(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.options/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11421,6 +13320,17 @@ The special path &quot;*&quot; can be used to obtain information about t </item> <item> + <title>gun:options(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.options/</guid> + <description>Name gun:options - Query the capabilities of the server or a resource +Description options(ConnPid, Path) -&gt; options(ConnPid, Path, [], #{}). options(ConnPid, Path, Headers) -&gt; options(ConnPid, Path, Headers, #{}) options(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Query the capabilities of the server or a resource. +The special path &quot;*&quot; can be used to obtain information about the server as a whole.</description> + </item> + + <item> <title>gun:patch(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.patch/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11475,6 +13385,16 @@ Description patch(ConnPid, Path, Headers) -&gt; patch(ConnPid, Path, Headers </item> <item> + <title>gun:patch(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.patch/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.patch/</guid> + <description>Name gun:patch - Apply a set of changes to a resource +Description patch(ConnPid, Path, Headers) -&gt; patch(ConnPid, Path, Headers, #{}) patch(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef patch(ConnPid, Path, Headers, Body) -&gt; patch(ConnPid, Path, Headers, Body, #{}) patch(ConnPid, Path, Headers, Body, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() Body :: iodata() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Apply a set of changes to a resource.</description> + </item> + + <item> <title>gun:post(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.post/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11529,6 +13449,16 @@ Description post(ConnPid, Path, Headers) -&gt; post(ConnPid, Path, Headers, </item> <item> + <title>gun:post(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.post/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.post/</guid> + <description>Name gun:post - Process the enclosed representation according to a resource&apos;s own semantics +Description post(ConnPid, Path, Headers) -&gt; post(ConnPid, Path, Headers, #{}) post(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef post(ConnPid, Path, Headers, Body) -&gt; post(ConnPid, Path, Headers, Body, #{}) post(ConnPid, Path, Headers, Body, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() Body :: iodata() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Process the enclosed representation according to a resource&apos;s own semantics.</description> + </item> + + <item> <title>gun:put(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.put/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11588,6 +13518,17 @@ The behavior of this function varies depending on whether a body is provided.</d </item> <item> + <title>gun:put(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.put/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.put/</guid> + <description>Name gun:put - Create or replace a resource +Description put(ConnPid, Path, Headers) -&gt; put(ConnPid, Path, Headers, #{}) put(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef put(ConnPid, Path, Headers, Body) -&gt; put(ConnPid, Path, Headers, Body, #{}) put(ConnPid, Path, Headers, Body, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() Body :: iodata() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Create or replace a resource. +The behavior of this function varies depending on whether a body is provided.</description> + </item> + + <item> <title>gun:request(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.request/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11643,6 +13584,17 @@ This is a general purpose function that should only be used when other method-sp </item> <item> + <title>gun:request(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.request/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.request/</guid> + <description>Name gun:request - Perform the given request +Description request(ConnPid, Method, Path, Headers, Body) -&gt; request(ConnPid, Method, Path, Headers, Body, #{}) request(ConnPid, Method, Path, Headers, Body, ReqOpts) -&gt; StreamRef ConnPid :: pid() Method :: binary() Path :: iodata() Headers :: gun:req_headers() Body :: iodata() ReqOpts :: gun:req_opts() StreamRef :: gun:stream_ref() Perform the given request. +This is a general purpose function that should only be used when other method-specific functions do not apply.</description> + </item> + + <item> <title>gun:set_owner(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.set_owner/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11657,6 +13609,20 @@ Arguments ConnPid The pid of the Gun connection process. </item> <item> + <title>gun:set_owner(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.set_owner/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.set_owner/</guid> + <description>Name gun:set_owner - Set a new owner for the connection +Description set_owner(ConnPid, OwnerPid) -&gt; ok ConnPid :: pid() OwnerPid :: pid() Set a new owner for the connection. +Only the current owner of the connection can set a new owner. +Gun monitors the owner of the connection and automatically shuts down gracefully when the owner exits. +Arguments ConnPid The pid of the Gun connection process. + OwnerPid The pid of the new owner for the connection.</description> + </item> + + <item> <title>gun:shutdown(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.shutdown/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11669,6 +13635,18 @@ For HTTP/1.1 there is no such mechanism and Gun will close the connection once t </item> <item> + <title>gun:shutdown(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.shutdown/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.shutdown/</guid> + <description>Name gun:shutdown - Gracefully close the connection +Description shutdown(ConnPid) -&gt; ok ConnPid :: pid() Gracefully close the connection. +Gun will wait for up to closing_timeout milliseconds before brutally closing the connection. The graceful shutdown mechanism varies between the different protocols: +For HTTP/1.1 there is no such mechanism and Gun will close the connection once the current response is received. Any pipelined requests are immediately terminated. For HTTP/2 Gun will send a GOAWAY frame and wait for the existing streams to terminate.</description> + </item> + + <item> <title>gun:stream_info(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.stream_info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11679,6 +13657,16 @@ Description stream_info(ConnPid, StreamRef) -&gt; {ok, undefined | Info} | { </item> <item> + <title>gun:stream_info(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.stream_info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.stream_info/</guid> + <description>Name gun:stream_info - Obtain information about a stream +Description stream_info(ConnPid, StreamRef) -&gt; {ok, undefined | Info} | {error, not_connected} ConnPid :: pid() StreamRef :: gun:stream_ref() Info :: #{ ref =&gt; gun:stream_ref(), reply_to =&gt; pid(), state =&gt; running | stopping, intermediaries =&gt; [Intermediary], tunnel =&gt; Tunnel } Intermediary :: #{ type =&gt; connect | socks5, host =&gt; inet:hostname() | inet:ip_address(), port =&gt; inet:port_number(), transport =&gt; tcp | tls, protocol =&gt; http | http2 | socks | raw } Tunnel :: #{ transport =&gt; tcp | tls, protocol =&gt; http | http2 | socks | raw, origin_scheme =&gt; binary() | undefined, origin_host =&gt; inet:hostname() | inet:ip_address(), origin_port =&gt; inet:port_number() } Obtain information about a stream.</description> + </item> + + <item> <title>gun:update_flow(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.update_flow/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11693,6 +13681,20 @@ Arguments ConnPid The pid of the Gun connection process. </item> <item> + <title>gun:update_flow(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.update_flow/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.update_flow/</guid> + <description>Name gun:update_flow - Update a stream&apos;s flow control value +Description update_flow(ConnPid, StreamRef, Flow) -&gt; ok ConnPid :: pid() StreamRef :: gun:stream_ref() Flow :: pos_integer() Update a stream&apos;s flow control value. +The flow value can only ever be incremented. +This function does nothing for streams that have flow control disabled (which is the default). +Arguments ConnPid The pid of the Gun connection process. + StreamRef Identifier of the stream for the original request.</description> + </item> + + <item> <title>gun:ws_send(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.ws_send/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11757,6 +13759,18 @@ Arguments ConnPid The pid of the Gun connection process.</description> </item> <item> + <title>gun:ws_send(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.ws_send/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.ws_send/</guid> + <description>Name gun:ws_send - Send Websocket frames +Description ws_send(ConnPid, StreamRef, Frames) -&gt; ok ConnPid :: pid() StreamRef :: gun:stream_ref() Frames :: Frame | [Frame] Frame :: close | ping | pong | {text | binary | close | ping | pong, iodata()} | {close, non_neg_integer(), iodata()} Send Websocket frames. +The connection must first be upgraded to Websocket using the function gun:ws_upgrade(3). +Arguments ConnPid The pid of the Gun connection process.</description> + </item> + + <item> <title>gun:ws_upgrade(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.ws_upgrade/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11817,6 +13831,18 @@ HTTP/1.1 cannot handle Websocket and HTTP requests concurrently. The upgrade, if </item> <item> + <title>gun:ws_upgrade(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun.ws_upgrade/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun.ws_upgrade/</guid> + <description>Name gun:ws_upgrade - Upgrade to Websocket +Description ws_upgrade(ConnPid, Path) -&gt; ws_upgrade(ConnPid, Path, []) ws_upgrade(ConnPid, Path, Headers) -&gt; StreamRef ws_upgrade(ConnPid, Path, Headers, WsOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() WsOpts :: gun:ws_opts() StreamRef :: gun:stream_ref() Upgrade to Websocket. +The behavior of this function depends on the protocol selected. +HTTP/1.1 cannot handle Websocket and HTTP requests concurrently. The upgrade, if successful, will result in the complete takeover of the connection.</description> + </item> + + <item> <title>gun_cookies(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_cookies/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11829,6 +13855,18 @@ init init(Opts :: any()) -&gt; gun_cookies:store() Initialize the cookie st </item> <item> + <title>gun_cookies(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies/</guid> + <description>Name gun_cookies - Cookie store engine +Description The gun_cookies module implements a cookie store engine. It will be used by Gun when a cookie store is configured. It also defines the interface and provides functions used to implement cookie store backends. +Callbacks Cookie store backends implement the following interface. Functions are organized by theme: initialization, querying, storing and garbage collecting: +init init(Opts :: any()) -&gt; gun_cookies:store() Initialize the cookie store.</description> + </item> + + <item> <title>gun_cookies:domain_match(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_cookies.domain_match/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11844,6 +13882,21 @@ Changelog 2.0: Function introduced. Examples Perform a domain match Match = gu </item> <item> + <title>gun_cookies:domain_match(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies.domain_match/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies.domain_match/</guid> + <description>Name gun_cookies:domain_match - Cookie domain match +Description domain_match(String, DomainString) -&gt; boolean() String :: binary() DomainString :: binary() Cookie domain match. +This function can be used when implementing the set_cookie_secure_match callback of a cookie store. +Arguments String The string to match. + DomainString The domain string that will be matched against. + Return value Returns true when String domain-matches DomainString, and false otherwise. +Changelog 2.0: Function introduced. Examples Perform a domain match Match = gun_cookies:domain_match(Domain, CookieDomain).</description> + </item> + + <item> <title>gun_cookies:path_match(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_cookies.path_match/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11859,6 +13912,21 @@ Changelog 2.0: Function introduced. Examples Perform a path match Match = gun_ </item> <item> + <title>gun_cookies:path_match(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies.path_match/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies.path_match/</guid> + <description>Name gun_cookies:path_match - Cookie path match +Description path_match(ReqPath, CookiePath) -&gt; boolean() ReqPath :: binary() CookiePath :: binary() Cookie path match. +This function can be used when implementing the set_cookie_secure_match callback of a cookie store. +Arguments ReqPath The request path to match. + CookiePath The cookie path that will be matched against. + Return value Returns true when ReqPath path-matches CookiePath, and false otherwise. +Changelog 2.0: Function introduced. Examples Perform a path match Match = gun_cookies:path_match(ReqPath, CookiePath).</description> + </item> + + <item> <title>gun_cookies_list(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_cookies_list/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11872,6 +13940,19 @@ Types opts() opts() :: #{ } Cookie store backend options.</description> </item> <item> + <title>gun_cookies_list(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies_list/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies_list/</guid> + <description>Name gun_cookies_list - Cookie store backend: in-memory, per connection +Description The gun_cookies_list module implements a cookie store backend that keeps all the cookie data in-memory and tied to a specific connection. +It is possible to implement a custom backend on top of gun_cookies_list in order to add persistence or sharing properties. +Exports This module implements the callbacks defined in gun_cookies(3). +Types opts() opts() :: #{ } Cookie store backend options.</description> + </item> + + <item> <title>gun_data(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_data/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11937,6 +14018,19 @@ The response body may be terminated either by a data message with the flag fin s </item> <item> + <title>gun_data(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_data/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_data/</guid> + <description>Name gun_data - Response body +Description {gun_data, ConnPid, StreamRef, IsFin, Data} ConnPid :: pid() StreamRef :: gun:stream_ref() IsFin :: fin | nofin Data :: binary() Response body. +This message informs the relevant process that the server sent a all or part of the body for the response to the original request. +A data message is always preceded by a response message. +The response body may be terminated either by a data message with the flag fin set or by a gun_trailers(3) message.</description> + </item> + + <item> <title>gun_down(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_down/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11997,6 +14091,18 @@ When the connection goes back up, Gun will not attempt to retry requests.</descr </item> <item> + <title>gun_down(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_down/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_down/</guid> + <description>Name gun_down - The connection is down +Description {gun_down, ConnPid, Protocol, Reason, KilledStreams} ConnPid :: pid() Protocol :: http | http2 | socks | ws Reason :: any() KilledStreams :: [gun:stream_ref()] The connection is down. +This message informs the owner process that the connection was lost. Depending on the retry and retry_timeout options Gun may automatically attempt to reconnect. +When the connection goes back up, Gun will not attempt to retry requests.</description> + </item> + + <item> <title>gun_error(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_error/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12052,6 +14158,17 @@ These messages inform the relevant process that an error occurred. A reference i </item> <item> + <title>gun_error(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_error/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_error/</guid> + <description>Name gun_error - Stream or connection-wide error +Description {gun_error, ConnPid, StreamRef, Reason} {gun_error, ConnPid, Reason} ConnPid :: pid() StreamRef :: gun:stream_ref() Reason :: any() Stream or connection-wide error. +These messages inform the relevant process that an error occurred. A reference is given when the error pertains to a specific stream. Connection-wide errors do not imply that the connection is no longer usable, they are used for all errors that are not specific to a stream.</description> + </item> + + <item> <title>gun_event(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_event/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12065,6 +14182,19 @@ init init_event() :: #{ owner := pid(), transport := tcp | tls, origin_scheme := </item> <item> + <title>gun_event(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_event/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_event/</guid> + <description>Name gun_event - Events +Description The gun_event module provides the callback interface and types for implementing event handlers. +Callbacks Event handlers implement the following interface. Because types are tied to specific events, they are documented alongside them. All event types are exported and can be referred to as gun_event:Type(). +The events are ordered by the order they are likely to be triggered, with the most frequent events listed first. +init init_event() :: #{ owner := pid(), transport := tcp | tls, origin_scheme := binary(), origin_host := inet:hostname() | inet:ip_address(), origin_port := inet:port_number(), opts := gun:opts() } init(init_event(), State) -&gt; State Gun is initializing.</description> + </item> + + <item> <title>gun_inform(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_inform/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12125,6 +14255,18 @@ Informational responses are only intermediate responses and provide no guarantee </item> <item> + <title>gun_inform(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_inform/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_inform/</guid> + <description>Name gun_inform - Informational response +Description {gun_inform, ConnPid, StreamRef, Status, Headers} ConnPid :: pid() StreamRef :: gun:stream_ref() Status :: 100..199 Headers :: [{binary(), binary()}] Informational response. +This message informs the relevant process that the server sent an informational response to the original request. +Informational responses are only intermediate responses and provide no guarantees as to what the final response will be. An informational response always precedes the response to the original request.</description> + </item> + + <item> <title>gun_push(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_push/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12185,6 +14327,18 @@ A server-initiated push message always precedes the response to the original req </item> <item> + <title>gun_push(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_push/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_push/</guid> + <description>Name gun_push - Server-initiated push +Description {gun_push, ConnPid, StreamRef, NewStreamRef, Method, URI, Headers} ConnPid :: pid() StreamRef :: gun:stream_ref() NewStreamRef :: gun:stream_ref() Method :: binary() URI :: binary() Headers :: [{binary(), binary()}] Server-initiated push. +This message informs the relevant process that the server is pushing a resource related to the effective target URI of the original request. +A server-initiated push message always precedes the response to the original request.</description> + </item> + + <item> <title>gun_response(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_response/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12255,6 +14409,20 @@ Elements ConnPid The pid of the Gun connection process. </item> <item> + <title>gun_response(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_response/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_response/</guid> + <description>Name gun_response - Response +Description {gun_response, ConnPid, StreamRef, IsFin, Status, Headers} ConnPid :: pid() StreamRef :: gun:stream_ref() IsFin :: fin | nofin Status :: non_neg_integer() Headers :: [{binary(), binary()}] Response. +This message informs the relevant process that the server sent a response to the original request. +Elements ConnPid The pid of the Gun connection process. + StreamRef Identifier of the stream for the original request. + IsFin Whether this message terminates the response.</description> + </item> + + <item> <title>gun_trailers(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_trailers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12330,6 +14498,21 @@ Elements ConnPid The pid of the Gun connection process. </item> <item> + <title>gun_trailers(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_trailers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_trailers/</guid> + <description>Name gun_trailers - Response trailers +Description {gun_trailers, ConnPid, StreamRef, Headers} ConnPid :: pid() StreamRef :: gun:stream_ref() Headers :: [{binary(), binary()}] Response trailers. +This message informs the relevant process that the server sent response trailers for the response to the original request. +A trailers message terminates the response. +Elements ConnPid The pid of the Gun connection process. + StreamRef Identifier of the stream for the original request. + Headers Trailing headers sent after the response body.</description> + </item> + + <item> <title>gun_tunnel_up(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_tunnel_up/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12342,6 +14525,18 @@ If Gun is configured to connect to another SOCKS server, then the connection is </item> <item> + <title>gun_tunnel_up(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_tunnel_up/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_tunnel_up/</guid> + <description>Name gun_tunnel_up - The tunnel is up +Description {gun_tunnel_up, ConnPid, StreamRef, Protocol} ConnPid :: pid() StreamRef :: gun:stream_ref() | undefined Protocol :: http | http2 | socks The tunnel is up. +This message informs the owner/calling process that the connection completed through the SOCKS or CONNECT proxy. +If Gun is configured to connect to another SOCKS server, then the connection is not usable yet. One or more gun_tunnel_up(3) messages will follow.</description> + </item> + + <item> <title>gun_up(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_up/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12403,6 +14598,19 @@ Otherwise, Gun will start processing the messages it received while waiting for </item> <item> + <title>gun_up(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_up/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_up/</guid> + <description>Name gun_up - The connection is up +Description {gun_up, ConnPid, Protocol} ConnPid :: pid() Protocol :: http | http2 | raw | socks The connection is up. +This message informs the owner process that the connection or reconnection completed. +If Gun is configured to connect to a Socks server, then the connection is not usable yet. One or more gun_tunnel_up(3) messages will follow. +Otherwise, Gun will start processing the messages it received while waiting for the connection to be up.</description> + </item> + + <item> <title>gun_upgrade(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_upgrade/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12463,6 +14671,18 @@ The exact semantics of this message depend on the original protocol. HTTP/1.1 up </item> <item> + <title>gun_upgrade(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_upgrade/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_upgrade/</guid> + <description>Name gun_upgrade - Successful protocol upgrade +Description {gun_upgrade, ConnPid, StreamRef, Protocols, Headers} ConnPid :: pid() StreamRef :: gun:stream_ref() Protocols :: [&lt;&lt;"websocket"&gt;&gt;] Headers :: [{binary(), binary()}] Successful protocol upgrade. +This message informs the relevant process that the server accepted to upgrade to one or more protocols given in the original request. +The exact semantics of this message depend on the original protocol. HTTP/1.1 upgrades apply to the entire connection. HTTP/2 uses a different mechanism which allows switching specific streams to a different protocol.</description> + </item> + + <item> <title>gun_ws(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_ws/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12527,6 +14747,18 @@ This message can only be sent on streams that were upgraded to the Websocket pro </item> <item> + <title>gun_ws(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_ws/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_ws/</guid> + <description>Name gun_ws - Websocket frame +Description {gun_ws, ConnPid, StreamRef, Frame} ConnPid :: pid() StreamRef :: gun:stream_ref() Frame :: close | ping | pong | {text | binary | close, binary()} | {close, non_neg_integer(), binary()} | {ping | pong, binary()} Websocket frame. +This message informs the relevant process that the server sent the enclosed frame. +This message can only be sent on streams that were upgraded to the Websocket protocol.</description> + </item> + + <item> <title>gun_ws_protocol(3)</title> <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_ws_protocol/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12540,6 +14772,19 @@ ReplyTo The pid of the process that owns the stream and to which messages will b </item> <item> + <title>gun_ws_protocol(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.1/manual/gun_ws_protocol/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.1/manual/gun_ws_protocol/</guid> + <description>Name gun_ws_protocol - Websocket subprotocols +Description The gun_ws_protocol module provides the callback interface and types for implementing Websocket subprotocols. +Callbacks Websocket subprotocols implement the following interface. +init init(ReplyTo, StreamRef, Headers, Opts) -&gt; {ok, State} ReplyTo :: pid() StreamRef :: reference() Headers :: cow_http:headers() Opts :: gun:ws_opts() State :: protocol_state() Initialize the Websocket protocol. +ReplyTo The pid of the process that owns the stream and to which messages will be sent to.</description> + </item> + + <item> <title>HTTP status codes(7)</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/manual/http_status_codes/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12563,6 +14808,17 @@ Description This chapter aims to list all HTTP status codes that Cowboy may retu <item> <title>HTTP status codes(7)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.12/manual/http_status_codes/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.12/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>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> diff --git a/services/index.html b/services/index.html index 92648cb4..49576e72 100644 --- a/services/index.html +++ b/services/index.html @@ -839,6 +839,108 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <h3 id="_like_my_work__donate">Like my work? Donate!</h3> <p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> <form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> @@ -2574,6 +2676,280 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + </div> </div> </div> diff --git a/sitemap.xml b/sitemap.xml index e297afba..9b186169 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -23,6 +23,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/guide/introduction/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/guide/introduction/</loc> </url> @@ -51,6 +55,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/modern_web/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/modern_web/</loc> </url> @@ -75,6 +83,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/erlang_web/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/erlang_web/</loc> </url> @@ -131,6 +143,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/guide/start/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/guide/protocols/</loc> </url> @@ -151,6 +167,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/guide/protocols/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/guide/introduction/</loc> </url> @@ -159,6 +179,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/introduction/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/introduction/</loc> </url> @@ -215,6 +239,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/guide/connect/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/guide/protocols/</loc> </url> @@ -243,6 +271,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/getting_started/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/getting_started/</loc> </url> @@ -279,6 +311,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/guide/http/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/guide/embedded/</loc> </url> @@ -307,6 +343,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/flow_diagram/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/flow_diagram/</loc> </url> @@ -343,6 +383,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/guide/websocket/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/guide/parsers/</loc> </url> @@ -371,6 +415,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/guide/internals_tls_over_tls/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.1/guide/migrating_from_1.0/</loc> </url> @@ -387,6 +435,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/listeners/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/listeners/</loc> </url> @@ -431,6 +483,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/routing/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/routing/</loc> </url> @@ -479,6 +535,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_2.0/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/guide/constraints/</loc> </url> @@ -487,6 +547,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/constraints/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/constraints/</loc> </url> @@ -535,6 +599,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/handlers/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/handlers/</loc> </url> @@ -555,6 +623,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.3/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/2.0/guide/migrating_from_1.7/</loc> </url> @@ -583,6 +655,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/loop_handlers/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/loop_handlers/</loc> </url> @@ -607,6 +683,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.2/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/guide/static_files/</loc> </url> @@ -615,6 +695,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/static_files/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/static_files/</loc> </url> @@ -655,6 +739,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.1/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/guide/req/</loc> </url> @@ -663,6 +751,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/req/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/req/</loc> </url> @@ -707,6 +799,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/req_body/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/req_body/</loc> </url> @@ -727,6 +823,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/guide/migrating_from_1.0/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/guide/resp/</loc> </url> @@ -735,6 +835,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/resp/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/resp/</loc> </url> @@ -775,6 +879,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/cookies/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/cookies/</loc> </url> @@ -799,6 +907,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/multipart/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/multipart/</loc> </url> @@ -827,6 +939,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/rest_principles/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/rest_principles/</loc> </url> @@ -851,6 +967,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/rest_handlers/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/rest_handlers/</loc> </url> @@ -875,6 +995,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/rest_flowcharts/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/rest_flowcharts/</loc> </url> @@ -899,6 +1023,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/resource_design/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/resource_design/</loc> </url> @@ -923,6 +1051,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/ws_protocol/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/ws_protocol/</loc> </url> @@ -947,6 +1079,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/ws_handlers/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/ws_handlers/</loc> </url> @@ -971,6 +1107,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/streams/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/streams/</loc> </url> @@ -995,6 +1135,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/middlewares/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/middlewares/</loc> </url> @@ -1027,6 +1171,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/performance/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.8/guide/performance/</loc> </url> @@ -1039,6 +1187,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.11/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.8/guide/migrating_from_2.7/</loc> </url> @@ -1071,6 +1223,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.10/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.11/guide/migrating_from_2.9/</loc> </url> @@ -1099,6 +1255,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.9/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.3/</loc> </url> @@ -1123,6 +1283,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.8/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.2/</loc> </url> @@ -1147,6 +1311,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.7/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.1/</loc> </url> @@ -1171,6 +1339,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.6/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.0/</loc> </url> @@ -1195,6 +1367,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.5/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_1.0/</loc> </url> @@ -1219,6 +1395,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.4/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/specs/</loc> </url> @@ -1243,6 +1423,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.3/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.8/guide/specs/</loc> </url> @@ -1259,6 +1443,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.2/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.9/guide/specs/</loc> </url> @@ -1271,6 +1459,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.1/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/guide/specs/</loc> </url> @@ -1279,10 +1471,22 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_2.0/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.11/guide/specs/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/migrating_from_1.0/</loc> + </url> + + <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/specs/</loc> + </url> + + <url> <loc>https://ninenines.eu/articles/</loc> <lastmod>2024-01-29T07:00:00+01:00</lastmod> </url> @@ -1624,6 +1828,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie/</loc> </url> @@ -1644,6 +1852,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.cookie/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowlib/2.9/manual/cow_cookie.cookie/</loc> </url> @@ -1660,6 +1872,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.parse_cookie/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie.parse_cookie/</loc> </url> @@ -1680,6 +1896,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.parse_set_cookie/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowlib/2.9/manual/cow_cookie.parse_set_cookie/</loc> </url> @@ -1696,6 +1916,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowlib/2.13/manual/cow_cookie.setcookie/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie.setcookie/</loc> </url> @@ -1712,6 +1936,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/</loc> </url> @@ -1736,6 +1964,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/guide/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/guide/</loc> </url> @@ -1760,6 +1992,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy/</loc> </url> @@ -1784,6 +2020,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_app/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_app/</loc> </url> @@ -1804,6 +2044,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.get_env/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/manual/cowboy.set_env/</loc> </url> @@ -1812,6 +2056,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.set_env/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy.set_env/</loc> </url> @@ -1836,6 +2084,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.start_clear/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy.start_clear/</loc> </url> @@ -1860,6 +2112,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.start_tls/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy.start_tls/</loc> </url> @@ -1884,6 +2140,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy.stop_listener/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy.stop_listener/</loc> </url> @@ -1908,6 +2168,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_compress_h/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_compress_h/</loc> </url> @@ -1932,6 +2196,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_constraints/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_constraints/</loc> </url> @@ -1956,6 +2224,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_constraints.int/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_constraints.int/</loc> </url> @@ -1980,6 +2252,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_constraints.nonempty/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_constraints.nonempty/</loc> </url> @@ -2000,6 +2276,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_decompress_h/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/manual/cowboy_handler/</loc> </url> @@ -2008,6 +2288,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_handler/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_handler/</loc> </url> @@ -2032,6 +2316,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_handler.terminate/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_handler.terminate/</loc> </url> @@ -2056,6 +2344,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_http/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_http/</loc> </url> @@ -2080,6 +2372,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_http2/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_http2/</loc> </url> @@ -2104,6 +2400,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_loop/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_loop/</loc> </url> @@ -2128,6 +2428,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_metrics_h/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_metrics_h/</loc> </url> @@ -2148,6 +2452,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_middleware/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_middleware/</loc> </url> @@ -2172,6 +2480,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req/</loc> </url> @@ -2196,6 +2508,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.binding/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.binding/</loc> </url> @@ -2220,6 +2536,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.bindings/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.bindings/</loc> </url> @@ -2244,6 +2564,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.body_length/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.body_length/</loc> </url> @@ -2268,6 +2592,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.cast/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_req.cast/</loc> </url> @@ -2288,6 +2616,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.cert/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.cert/</loc> </url> @@ -2312,6 +2644,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.delete_resp_header/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.delete_resp_header/</loc> </url> @@ -2336,6 +2672,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.filter_cookies/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_req.filter_cookies/</loc> </url> @@ -2356,6 +2696,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.has_body/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.has_body/</loc> </url> @@ -2380,6 +2724,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.has_resp_body/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.has_resp_body/</loc> </url> @@ -2404,6 +2752,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.has_resp_header/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.has_resp_header/</loc> </url> @@ -2428,6 +2780,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.header/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.header/</loc> </url> @@ -2452,6 +2808,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.headers/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.headers/</loc> </url> @@ -2476,6 +2836,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.host/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.host/</loc> </url> @@ -2500,6 +2864,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.host_info/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.host_info/</loc> </url> @@ -2524,6 +2892,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.inform/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.inform/</loc> </url> @@ -2548,6 +2920,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.match_cookies/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.match_cookies/</loc> </url> @@ -2572,6 +2948,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.match_qs/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.match_qs/</loc> </url> @@ -2596,6 +2976,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.method/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.method/</loc> </url> @@ -2620,6 +3004,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.parse_cookies/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.parse_cookies/</loc> </url> @@ -2644,6 +3032,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.parse_header/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.parse_header/</loc> </url> @@ -2668,6 +3060,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.parse_qs/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.parse_qs/</loc> </url> @@ -2692,6 +3088,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.path/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.path/</loc> </url> @@ -2716,6 +3116,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.path_info/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.path_info/</loc> </url> @@ -2740,6 +3144,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.peer/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.peer/</loc> </url> @@ -2764,6 +3172,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.port/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.port/</loc> </url> @@ -2788,6 +3200,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.push/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.push/</loc> </url> @@ -2812,6 +3228,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.qs/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.qs/</loc> </url> @@ -2836,6 +3256,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.read_and_match_urlencoded_body/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.read_and_match_urlencoded_body/</loc> </url> @@ -2860,6 +3284,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.read_body/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.read_body/</loc> </url> @@ -2884,6 +3312,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.read_part/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.read_part/</loc> </url> @@ -2908,6 +3340,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.read_part_body/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.read_part_body/</loc> </url> @@ -2932,6 +3368,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.read_urlencoded_body/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.read_urlencoded_body/</loc> </url> @@ -2956,6 +3396,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.reply/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.reply/</loc> </url> @@ -2980,6 +3424,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.resp_header/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.resp_header/</loc> </url> @@ -3004,6 +3452,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.resp_headers/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.resp_headers/</loc> </url> @@ -3028,6 +3480,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.scheme/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.scheme/</loc> </url> @@ -3052,6 +3508,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.set_resp_body/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_body/</loc> </url> @@ -3076,6 +3536,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.set_resp_cookie/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_cookie/</loc> </url> @@ -3100,6 +3564,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.set_resp_header/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_header/</loc> </url> @@ -3124,6 +3592,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.set_resp_headers/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.set_resp_headers/</loc> </url> @@ -3148,6 +3620,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.sock/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.sock/</loc> </url> @@ -3172,6 +3648,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.stream_body/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.stream_body/</loc> </url> @@ -3196,6 +3676,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.stream_events/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.stream_events/</loc> </url> @@ -3220,6 +3704,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.stream_reply/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.stream_reply/</loc> </url> @@ -3244,6 +3732,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.stream_trailers/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.stream_trailers/</loc> </url> @@ -3268,6 +3760,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.uri/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.uri/</loc> </url> @@ -3292,6 +3788,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_req.version/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_req.version/</loc> </url> @@ -3316,6 +3816,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_rest/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_rest/</loc> </url> @@ -3340,6 +3844,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_router/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_router/</loc> </url> @@ -3364,6 +3872,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_router.compile/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_router.compile/</loc> </url> @@ -3388,6 +3900,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_static/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_static/</loc> </url> @@ -3412,6 +3928,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_stream/</loc> </url> @@ -3432,22 +3952,42 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.data/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.11/manual/cowboy_stream.early_error/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.early_error/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.11/manual/cowboy_stream.info/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.info/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.11/manual/cowboy_stream.init/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.init/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.11/manual/cowboy_stream.terminate/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream.terminate/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/manual/cowboy_stream_h/</loc> </url> @@ -3456,6 +3996,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_stream_h/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_stream_h/</loc> </url> @@ -3480,6 +4024,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_tracer_h/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_tracer_h/</loc> </url> @@ -3500,6 +4048,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/cowboy_websocket/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_websocket/</loc> </url> @@ -3528,6 +4080,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowlib/2.13/manual/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowlib/2.8/manual/</loc> </url> @@ -3548,6 +4104,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowlib/2.13/manual/cowlib_app/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowlib/2.8/manual/cowlib_app/</loc> </url> @@ -3580,6 +4140,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/guide/</loc> </url> @@ -3600,6 +4164,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/guide/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun/</loc> </url> @@ -3620,6 +4188,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun_app/</loc> </url> @@ -3640,6 +4212,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_app/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.await/</loc> </url> @@ -3660,6 +4236,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.await/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.await_body/</loc> </url> @@ -3680,6 +4260,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.await_body/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.await_up/</loc> </url> @@ -3700,6 +4284,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.await_up/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.cancel/</loc> </url> @@ -3720,6 +4308,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.cancel/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.close/</loc> </url> @@ -3740,6 +4332,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.close/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.2/manual/gun.connect/</loc> </url> @@ -3752,6 +4348,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.connect/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.data/</loc> </url> @@ -3772,6 +4372,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.data/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.delete/</loc> </url> @@ -3792,6 +4396,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.delete/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.flush/</loc> </url> @@ -3812,6 +4420,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.flush/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.get/</loc> </url> @@ -3832,6 +4444,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.get/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.head/</loc> </url> @@ -3852,10 +4468,18 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.head/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/2.0/manual/gun.headers/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.headers/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.info/</loc> </url> @@ -3876,6 +4500,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.info/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.open/</loc> </url> @@ -3896,6 +4524,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.open/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.open_unix/</loc> </url> @@ -3916,6 +4548,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.open_unix/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.options/</loc> </url> @@ -3936,6 +4572,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.options/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.patch/</loc> </url> @@ -3956,6 +4596,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.patch/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.post/</loc> </url> @@ -3976,6 +4620,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.post/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.put/</loc> </url> @@ -3996,6 +4644,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.put/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.request/</loc> </url> @@ -4016,22 +4668,42 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.request/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/2.0/manual/gun.set_owner/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.set_owner/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/2.0/manual/gun.shutdown/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.shutdown/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/2.0/manual/gun.stream_info/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.stream_info/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/2.0/manual/gun.update_flow/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.update_flow/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.ws_send/</loc> </url> @@ -4052,6 +4724,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.ws_send/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun.ws_upgrade/</loc> </url> @@ -4072,22 +4748,42 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun.ws_upgrade/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/2.0/manual/gun_cookies/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/2.0/manual/gun_cookies.domain_match/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies.domain_match/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/2.0/manual/gun_cookies.path_match/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies.path_match/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/2.0/manual/gun_cookies_list/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_cookies_list/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun_data/</loc> </url> @@ -4108,6 +4804,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_data/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun_down/</loc> </url> @@ -4128,6 +4828,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_down/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun_error/</loc> </url> @@ -4148,10 +4852,18 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_error/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/2.0/manual/gun_event/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_event/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun_inform/</loc> </url> @@ -4172,6 +4884,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_inform/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun_push/</loc> </url> @@ -4192,6 +4908,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_push/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun_response/</loc> </url> @@ -4212,6 +4932,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_response/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun_trailers/</loc> </url> @@ -4232,10 +4956,18 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_trailers/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/2.0/manual/gun_tunnel_up/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_tunnel_up/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun_up/</loc> </url> @@ -4256,6 +4988,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_up/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun_upgrade/</loc> </url> @@ -4276,6 +5012,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_upgrade/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/manual/gun_ws/</loc> </url> @@ -4296,10 +5036,18 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_ws/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/2.0/manual/gun_ws_protocol/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/gun/2.1/manual/gun_ws_protocol/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/manual/http_status_codes/</loc> </url> @@ -4308,6 +5056,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/cowboy/2.12/manual/http_status_codes/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.6/manual/http_status_codes/</loc> </url> |
