diff options
author | Loïc Hoguin <[email protected]> | 2025-02-17 12:27:46 +0100 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2025-02-17 12:27:46 +0100 |
commit | affdec9617b854277e7350ed7236a17c7c4fd434 (patch) | |
tree | fccea7efb022c9930a928fd2f8accec7ae3c768d | |
parent | 548e971645543d3be355d569155959ba5a906656 (diff) | |
download | ninenines.eu-affdec9617b854277e7350ed7236a17c7c4fd434.tar.gz ninenines.eu-affdec9617b854277e7350ed7236a17c7c4fd434.tar.bz2 ninenines.eu-affdec9617b854277e7350ed7236a17c7c4fd434.zip |
Ranch 2.2.0
369 files changed, 16764 insertions, 68 deletions
diff --git a/_build/content/articles/ranch-2.2.0.asciidoc b/_build/content/articles/ranch-2.2.0.asciidoc new file mode 100644 index 00000000..5f521712 --- /dev/null +++ b/_build/content/articles/ranch-2.2.0.asciidoc @@ -0,0 +1,32 @@ ++++ +date = "2025-17-02T07:00:00+01:00" +title = "Ranch 2.2" + ++++ + +Ranch `2.2.0` has been released! + +Ranch 2.2 is a maintenance release containing a +small number of fixes and improvements. + +The key addition in this release is the support +for `DTLS` which has been added to the test suites. + +Ranch 2.2 is tested with Erlang/OTP 24.0 onward, although it +should be compatible with Erlang/OTP 22.0 and above. It is +tested and supported on Linux, macOS and Windows, but should +also work on BSD. + +A complete list of changes can be found in the migration guide: +https://ninenines.eu/docs/en/ranch/2.1/guide/migrating_from_2.1/[Migrating from Ranch 2.1 to 2.2]. + +Ranch `1.8.1` was also released to provide +compatibility with OTP-28. + +You can donate to this project via +https://github.com/sponsors/essen[GitHub Sponsors]. + +As usual, feedback is appreciated, and issues or +questions should be sent via Github tickets or +discussions. We also have a new Discord server. +https://discord.gg/x25nNq2fFE[Join Erlang OSS Discord now!] diff --git a/_build/data/projects/ranch.toml b/_build/data/projects/ranch.toml index 61b043cd..1ff7a44f 100644 --- a/_build/data/projects/ranch.toml +++ b/_build/data/projects/ranch.toml @@ -3,8 +3,8 @@ catchphrase = "The holy cow of servers." description = "Ranch is a socket acceptor pool for building awesome TCP and TLS servers." name = "ranch" repository = "https://github.com/ninenines/ranch" -versions = ["2.1", "2.0", "1.8", "1.7", "1.6"] -branches = ["fa6c24a65e0e1482ce52dd1f0e08a39ad85b6c82", "2.0.0", "1.8.0", "1.7.1", "1.6.2"] +versions = ["2.2", "2.1", "2.0", "1.8", "1.7", "1.6"] +branches = ["2.2.0", "fa6c24a65e0e1482ce52dd1f0e08a39ad85b6c82", "2.0.0", "1.8.1", "1.7.1", "1.6.2"] has_source = true has_guide = true has_manual = true diff --git a/articles/asciideck/index.html b/articles/asciideck/index.html index b451baa6..c30e2d3a 100644 --- a/articles/asciideck/index.html +++ b/articles/asciideck/index.html @@ -348,6 +348,10 @@ http://www.gnu.org/software/src-highlite --> <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.0.0-pre.4/index.html b/articles/cowboy-2.0.0-pre.4/index.html index deab275f..39954c8c 100644 --- a/articles/cowboy-2.0.0-pre.4/index.html +++ b/articles/cowboy-2.0.0-pre.4/index.html @@ -367,6 +367,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.0.0-rc.1/index.html b/articles/cowboy-2.0.0-rc.1/index.html index b99c25de..9bb9a760 100644 --- a/articles/cowboy-2.0.0-rc.1/index.html +++ b/articles/cowboy-2.0.0-rc.1/index.html @@ -338,6 +338,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.0.0-rc.2/index.html b/articles/cowboy-2.0.0-rc.2/index.html index 413e6e2f..2f3d2663 100644 --- a/articles/cowboy-2.0.0-rc.2/index.html +++ b/articles/cowboy-2.0.0-rc.2/index.html @@ -331,6 +331,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.0.0/index.html b/articles/cowboy-2.0.0/index.html index 7bdb7d07..a2990ff9 100644 --- a/articles/cowboy-2.0.0/index.html +++ b/articles/cowboy-2.0.0/index.html @@ -337,6 +337,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.1.0/index.html b/articles/cowboy-2.1.0/index.html index 2ee3f453..d64db13f 100644 --- a/articles/cowboy-2.1.0/index.html +++ b/articles/cowboy-2.1.0/index.html @@ -334,6 +334,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.11.0/index.html b/articles/cowboy-2.11.0/index.html index defc7b21..f093f68b 100644 --- a/articles/cowboy-2.11.0/index.html +++ b/articles/cowboy-2.11.0/index.html @@ -327,6 +327,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.12.0/index.html b/articles/cowboy-2.12.0/index.html index d7611efb..7de1545b 100644 --- a/articles/cowboy-2.12.0/index.html +++ b/articles/cowboy-2.12.0/index.html @@ -328,6 +328,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.13.0-performance/index.html b/articles/cowboy-2.13.0-performance/index.html index 1ae97553..b56d419f 100644 --- a/articles/cowboy-2.13.0-performance/index.html +++ b/articles/cowboy-2.13.0-performance/index.html @@ -342,6 +342,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.2.0/index.html b/articles/cowboy-2.2.0/index.html index 41879ff1..67546f05 100644 --- a/articles/cowboy-2.2.0/index.html +++ b/articles/cowboy-2.2.0/index.html @@ -332,6 +332,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.3.0/index.html b/articles/cowboy-2.3.0/index.html index b2e71a14..aa11cab1 100644 --- a/articles/cowboy-2.3.0/index.html +++ b/articles/cowboy-2.3.0/index.html @@ -324,6 +324,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.4.0/index.html b/articles/cowboy-2.4.0/index.html index 934ff59c..9d641a92 100644 --- a/articles/cowboy-2.4.0/index.html +++ b/articles/cowboy-2.4.0/index.html @@ -326,6 +326,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.5.0/index.html b/articles/cowboy-2.5.0/index.html index 0fa6f0f7..2569f406 100644 --- a/articles/cowboy-2.5.0/index.html +++ b/articles/cowboy-2.5.0/index.html @@ -330,6 +330,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.6.0/index.html b/articles/cowboy-2.6.0/index.html index c1662a44..8c43ec87 100644 --- a/articles/cowboy-2.6.0/index.html +++ b/articles/cowboy-2.6.0/index.html @@ -327,6 +327,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.7.0/index.html b/articles/cowboy-2.7.0/index.html index 6a0ab127..a2af58b8 100644 --- a/articles/cowboy-2.7.0/index.html +++ b/articles/cowboy-2.7.0/index.html @@ -328,6 +328,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.8.0/index.html b/articles/cowboy-2.8.0/index.html index 3530045d..382e02b5 100644 --- a/articles/cowboy-2.8.0/index.html +++ b/articles/cowboy-2.8.0/index.html @@ -327,6 +327,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy-2.9.0/index.html b/articles/cowboy-2.9.0/index.html index 6da1c856..4a95b00f 100644 --- a/articles/cowboy-2.9.0/index.html +++ b/articles/cowboy-2.9.0/index.html @@ -326,6 +326,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/cowboy2-qs/index.html b/articles/cowboy2-qs/index.html index 1c0443a5..6b910f1a 100644 --- a/articles/cowboy2-qs/index.html +++ b/articles/cowboy2-qs/index.html @@ -368,6 +368,10 @@ http://www.gnu.org/software/src-highlite --> <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/discord-server/index.html b/articles/discord-server/index.html index 950d8e07..5a7d8529 100644 --- a/articles/discord-server/index.html +++ b/articles/discord-server/index.html @@ -324,6 +324,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/dont-let-it-crash/index.html b/articles/dont-let-it-crash/index.html index 96e29f25..77e2d184 100644 --- a/articles/dont-let-it-crash/index.html +++ b/articles/dont-let-it-crash/index.html @@ -343,6 +343,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/erlang-meetup-10-septembre-2019/index.html b/articles/erlang-meetup-10-septembre-2019/index.html index 109b47a8..eb378302 100644 --- a/articles/erlang-meetup-10-septembre-2019/index.html +++ b/articles/erlang-meetup-10-septembre-2019/index.html @@ -323,6 +323,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/erlang-scalability/index.html b/articles/erlang-scalability/index.html index 8b00787e..95674f0b 100644 --- a/articles/erlang-scalability/index.html +++ b/articles/erlang-scalability/index.html @@ -355,6 +355,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/erlang-validate-utf8/index.html b/articles/erlang-validate-utf8/index.html index 1d7c7f9c..0311f503 100644 --- a/articles/erlang-validate-utf8/index.html +++ b/articles/erlang-validate-utf8/index.html @@ -471,6 +471,10 @@ http://www.gnu.org/software/src-highlite --> <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/erlang.mk-and-relx/index.html b/articles/erlang.mk-and-relx/index.html index db8b348c..c79db202 100644 --- a/articles/erlang.mk-and-relx/index.html +++ b/articles/erlang.mk-and-relx/index.html @@ -357,6 +357,10 @@ cowboy-0.8.5 erlydtl-0.7.0 ninenines-0.2.0 stdlib-1.19.1</pre></div></div> <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/erlanger-playbook-september-2015-update/index.html b/articles/erlanger-playbook-september-2015-update/index.html index a5ed4d1a..4ec59ef6 100644 --- a/articles/erlanger-playbook-september-2015-update/index.html +++ b/articles/erlanger-playbook-september-2015-update/index.html @@ -326,6 +326,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/erlanger-playbook/index.html b/articles/erlanger-playbook/index.html index 91a69925..fc209391 100644 --- a/articles/erlanger-playbook/index.html +++ b/articles/erlanger-playbook/index.html @@ -367,6 +367,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/farwest-funded/index.html b/articles/farwest-funded/index.html index bd4a6a48..d9867f5d 100644 --- a/articles/farwest-funded/index.html +++ b/articles/farwest-funded/index.html @@ -327,6 +327,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/github-sponsors/index.html b/articles/github-sponsors/index.html index ff525315..cdd29154 100644 --- a/articles/github-sponsors/index.html +++ b/articles/github-sponsors/index.html @@ -324,6 +324,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/gun-1.0.0-rc.1/index.html b/articles/gun-1.0.0-rc.1/index.html index cefd36c9..bf35db7a 100644 --- a/articles/gun-1.0.0-rc.1/index.html +++ b/articles/gun-1.0.0-rc.1/index.html @@ -328,6 +328,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/gun-1.0.0/index.html b/articles/gun-1.0.0/index.html index 6ee28651..29a755e1 100644 --- a/articles/gun-1.0.0/index.html +++ b/articles/gun-1.0.0/index.html @@ -327,6 +327,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/gun-1.2.0/index.html b/articles/gun-1.2.0/index.html index 785b5478..c56fbe60 100644 --- a/articles/gun-1.2.0/index.html +++ b/articles/gun-1.2.0/index.html @@ -327,6 +327,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/gun-1.3.0/index.html b/articles/gun-1.3.0/index.html index 1f00de7a..c8a1110b 100644 --- a/articles/gun-1.3.0/index.html +++ b/articles/gun-1.3.0/index.html @@ -325,6 +325,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/gun-2.0.0-pre.1/index.html b/articles/gun-2.0.0-pre.1/index.html index 71b24674..0fa572dc 100644 --- a/articles/gun-2.0.0-pre.1/index.html +++ b/articles/gun-2.0.0-pre.1/index.html @@ -332,6 +332,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/gun-2.0.0-pre.2/index.html b/articles/gun-2.0.0-pre.2/index.html index 080c560d..b27bb787 100644 --- a/articles/gun-2.0.0-pre.2/index.html +++ b/articles/gun-2.0.0-pre.2/index.html @@ -330,6 +330,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/gun-2.0.0-rc.1/index.html b/articles/gun-2.0.0-rc.1/index.html index e8aadd63..614b76d8 100644 --- a/articles/gun-2.0.0-rc.1/index.html +++ b/articles/gun-2.0.0-rc.1/index.html @@ -335,6 +335,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/gun-2.0.0/index.html b/articles/gun-2.0.0/index.html index 5ed62f28..df054994 100644 --- a/articles/gun-2.0.0/index.html +++ b/articles/gun-2.0.0/index.html @@ -337,6 +337,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/index.html b/articles/index.html index 850e7e7e..a1ff85bc 100644 --- a/articles/index.html +++ b/articles/index.html @@ -429,7 +429,7 @@ My most striking memory of Joe was during dinner at his place after a conference <nav class="pagination" role="pagination"> - <span>1 / 3</span> + <span>1 / 4</span> <a href="/articles/page/2/"><i class="fa fa-angle-double-right"></i></a> diff --git a/articles/index.xml b/articles/index.xml index 2d451636..06fae9fa 100644 --- a/articles/index.xml +++ b/articles/index.xml @@ -686,5 +686,17 @@ Writing an algorithm to check for victory sounds easy, right? It&apos;s easi In Erlang though, you probably wouldn&apos;t want an algorithm.</description> </item> + <item> + <title>Ranch 2.2</title> + <link>https://ninenines.eu/articles/ranch-2.2.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/articles/ranch-2.2.0/</guid> + <description>Ranch 2.2.0 has been released! +Ranch 2.2 is a maintenance release containing a small number of fixes and improvements. +The key addition in this release is the support for DTLS which has been added to the test suites. +Ranch 2.2 is tested with Erlang/OTP 24.0 onward, although it should be compatible with Erlang/OTP 22.0 and above. It is tested and supported on Linux, macOS and Windows, but should also work on BSD.</description> + </item> + </channel> </rss>
\ No newline at end of file diff --git a/articles/january-2014-status/index.html b/articles/january-2014-status/index.html index f64228c3..e75f4a29 100644 --- a/articles/january-2014-status/index.html +++ b/articles/january-2014-status/index.html @@ -353,6 +353,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/joe_the_rubber_duck/index.html b/articles/joe_the_rubber_duck/index.html index 4e9ef2a0..39c6f808 100644 --- a/articles/joe_the_rubber_duck/index.html +++ b/articles/joe_the_rubber_duck/index.html @@ -327,6 +327,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/merry-christmas-2018/index.html b/articles/merry-christmas-2018/index.html index 5f2843c3..c9c182cc 100644 --- a/articles/merry-christmas-2018/index.html +++ b/articles/merry-christmas-2018/index.html @@ -334,6 +334,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/merry-christmas-2019/index.html b/articles/merry-christmas-2019/index.html index 16f4e6ad..4bda84ac 100644 --- a/articles/merry-christmas-2019/index.html +++ b/articles/merry-christmas-2019/index.html @@ -330,6 +330,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/ml-archives/index.html b/articles/ml-archives/index.html index 93b24cc8..381a78bd 100644 --- a/articles/ml-archives/index.html +++ b/articles/ml-archives/index.html @@ -324,6 +324,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/on-open-source/index.html b/articles/on-open-source/index.html index fb9a3162..eeb2a4f2 100644 --- a/articles/on-open-source/index.html +++ b/articles/on-open-source/index.html @@ -336,6 +336,10 @@ much left to look at today</a>. This was followed by a <a href="https://github.c <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/otp-26/index.html b/articles/otp-26/index.html index 11502b14..61f184f0 100644 --- a/articles/otp-26/index.html +++ b/articles/otp-26/index.html @@ -331,6 +331,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/page/2/index.html b/articles/page/2/index.html index f234f775..b39b5b51 100644 --- a/articles/page/2/index.html +++ b/articles/page/2/index.html @@ -440,7 +440,7 @@ A new architecture: there now is one process per connection and one process per <a href="/articles/"><i class="fa fa-angle-double-left"></i></a> - <span>2 / 3</span> + <span>2 / 4</span> <a href="/articles/page/3/"><i class="fa fa-angle-double-right"></i></a> diff --git a/articles/page/3/index.html b/articles/page/3/index.html index 99fbac21..e6ac1b30 100644 --- a/articles/page/3/index.html +++ b/articles/page/3/index.html @@ -431,7 +431,9 @@ In Erlang though, you probably wouldn't want an algorithm.</p> <a href="/articles/page/2/"><i class="fa fa-angle-double-left"></i></a> - <span>3 / 3</span> + <span>3 / 4</span> + + <a href="/articles/page/4/"><i class="fa fa-angle-double-right"></i></a> </nav> diff --git a/articles/page/4/index.html b/articles/page/4/index.html new file mode 100644 index 00000000..64fbd0a6 --- /dev/null +++ b/articles/page/4/index.html @@ -0,0 +1,125 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Articles</title> + + <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"> + + <link rel="alternate" type="application/rss+xml" href="https://ninenines.eu/articles/index.xml" title="Nine Nines" /> + </head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li class="active"><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div class="span9 maincol"> + +<h1 class="lined-header"><span>Articles</span></h1> + + + <article class="blog_item"> + <header> + <h2><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></h2> + <p class="date"> + <span class="year">0001</span> + <span class="day-month">01 Jan</span> + </p> + </header> + + <p>Ranch 2.2.0 has been released! +Ranch 2.2 is a maintenance release containing a small number of fixes and improvements. +The key addition in this release is the support for DTLS which has been added to the test suites. +Ranch 2.2 is tested with Erlang/OTP 24.0 onward, although it should be compatible with Erlang/OTP 22.0 and above. It is tested and supported on Linux, macOS and Windows, but should also work on BSD.</p> + + <p style="text-align:right"> + <a class="read_more" href="https://ninenines.eu/articles/ranch-2.2.0/">Read More</a> + </p> + </article> + + + +<nav class="pagination" role="pagination"> + + <a href="/articles/page/3/"><i class="fa fa-angle-double-left"></i></a> + + <span>4 / 4</span> + +</nav> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + diff --git a/articles/ranch-1.3/index.html b/articles/ranch-1.3/index.html index d0fdcda7..22daa2c8 100644 --- a/articles/ranch-1.3/index.html +++ b/articles/ranch-1.3/index.html @@ -365,6 +365,10 @@ Primary key fingerprint<font color="#990000">:</font> F19F 189C ECC7 <font color <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/ranch-1.6.0/index.html b/articles/ranch-1.6.0/index.html index 79a85ff0..71a8b575 100644 --- a/articles/ranch-1.6.0/index.html +++ b/articles/ranch-1.6.0/index.html @@ -327,6 +327,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/ranch-1.7.0/index.html b/articles/ranch-1.7.0/index.html index 11dccacb..48cc3b3b 100644 --- a/articles/ranch-1.7.0/index.html +++ b/articles/ranch-1.7.0/index.html @@ -326,6 +326,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/ranch-2.0.0-rc.1/index.html b/articles/ranch-2.0.0-rc.1/index.html index 3f898c6a..e542415c 100644 --- a/articles/ranch-2.0.0-rc.1/index.html +++ b/articles/ranch-2.0.0-rc.1/index.html @@ -335,6 +335,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/ranch-2.0.0/index.html b/articles/ranch-2.0.0/index.html index a5a9957a..52585085 100644 --- a/articles/ranch-2.0.0/index.html +++ b/articles/ranch-2.0.0/index.html @@ -334,6 +334,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/ranch-2.1.0/index.html b/articles/ranch-2.1.0/index.html index b4b141f1..f89dcd0b 100644 --- a/articles/ranch-2.1.0/index.html +++ b/articles/ranch-2.1.0/index.html @@ -329,6 +329,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/ranch-2.2.0/index.html b/articles/ranch-2.2.0/index.html new file mode 100644 index 00000000..fa12f9ca --- /dev/null +++ b/articles/ranch-2.2.0/index.html @@ -0,0 +1,369 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Ranch 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 class="active"><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents"> +<div class="container"> +<div class="row"> +<div class="span9 maincol"> + +<article class="blog_item"> +<header> + <h1 class="lined-header"><span>Ranch 2.2</span></h1> + <p class="date"> + <span class="year">0001</span> + <span class="day-month">01 Jan</span> + </p> +</header> + +<p>Ranch <code>2.2.0</code> has been released!</p> +<p>Ranch 2.2 is a maintenance release containing a small number of fixes and improvements.</p> +<p>The key addition in this release is the support for <code>DTLS</code> which has been added to the test suites.</p> +<p>Ranch 2.2 is tested with Erlang/OTP 24.0 onward, although it should be compatible with Erlang/OTP 22.0 and above. It is tested and supported on Linux, macOS and Windows, but should also work on BSD.</p> +<p>A complete list of changes can be found in the migration guide: <a href="https://ninenines.eu/docs/en/ranch/2.1/guide/migrating_from_2.1/">Migrating from Ranch 2.1 to 2.2</a>.</p> +<p>Ranch <code>1.8.1</code> was also released to provide compatibility with OTP-28.</p> +<p>You can donate to this project via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>.</p> +<p>As usual, feedback is appreciated, and issues or questions should be sent via Github tickets or discussions. We also have a new Discord server. <a href="https://discord.gg/x25nNq2fFE">Join Erlang OSS Discord now!</a></p> + + +</article> +</div> + +<div class="span3 sidecol"> +<h3>More articles</h3> +<ul id="articles-nav" class="extra_margin"> + + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.13.0-performance/">Performance improvements in Cowboy 2.13</a></li> + + + + <li><a href="https://ninenines.eu/articles/discord-server/">Erlang OSS Discord server</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.12.0/">Cowboy 2.12</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.11.0/">Cowboy 2.11</a></li> + + + + <li><a href="https://ninenines.eu/articles/otp-26/">Erlang/OTP 26</a></li> + + + + <li><a href="https://ninenines.eu/articles/gun-2.0.0/">Gun 2.0</a></li> + + + + <li><a href="https://ninenines.eu/articles/ranch-2.1.0/">Ranch 2.1</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.9.0/">Cowboy 2.9</a></li> + + + + <li><a href="https://ninenines.eu/articles/gun-2.0.0-rc.1/">Gun 2.0 release candidate 1</a></li> + + + + <li><a href="https://ninenines.eu/articles/ranch-2.0.0/">Ranch 2.0</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.8.0/">Cowboy 2.8</a></li> + + + + <li><a href="https://ninenines.eu/articles/the-gateway-trilogy/">The Gateway Trilogy</a></li> + + + + <li><a href="https://ninenines.eu/articles/gun-2.0.0-pre.2/">Gun 2.0 pre-release 2</a></li> + + + + <li><a href="https://ninenines.eu/articles/merry-christmas-2019/">Merry Christmas 2019: New Beginnings</a></li> + + + + <li><a href="https://ninenines.eu/articles/github-sponsors/">GitHub Sponsors</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.7.0/">Cowboy 2.7</a></li> + + + + <li><a href="https://ninenines.eu/articles/gun-2.0.0-pre.1/">Gun 2.0 pre-release 1</a></li> + + + + <li><a href="https://ninenines.eu/articles/erlang-meetup-10-septembre-2019/">Erlang meetup: 10 septembre 2019</a></li> + + + + <li><a href="https://ninenines.eu/articles/ranch-2.0.0-rc.1/">Ranch 2.0 release candidate 1</a></li> + + + + <li><a href="https://ninenines.eu/articles/joe_the_rubber_duck/">Joe Armstrong the rubber duck</a></li> + + + + <li><a href="https://ninenines.eu/articles/merry-christmas-2018/">Merry Christmas 2018: A Recap</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.6.0/">Cowboy 2.6</a></li> + + + + <li><a href="https://ninenines.eu/articles/ranch-1.7.0/">Ranch 1.7</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.5.0/">Cowboy 2.5</a></li> + + + + <li><a href="https://ninenines.eu/articles/gun-1.3.0/">Gun 1.3</a></li> + + + + <li><a href="https://ninenines.eu/articles/gun-1.2.0/">Gun 1.2</a></li> + + + + <li><a href="https://ninenines.eu/articles/ranch-1.6.0/">Ranch 1.6</a></li> + + + + <li><a href="https://ninenines.eu/articles/gun-1.0.0/">Gun 1.0</a></li> + + + + <li><a href="https://ninenines.eu/articles/asciideck/">Asciideck: Asciidoc for Erlang</a></li> + + + + <li><a href="https://ninenines.eu/articles/gun-1.0.0-rc.1/">Gun 1.0 release candidate 1</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.4.0/">Cowboy 2.4</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.3.0/">Cowboy 2.3</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.2.0/">Cowboy 2.2</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.1.0/">Cowboy 2.1</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.0.0/">Cowboy 2.0</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.0.0-rc.2/">Cowboy 2.0 release candidate 2</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.0.0-rc.1/">Cowboy 2.0 release candidate 1</a></li> + + + + <li><a href="https://ninenines.eu/articles/the-elephant-in-the-room/">The elephant in the room</a></li> + + + + <li><a href="https://ninenines.eu/articles/dont-let-it-crash/">Don't let it crash</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy-2.0.0-pre.4/">Cowboy 2.0 pre-release 4</a></li> + + + + <li><a href="https://ninenines.eu/articles/ranch-1.3/">Ranch 1.3</a></li> + + + + <li><a href="https://ninenines.eu/articles/ml-archives/">Mailing list archived</a></li> + + + + <li><a href="https://ninenines.eu/articles/website-update/">Website update</a></li> + + + + <li><a href="https://ninenines.eu/articles/erlanger-playbook-september-2015-update/">The Erlanger Playbook September 2015 Update</a></li> + + + + <li><a href="https://ninenines.eu/articles/erlanger-playbook/">The Erlanger Playbook</a></li> + + + + <li><a href="https://ninenines.eu/articles/erlang-validate-utf8/">Validating UTF-8 binaries with Erlang</a></li> + + + + <li><a href="https://ninenines.eu/articles/on-open-source/">On open source</a></li> + + + + <li><a href="https://ninenines.eu/articles/the-story-so-far/">The story so far</a></li> + + + + <li><a href="https://ninenines.eu/articles/cowboy2-qs/">Cowboy 2.0 and query strings</a></li> + + + + <li><a href="https://ninenines.eu/articles/january-2014-status/">January 2014 status</a></li> + + + + <li><a href="https://ninenines.eu/articles/farwest-funded/">Farwest got funded!</a></li> + + + + <li><a href="https://ninenines.eu/articles/erlang.mk-and-relx/">Build Erlang releases with Erlang.mk and Relx</a></li> + + + + <li><a href="https://ninenines.eu/articles/xerl-0.5-intermediate-module/">Xerl: intermediate module</a></li> + + + + <li><a href="https://ninenines.eu/articles/xerl-0.4-expression-separator/">Xerl: expression separator</a></li> + + + + <li><a href="https://ninenines.eu/articles/erlang-scalability/">Erlang Scalability</a></li> + + + + <li><a href="https://ninenines.eu/articles/xerl-0.3-atomic-expressions/">Xerl: atomic expressions</a></li> + + + + <li><a href="https://ninenines.eu/articles/xerl-0.2-two-modules/">Xerl: two modules</a></li> + + + + <li><a href="https://ninenines.eu/articles/xerl-0.1-empty-modules/">Xerl: empty modules</a></li> + + + + <li><a href="https://ninenines.eu/articles/ranch-ftp/">Build an FTP Server with Ranch in 30 Minutes</a></li> + + + + <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + +</ul> + +<h3>Feedback</h3> +<p>Feel free to <a href="mailto:[email protected]">email us</a> +if you found any mistake or need clarification on any of the +articles.</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/articles/ranch-ftp/index.html b/articles/ranch-ftp/index.html index 2ba44ce6..cfae7006 100644 --- a/articles/ranch-ftp/index.html +++ b/articles/ranch-ftp/index.html @@ -467,6 +467,10 @@ http://www.gnu.org/software/src-highlite --> <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/the-elephant-in-the-room/index.html b/articles/the-elephant-in-the-room/index.html index cee462f3..c2f01c11 100644 --- a/articles/the-elephant-in-the-room/index.html +++ b/articles/the-elephant-in-the-room/index.html @@ -349,6 +349,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/the-gateway-trilogy/index.html b/articles/the-gateway-trilogy/index.html index c8624105..b7cfc601 100644 --- a/articles/the-gateway-trilogy/index.html +++ b/articles/the-gateway-trilogy/index.html @@ -324,6 +324,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/the-story-so-far/index.html b/articles/the-story-so-far/index.html index 6f4ed947..3f17308f 100644 --- a/articles/the-story-so-far/index.html +++ b/articles/the-story-so-far/index.html @@ -340,6 +340,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/tictactoe/index.html b/articles/tictactoe/index.html index 4601bede..d1e1e6b5 100644 --- a/articles/tictactoe/index.html +++ b/articles/tictactoe/index.html @@ -372,6 +372,10 @@ http://www.gnu.org/software/src-highlite --> <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/website-update/index.html b/articles/website-update/index.html index ff7c03a7..4b786e7a 100644 --- a/articles/website-update/index.html +++ b/articles/website-update/index.html @@ -329,6 +329,10 @@ <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/xerl-0.1-empty-modules/index.html b/articles/xerl-0.1-empty-modules/index.html index ea85e74f..3b00cbf8 100644 --- a/articles/xerl-0.1-empty-modules/index.html +++ b/articles/xerl-0.1-empty-modules/index.html @@ -407,6 +407,10 @@ http://www.gnu.org/software/src-highlite --> <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/xerl-0.2-two-modules/index.html b/articles/xerl-0.2-two-modules/index.html index ffb175fc..18ca24ec 100644 --- a/articles/xerl-0.2-two-modules/index.html +++ b/articles/xerl-0.2-two-modules/index.html @@ -435,6 +435,10 @@ http://www.gnu.org/software/src-highlite --> <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/xerl-0.3-atomic-expressions/index.html b/articles/xerl-0.3-atomic-expressions/index.html index aace71e5..e83ff96b 100644 --- a/articles/xerl-0.3-atomic-expressions/index.html +++ b/articles/xerl-0.3-atomic-expressions/index.html @@ -404,6 +404,10 @@ http://www.gnu.org/software/src-highlite --> <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/xerl-0.4-expression-separator/index.html b/articles/xerl-0.4-expression-separator/index.html index a75f7cc5..3a89bdfd 100644 --- a/articles/xerl-0.4-expression-separator/index.html +++ b/articles/xerl-0.4-expression-separator/index.html @@ -356,6 +356,10 @@ http://www.gnu.org/software/src-highlite --> <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/articles/xerl-0.5-intermediate-module/index.html b/articles/xerl-0.5-intermediate-module/index.html index 46f7ca03..6e005b50 100644 --- a/articles/xerl-0.5-intermediate-module/index.html +++ b/articles/xerl-0.5-intermediate-module/index.html @@ -400,6 +400,10 @@ http://www.gnu.org/software/src-highlite --> <li><a href="https://ninenines.eu/articles/tictactoe/">Erlang Tic Tac Toe</a></li> + + <li><a href="https://ninenines.eu/articles/ranch-2.2.0/">Ranch 2.2</a></li> + + </ul> <h3>Feedback</h3> diff --git a/docs/en/ranch/1.6/guide/embedded/index.html b/docs/en/ranch/1.6/guide/embedded/index.html index 9d94807d..ca866e8f 100644 --- a/docs/en/ranch/1.6/guide/embedded/index.html +++ b/docs/en/ranch/1.6/guide/embedded/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.6/guide/index.html b/docs/en/ranch/1.6/guide/index.html index e9d0d2fa..08377254 100644 --- a/docs/en/ranch/1.6/guide/index.html +++ b/docs/en/ranch/1.6/guide/index.html @@ -128,6 +128,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.6/guide/internals/index.html b/docs/en/ranch/1.6/guide/internals/index.html index 520466fd..2028dab6 100644 --- a/docs/en/ranch/1.6/guide/internals/index.html +++ b/docs/en/ranch/1.6/guide/internals/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.6/guide/introduction/index.html b/docs/en/ranch/1.6/guide/introduction/index.html index 159258db..9c221285 100644 --- a/docs/en/ranch/1.6/guide/introduction/index.html +++ b/docs/en/ranch/1.6/guide/introduction/index.html @@ -125,6 +125,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.6/guide/listeners/index.html b/docs/en/ranch/1.6/guide/listeners/index.html index 05643d30..241ddc9d 100644 --- a/docs/en/ranch/1.6/guide/listeners/index.html +++ b/docs/en/ranch/1.6/guide/listeners/index.html @@ -360,6 +360,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.6/guide/migrating_from_1.5/index.html b/docs/en/ranch/1.6/guide/migrating_from_1.5/index.html index 472219b3..3561fcae 100644 --- a/docs/en/ranch/1.6/guide/migrating_from_1.5/index.html +++ b/docs/en/ranch/1.6/guide/migrating_from_1.5/index.html @@ -160,6 +160,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.6/guide/migrating_from_1.6/index.html b/docs/en/ranch/1.6/guide/migrating_from_1.6/index.html index 77a46354..0aba1deb 100644 --- a/docs/en/ranch/1.6/guide/migrating_from_1.6/index.html +++ b/docs/en/ranch/1.6/guide/migrating_from_1.6/index.html @@ -123,6 +123,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.6/guide/migrating_from_1.x/index.html b/docs/en/ranch/1.6/guide/migrating_from_1.x/index.html index 023a2b5f..eecb0cf1 100644 --- a/docs/en/ranch/1.6/guide/migrating_from_1.x/index.html +++ b/docs/en/ranch/1.6/guide/migrating_from_1.x/index.html @@ -213,6 +213,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.6/guide/parsers/index.html b/docs/en/ranch/1.6/guide/parsers/index.html index 4f49deee..c5659158 100644 --- a/docs/en/ranch/1.6/guide/parsers/index.html +++ b/docs/en/ranch/1.6/guide/parsers/index.html @@ -180,6 +180,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.6/guide/protocols/index.html b/docs/en/ranch/1.6/guide/protocols/index.html index 30a92add..097c2675 100644 --- a/docs/en/ranch/1.6/guide/protocols/index.html +++ b/docs/en/ranch/1.6/guide/protocols/index.html @@ -187,6 +187,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.6/guide/ssl_auth/index.html b/docs/en/ranch/1.6/guide/ssl_auth/index.html index d5c3fc04..a40028e0 100644 --- a/docs/en/ranch/1.6/guide/ssl_auth/index.html +++ b/docs/en/ranch/1.6/guide/ssl_auth/index.html @@ -193,6 +193,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.6/guide/transports/index.html b/docs/en/ranch/1.6/guide/transports/index.html index c99b6ef0..2496cd89 100644 --- a/docs/en/ranch/1.6/guide/transports/index.html +++ b/docs/en/ranch/1.6/guide/transports/index.html @@ -227,6 +227,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.6/guide/upcoming_2.0_changes/index.html b/docs/en/ranch/1.6/guide/upcoming_2.0_changes/index.html index a1e7cd19..313f433a 100644 --- a/docs/en/ranch/1.6/guide/upcoming_2.0_changes/index.html +++ b/docs/en/ranch/1.6/guide/upcoming_2.0_changes/index.html @@ -134,6 +134,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/index.html b/docs/en/ranch/1.6/manual/index.html index a506d0cb..54e07e34 100644 --- a/docs/en/ranch/1.6/manual/index.html +++ b/docs/en/ranch/1.6/manual/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.child_spec/index.html b/docs/en/ranch/1.6/manual/ranch.child_spec/index.html index 11ba3171..a5e78322 100644 --- a/docs/en/ranch/1.6/manual/ranch.child_spec/index.html +++ b/docs/en/ranch/1.6/manual/ranch.child_spec/index.html @@ -158,6 +158,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.get_addr/index.html b/docs/en/ranch/1.6/manual/ranch.get_addr/index.html index 5e135805..e2fa3507 100644 --- a/docs/en/ranch/1.6/manual/ranch.get_addr/index.html +++ b/docs/en/ranch/1.6/manual/ranch.get_addr/index.html @@ -126,6 +126,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.get_max_connections/index.html b/docs/en/ranch/1.6/manual/ranch.get_max_connections/index.html index 1035bec6..dc0bfd1a 100644 --- a/docs/en/ranch/1.6/manual/ranch.get_max_connections/index.html +++ b/docs/en/ranch/1.6/manual/ranch.get_max_connections/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.get_port/index.html b/docs/en/ranch/1.6/manual/ranch.get_port/index.html index 5e8a110d..cf861b7c 100644 --- a/docs/en/ranch/1.6/manual/ranch.get_port/index.html +++ b/docs/en/ranch/1.6/manual/ranch.get_port/index.html @@ -125,6 +125,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.get_protocol_options/index.html b/docs/en/ranch/1.6/manual/ranch.get_protocol_options/index.html index 5f359ab2..a94d3120 100644 --- a/docs/en/ranch/1.6/manual/ranch.get_protocol_options/index.html +++ b/docs/en/ranch/1.6/manual/ranch.get_protocol_options/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.get_status/index.html b/docs/en/ranch/1.6/manual/ranch.get_status/index.html index 15afa5b5..4d16fe5b 100644 --- a/docs/en/ranch/1.6/manual/ranch.get_status/index.html +++ b/docs/en/ranch/1.6/manual/ranch.get_status/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.get_transport_options/index.html b/docs/en/ranch/1.6/manual/ranch.get_transport_options/index.html index 77bba5de..f1922a6d 100644 --- a/docs/en/ranch/1.6/manual/ranch.get_transport_options/index.html +++ b/docs/en/ranch/1.6/manual/ranch.get_transport_options/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.handshake/index.html b/docs/en/ranch/1.6/manual/ranch.handshake/index.html index f189d8b2..cc10e8ec 100644 --- a/docs/en/ranch/1.6/manual/ranch.handshake/index.html +++ b/docs/en/ranch/1.6/manual/ranch.handshake/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.info/index.html b/docs/en/ranch/1.6/manual/ranch.info/index.html index 789aafe3..b558a783 100644 --- a/docs/en/ranch/1.6/manual/ranch.info/index.html +++ b/docs/en/ranch/1.6/manual/ranch.info/index.html @@ -172,6 +172,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.procs/index.html b/docs/en/ranch/1.6/manual/ranch.procs/index.html index b75f5946..c9cec102 100644 --- a/docs/en/ranch/1.6/manual/ranch.procs/index.html +++ b/docs/en/ranch/1.6/manual/ranch.procs/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.remove_connection/index.html b/docs/en/ranch/1.6/manual/ranch.remove_connection/index.html index ed6ef6c0..690ef2fc 100644 --- a/docs/en/ranch/1.6/manual/ranch.remove_connection/index.html +++ b/docs/en/ranch/1.6/manual/ranch.remove_connection/index.html @@ -125,6 +125,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.resume_listener/index.html b/docs/en/ranch/1.6/manual/ranch.resume_listener/index.html index fad54584..293a1242 100644 --- a/docs/en/ranch/1.6/manual/ranch.resume_listener/index.html +++ b/docs/en/ranch/1.6/manual/ranch.resume_listener/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.set_max_connections/index.html b/docs/en/ranch/1.6/manual/ranch.set_max_connections/index.html index 0eaefc31..9442ac8e 100644 --- a/docs/en/ranch/1.6/manual/ranch.set_max_connections/index.html +++ b/docs/en/ranch/1.6/manual/ranch.set_max_connections/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.set_protocol_options/index.html b/docs/en/ranch/1.6/manual/ranch.set_protocol_options/index.html index 16513804..25e5a6ff 100644 --- a/docs/en/ranch/1.6/manual/ranch.set_protocol_options/index.html +++ b/docs/en/ranch/1.6/manual/ranch.set_protocol_options/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.set_transport_options/index.html b/docs/en/ranch/1.6/manual/ranch.set_transport_options/index.html index d3777dfd..bae1b57a 100644 --- a/docs/en/ranch/1.6/manual/ranch.set_transport_options/index.html +++ b/docs/en/ranch/1.6/manual/ranch.set_transport_options/index.html @@ -134,6 +134,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.start_listener/index.html b/docs/en/ranch/1.6/manual/ranch.start_listener/index.html index a3e32aed..839396e5 100644 --- a/docs/en/ranch/1.6/manual/ranch.start_listener/index.html +++ b/docs/en/ranch/1.6/manual/ranch.start_listener/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.stop_listener/index.html b/docs/en/ranch/1.6/manual/ranch.stop_listener/index.html index 5b626d9b..21ebb589 100644 --- a/docs/en/ranch/1.6/manual/ranch.stop_listener/index.html +++ b/docs/en/ranch/1.6/manual/ranch.stop_listener/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.suspend_listener/index.html b/docs/en/ranch/1.6/manual/ranch.suspend_listener/index.html index baafc2b2..4daf90fd 100644 --- a/docs/en/ranch/1.6/manual/ranch.suspend_listener/index.html +++ b/docs/en/ranch/1.6/manual/ranch.suspend_listener/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch.wait_for_connections/index.html b/docs/en/ranch/1.6/manual/ranch.wait_for_connections/index.html index 372d67d2..2b7809fa 100644 --- a/docs/en/ranch/1.6/manual/ranch.wait_for_connections/index.html +++ b/docs/en/ranch/1.6/manual/ranch.wait_for_connections/index.html @@ -152,6 +152,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch/index.html b/docs/en/ranch/1.6/manual/ranch/index.html index bfa6a644..ce515858 100644 --- a/docs/en/ranch/1.6/manual/ranch/index.html +++ b/docs/en/ranch/1.6/manual/ranch/index.html @@ -235,6 +235,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch_app/index.html b/docs/en/ranch/1.6/manual/ranch_app/index.html index 57f75b25..77780257 100644 --- a/docs/en/ranch/1.6/manual/ranch_app/index.html +++ b/docs/en/ranch/1.6/manual/ranch_app/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch_protocol/index.html b/docs/en/ranch/1.6/manual/ranch_protocol/index.html index 26b0d32f..554e1840 100644 --- a/docs/en/ranch/1.6/manual/ranch_protocol/index.html +++ b/docs/en/ranch/1.6/manual/ranch_protocol/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch_ssl/index.html b/docs/en/ranch/1.6/manual/ranch_ssl/index.html index 481d618d..cfb110c5 100644 --- a/docs/en/ranch/1.6/manual/ranch_ssl/index.html +++ b/docs/en/ranch/1.6/manual/ranch_ssl/index.html @@ -276,6 +276,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch_tcp/index.html b/docs/en/ranch/1.6/manual/ranch_tcp/index.html index df34fa2f..602f135d 100644 --- a/docs/en/ranch/1.6/manual/ranch_tcp/index.html +++ b/docs/en/ranch/1.6/manual/ranch_tcp/index.html @@ -223,6 +223,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch_transport.sendfile/index.html b/docs/en/ranch/1.6/manual/ranch_transport.sendfile/index.html index 7a5a7733..d1bea0fa 100644 --- a/docs/en/ranch/1.6/manual/ranch_transport.sendfile/index.html +++ b/docs/en/ranch/1.6/manual/ranch_transport.sendfile/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.6/manual/ranch_transport/index.html b/docs/en/ranch/1.6/manual/ranch_transport/index.html index e05490b5..72842b53 100644 --- a/docs/en/ranch/1.6/manual/ranch_transport/index.html +++ b/docs/en/ranch/1.6/manual/ranch_transport/index.html @@ -324,6 +324,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/guide/embedded/index.html b/docs/en/ranch/1.7/guide/embedded/index.html index 5dd25f19..2afacf83 100644 --- a/docs/en/ranch/1.7/guide/embedded/index.html +++ b/docs/en/ranch/1.7/guide/embedded/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.7/guide/index.html b/docs/en/ranch/1.7/guide/index.html index 5839a43d..a0835fbc 100644 --- a/docs/en/ranch/1.7/guide/index.html +++ b/docs/en/ranch/1.7/guide/index.html @@ -130,6 +130,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.7/guide/internals/index.html b/docs/en/ranch/1.7/guide/internals/index.html index bc99bed7..dfd418d1 100644 --- a/docs/en/ranch/1.7/guide/internals/index.html +++ b/docs/en/ranch/1.7/guide/internals/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.7/guide/introduction/index.html b/docs/en/ranch/1.7/guide/introduction/index.html index 0b999320..c514931f 100644 --- a/docs/en/ranch/1.7/guide/introduction/index.html +++ b/docs/en/ranch/1.7/guide/introduction/index.html @@ -124,6 +124,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.7/guide/listeners/index.html b/docs/en/ranch/1.7/guide/listeners/index.html index 4fe02cc5..4a5a8762 100644 --- a/docs/en/ranch/1.7/guide/listeners/index.html +++ b/docs/en/ranch/1.7/guide/listeners/index.html @@ -360,6 +360,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.7/guide/migrating_from_1.5/index.html b/docs/en/ranch/1.7/guide/migrating_from_1.5/index.html index cc060777..24129b7a 100644 --- a/docs/en/ranch/1.7/guide/migrating_from_1.5/index.html +++ b/docs/en/ranch/1.7/guide/migrating_from_1.5/index.html @@ -160,6 +160,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.7/guide/migrating_from_1.6/index.html b/docs/en/ranch/1.7/guide/migrating_from_1.6/index.html index dc284a1a..7d3435e5 100644 --- a/docs/en/ranch/1.7/guide/migrating_from_1.6/index.html +++ b/docs/en/ranch/1.7/guide/migrating_from_1.6/index.html @@ -140,6 +140,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.7/guide/migrating_from_1.7/index.html b/docs/en/ranch/1.7/guide/migrating_from_1.7/index.html index 5a24ba05..0e7dff69 100644 --- a/docs/en/ranch/1.7/guide/migrating_from_1.7/index.html +++ b/docs/en/ranch/1.7/guide/migrating_from_1.7/index.html @@ -122,6 +122,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.7/guide/migrating_from_1.x/index.html b/docs/en/ranch/1.7/guide/migrating_from_1.x/index.html index 4b7d8330..cb5cacf0 100644 --- a/docs/en/ranch/1.7/guide/migrating_from_1.x/index.html +++ b/docs/en/ranch/1.7/guide/migrating_from_1.x/index.html @@ -213,6 +213,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.7/guide/parsers/index.html b/docs/en/ranch/1.7/guide/parsers/index.html index d48e4879..204aad05 100644 --- a/docs/en/ranch/1.7/guide/parsers/index.html +++ b/docs/en/ranch/1.7/guide/parsers/index.html @@ -180,6 +180,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.7/guide/protocols/index.html b/docs/en/ranch/1.7/guide/protocols/index.html index 128fec86..79b263e8 100644 --- a/docs/en/ranch/1.7/guide/protocols/index.html +++ b/docs/en/ranch/1.7/guide/protocols/index.html @@ -187,6 +187,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.7/guide/ssl_auth/index.html b/docs/en/ranch/1.7/guide/ssl_auth/index.html index 97ea5780..7c91a88e 100644 --- a/docs/en/ranch/1.7/guide/ssl_auth/index.html +++ b/docs/en/ranch/1.7/guide/ssl_auth/index.html @@ -193,6 +193,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.7/guide/transports/index.html b/docs/en/ranch/1.7/guide/transports/index.html index 9d0de945..06071789 100644 --- a/docs/en/ranch/1.7/guide/transports/index.html +++ b/docs/en/ranch/1.7/guide/transports/index.html @@ -227,6 +227,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.7/guide/upcoming_2.0_changes/index.html b/docs/en/ranch/1.7/guide/upcoming_2.0_changes/index.html index bc7a03d0..0dfbb6ba 100644 --- a/docs/en/ranch/1.7/guide/upcoming_2.0_changes/index.html +++ b/docs/en/ranch/1.7/guide/upcoming_2.0_changes/index.html @@ -134,6 +134,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/index.html b/docs/en/ranch/1.7/manual/index.html index d4e2d462..f95c5934 100644 --- a/docs/en/ranch/1.7/manual/index.html +++ b/docs/en/ranch/1.7/manual/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.child_spec/index.html b/docs/en/ranch/1.7/manual/ranch.child_spec/index.html index f6305510..f9e86acb 100644 --- a/docs/en/ranch/1.7/manual/ranch.child_spec/index.html +++ b/docs/en/ranch/1.7/manual/ranch.child_spec/index.html @@ -158,6 +158,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.get_addr/index.html b/docs/en/ranch/1.7/manual/ranch.get_addr/index.html index 9f6f3fe3..1b7fa3f7 100644 --- a/docs/en/ranch/1.7/manual/ranch.get_addr/index.html +++ b/docs/en/ranch/1.7/manual/ranch.get_addr/index.html @@ -126,6 +126,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.get_max_connections/index.html b/docs/en/ranch/1.7/manual/ranch.get_max_connections/index.html index afa526df..f6266b70 100644 --- a/docs/en/ranch/1.7/manual/ranch.get_max_connections/index.html +++ b/docs/en/ranch/1.7/manual/ranch.get_max_connections/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.get_port/index.html b/docs/en/ranch/1.7/manual/ranch.get_port/index.html index ad90662c..868a6c54 100644 --- a/docs/en/ranch/1.7/manual/ranch.get_port/index.html +++ b/docs/en/ranch/1.7/manual/ranch.get_port/index.html @@ -125,6 +125,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.get_protocol_options/index.html b/docs/en/ranch/1.7/manual/ranch.get_protocol_options/index.html index 67a3a182..4cfb9788 100644 --- a/docs/en/ranch/1.7/manual/ranch.get_protocol_options/index.html +++ b/docs/en/ranch/1.7/manual/ranch.get_protocol_options/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.get_status/index.html b/docs/en/ranch/1.7/manual/ranch.get_status/index.html index 3eaa690c..f8de1bad 100644 --- a/docs/en/ranch/1.7/manual/ranch.get_status/index.html +++ b/docs/en/ranch/1.7/manual/ranch.get_status/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.get_transport_options/index.html b/docs/en/ranch/1.7/manual/ranch.get_transport_options/index.html index 041b7179..8ba18274 100644 --- a/docs/en/ranch/1.7/manual/ranch.get_transport_options/index.html +++ b/docs/en/ranch/1.7/manual/ranch.get_transport_options/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.handshake/index.html b/docs/en/ranch/1.7/manual/ranch.handshake/index.html index 3628bb4a..39a51887 100644 --- a/docs/en/ranch/1.7/manual/ranch.handshake/index.html +++ b/docs/en/ranch/1.7/manual/ranch.handshake/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.info/index.html b/docs/en/ranch/1.7/manual/ranch.info/index.html index 583c29cd..b87a1cb4 100644 --- a/docs/en/ranch/1.7/manual/ranch.info/index.html +++ b/docs/en/ranch/1.7/manual/ranch.info/index.html @@ -172,6 +172,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.procs/index.html b/docs/en/ranch/1.7/manual/ranch.procs/index.html index 7f961e9f..7728788c 100644 --- a/docs/en/ranch/1.7/manual/ranch.procs/index.html +++ b/docs/en/ranch/1.7/manual/ranch.procs/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.recv_proxy_header/index.html b/docs/en/ranch/1.7/manual/ranch.recv_proxy_header/index.html index 0f496439..a6092d9d 100644 --- a/docs/en/ranch/1.7/manual/ranch.recv_proxy_header/index.html +++ b/docs/en/ranch/1.7/manual/ranch.recv_proxy_header/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.remove_connection/index.html b/docs/en/ranch/1.7/manual/ranch.remove_connection/index.html index 19c60b4b..f7cd3ac8 100644 --- a/docs/en/ranch/1.7/manual/ranch.remove_connection/index.html +++ b/docs/en/ranch/1.7/manual/ranch.remove_connection/index.html @@ -125,6 +125,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.resume_listener/index.html b/docs/en/ranch/1.7/manual/ranch.resume_listener/index.html index ce189c54..015154bb 100644 --- a/docs/en/ranch/1.7/manual/ranch.resume_listener/index.html +++ b/docs/en/ranch/1.7/manual/ranch.resume_listener/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.set_max_connections/index.html b/docs/en/ranch/1.7/manual/ranch.set_max_connections/index.html index b48fd607..f7eedb5d 100644 --- a/docs/en/ranch/1.7/manual/ranch.set_max_connections/index.html +++ b/docs/en/ranch/1.7/manual/ranch.set_max_connections/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.set_protocol_options/index.html b/docs/en/ranch/1.7/manual/ranch.set_protocol_options/index.html index 1842a44b..f2586178 100644 --- a/docs/en/ranch/1.7/manual/ranch.set_protocol_options/index.html +++ b/docs/en/ranch/1.7/manual/ranch.set_protocol_options/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.set_transport_options/index.html b/docs/en/ranch/1.7/manual/ranch.set_transport_options/index.html index ecc73d32..6a255011 100644 --- a/docs/en/ranch/1.7/manual/ranch.set_transport_options/index.html +++ b/docs/en/ranch/1.7/manual/ranch.set_transport_options/index.html @@ -134,6 +134,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.start_listener/index.html b/docs/en/ranch/1.7/manual/ranch.start_listener/index.html index 6302dff0..ae575e19 100644 --- a/docs/en/ranch/1.7/manual/ranch.start_listener/index.html +++ b/docs/en/ranch/1.7/manual/ranch.start_listener/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.stop_listener/index.html b/docs/en/ranch/1.7/manual/ranch.stop_listener/index.html index bbcdb941..aa3ef71d 100644 --- a/docs/en/ranch/1.7/manual/ranch.stop_listener/index.html +++ b/docs/en/ranch/1.7/manual/ranch.stop_listener/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.suspend_listener/index.html b/docs/en/ranch/1.7/manual/ranch.suspend_listener/index.html index 4ff419f6..3859773e 100644 --- a/docs/en/ranch/1.7/manual/ranch.suspend_listener/index.html +++ b/docs/en/ranch/1.7/manual/ranch.suspend_listener/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch.wait_for_connections/index.html b/docs/en/ranch/1.7/manual/ranch.wait_for_connections/index.html index a3a57116..46b3f72f 100644 --- a/docs/en/ranch/1.7/manual/ranch.wait_for_connections/index.html +++ b/docs/en/ranch/1.7/manual/ranch.wait_for_connections/index.html @@ -152,6 +152,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch/index.html b/docs/en/ranch/1.7/manual/ranch/index.html index a577211b..22daf9b2 100644 --- a/docs/en/ranch/1.7/manual/ranch/index.html +++ b/docs/en/ranch/1.7/manual/ranch/index.html @@ -237,6 +237,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch_app/index.html b/docs/en/ranch/1.7/manual/ranch_app/index.html index 4bd7b427..b9fd822c 100644 --- a/docs/en/ranch/1.7/manual/ranch_app/index.html +++ b/docs/en/ranch/1.7/manual/ranch_app/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch_protocol/index.html b/docs/en/ranch/1.7/manual/ranch_protocol/index.html index 5b79f699..75f9a32a 100644 --- a/docs/en/ranch/1.7/manual/ranch_protocol/index.html +++ b/docs/en/ranch/1.7/manual/ranch_protocol/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch_proxy_header.header/index.html b/docs/en/ranch/1.7/manual/ranch_proxy_header.header/index.html index 2f306c77..c7533c14 100644 --- a/docs/en/ranch/1.7/manual/ranch_proxy_header.header/index.html +++ b/docs/en/ranch/1.7/manual/ranch_proxy_header.header/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch_proxy_header.parse/index.html b/docs/en/ranch/1.7/manual/ranch_proxy_header.parse/index.html index eccc375b..296c2c21 100644 --- a/docs/en/ranch/1.7/manual/ranch_proxy_header.parse/index.html +++ b/docs/en/ranch/1.7/manual/ranch_proxy_header.parse/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch_proxy_header/index.html b/docs/en/ranch/1.7/manual/ranch_proxy_header/index.html index 091dff66..832e6f8a 100644 --- a/docs/en/ranch/1.7/manual/ranch_proxy_header/index.html +++ b/docs/en/ranch/1.7/manual/ranch_proxy_header/index.html @@ -213,6 +213,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch_ssl/index.html b/docs/en/ranch/1.7/manual/ranch_ssl/index.html index caa6b64c..2a4c2692 100644 --- a/docs/en/ranch/1.7/manual/ranch_ssl/index.html +++ b/docs/en/ranch/1.7/manual/ranch_ssl/index.html @@ -276,6 +276,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch_tcp/index.html b/docs/en/ranch/1.7/manual/ranch_tcp/index.html index ab67bba9..66f21281 100644 --- a/docs/en/ranch/1.7/manual/ranch_tcp/index.html +++ b/docs/en/ranch/1.7/manual/ranch_tcp/index.html @@ -223,6 +223,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch_transport.sendfile/index.html b/docs/en/ranch/1.7/manual/ranch_transport.sendfile/index.html index 65e71062..aebf7cc3 100644 --- a/docs/en/ranch/1.7/manual/ranch_transport.sendfile/index.html +++ b/docs/en/ranch/1.7/manual/ranch_transport.sendfile/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.7/manual/ranch_transport/index.html b/docs/en/ranch/1.7/manual/ranch_transport/index.html index 345d6226..c09541ee 100644 --- a/docs/en/ranch/1.7/manual/ranch_transport/index.html +++ b/docs/en/ranch/1.7/manual/ranch_transport/index.html @@ -324,6 +324,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/guide/embedded/index.html b/docs/en/ranch/1.8/guide/embedded/index.html index d6f7ead4..991dca65 100644 --- a/docs/en/ranch/1.8/guide/embedded/index.html +++ b/docs/en/ranch/1.8/guide/embedded/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.8/guide/index.html b/docs/en/ranch/1.8/guide/index.html index c82543ed..eaff8088 100644 --- a/docs/en/ranch/1.8/guide/index.html +++ b/docs/en/ranch/1.8/guide/index.html @@ -86,6 +86,8 @@ <h2 id="_additional_information">Additional information</h2> <ul><li><a href="upcoming_2.0_changes/">Upcoming changes in Ranch 2.0</a> </li> +<li><a href="migrating_from_1.8/">Changes since Ranch 1.8</a> +</li> <li><a href="migrating_from_1.7/">Migrating from Ranch 1.7 to 1.8</a> </li> <li><a href="migrating_from_1.6/">Migrating from Ranch 1.6 to 1.7</a> @@ -130,6 +132,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.8/guide/internals/index.html b/docs/en/ranch/1.8/guide/internals/index.html index d93bcb13..fd01e4a4 100644 --- a/docs/en/ranch/1.8/guide/internals/index.html +++ b/docs/en/ranch/1.8/guide/internals/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.8/guide/introduction/index.html b/docs/en/ranch/1.8/guide/introduction/index.html index bf167bf1..4b253a4f 100644 --- a/docs/en/ranch/1.8/guide/introduction/index.html +++ b/docs/en/ranch/1.8/guide/introduction/index.html @@ -124,6 +124,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.8/guide/listeners/index.html b/docs/en/ranch/1.8/guide/listeners/index.html index 2ab59962..9c8975ba 100644 --- a/docs/en/ranch/1.8/guide/listeners/index.html +++ b/docs/en/ranch/1.8/guide/listeners/index.html @@ -360,6 +360,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.8/guide/migrating_from_1.5/index.html b/docs/en/ranch/1.8/guide/migrating_from_1.5/index.html index bdbf2f5f..4bc36d80 100644 --- a/docs/en/ranch/1.8/guide/migrating_from_1.5/index.html +++ b/docs/en/ranch/1.8/guide/migrating_from_1.5/index.html @@ -160,6 +160,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.8/guide/migrating_from_1.6/index.html b/docs/en/ranch/1.8/guide/migrating_from_1.6/index.html index 3394392e..cccc360a 100644 --- a/docs/en/ranch/1.8/guide/migrating_from_1.6/index.html +++ b/docs/en/ranch/1.8/guide/migrating_from_1.6/index.html @@ -140,6 +140,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.8/guide/migrating_from_1.7/index.html b/docs/en/ranch/1.8/guide/migrating_from_1.7/index.html index acccf377..e134d1c2 100644 --- a/docs/en/ranch/1.8/guide/migrating_from_1.7/index.html +++ b/docs/en/ranch/1.8/guide/migrating_from_1.7/index.html @@ -80,8 +80,8 @@ <nav style="margin:1em 0"> - <a style="float:left" href="https://ninenines.eu/docs/en/ranch/1.8/guide/upcoming_2.0_changes/"> - Upcoming changes in Ranch 2.0 + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.8/"> + Changes since Ranch 1.8 </a> @@ -124,6 +124,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.8/guide/migrating_from_1.8.asciidoc b/docs/en/ranch/1.8/guide/migrating_from_1.8.asciidoc new file mode 100644 index 00000000..1d35333b --- /dev/null +++ b/docs/en/ranch/1.8/guide/migrating_from_1.8.asciidoc @@ -0,0 +1,14 @@ +[appendix] +== Changes since Ranch 1.8 + +Ranch 1.8 is the last Ranch 1.x release series. Only compatibility +fixes are to be released moving forward. Support for Ranch 1.8 +will be discontinued when Cowboy 3.0 is released. + +The following patch releases have been issued: + +=== Ranch 1.8.1 + +* Fix `ranch:recv_proxy_header/2` for the upcoming Erlang/OTP 28. + +* Erlang.mk has been updated. diff --git a/docs/en/ranch/1.8/guide/migrating_from_1.8/index.html b/docs/en/ranch/1.8/guide/migrating_from_1.8/index.html new file mode 100644 index 00000000..5f6dfe53 --- /dev/null +++ b/docs/en/ranch/1.8/guide/migrating_from_1.8/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: Changes since Ranch 1.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>Changes since Ranch 1.8</span></h1> + +<p>Ranch 1.8 is the last Ranch 1.x release series. Only compatibility fixes are to be released moving forward. Support for Ranch 1.8 will be discontinued when Cowboy 3.0 is released.</p> +<p>The following patch releases have been issued:</p> +<h2 id="_ranch_1_8_1">Ranch 1.8.1</h2> +<ul><li>Fix <code>ranch:recv_proxy_header/2</code> for the upcoming Erlang/OTP 28. +</li> +<li>Erlang.mk has been updated. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/1.8/guide/upcoming_2.0_changes/"> + Upcoming changes in Ranch 2.0 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.7/"> + Migrating from Ranch 1.7 to 1.8 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 1.8 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/1.8/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/1.8/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/1.8/guide/migrating_from_1.x/index.html b/docs/en/ranch/1.8/guide/migrating_from_1.x/index.html index b0c5c024..a8efc3a7 100644 --- a/docs/en/ranch/1.8/guide/migrating_from_1.x/index.html +++ b/docs/en/ranch/1.8/guide/migrating_from_1.x/index.html @@ -213,6 +213,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.8/guide/parsers/index.html b/docs/en/ranch/1.8/guide/parsers/index.html index 81387c89..feb16af1 100644 --- a/docs/en/ranch/1.8/guide/parsers/index.html +++ b/docs/en/ranch/1.8/guide/parsers/index.html @@ -180,6 +180,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.8/guide/protocols/index.html b/docs/en/ranch/1.8/guide/protocols/index.html index 47ffd4cc..1d45f73b 100644 --- a/docs/en/ranch/1.8/guide/protocols/index.html +++ b/docs/en/ranch/1.8/guide/protocols/index.html @@ -187,6 +187,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.8/guide/ssl_auth/index.html b/docs/en/ranch/1.8/guide/ssl_auth/index.html index 58a521c2..189202e0 100644 --- a/docs/en/ranch/1.8/guide/ssl_auth/index.html +++ b/docs/en/ranch/1.8/guide/ssl_auth/index.html @@ -193,6 +193,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.8/guide/transports/index.html b/docs/en/ranch/1.8/guide/transports/index.html index 6cfecf5a..c237a648 100644 --- a/docs/en/ranch/1.8/guide/transports/index.html +++ b/docs/en/ranch/1.8/guide/transports/index.html @@ -227,6 +227,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.8/guide/upcoming_2.0_changes/index.html b/docs/en/ranch/1.8/guide/upcoming_2.0_changes/index.html index 270ac82a..347122a4 100644 --- a/docs/en/ranch/1.8/guide/upcoming_2.0_changes/index.html +++ b/docs/en/ranch/1.8/guide/upcoming_2.0_changes/index.html @@ -96,8 +96,8 @@ - <a style="float:right" href="https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.7/"> - Migrating from Ranch 1.7 to 1.8 + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.8/"> + Changes since Ranch 1.8 </a> </nav> @@ -134,6 +134,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/index.html b/docs/en/ranch/1.8/manual/index.html index 31844ae2..098c3e73 100644 --- a/docs/en/ranch/1.8/manual/index.html +++ b/docs/en/ranch/1.8/manual/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.child_spec/index.html b/docs/en/ranch/1.8/manual/ranch.child_spec/index.html index 6c898ec7..b3cedec6 100644 --- a/docs/en/ranch/1.8/manual/ranch.child_spec/index.html +++ b/docs/en/ranch/1.8/manual/ranch.child_spec/index.html @@ -158,6 +158,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.get_addr/index.html b/docs/en/ranch/1.8/manual/ranch.get_addr/index.html index 5f1fcf8b..4483be71 100644 --- a/docs/en/ranch/1.8/manual/ranch.get_addr/index.html +++ b/docs/en/ranch/1.8/manual/ranch.get_addr/index.html @@ -126,6 +126,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.get_max_connections/index.html b/docs/en/ranch/1.8/manual/ranch.get_max_connections/index.html index 643acbf0..8898ab83 100644 --- a/docs/en/ranch/1.8/manual/ranch.get_max_connections/index.html +++ b/docs/en/ranch/1.8/manual/ranch.get_max_connections/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.get_port/index.html b/docs/en/ranch/1.8/manual/ranch.get_port/index.html index 5e120b44..f860852d 100644 --- a/docs/en/ranch/1.8/manual/ranch.get_port/index.html +++ b/docs/en/ranch/1.8/manual/ranch.get_port/index.html @@ -125,6 +125,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.get_protocol_options/index.html b/docs/en/ranch/1.8/manual/ranch.get_protocol_options/index.html index 104ac71e..b09431cf 100644 --- a/docs/en/ranch/1.8/manual/ranch.get_protocol_options/index.html +++ b/docs/en/ranch/1.8/manual/ranch.get_protocol_options/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.get_status/index.html b/docs/en/ranch/1.8/manual/ranch.get_status/index.html index e40e3fdd..640db87b 100644 --- a/docs/en/ranch/1.8/manual/ranch.get_status/index.html +++ b/docs/en/ranch/1.8/manual/ranch.get_status/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.get_transport_options/index.html b/docs/en/ranch/1.8/manual/ranch.get_transport_options/index.html index f471a069..c67551f4 100644 --- a/docs/en/ranch/1.8/manual/ranch.get_transport_options/index.html +++ b/docs/en/ranch/1.8/manual/ranch.get_transport_options/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.handshake/index.html b/docs/en/ranch/1.8/manual/ranch.handshake/index.html index 5ee0971f..d7d10f1f 100644 --- a/docs/en/ranch/1.8/manual/ranch.handshake/index.html +++ b/docs/en/ranch/1.8/manual/ranch.handshake/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.info/index.html b/docs/en/ranch/1.8/manual/ranch.info/index.html index 2fbdd93b..d270a6db 100644 --- a/docs/en/ranch/1.8/manual/ranch.info/index.html +++ b/docs/en/ranch/1.8/manual/ranch.info/index.html @@ -172,6 +172,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.procs/index.html b/docs/en/ranch/1.8/manual/ranch.procs/index.html index f0c36daf..dc0507e7 100644 --- a/docs/en/ranch/1.8/manual/ranch.procs/index.html +++ b/docs/en/ranch/1.8/manual/ranch.procs/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.recv_proxy_header/index.html b/docs/en/ranch/1.8/manual/ranch.recv_proxy_header/index.html index e2c4bc7e..acec42b3 100644 --- a/docs/en/ranch/1.8/manual/ranch.recv_proxy_header/index.html +++ b/docs/en/ranch/1.8/manual/ranch.recv_proxy_header/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.remove_connection/index.html b/docs/en/ranch/1.8/manual/ranch.remove_connection/index.html index 21a1c861..eb1d9dcc 100644 --- a/docs/en/ranch/1.8/manual/ranch.remove_connection/index.html +++ b/docs/en/ranch/1.8/manual/ranch.remove_connection/index.html @@ -125,6 +125,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.resume_listener/index.html b/docs/en/ranch/1.8/manual/ranch.resume_listener/index.html index 2df61ee8..95d5403b 100644 --- a/docs/en/ranch/1.8/manual/ranch.resume_listener/index.html +++ b/docs/en/ranch/1.8/manual/ranch.resume_listener/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.set_max_connections/index.html b/docs/en/ranch/1.8/manual/ranch.set_max_connections/index.html index 6fd8b92d..7c549aa0 100644 --- a/docs/en/ranch/1.8/manual/ranch.set_max_connections/index.html +++ b/docs/en/ranch/1.8/manual/ranch.set_max_connections/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.set_protocol_options/index.html b/docs/en/ranch/1.8/manual/ranch.set_protocol_options/index.html index 64197f21..024a49fd 100644 --- a/docs/en/ranch/1.8/manual/ranch.set_protocol_options/index.html +++ b/docs/en/ranch/1.8/manual/ranch.set_protocol_options/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.set_transport_options/index.html b/docs/en/ranch/1.8/manual/ranch.set_transport_options/index.html index 14912266..070ad581 100644 --- a/docs/en/ranch/1.8/manual/ranch.set_transport_options/index.html +++ b/docs/en/ranch/1.8/manual/ranch.set_transport_options/index.html @@ -134,6 +134,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.start_listener/index.html b/docs/en/ranch/1.8/manual/ranch.start_listener/index.html index 91699416..a1a32ee5 100644 --- a/docs/en/ranch/1.8/manual/ranch.start_listener/index.html +++ b/docs/en/ranch/1.8/manual/ranch.start_listener/index.html @@ -183,6 +183,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.stop_listener/index.html b/docs/en/ranch/1.8/manual/ranch.stop_listener/index.html index 276adfc7..91e73a1b 100644 --- a/docs/en/ranch/1.8/manual/ranch.stop_listener/index.html +++ b/docs/en/ranch/1.8/manual/ranch.stop_listener/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.suspend_listener/index.html b/docs/en/ranch/1.8/manual/ranch.suspend_listener/index.html index a7b69e21..d751ad6b 100644 --- a/docs/en/ranch/1.8/manual/ranch.suspend_listener/index.html +++ b/docs/en/ranch/1.8/manual/ranch.suspend_listener/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch.wait_for_connections/index.html b/docs/en/ranch/1.8/manual/ranch.wait_for_connections/index.html index f659fb2b..14000e31 100644 --- a/docs/en/ranch/1.8/manual/ranch.wait_for_connections/index.html +++ b/docs/en/ranch/1.8/manual/ranch.wait_for_connections/index.html @@ -152,6 +152,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch/index.html b/docs/en/ranch/1.8/manual/ranch/index.html index 24c23ec5..4e59049b 100644 --- a/docs/en/ranch/1.8/manual/ranch/index.html +++ b/docs/en/ranch/1.8/manual/ranch/index.html @@ -237,6 +237,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch_app/index.html b/docs/en/ranch/1.8/manual/ranch_app/index.html index 172268c3..8d5f3490 100644 --- a/docs/en/ranch/1.8/manual/ranch_app/index.html +++ b/docs/en/ranch/1.8/manual/ranch_app/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch_protocol/index.html b/docs/en/ranch/1.8/manual/ranch_protocol/index.html index 2ee6f15e..1121259b 100644 --- a/docs/en/ranch/1.8/manual/ranch_protocol/index.html +++ b/docs/en/ranch/1.8/manual/ranch_protocol/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch_proxy_header.header/index.html b/docs/en/ranch/1.8/manual/ranch_proxy_header.header/index.html index 5fe6015c..19b43e6f 100644 --- a/docs/en/ranch/1.8/manual/ranch_proxy_header.header/index.html +++ b/docs/en/ranch/1.8/manual/ranch_proxy_header.header/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch_proxy_header.parse/index.html b/docs/en/ranch/1.8/manual/ranch_proxy_header.parse/index.html index 430193ee..0caa8469 100644 --- a/docs/en/ranch/1.8/manual/ranch_proxy_header.parse/index.html +++ b/docs/en/ranch/1.8/manual/ranch_proxy_header.parse/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch_proxy_header/index.html b/docs/en/ranch/1.8/manual/ranch_proxy_header/index.html index c3fe8290..51f71888 100644 --- a/docs/en/ranch/1.8/manual/ranch_proxy_header/index.html +++ b/docs/en/ranch/1.8/manual/ranch_proxy_header/index.html @@ -213,6 +213,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch_ssl/index.html b/docs/en/ranch/1.8/manual/ranch_ssl/index.html index 0e7a2218..bd625d46 100644 --- a/docs/en/ranch/1.8/manual/ranch_ssl/index.html +++ b/docs/en/ranch/1.8/manual/ranch_ssl/index.html @@ -276,6 +276,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch_tcp/index.html b/docs/en/ranch/1.8/manual/ranch_tcp/index.html index 21254576..6eb612c2 100644 --- a/docs/en/ranch/1.8/manual/ranch_tcp/index.html +++ b/docs/en/ranch/1.8/manual/ranch_tcp/index.html @@ -223,6 +223,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch_transport.sendfile/index.html b/docs/en/ranch/1.8/manual/ranch_transport.sendfile/index.html index 773d2c47..9565703b 100644 --- a/docs/en/ranch/1.8/manual/ranch_transport.sendfile/index.html +++ b/docs/en/ranch/1.8/manual/ranch_transport.sendfile/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/1.8/manual/ranch_transport/index.html b/docs/en/ranch/1.8/manual/ranch_transport/index.html index 09ccf115..3e4df415 100644 --- a/docs/en/ranch/1.8/manual/ranch_transport/index.html +++ b/docs/en/ranch/1.8/manual/ranch_transport/index.html @@ -324,6 +324,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/guide/connection_draining/index.html b/docs/en/ranch/2.0/guide/connection_draining/index.html index 9def9e6f..25ea8cf6 100644 --- a/docs/en/ranch/2.0/guide/connection_draining/index.html +++ b/docs/en/ranch/2.0/guide/connection_draining/index.html @@ -197,6 +197,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.0/guide/embedded/index.html b/docs/en/ranch/2.0/guide/embedded/index.html index becf723b..7cdf062d 100644 --- a/docs/en/ranch/2.0/guide/embedded/index.html +++ b/docs/en/ranch/2.0/guide/embedded/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.0/guide/index.html b/docs/en/ranch/2.0/guide/index.html index 289e53e4..77952453 100644 --- a/docs/en/ranch/2.0/guide/index.html +++ b/docs/en/ranch/2.0/guide/index.html @@ -130,6 +130,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.0/guide/internals/index.html b/docs/en/ranch/2.0/guide/internals/index.html index 54d73033..f2d3f6d8 100644 --- a/docs/en/ranch/2.0/guide/internals/index.html +++ b/docs/en/ranch/2.0/guide/internals/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.0/guide/introduction/index.html b/docs/en/ranch/2.0/guide/introduction/index.html index 9822c216..f9f8bd47 100644 --- a/docs/en/ranch/2.0/guide/introduction/index.html +++ b/docs/en/ranch/2.0/guide/introduction/index.html @@ -124,6 +124,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.0/guide/listeners/index.html b/docs/en/ranch/2.0/guide/listeners/index.html index 1b39dff2..2a503ad9 100644 --- a/docs/en/ranch/2.0/guide/listeners/index.html +++ b/docs/en/ranch/2.0/guide/listeners/index.html @@ -387,6 +387,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.0/guide/migrating_from_1.5/index.html b/docs/en/ranch/2.0/guide/migrating_from_1.5/index.html index 23e50d07..94d57e19 100644 --- a/docs/en/ranch/2.0/guide/migrating_from_1.5/index.html +++ b/docs/en/ranch/2.0/guide/migrating_from_1.5/index.html @@ -160,6 +160,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.0/guide/migrating_from_1.6/index.html b/docs/en/ranch/2.0/guide/migrating_from_1.6/index.html index 91b714f6..49d1247b 100644 --- a/docs/en/ranch/2.0/guide/migrating_from_1.6/index.html +++ b/docs/en/ranch/2.0/guide/migrating_from_1.6/index.html @@ -140,6 +140,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.0/guide/migrating_from_1.7/index.html b/docs/en/ranch/2.0/guide/migrating_from_1.7/index.html index 346a852f..2c0b1220 100644 --- a/docs/en/ranch/2.0/guide/migrating_from_1.7/index.html +++ b/docs/en/ranch/2.0/guide/migrating_from_1.7/index.html @@ -197,6 +197,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.0/guide/migrating_from_1.x/index.html b/docs/en/ranch/2.0/guide/migrating_from_1.x/index.html index 6d335a44..9fdb4bec 100644 --- a/docs/en/ranch/2.0/guide/migrating_from_1.x/index.html +++ b/docs/en/ranch/2.0/guide/migrating_from_1.x/index.html @@ -213,6 +213,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.0/guide/parsers/index.html b/docs/en/ranch/2.0/guide/parsers/index.html index acab0d26..02b56a75 100644 --- a/docs/en/ranch/2.0/guide/parsers/index.html +++ b/docs/en/ranch/2.0/guide/parsers/index.html @@ -180,6 +180,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.0/guide/protocols/index.html b/docs/en/ranch/2.0/guide/protocols/index.html index e7f5e27b..dd06eaee 100644 --- a/docs/en/ranch/2.0/guide/protocols/index.html +++ b/docs/en/ranch/2.0/guide/protocols/index.html @@ -187,6 +187,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.0/guide/ssl_auth/index.html b/docs/en/ranch/2.0/guide/ssl_auth/index.html index 29dbbf79..10b15a24 100644 --- a/docs/en/ranch/2.0/guide/ssl_auth/index.html +++ b/docs/en/ranch/2.0/guide/ssl_auth/index.html @@ -193,6 +193,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.0/guide/transports/index.html b/docs/en/ranch/2.0/guide/transports/index.html index d9187a3a..1a36a4e7 100644 --- a/docs/en/ranch/2.0/guide/transports/index.html +++ b/docs/en/ranch/2.0/guide/transports/index.html @@ -227,6 +227,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/index.html b/docs/en/ranch/2.0/manual/index.html index 296ab813..f85e2825 100644 --- a/docs/en/ranch/2.0/manual/index.html +++ b/docs/en/ranch/2.0/manual/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.child_spec/index.html b/docs/en/ranch/2.0/manual/ranch.child_spec/index.html index bab110c3..9e054545 100644 --- a/docs/en/ranch/2.0/manual/ranch.child_spec/index.html +++ b/docs/en/ranch/2.0/manual/ranch.child_spec/index.html @@ -162,6 +162,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.get_addr/index.html b/docs/en/ranch/2.0/manual/ranch.get_addr/index.html index dd3cb61a..84427adc 100644 --- a/docs/en/ranch/2.0/manual/ranch.get_addr/index.html +++ b/docs/en/ranch/2.0/manual/ranch.get_addr/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.get_max_connections/index.html b/docs/en/ranch/2.0/manual/ranch.get_max_connections/index.html index 4367c2f9..ae4e79c3 100644 --- a/docs/en/ranch/2.0/manual/ranch.get_max_connections/index.html +++ b/docs/en/ranch/2.0/manual/ranch.get_max_connections/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.get_port/index.html b/docs/en/ranch/2.0/manual/ranch.get_port/index.html index e37956bb..65d4c45e 100644 --- a/docs/en/ranch/2.0/manual/ranch.get_port/index.html +++ b/docs/en/ranch/2.0/manual/ranch.get_port/index.html @@ -126,6 +126,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.get_protocol_options/index.html b/docs/en/ranch/2.0/manual/ranch.get_protocol_options/index.html index eccef365..0603c17a 100644 --- a/docs/en/ranch/2.0/manual/ranch.get_protocol_options/index.html +++ b/docs/en/ranch/2.0/manual/ranch.get_protocol_options/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.get_status/index.html b/docs/en/ranch/2.0/manual/ranch.get_status/index.html index 4663780a..b7d0833b 100644 --- a/docs/en/ranch/2.0/manual/ranch.get_status/index.html +++ b/docs/en/ranch/2.0/manual/ranch.get_status/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.get_transport_options/index.html b/docs/en/ranch/2.0/manual/ranch.get_transport_options/index.html index 01072ae3..aa52fcc4 100644 --- a/docs/en/ranch/2.0/manual/ranch.get_transport_options/index.html +++ b/docs/en/ranch/2.0/manual/ranch.get_transport_options/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.handshake/index.html b/docs/en/ranch/2.0/manual/ranch.handshake/index.html index decc5fec..6304a727 100644 --- a/docs/en/ranch/2.0/manual/ranch.handshake/index.html +++ b/docs/en/ranch/2.0/manual/ranch.handshake/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.handshake_cancel/index.html b/docs/en/ranch/2.0/manual/ranch.handshake_cancel/index.html index 5b012e6e..e060f503 100644 --- a/docs/en/ranch/2.0/manual/ranch.handshake_cancel/index.html +++ b/docs/en/ranch/2.0/manual/ranch.handshake_cancel/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.handshake_continue/index.html b/docs/en/ranch/2.0/manual/ranch.handshake_continue/index.html index 35c1c46c..2026cd1d 100644 --- a/docs/en/ranch/2.0/manual/ranch.handshake_continue/index.html +++ b/docs/en/ranch/2.0/manual/ranch.handshake_continue/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.info/index.html b/docs/en/ranch/2.0/manual/ranch.info/index.html index c8cbcf4d..321a8a40 100644 --- a/docs/en/ranch/2.0/manual/ranch.info/index.html +++ b/docs/en/ranch/2.0/manual/ranch.info/index.html @@ -173,6 +173,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.procs/index.html b/docs/en/ranch/2.0/manual/ranch.procs/index.html index 25f701a3..268087af 100644 --- a/docs/en/ranch/2.0/manual/ranch.procs/index.html +++ b/docs/en/ranch/2.0/manual/ranch.procs/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.recv_proxy_header/index.html b/docs/en/ranch/2.0/manual/ranch.recv_proxy_header/index.html index cfc0add7..7d0e2a6d 100644 --- a/docs/en/ranch/2.0/manual/ranch.recv_proxy_header/index.html +++ b/docs/en/ranch/2.0/manual/ranch.recv_proxy_header/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.remove_connection/index.html b/docs/en/ranch/2.0/manual/ranch.remove_connection/index.html index ad0541bb..000e754e 100644 --- a/docs/en/ranch/2.0/manual/ranch.remove_connection/index.html +++ b/docs/en/ranch/2.0/manual/ranch.remove_connection/index.html @@ -125,6 +125,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.resume_listener/index.html b/docs/en/ranch/2.0/manual/ranch.resume_listener/index.html index 39ba4aee..6ebcd7b8 100644 --- a/docs/en/ranch/2.0/manual/ranch.resume_listener/index.html +++ b/docs/en/ranch/2.0/manual/ranch.resume_listener/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.set_max_connections/index.html b/docs/en/ranch/2.0/manual/ranch.set_max_connections/index.html index 69c6528f..8464797e 100644 --- a/docs/en/ranch/2.0/manual/ranch.set_max_connections/index.html +++ b/docs/en/ranch/2.0/manual/ranch.set_max_connections/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.set_protocol_options/index.html b/docs/en/ranch/2.0/manual/ranch.set_protocol_options/index.html index 7c0a136f..44b92926 100644 --- a/docs/en/ranch/2.0/manual/ranch.set_protocol_options/index.html +++ b/docs/en/ranch/2.0/manual/ranch.set_protocol_options/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.set_transport_options/index.html b/docs/en/ranch/2.0/manual/ranch.set_transport_options/index.html index 432b1db0..3841eb1c 100644 --- a/docs/en/ranch/2.0/manual/ranch.set_transport_options/index.html +++ b/docs/en/ranch/2.0/manual/ranch.set_transport_options/index.html @@ -168,6 +168,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.start_listener/index.html b/docs/en/ranch/2.0/manual/ranch.start_listener/index.html index e62d744d..63519607 100644 --- a/docs/en/ranch/2.0/manual/ranch.start_listener/index.html +++ b/docs/en/ranch/2.0/manual/ranch.start_listener/index.html @@ -185,6 +185,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.stop_listener/index.html b/docs/en/ranch/2.0/manual/ranch.stop_listener/index.html index 0234ec25..f99be14f 100644 --- a/docs/en/ranch/2.0/manual/ranch.stop_listener/index.html +++ b/docs/en/ranch/2.0/manual/ranch.stop_listener/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.suspend_listener/index.html b/docs/en/ranch/2.0/manual/ranch.suspend_listener/index.html index 558bde1d..2001aa97 100644 --- a/docs/en/ranch/2.0/manual/ranch.suspend_listener/index.html +++ b/docs/en/ranch/2.0/manual/ranch.suspend_listener/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch.wait_for_connections/index.html b/docs/en/ranch/2.0/manual/ranch.wait_for_connections/index.html index d765f21b..3586f23d 100644 --- a/docs/en/ranch/2.0/manual/ranch.wait_for_connections/index.html +++ b/docs/en/ranch/2.0/manual/ranch.wait_for_connections/index.html @@ -152,6 +152,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch/index.html b/docs/en/ranch/2.0/manual/ranch/index.html index 9b1033a6..d2b958cd 100644 --- a/docs/en/ranch/2.0/manual/ranch/index.html +++ b/docs/en/ranch/2.0/manual/ranch/index.html @@ -248,6 +248,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch_app/index.html b/docs/en/ranch/2.0/manual/ranch_app/index.html index 0c187742..c3cdcff8 100644 --- a/docs/en/ranch/2.0/manual/ranch_app/index.html +++ b/docs/en/ranch/2.0/manual/ranch_app/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch_protocol/index.html b/docs/en/ranch/2.0/manual/ranch_protocol/index.html index cdd8e216..ecae09bb 100644 --- a/docs/en/ranch/2.0/manual/ranch_protocol/index.html +++ b/docs/en/ranch/2.0/manual/ranch_protocol/index.html @@ -125,6 +125,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch_proxy_header.header/index.html b/docs/en/ranch/2.0/manual/ranch_proxy_header.header/index.html index 10ef6621..1d02e085 100644 --- a/docs/en/ranch/2.0/manual/ranch_proxy_header.header/index.html +++ b/docs/en/ranch/2.0/manual/ranch_proxy_header.header/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch_proxy_header.parse/index.html b/docs/en/ranch/2.0/manual/ranch_proxy_header.parse/index.html index e4c711a2..a2cdeeca 100644 --- a/docs/en/ranch/2.0/manual/ranch_proxy_header.parse/index.html +++ b/docs/en/ranch/2.0/manual/ranch_proxy_header.parse/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch_proxy_header/index.html b/docs/en/ranch/2.0/manual/ranch_proxy_header/index.html index e71a2608..916c7946 100644 --- a/docs/en/ranch/2.0/manual/ranch_proxy_header/index.html +++ b/docs/en/ranch/2.0/manual/ranch_proxy_header/index.html @@ -213,6 +213,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch_ssl/index.html b/docs/en/ranch/2.0/manual/ranch_ssl/index.html index 84107889..b069992a 100644 --- a/docs/en/ranch/2.0/manual/ranch_ssl/index.html +++ b/docs/en/ranch/2.0/manual/ranch_ssl/index.html @@ -323,6 +323,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch_tcp/index.html b/docs/en/ranch/2.0/manual/ranch_tcp/index.html index a9ea2eae..b5115191 100644 --- a/docs/en/ranch/2.0/manual/ranch_tcp/index.html +++ b/docs/en/ranch/2.0/manual/ranch_tcp/index.html @@ -225,6 +225,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch_transport.sendfile/index.html b/docs/en/ranch/2.0/manual/ranch_transport.sendfile/index.html index eebf8668..28dee8e7 100644 --- a/docs/en/ranch/2.0/manual/ranch_transport.sendfile/index.html +++ b/docs/en/ranch/2.0/manual/ranch_transport.sendfile/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.0/manual/ranch_transport/index.html b/docs/en/ranch/2.0/manual/ranch_transport/index.html index 88072219..56ce467c 100644 --- a/docs/en/ranch/2.0/manual/ranch_transport/index.html +++ b/docs/en/ranch/2.0/manual/ranch_transport/index.html @@ -366,6 +366,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/guide/connection_draining/index.html b/docs/en/ranch/2.1/guide/connection_draining/index.html index 74e013ee..74eeaeea 100644 --- a/docs/en/ranch/2.1/guide/connection_draining/index.html +++ b/docs/en/ranch/2.1/guide/connection_draining/index.html @@ -197,6 +197,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.1/guide/embedded/index.html b/docs/en/ranch/2.1/guide/embedded/index.html index f9ddd04f..5e3655ba 100644 --- a/docs/en/ranch/2.1/guide/embedded/index.html +++ b/docs/en/ranch/2.1/guide/embedded/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.1/guide/index.html b/docs/en/ranch/2.1/guide/index.html index ad0d19b2..c84df2cf 100644 --- a/docs/en/ranch/2.1/guide/index.html +++ b/docs/en/ranch/2.1/guide/index.html @@ -132,6 +132,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.1/guide/internals/index.html b/docs/en/ranch/2.1/guide/internals/index.html index c12072e2..dd57ef42 100644 --- a/docs/en/ranch/2.1/guide/internals/index.html +++ b/docs/en/ranch/2.1/guide/internals/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.1/guide/introduction/index.html b/docs/en/ranch/2.1/guide/introduction/index.html index ed06d277..81857e21 100644 --- a/docs/en/ranch/2.1/guide/introduction/index.html +++ b/docs/en/ranch/2.1/guide/introduction/index.html @@ -124,6 +124,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.1/guide/listeners/index.html b/docs/en/ranch/2.1/guide/listeners/index.html index 7c350295..ab005311 100644 --- a/docs/en/ranch/2.1/guide/listeners/index.html +++ b/docs/en/ranch/2.1/guide/listeners/index.html @@ -441,6 +441,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.1/guide/migrating_from_1.5/index.html b/docs/en/ranch/2.1/guide/migrating_from_1.5/index.html index 6b092945..5429fcbd 100644 --- a/docs/en/ranch/2.1/guide/migrating_from_1.5/index.html +++ b/docs/en/ranch/2.1/guide/migrating_from_1.5/index.html @@ -160,6 +160,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.1/guide/migrating_from_1.6/index.html b/docs/en/ranch/2.1/guide/migrating_from_1.6/index.html index c225652b..9ac7ccd7 100644 --- a/docs/en/ranch/2.1/guide/migrating_from_1.6/index.html +++ b/docs/en/ranch/2.1/guide/migrating_from_1.6/index.html @@ -140,6 +140,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.1/guide/migrating_from_1.7/index.html b/docs/en/ranch/2.1/guide/migrating_from_1.7/index.html index ca243a9d..6a1608bb 100644 --- a/docs/en/ranch/2.1/guide/migrating_from_1.7/index.html +++ b/docs/en/ranch/2.1/guide/migrating_from_1.7/index.html @@ -197,6 +197,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.1/guide/migrating_from_1.x/index.html b/docs/en/ranch/2.1/guide/migrating_from_1.x/index.html index eac1c342..40d4ef17 100644 --- a/docs/en/ranch/2.1/guide/migrating_from_1.x/index.html +++ b/docs/en/ranch/2.1/guide/migrating_from_1.x/index.html @@ -213,6 +213,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.1/guide/migrating_from_2.0/index.html b/docs/en/ranch/2.1/guide/migrating_from_2.0/index.html index bb75c367..96d18b6f 100644 --- a/docs/en/ranch/2.1/guide/migrating_from_2.0/index.html +++ b/docs/en/ranch/2.1/guide/migrating_from_2.0/index.html @@ -145,6 +145,8 @@ + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.1/guide/parsers/index.html b/docs/en/ranch/2.1/guide/parsers/index.html index 2c2eaa37..8bc0268c 100644 --- a/docs/en/ranch/2.1/guide/parsers/index.html +++ b/docs/en/ranch/2.1/guide/parsers/index.html @@ -180,6 +180,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.1/guide/protocols/index.html b/docs/en/ranch/2.1/guide/protocols/index.html index a346ca38..a68fbaec 100644 --- a/docs/en/ranch/2.1/guide/protocols/index.html +++ b/docs/en/ranch/2.1/guide/protocols/index.html @@ -200,6 +200,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.1/guide/ssl_auth/index.html b/docs/en/ranch/2.1/guide/ssl_auth/index.html index 16a0c806..8692898d 100644 --- a/docs/en/ranch/2.1/guide/ssl_auth/index.html +++ b/docs/en/ranch/2.1/guide/ssl_auth/index.html @@ -193,6 +193,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.1/guide/transports/index.html b/docs/en/ranch/2.1/guide/transports/index.html index 922e8b3a..fbcb89ec 100644 --- a/docs/en/ranch/2.1/guide/transports/index.html +++ b/docs/en/ranch/2.1/guide/transports/index.html @@ -230,6 +230,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/index.html b/docs/en/ranch/2.1/manual/index.html index 24b974eb..a44909a1 100644 --- a/docs/en/ranch/2.1/manual/index.html +++ b/docs/en/ranch/2.1/manual/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.child_spec/index.html b/docs/en/ranch/2.1/manual/ranch.child_spec/index.html index 6afab174..a428320d 100644 --- a/docs/en/ranch/2.1/manual/ranch.child_spec/index.html +++ b/docs/en/ranch/2.1/manual/ranch.child_spec/index.html @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.get_addr/index.html b/docs/en/ranch/2.1/manual/ranch.get_addr/index.html index 1824515f..3ad212fb 100644 --- a/docs/en/ranch/2.1/manual/ranch.get_addr/index.html +++ b/docs/en/ranch/2.1/manual/ranch.get_addr/index.html @@ -136,6 +136,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.get_max_connections/index.html b/docs/en/ranch/2.1/manual/ranch.get_max_connections/index.html index eea16999..391701c0 100644 --- a/docs/en/ranch/2.1/manual/ranch.get_max_connections/index.html +++ b/docs/en/ranch/2.1/manual/ranch.get_max_connections/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.get_port/index.html b/docs/en/ranch/2.1/manual/ranch.get_port/index.html index 57e8d1c9..3e95cab7 100644 --- a/docs/en/ranch/2.1/manual/ranch.get_port/index.html +++ b/docs/en/ranch/2.1/manual/ranch.get_port/index.html @@ -126,6 +126,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.get_protocol_options/index.html b/docs/en/ranch/2.1/manual/ranch.get_protocol_options/index.html index f88effd6..0b2eedae 100644 --- a/docs/en/ranch/2.1/manual/ranch.get_protocol_options/index.html +++ b/docs/en/ranch/2.1/manual/ranch.get_protocol_options/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.get_status/index.html b/docs/en/ranch/2.1/manual/ranch.get_status/index.html index 9598267f..9694ac8c 100644 --- a/docs/en/ranch/2.1/manual/ranch.get_status/index.html +++ b/docs/en/ranch/2.1/manual/ranch.get_status/index.html @@ -127,6 +127,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.get_transport_options/index.html b/docs/en/ranch/2.1/manual/ranch.get_transport_options/index.html index 2e01a2aa..18918351 100644 --- a/docs/en/ranch/2.1/manual/ranch.get_transport_options/index.html +++ b/docs/en/ranch/2.1/manual/ranch.get_transport_options/index.html @@ -124,6 +124,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.handshake/index.html b/docs/en/ranch/2.1/manual/ranch.handshake/index.html index 52c033c9..1575ac6b 100644 --- a/docs/en/ranch/2.1/manual/ranch.handshake/index.html +++ b/docs/en/ranch/2.1/manual/ranch.handshake/index.html @@ -150,6 +150,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.handshake_cancel/index.html b/docs/en/ranch/2.1/manual/ranch.handshake_cancel/index.html index a96766cb..43d0697c 100644 --- a/docs/en/ranch/2.1/manual/ranch.handshake_cancel/index.html +++ b/docs/en/ranch/2.1/manual/ranch.handshake_cancel/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.handshake_continue/index.html b/docs/en/ranch/2.1/manual/ranch.handshake_continue/index.html index d6f8a02a..83329d5c 100644 --- a/docs/en/ranch/2.1/manual/ranch.handshake_continue/index.html +++ b/docs/en/ranch/2.1/manual/ranch.handshake_continue/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.info/index.html b/docs/en/ranch/2.1/manual/ranch.info/index.html index 3329c7d4..0437c2d6 100644 --- a/docs/en/ranch/2.1/manual/ranch.info/index.html +++ b/docs/en/ranch/2.1/manual/ranch.info/index.html @@ -187,6 +187,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.procs/index.html b/docs/en/ranch/2.1/manual/ranch.procs/index.html index b03b96a5..62dca40c 100644 --- a/docs/en/ranch/2.1/manual/ranch.procs/index.html +++ b/docs/en/ranch/2.1/manual/ranch.procs/index.html @@ -135,6 +135,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.recv_proxy_header/index.html b/docs/en/ranch/2.1/manual/ranch.recv_proxy_header/index.html index 9359c54b..88281ffa 100644 --- a/docs/en/ranch/2.1/manual/ranch.recv_proxy_header/index.html +++ b/docs/en/ranch/2.1/manual/ranch.recv_proxy_header/index.html @@ -145,6 +145,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.remove_connection/index.html b/docs/en/ranch/2.1/manual/ranch.remove_connection/index.html index 19829653..63beab5d 100644 --- a/docs/en/ranch/2.1/manual/ranch.remove_connection/index.html +++ b/docs/en/ranch/2.1/manual/ranch.remove_connection/index.html @@ -125,6 +125,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.resume_listener/index.html b/docs/en/ranch/2.1/manual/ranch.resume_listener/index.html index a27e86bc..76d24420 100644 --- a/docs/en/ranch/2.1/manual/ranch.resume_listener/index.html +++ b/docs/en/ranch/2.1/manual/ranch.resume_listener/index.html @@ -131,6 +131,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.set_max_connections/index.html b/docs/en/ranch/2.1/manual/ranch.set_max_connections/index.html index adef279d..d5234777 100644 --- a/docs/en/ranch/2.1/manual/ranch.set_max_connections/index.html +++ b/docs/en/ranch/2.1/manual/ranch.set_max_connections/index.html @@ -133,6 +133,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.set_protocol_options/index.html b/docs/en/ranch/2.1/manual/ranch.set_protocol_options/index.html index a2584190..ac0eb3be 100644 --- a/docs/en/ranch/2.1/manual/ranch.set_protocol_options/index.html +++ b/docs/en/ranch/2.1/manual/ranch.set_protocol_options/index.html @@ -139,6 +139,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.set_transport_options/index.html b/docs/en/ranch/2.1/manual/ranch.set_transport_options/index.html index 174b1f92..5ae85c5f 100644 --- a/docs/en/ranch/2.1/manual/ranch.set_transport_options/index.html +++ b/docs/en/ranch/2.1/manual/ranch.set_transport_options/index.html @@ -187,6 +187,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.start_listener/index.html b/docs/en/ranch/2.1/manual/ranch.start_listener/index.html index 4f73920f..f9925322 100644 --- a/docs/en/ranch/2.1/manual/ranch.start_listener/index.html +++ b/docs/en/ranch/2.1/manual/ranch.start_listener/index.html @@ -185,6 +185,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.stop_listener/index.html b/docs/en/ranch/2.1/manual/ranch.stop_listener/index.html index acfb85e5..02820cf6 100644 --- a/docs/en/ranch/2.1/manual/ranch.stop_listener/index.html +++ b/docs/en/ranch/2.1/manual/ranch.stop_listener/index.html @@ -128,6 +128,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.suspend_listener/index.html b/docs/en/ranch/2.1/manual/ranch.suspend_listener/index.html index d60b014a..6da0f804 100644 --- a/docs/en/ranch/2.1/manual/ranch.suspend_listener/index.html +++ b/docs/en/ranch/2.1/manual/ranch.suspend_listener/index.html @@ -132,6 +132,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch.wait_for_connections/index.html b/docs/en/ranch/2.1/manual/ranch.wait_for_connections/index.html index a1f42366..56379d48 100644 --- a/docs/en/ranch/2.1/manual/ranch.wait_for_connections/index.html +++ b/docs/en/ranch/2.1/manual/ranch.wait_for_connections/index.html @@ -152,6 +152,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch/index.html b/docs/en/ranch/2.1/manual/ranch/index.html index b8a76ae9..f59a92fa 100644 --- a/docs/en/ranch/2.1/manual/ranch/index.html +++ b/docs/en/ranch/2.1/manual/ranch/index.html @@ -279,6 +279,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch_app/index.html b/docs/en/ranch/2.1/manual/ranch_app/index.html index b9b20e73..426bee1b 100644 --- a/docs/en/ranch/2.1/manual/ranch_app/index.html +++ b/docs/en/ranch/2.1/manual/ranch_app/index.html @@ -140,6 +140,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch_protocol/index.html b/docs/en/ranch/2.1/manual/ranch_protocol/index.html index 032c7625..9e6f9c06 100644 --- a/docs/en/ranch/2.1/manual/ranch_protocol/index.html +++ b/docs/en/ranch/2.1/manual/ranch_protocol/index.html @@ -125,6 +125,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch_proxy_header.header/index.html b/docs/en/ranch/2.1/manual/ranch_proxy_header.header/index.html index 6c7c9e17..706a1d68 100644 --- a/docs/en/ranch/2.1/manual/ranch_proxy_header.header/index.html +++ b/docs/en/ranch/2.1/manual/ranch_proxy_header.header/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch_proxy_header.parse/index.html b/docs/en/ranch/2.1/manual/ranch_proxy_header.parse/index.html index 2ef77fdf..272c9500 100644 --- a/docs/en/ranch/2.1/manual/ranch_proxy_header.parse/index.html +++ b/docs/en/ranch/2.1/manual/ranch_proxy_header.parse/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch_proxy_header.to_connection_info/index.html b/docs/en/ranch/2.1/manual/ranch_proxy_header.to_connection_info/index.html index ecd0c2f3..937243df 100644 --- a/docs/en/ranch/2.1/manual/ranch_proxy_header.to_connection_info/index.html +++ b/docs/en/ranch/2.1/manual/ranch_proxy_header.to_connection_info/index.html @@ -129,6 +129,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch_proxy_header/index.html b/docs/en/ranch/2.1/manual/ranch_proxy_header/index.html index 7e59b02b..81293ad6 100644 --- a/docs/en/ranch/2.1/manual/ranch_proxy_header/index.html +++ b/docs/en/ranch/2.1/manual/ranch_proxy_header/index.html @@ -215,6 +215,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch_ssl/index.html b/docs/en/ranch/2.1/manual/ranch_ssl/index.html index ae58c041..25d40600 100644 --- a/docs/en/ranch/2.1/manual/ranch_ssl/index.html +++ b/docs/en/ranch/2.1/manual/ranch_ssl/index.html @@ -323,6 +323,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch_tcp/index.html b/docs/en/ranch/2.1/manual/ranch_tcp/index.html index 25d11344..5a753f7a 100644 --- a/docs/en/ranch/2.1/manual/ranch_tcp/index.html +++ b/docs/en/ranch/2.1/manual/ranch_tcp/index.html @@ -225,6 +225,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch_transport.sendfile/index.html b/docs/en/ranch/2.1/manual/ranch_transport.sendfile/index.html index 22032921..9e388cb0 100644 --- a/docs/en/ranch/2.1/manual/ranch_transport.sendfile/index.html +++ b/docs/en/ranch/2.1/manual/ranch_transport.sendfile/index.html @@ -159,6 +159,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.1/manual/ranch_transport/index.html b/docs/en/ranch/2.1/manual/ranch_transport/index.html index 8bc12d80..3b6ba9ff 100644 --- a/docs/en/ranch/2.1/manual/ranch_transport/index.html +++ b/docs/en/ranch/2.1/manual/ranch_transport/index.html @@ -366,6 +366,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> diff --git a/docs/en/ranch/2.2/guide/connection_draining.asciidoc b/docs/en/ranch/2.2/guide/connection_draining.asciidoc new file mode 100644 index 00000000..2ccdbc84 --- /dev/null +++ b/docs/en/ranch/2.2/guide/connection_draining.asciidoc @@ -0,0 +1,98 @@ +== Connection draining + +Stopping a Ranch listener via `ranch:stop_listener/1` will invariably kill +all connection processes the listener hosts. However, you may want to stop +a listener in a graceful fashion, ie by not accepting any new connections, +but allowing the existing connection processes to exit by themselves instead +of being killed. + +For this purpose, you should first suspend the listener you wish to +stop gracefully, and then wait for its connection count to drop to +zero. + +.Draining a single listener + +[source,erlang] +---- +ok = ranch:suspend_listener(Ref), +ok = ranch:wait_for_connections(Ref, '==', 0), +ok = ranch:stop_listener(Ref). +---- + +If you want to drain more than just one listener, it may be important to first suspend +them all before beginning to wait for their connection counts to reach zero. Otherwise, +the not yet suspended listeners will still be accepting connections while you wait for +the suspended ones to be drained. + +.Draining multiple listeners + +[source,erlang] +---- +lists:foreach( + fun (Ref) -> + ok = ranch:suspend_listener(Ref) + end, + Refs +), +lists:foreach( + fun (Ref) -> + ok = ranch:wait_for_connections(Ref, '==', 0), + ok = ranch:stop_listener(Ref) + end, + Refs +). +---- + +If you have long-running connection processes hosted by the listener you want to stop +gracefully, draining may take a long time, possibly forever. If you just want to give +the connection processes a chance to finish, but are not willing to wait for infinity, +the waiting part could be handled in a separate process. + +.Draining a listener with a timeout + +[source,erlang] +---- +ok = ranch:suspend_listener(Ref), +{DrainPid, DrainRef} = spawn_monitor( + fun () -> + ok = ranch:wait_for_connections(Ref, '==', 0) + end +), +receive + {'DOWN', DrainRef, process, DrainPid, _} -> + ok +after DrainTimeout -> + exit(DrainPid, kill), + ok +end, +ok = ranch:stop_listener(Ref). +---- + +To drain listeners automatically as part of your application shutdown routine, +use the `prep_stop/1` function of your application module. + +.Draining listeners automatically on application shutdown + +[source,erlang] +---- +-module(my_app). + +-behavior(application). + +-export([start/2]). +-export([prep_stop/1]). +-export([stop/1]). + +start(_StartType, _StartArgs) -> + {ok, _} = ranch:start_listener(my_listener, ranch_tcp, #{}, my_protocol, []), + my_app_sup:start_link(). + +prep_stop(State) -> + ok = ranch:suspend_listener(my_listener), + ok = ranch:wait_for_connections(my_listener, '==', 0), + ok = ranch:stop_listener(my_listener), + State. + +stop(_State) -> + ok. +---- diff --git a/docs/en/ranch/2.2/guide/connection_draining/index.html b/docs/en/ranch/2.2/guide/connection_draining/index.html new file mode 100644 index 00000000..7801532f --- /dev/null +++ b/docs/en/ranch/2.2/guide/connection_draining/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: Connection draining</title> + + <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 draining</span></h1> + +<p>Stopping a Ranch listener via <code>ranch:stop_listener/1</code> will invariably kill all connection processes the listener hosts. However, you may want to stop a listener in a graceful fashion, ie by not accepting any new connections, but allowing the existing connection processes to exit by themselves instead of being killed.</p> +<p>For this purpose, you should first suspend the listener you wish to stop gracefully, and then wait for its connection count to drop to zero.</p> +<div class="listingblock"><div class="title">Draining a single 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">ranch:suspend_listener</font></b>(<font color="#009900">Ref</font>), +<font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:wait_for_connections</font></b>(<font color="#009900">Ref</font>, <font color="#FF6600">'=='</font>, <font color="#993399">0</font>), +<font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:stop_listener</font></b>(<font color="#009900">Ref</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>If you want to drain more than just one listener, it may be important to first suspend them all before beginning to wait for their connection counts to reach zero. Otherwise, the not yet suspended listeners will still be accepting connections while you wait for the suspended ones to be drained.</p> +<div class="listingblock"><div class="title">Draining multiple listeners</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">lists:foreach</font></b>( + <b><font color="#0000FF">fun</font></b> (<font color="#009900">Ref</font>) <font color="#990000">-></font> + <font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:suspend_listener</font></b>(<font color="#009900">Ref</font>) + <b><font color="#0000FF">end</font></b>, + <font color="#009900">Refs</font> +), +<b><font color="#000000">lists:foreach</font></b>( + <b><font color="#0000FF">fun</font></b> (<font color="#009900">Ref</font>) <font color="#990000">-></font> + <font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:wait_for_connections</font></b>(<font color="#009900">Ref</font>, <font color="#FF6600">'=='</font>, <font color="#993399">0</font>), + <font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:stop_listener</font></b>(<font color="#009900">Ref</font>) + <b><font color="#0000FF">end</font></b>, + <font color="#009900">Refs</font> +)<font color="#990000">.</font></tt></pre> +</div></div> +<p>If you have long-running connection processes hosted by the listener you want to stop gracefully, draining may take a long time, possibly forever. If you just want to give the connection processes a chance to finish, but are not willing to wait for infinity, the waiting part could be handled in a separate process.</p> +<div class="listingblock"><div class="title">Draining a listener with a 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><font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:suspend_listener</font></b>(<font color="#009900">Ref</font>), +{<font color="#009900">DrainPid</font>, <font color="#009900">DrainRef</font>} <font color="#990000">=</font> <b><font color="#000000">spawn_monitor</font></b>( + <b><font color="#0000FF">fun</font></b> () <font color="#990000">-></font> + <font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:wait_for_connections</font></b>(<font color="#009900">Ref</font>, <font color="#FF6600">'=='</font>, <font color="#993399">0</font>) + <b><font color="#0000FF">end</font></b> +), +<b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">'DOWN'</font>, <font color="#009900">DrainRef</font>, <b><font color="#000080">process</font></b>, <font color="#009900">DrainPid</font>, <font color="#990000">_</font>} <font color="#990000">-></font> + <font color="#FF6600">ok</font> +<b><font color="#0000FF">after</font></b> <font color="#009900">DrainTimeout</font> <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>(<font color="#009900">DrainPid</font>, <b><font color="#000080">kill</font></b>), + <font color="#FF6600">ok</font> +<b><font color="#0000FF">end</font></b>, +<font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:stop_listener</font></b>(<font color="#009900">Ref</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>To drain listeners automatically as part of your application shutdown routine, use the <code>prep_stop/1</code> function of your application module.</p> +<div class="listingblock"><div class="title">Draining listeners automatically on application shutdown</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="#000080">-module</font></b>(<font color="#FF6600">my_app</font>)<font color="#990000">.</font> + +<b><font color="#000080">-behavior</font></b>(<font color="#FF6600">application</font>)<font color="#990000">.</font> + +<b><font color="#000080">-export</font></b>([<b><font color="#000000">start</font></b><font color="#990000">/</font><font color="#993399">2</font>])<font color="#990000">.</font> +<b><font color="#000080">-export</font></b>([<b><font color="#000000">prep_stop</font></b><font color="#990000">/</font><font color="#993399">1</font>])<font color="#990000">.</font> +<b><font color="#000080">-export</font></b>([<b><font color="#000000">stop</font></b><font color="#990000">/</font><font color="#993399">1</font>])<font color="#990000">.</font> + +<b><font color="#000000">start</font></b>(<font color="#009900">_StartType</font>, <font color="#009900">_StartArgs</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:start_listener</font></b>(<font color="#FF6600">my_listener</font>, <font color="#FF6600">ranch_tcp</font>, #{}, <font color="#FF6600">my_protocol</font>, []), + <b><font color="#000000">my_app_sup:start_link</font></b>()<font color="#990000">.</font> + +<b><font color="#000000">prep_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">ranch:suspend_listener</font></b>(<font color="#FF6600">my_listener</font>), + <font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:wait_for_connections</font></b>(<font color="#FF6600">my_listener</font>, <font color="#FF6600">'=='</font>, <font color="#993399">0</font>), + <font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:stop_listener</font></b>(<font color="#FF6600">my_listener</font>), + <font color="#009900">State</font><font color="#990000">.</font> + +<b><font color="#000000">stop</font></b>(<font color="#009900">_State</font>) <font color="#990000">-></font> + <font color="#FF6600">ok</font><font color="#990000">.</font></tt></pre> +</div></div> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/2.2/guide/ssl_auth/"> + SSL client authentication + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/2.2/guide/internals/"> + Internals + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/guide/embedded.asciidoc b/docs/en/ranch/2.2/guide/embedded.asciidoc new file mode 100644 index 00000000..28f567bc --- /dev/null +++ b/docs/en/ranch/2.2/guide/embedded.asciidoc @@ -0,0 +1,47 @@ +== Embedded mode + +Embedded mode allows you to insert Ranch listeners directly +in your supervision tree. This allows for greater fault tolerance +control by permitting the shutdown of a listener due to the +failure of another part of the application and vice versa. + +However, just as for non-embedded listeners that were started via +`ranch:start_listener/5`, it is required that the `ranch` application +is running before you can start embedded listeners. Furthermore, +this also means that embedded listeners will restart when `ranch_sup` fails. + +WARNING: By using embedded mode, it is possible to start a listener with the same name +as an already existing listener. This will corrupt the information Ranch +keeps for that listener, so you should take care to ensure unique listener +names yourself. A good way to achieve this is by combining the embedded +listener's name with `?MODULE`, or the name of the application it is used +in. + +=== Embedding + +To embed Ranch in your application you can simply add the child specs +to your supervision tree. This can all be done in the `init/1` function +of one of your application supervisors. + +Ranch has a convenience function for getting the listeners child specs +called `ranch:child_spec/5`, that works like `ranch:start_listener/5`, +except that it doesn't start anything, it only returns child specs. + +The following example adds one listener to another application's +supervision tree. + +.Embed Ranch directly in your supervision tree + +[source,erlang] +---- +init([]) -> + ListenerSpec = ranch:child_spec({?MODULE, echo}, + ranch_tcp, #{socket_opts => [{port, 5555}]}, + echo_protocol, [] + ), + {ok, {#{}, [ListenerSpec]}}. +---- + +Embedded listeners cannot be stopped via `ranch:stop_listener/1`. Instead, +are to be stopped as part of the shutdown of your application's supervison +tree. diff --git a/docs/en/ranch/2.2/guide/embedded/index.html b/docs/en/ranch/2.2/guide/embedded/index.html new file mode 100644 index 00000000..c7845ed9 --- /dev/null +++ b/docs/en/ranch/2.2/guide/embedded/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: Embedded mode</title> + + <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>Embedded mode</span></h1> + +<p>Embedded mode allows you to insert Ranch listeners directly in your supervision tree. This allows for greater fault tolerance control by permitting the shutdown of a listener due to the failure of another part of the application and vice versa.</p> +<p>However, just as for non-embedded listeners that were started via <code>ranch:start_listener/5</code>, it is required that the <code>ranch</code> application is running before you can start embedded listeners. Furthermore, this also means that embedded listeners will restart when <code>ranch_sup</code> fails.</p> +<p>WARNING: By using embedded mode, it is possible to start a listener with the same name as an already existing listener. This will corrupt the information Ranch keeps for that listener, so you should take care to ensure unique listener names yourself. A good way to achieve this is by combining the embedded listener's name with <code>?MODULE</code>, or the name of the application it is used in.</p> +<h2 id="_embedding">Embedding</h2> +<p>To embed Ranch in your application you can simply add the child specs to your supervision tree. This can all be done in the <code>init/1</code> function of one of your application supervisors.</p> +<p>Ranch has a convenience function for getting the listeners child specs called <code>ranch:child_spec/5</code>, that works like <code>ranch:start_listener/5</code>, except that it doesn't start anything, it only returns child specs.</p> +<p>The following example adds one listener to another application's supervision tree.</p> +<div class="listingblock"><div class="title">Embed Ranch directly in your supervision tree</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="#990000">-></font> + <font color="#009900">ListenerSpec</font> <font color="#990000">=</font> <b><font color="#000000">ranch:child_spec</font></b>({<b><font color="#000080">?MODULE</font></b>, <font color="#FF6600">echo</font>}, + <font color="#FF6600">ranch_tcp</font>, #{<font color="#0000FF">socket_opts</font> <font color="#990000">=></font> [{<font color="#FF6600">port</font>, <font color="#993399">5555</font>}]}, + <font color="#FF6600">echo_protocol</font>, [] + ), + {<font color="#FF6600">ok</font>, {#{}, [<font color="#009900">ListenerSpec</font>]}}<font color="#990000">.</font></tt></pre> +</div></div> +<p>Embedded listeners cannot be stopped via <code>ranch:stop_listener/1</code>. Instead, are to be stopped as part of the shutdown of your application's supervison tree.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/2.2/guide/protocols/"> + Protocols + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/2.2/guide/parsers/"> + Writing parsers + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/guide/index.html b/docs/en/ranch/2.2/guide/index.html new file mode 100644 index 00000000..444e2a39 --- /dev/null +++ b/docs/en/ranch/2.2/guide/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: Ranch 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>Ranch User Guide</span></h1> + +<h2 id="_interface">Interface</h2> +<ul><li><a href="introduction/">Introduction</a> +</li> +<li><a href="listeners/">Listeners</a> +</li> +<li><a href="transports/">Transports</a> +</li> +<li><a href="protocols/">Protocols</a> +</li> +<li><a href="embedded/">Embedded mode</a> +</li> +</ul> +<h2 id="_how_to">How to</h2> +<ul><li><a href="parsers/">Writing parsers</a> +</li> +<li><a href="ssl_auth/">SSL client authentication</a> +</li> +<li><a href="connection_draining/">Connection draining</a> +</li> +</ul> +<h2 id="_advanced">Advanced</h2> +<ul><li><a href="internals/">Internals</a> +</li> +</ul> +<h2 id="_additional_information">Additional information</h2> +<ul><li><a href="migrating_from_2.1/">Migrating from Ranch 2.1 to 2.2</a> +</li> +<li><a href="migrating_from_2.0/">Migrating from Ranch 2.0 to 2.1</a> +</li> +<li><a href="migrating_from_1.7/">Migrating from Ranch 1.7 to 2.0</a> +</li> +<li><a href="migrating_from_1.6/">Migrating from Ranch 1.6 to 1.7</a> +</li> +<li><a href="migrating_from_1.5/">Migrating from Ranch 1.5 to 1.6</a> +</li> +<li><a href="migrating_from_1.x/">Migrating from Ranch 1.x</a> +</li> +</ul> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/guide/internals.asciidoc b/docs/en/ranch/2.2/guide/internals.asciidoc new file mode 100644 index 00000000..600920fc --- /dev/null +++ b/docs/en/ranch/2.2/guide/internals.asciidoc @@ -0,0 +1,99 @@ +== Internals + +This chapter may not apply to embedded Ranch as embedding allows you +to use an architecture specific to your application, which may or may +not be compatible with the description of the Ranch application. + +Note that for everything related to efficiency and performance, +you should perform the benchmarks yourself to get the numbers that +matter to you. Generic benchmarks found on the web may or may not +be of use to you, you can never know until you benchmark your own +system. + +A third party dive into the internals of Ranch is available should +you be interested: https://baozi.technology/ranch-under-the-hood/[Ranch: what's under the hood?] +We make no claims with regard to its freshness or accuracy but this +is a nice document to read along this section. + +=== Architecture + +Ranch is an OTP application. + +Like all OTP applications, Ranch has a top supervisor. It is responsible +for supervising the `ranch_server` process and all the listeners that +will be started. + +The `ranch_server` gen_server is a central process keeping track of the +listeners and their acceptors. It does so through the use of a public ets +table called `ranch_server`. The table is owned by the top supervisor +to improve fault tolerance. This way if the `ranch_server` gen_server +fails, it doesn't lose any information and the restarted process can +continue as if nothing happened. + +Ranch uses a custom supervisor for managing connections. This supervisor +keeps track of the number of connections and handles connection limits +directly. While it is heavily optimized to perform the task of creating +connection processes for accepted connections, it is still following the +OTP principles and the usual `sys` and `supervisor` calls will work on +it as expected. + +Listeners are grouped into the `ranch_listener_sup` supervisor and +consist of three kinds of processes: the listener gen_server, the +acceptor processes and the connection processes, both grouped under +their own supervisor. All of these processes are registered to the +`ranch_server` gen_server with varying amount of information. + +All socket operations, including listening for connections, go through +transport handlers. Accepted connections are given to the protocol handler. +Transport handlers are simple callback modules for performing operations on +sockets. Protocol handlers start a new process, which receives socket +ownership, with no requirements on how the code should be written inside +that new process. + +=== Number of acceptors + +The second argument to `ranch:start_listener/5` is the number of +processes that will be accepting connections. Care should be taken +when choosing this number. + +First of all, it should not be confused with the maximum number +of connections. Acceptor processes are only used for accepting and +have nothing else in common with connection processes. Therefore +there is nothing to be gained from setting this number too high, +in fact it can slow everything else down. + +Second, this number should be high enough to allow Ranch to accept +connections concurrently. But the number of cores available doesn't +seem to be the only factor for choosing this number, as we can +observe faster accepts if we have more acceptors than cores. It +might be entirely dependent on the protocol, however. + +Our observations suggest that using 100 acceptors on modern hardware +is a good solution, as it's big enough to always have acceptors ready +and it's low enough that it doesn't have a negative impact on the +system's performances. + +=== Platform-specific TCP features + +Some socket options are platform-specific and not supported by `inet`. +They can be of interest because they generally are related to +optimizations provided by the underlying OS. They can still be enabled +thanks to the `raw` option, for which we will see an example. + +One of these features is `TCP_DEFER_ACCEPT` on Linux. It is a simplified +accept mechanism which will wait for application data to come in before +handing out the connection to the Erlang process. + +This is especially useful if you expect many connections to be mostly +idle, perhaps part of a connection pool. They can be handled by the +kernel directly until they send any real data, instead of allocating +resources to idle connections. + +To enable this mechanism, the following option can be used. + +.Using raw transport options + +[source,erlang] +{raw, 6, 9, << 30:32/native >>} + +It means go on layer 6, turn on option 9 with the given integer parameter. diff --git a/docs/en/ranch/2.2/guide/internals/index.html b/docs/en/ranch/2.2/guide/internals/index.html new file mode 100644 index 00000000..b4b34784 --- /dev/null +++ b/docs/en/ranch/2.2/guide/internals/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: Internals</title> + + <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</span></h1> + +<p>This chapter may not apply to embedded Ranch as embedding allows you to use an architecture specific to your application, which may or may not be compatible with the description of the Ranch application.</p> +<p>Note that for everything related to efficiency and performance, you should perform the benchmarks yourself to get the numbers that matter to you. Generic benchmarks found on the web may or may not be of use to you, you can never know until you benchmark your own system.</p> +<p>A third party dive into the internals of Ranch is available should you be interested: <a href="https://baozi.technology/ranch-under-the-hood/">Ranch: what's under the hood?</a> We make no claims with regard to its freshness or accuracy but this is a nice document to read along this section.</p> +<h2 id="_architecture">Architecture</h2> +<p>Ranch is an OTP application.</p> +<p>Like all OTP applications, Ranch has a top supervisor. It is responsible for supervising the <code>ranch_server</code> process and all the listeners that will be started.</p> +<p>The <code>ranch_server</code> gen_server is a central process keeping track of the listeners and their acceptors. It does so through the use of a public ets table called <code>ranch_server</code>. The table is owned by the top supervisor to improve fault tolerance. This way if the <code>ranch_server</code> gen_server fails, it doesn't lose any information and the restarted process can continue as if nothing happened.</p> +<p>Ranch uses a custom supervisor for managing connections. This supervisor keeps track of the number of connections and handles connection limits directly. While it is heavily optimized to perform the task of creating connection processes for accepted connections, it is still following the OTP principles and the usual <code>sys</code> and <code>supervisor</code> calls will work on it as expected.</p> +<p>Listeners are grouped into the <code>ranch_listener_sup</code> supervisor and consist of three kinds of processes: the listener gen_server, the acceptor processes and the connection processes, both grouped under their own supervisor. All of these processes are registered to the <code>ranch_server</code> gen_server with varying amount of information.</p> +<p>All socket operations, including listening for connections, go through transport handlers. Accepted connections are given to the protocol handler. Transport handlers are simple callback modules for performing operations on sockets. Protocol handlers start a new process, which receives socket ownership, with no requirements on how the code should be written inside that new process.</p> +<h2 id="_number_of_acceptors">Number of acceptors</h2> +<p>The second argument to <code>ranch:start_listener/5</code> is the number of processes that will be accepting connections. Care should be taken when choosing this number.</p> +<p>First of all, it should not be confused with the maximum number of connections. Acceptor processes are only used for accepting and have nothing else in common with connection processes. Therefore there is nothing to be gained from setting this number too high, in fact it can slow everything else down.</p> +<p>Second, this number should be high enough to allow Ranch to accept connections concurrently. But the number of cores available doesn't seem to be the only factor for choosing this number, as we can observe faster accepts if we have more acceptors than cores. It might be entirely dependent on the protocol, however.</p> +<p>Our observations suggest that using 100 acceptors on modern hardware is a good solution, as it's big enough to always have acceptors ready and it's low enough that it doesn't have a negative impact on the system's performances.</p> +<h2 id="_platform_specific_tcp_features">Platform-specific TCP features</h2> +<p>Some socket options are platform-specific and not supported by <code>inet</code>. They can be of interest because they generally are related to optimizations provided by the underlying OS. They can still be enabled thanks to the <code>raw</code> option, for which we will see an example.</p> +<p>One of these features is <code>TCP_DEFER_ACCEPT</code> on Linux. It is a simplified accept mechanism which will wait for application data to come in before handing out the connection to the Erlang process.</p> +<p>This is especially useful if you expect many connections to be mostly idle, perhaps part of a connection pool. They can be handled by the kernel directly until they send any real data, instead of allocating resources to idle connections.</p> +<p>To enable this mechanism, the following option can be used.</p> +<div class="listingblock"><div class="title">Using raw transport 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">raw</font>, <font color="#993399">6</font>, <font color="#993399">9</font>, <font color="#990000"><<</font> <b><font color="#000000">30:32</font></b><font color="#990000">/</font><font color="#FF6600">native</font> <font color="#990000">>></font>}</tt></pre> +</div></div> +<p>It means go on layer 6, turn on option 9 with the given integer parameter.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/2.2/guide/connection_draining/"> + Connection draining + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_2.1/"> + Migrating from Ranch 2.1 to Ranch 2.2 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/guide/introduction.asciidoc b/docs/en/ranch/2.2/guide/introduction.asciidoc new file mode 100644 index 00000000..0bc86dd8 --- /dev/null +++ b/docs/en/ranch/2.2/guide/introduction.asciidoc @@ -0,0 +1,25 @@ +== Introduction + +Ranch is a socket acceptor pool for TCP protocols. + +Ranch aims to provide everything you need to accept TCP connections +with a small code base and low latency while being easy to use directly +as an application or to embed into your own. + +=== Prerequisites + +It is assumed the developer already knows Erlang and has some experience +with socket programming and TCP protocols. + +=== Supported platforms + +Ranch is tested and supported on Linux, FreeBSD, macOS and Windows. + +Ranch is developed for Erlang/OTP 24+. + +Ranch may be compiled on earlier Erlang versions with small source code +modifications but there is no guarantee that it will work as expected. + +=== Versioning + +Ranch uses http://semver.org/[Semantic Versioning 2.0.0] diff --git a/docs/en/ranch/2.2/guide/introduction/index.html b/docs/en/ranch/2.2/guide/introduction/index.html new file mode 100644 index 00000000..aa91b3f5 --- /dev/null +++ b/docs/en/ranch/2.2/guide/introduction/index.html @@ -0,0 +1,186 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: 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>Ranch is a socket acceptor pool for TCP protocols.</p> +<p>Ranch aims to provide everything you need to accept TCP connections with a small code base and low latency while being easy to use directly as an application or to embed into your own.</p> +<h2 id="_prerequisites">Prerequisites</h2> +<p>It is assumed the developer already knows Erlang and has some experience with socket programming and TCP protocols.</p> +<h2 id="_supported_platforms">Supported platforms</h2> +<p>Ranch is tested and supported on Linux, FreeBSD, macOS and Windows.</p> +<p>Ranch is developed for Erlang/OTP 24+.</p> +<p>Ranch may be compiled on earlier Erlang versions with small source code modifications but there is no guarantee that it will work as expected.</p> +<h2 id="_versioning">Versioning</h2> +<p>Ranch uses <a href="http://semver.org/">Semantic Versioning 2.0.0</a></p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/2.2/guide/listeners/"> + Listeners + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/guide/listeners.asciidoc b/docs/en/ranch/2.2/guide/listeners.asciidoc new file mode 100644 index 00000000..c30cb5ca --- /dev/null +++ b/docs/en/ranch/2.2/guide/listeners.asciidoc @@ -0,0 +1,479 @@ +== Listeners + +A listener is a set of processes whose role is to listen on a port +for new connections. It manages a pool of acceptor processes, each +of them indefinitely accepting connections. When it does, it starts +a new process executing the protocol handler code. All the socket +programming is abstracted through the use of transport handlers. + +The listener takes care of supervising all the acceptor and connection +processes, allowing developers to focus on building their application. + +=== Starting a listener + +Ranch does nothing by default. It is up to the application developer +to request that Ranch listens for connections. + +A listener can be started and stopped at will. + +When starting a listener, a number of different settings are required: + +* A name to identify it locally and be able to interact with it. +* A transport handler and its associated options. +* A protocol handler and its associated options. + +Ranch includes both TCP and SSL transport handlers, respectively +`ranch_tcp` and `ranch_ssl`. + +A listener can be started by calling the `ranch:start_listener/5` +function. Before doing so however, you must ensure that the `ranch` +application is started. + +.Starting the Ranch application + +[source,erlang] +ok = application:start(ranch). + +You are then ready to start a listener. Let's call it `tcp_echo`. It will +have a pool of 100 acceptors, use a TCP transport and forward connections +to the `echo_protocol` handler. + +.Starting a listener for TCP connections on port 5555 + +[source,erlang] +{ok, _} = ranch:start_listener(tcp_echo, + ranch_tcp, #{socket_opts => [{port, 5555}]}, + echo_protocol, [] +). + +You can try this out by compiling and running the `tcp_echo` example in the +examples directory. To do so, open a shell in the 'examples/tcp_echo/' +directory and run the following command: + +.Building and starting a Ranch example + +[source,bash] +$ make run + +You can then connect to it using telnet and see the echo server reply +everything you send to it. Then when you're done testing, you can use +the `Ctrl+]` key to escape to the telnet command line and type +`quit` to exit. + +.Connecting to the example listener with telnet + +[source,bash] +---- +$ telnet localhost 5555 +Trying 127.0.0.1... +Connected to localhost. +Escape character is '^]'. +Hello! +Hello! +It works! +It works! +^] + +telnet> quit +Connection closed. +---- + +=== Stopping a listener + +All you need to stop a Ranch listener is to call the +`ranch:stop_listener/1` function with the listener's name +as argument. In the previous section we started the listener +named `tcp_echo`. We can now stop it. + +.Stopping a listener + +[source,erlang] +ranch:stop_listener(tcp_echo). + +=== Suspending and resuming a listener + +Listeners can be suspended and resumed by calling +`ranch:suspend_listener/1` and `ranch:resume_listener/1`, +respectively, with the name of the listener as argument. + +Suspending a listener will cause it to stop listening and not accept +new connections, but existing connection processes will not be stopped. + +.Suspending a listener + +[source,erlang] +ranch:suspend_listener(tcp_echo). + +Resuming a listener will cause it to start listening and accept new +connections again. +It is worth mentioning, however, that if the listener is configured +to listen on a random port, it will listen on a different port than +before it was suspended. + +.Resuming a listener + +[source,erlang] +ranch:resume_listener(tcp_echo). + +Whether a listener is currently running or suspended can be queried +by calling `ranch:get_status/1` with the listener name as argument. + +=== Default transport options + +By default the socket will be set to return `binary` data, with the +options `{active, false}`, `{packet, raw}`, `{reuseaddr, true}` set. +These values can't be overridden when starting the listener, but +they can be overridden using `Transport:setopts/2` in the protocol. + +It will also set `{backlog, 1024}` and `{nodelay, true}`, which +can be overridden at listener startup. + +=== Listening on a random port + +You do not have to specify a specific port to listen on. If you give +the port number 0, or if you omit the port number entirely, Ranch will +start listening on a random port. + +You can retrieve this port number by calling `ranch:get_port/1`. The +argument is the name of the listener you gave in `ranch:start_listener/5`. + +.Starting a listener for TCP connections on a random port + +[source,erlang] +{ok, _} = ranch:start_listener(tcp_echo, + ranch_tcp, #{socket_opts => [{port, 0}]}, + echo_protocol, [] +). +Port = ranch:get_port(tcp_echo). + +=== Listening on privileged ports + +Some systems limit access to ports below 1024 for security reasons. +This can easily be identified by an `{error, eacces}` error when trying +to open a listening socket on such a port. + +The methods for listening on privileged ports vary between systems, +please refer to your system's documentation for more information. + +We recommend the use of port rewriting for systems with a single server, +and load balancing for systems with multiple servers. Documenting these +solutions is however out of the scope of this guide. + +=== Listening on a UNIX Domain socket + +On UNIX systems, it is also possible to use Ranch to listen on a UNIX +domain socket by specifying `{local, SocketFile}` for the `ip` socket +option. In this case, the port must be set to 0 or omitted. The given +file must not exist: Ranch must be able to create it. + +.Starting a listener for TCP connections on a UNIX Domain socket + +[source,erlang] +{ok, _} = ranch:start_listener(tcp_echo, + ranch_tcp, #{socket_opts => [ + {ip, {local, "/tmp/ranch_echo.sock"}}, + {port, 0} + ]}, echo_protocol, [] +). + +=== Performing additional setup steps on a listening socket + +If it is necessary to perform additional setup steps on the listening +socket, it is possible to specify a function with the transport option +`post_listen_callback`. This function will be called after the listening +socket has been created but before accepting connections on it, +with the socket as the single argument. + +The function must return either the atom `ok`, after which the listener +will start accepting connections on the socket, or a tuple +`{error, Reason}` which will cause the listener to fail starting with +`Reason`. + +.Setting permissions on a UNIX Domain socket file + +[source,erlang] +---- +PostListenCb = fun (Sock) -> + case ranch_tcp:sockname(Sock) of + {ok, {local, SockFile}} -> + file:change_mode(SockFile, 8#777); + {ok, _} -> + ok; + Error = {error, _} -> + Error + end +end, + +{ok, _} = ranch:start_listener(tcp_echo, + ranch_tcp, #{ + socket_opts => [ + {ip, {local, "/tmp/ranch_echo.sock"}}, + {port, 0}], + post_listen_callback => PostListenCb}, + echo_protocol, [] +). +---- + +=== Accepting connections on an existing socket + +If you want to accept connections on an existing socket, you can write +a custom `ranch_transport` implementation that fetches or otherwise +acquires a listening socket in the `listen/1` callback and returns it +in the form of `{ok, ListenSocket}`. + +The custom `listen/1` function must ensure that the listener process +(usually the process calling it) is also made the controlling process +of the socket it returns. Failing to do so will result in stop/start +and suspend/resume not working properly for that listener. + +=== Limiting the number of concurrent connections + +The `max_connections` transport option allows you to limit the number +of concurrent connections per connection supervisor (see below). +It defaults to 1024. Its purpose is to prevent your system from being +overloaded and ensuring all the connections are handled optimally. + +.Customizing the maximum number of concurrent connections + +[source,erlang] +{ok, _} = ranch:start_listener(tcp_echo, + ranch_tcp, #{socket_opts => [{port, 5555}], max_connections => 100}, + echo_protocol, [] +). + +You can disable this limit by setting its value to the atom `infinity`. + +.Disabling the limit for the number of connections + +[source,erlang] +{ok, _} = ranch:start_listener(tcp_echo, + ranch_tcp, #{socket_opts => [{port, 5555}], max_connections => infinity}, + echo_protocol, [] +). + +The maximum number of connections is a soft limit. In practice, it +can reach `max_connections` + the number of acceptors. + +When the maximum number of connections is reached, Ranch will stop +accepting connections. This will not result in further connections +being rejected, as the kernel option allows queueing incoming +connections. The size of this queue is determined by the `backlog` +option and defaults to 1024. Ranch does not know about the number +of connections that are in the backlog. + +You may not always want connections to be counted when checking for +`max_connections`. For example you might have a protocol where both +short-lived and long-lived connections are possible. If the long-lived +connections are mostly waiting for messages, then they don't consume +much resources and can safely be removed from the count. + +To remove the connection from the count, you must call the +`ranch:remove_connection/1` from within the connection process, +with the name of the listener as the only argument. + +.Removing a connection from the count of connections + +[source,erlang] +ranch:remove_connection(Ref). + +As seen in the chapter covering protocols, this reference is received +as the first argument of the protocol's `start_link/3` callback. + +You can modify the `max_connections` value on a running listener by +using the `ranch:set_max_connections/2` function, with the name of the +listener as first argument and the new value as the second. + +.Upgrading the maximum number of connections + +[source,erlang] +ranch:set_max_connections(tcp_echo, MaxConns). + +The change will occur immediately. + +=== Customizing the number of acceptor processes + +By default Ranch will use 10 acceptor processes. Their role is +to accept connections and spawn a connection process for every +new connection. + +This number can be tweaked to improve performance. A good +number is typically between 10 or 100 acceptors. You must +measure to find the best value for your application. + +.Specifying a custom number of acceptor processes + +[source,erlang] +{ok, _} = ranch:start_listener(tcp_echo, + ranch_tcp, #{socket_opts => [{port, 5555}], num_acceptors => 42}, + echo_protocol, [] +). + +=== Customizing the number of connection supervisors + +By default Ranch will use one connection supervisor for each +acceptor process (but not vice versa). Their task is to +supervise the connection processes started by an acceptor. +The number of connection supervisors can be tweaked. + +Note that the association between the individual acceptors and +connection supervisors is fixed, meaning that acceptors will +always use the same connection supervisor to start connection +processes. + +.Specifying a custom number of connection supervisors + +[source,erlang] +{ok, _} = ranch:start_listener(tcp_echo, + ranch_tcp, #{socket_opts => [{port, 5555}], num_conns_sups => 42}, + echo_protocol, [] +). + +=== Setting connection count alarms + +The `alarms` transport option allows you to configure alarms +which will be triggered when the number of connections tracked +by one connection supervisor reaches or exceeds the defined threshold. + +The `alarms` transport option takes a map with alarm names as keys and alarm +options as values. + +Any term is allowed as an alarm name. + +Alarm options include the alarm type and a threshold that, when reached, +triggers the given callback. A cooldown prevents the alarm from being +triggered too often. + +.Log warnings when the number of connections exceeds 100 + +[source,erlang] +---- +Alarms = #{ + my_alarm => #{ + type => num_connections, + threshold => 100, + callback => fun(Ref, Name, ConnSup, ConnPids]) -> + logger:warning("Warning (~s): " + "Supervisor ~s of listener ~s " + "has ~b connections", + [Name, Ref, ConnSup, length(ConnPids)]) + end + } +}, +{ok, _} = ranch:start_listener(tcp_echo, + ranch_tcp, #{alarms => Alarms, socket_opts => [{port, 5555}]}, + echo_protocol, [] +). +---- + +In the example code, an alarm named `my_alarm` is defined, which will +call the given function when the number of connections tracked +by the connection supervisor reaches or exceeds 100. When the number of +connections is still (or again) above 100 after the default cooldown +period of 5 seconds, the alarm will trigger again. + +=== When running out of file descriptors + +Operating systems have limits on the number of sockets +which can be opened by applications. When this maximum is +reached the listener can no longer accept new connections. The +accept rate of the listener will be automatically reduced, and a +warning message will be logged. + +---- +=ERROR REPORT==== 13-Jan-2016::12:24:38 === +Ranch acceptor reducing accept rate: out of file descriptors +---- + +If you notice messages like this you should increase the number +of file-descriptors which can be opened by your application. How +this should be done is operating-system dependent. Please consult +the documentation of your operating system. + +=== Using a supervisor for connection processes + +Ranch allows you to define the type of process that will be used +for the connection processes. By default it expects a `worker`. +When the `connection_type` configuration value is set to `supervisor`, +Ranch will consider that the connection process it manages is a +supervisor and will reflect that in its supervision tree. + +Connection processes of type `supervisor` can either handle the +socket directly or through one of their children. In the latter +case the start function for the connection process must return +two pids: the pid of the supervisor you created (that will be +supervised) and the pid of the protocol handling process (that +will receive the socket). + +Instead of returning `{ok, ConnPid}`, simply return +`{ok, SupPid, ConnPid}`. + +It is very important that the connection process be created +under the supervisor process so that everything works as intended. +If not, you will most likely experience issues when the supervised +process is stopped. + +=== Upgrading + +Ranch allows you to upgrade the protocol options. This takes effect +immediately and for all subsequent connections. + +To upgrade the protocol options, call `ranch:set_protocol_options/2` +with the name of the listener as first argument and the new options +as the second. + +.Upgrading the protocol options + +[source,erlang] +ranch:set_protocol_options(tcp_echo, NewOpts). + +All future connections will use the new options. + +You can also retrieve the current options similarly by +calling `ranch:get_protocol_options/1`. + +.Retrieving the current protocol options + +[source,erlang] +Opts = ranch:get_protocol_options(tcp_echo). + +=== Changing transport options + +Ranch allows you to change the transport options of a listener with +the `ranch:set_transport_options/2` function, for example to change the +number of acceptors or to make it listen on a different port. + +.Changing the transport options + +[source,erlang] +ranch:set_transport_options(tcp_echo, NewOpts). + +You can retrieve the current transport options by calling +`ranch:get_transport_options/1`. + +.Retrieving the current transport options + +[source,erlang] +Opts = ranch:get_transport_options(tcp_echo). + +=== Obtaining information about listeners + +Ranch provides two functions for retrieving information about the +listeners, for reporting and diagnostic purposes. + +The `ranch:info/0` function will return detailed information +about all listeners. + +.Retrieving detailed information +[source,erlang] +ranch:info(). + +The `ranch:procs/2` function will return all acceptor or listener +processes for a given listener. + +.Get all acceptor processes +[source,erlang] +ranch:procs(tcp_echo, acceptors). + +.Get all connection processes +[source,erlang] +ranch:procs(tcp_echo, connections). diff --git a/docs/en/ranch/2.2/guide/listeners/index.html b/docs/en/ranch/2.2/guide/listeners/index.html new file mode 100644 index 00000000..4a36156b --- /dev/null +++ b/docs/en/ranch/2.2/guide/listeners/index.html @@ -0,0 +1,503 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.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 whose role is to listen on a port for new connections. It manages a pool of acceptor processes, each of them indefinitely accepting connections. When it does, it starts a new process executing the protocol handler code. All the socket programming is abstracted through the use of transport handlers.</p> +<p>The listener takes care of supervising all the acceptor and connection processes, allowing developers to focus on building their application.</p> +<h2 id="_starting_a_listener">Starting a listener</h2> +<p>Ranch does nothing by default. It is up to the application developer to request that Ranch listens for connections.</p> +<p>A listener can be started and stopped at will.</p> +<p>When starting a listener, a number of different settings are required:</p> +<ul><li>A name to identify it locally and be able to interact with it. +</li> +<li>A transport handler and its associated options. +</li> +<li>A protocol handler and its associated options. +</li> +</ul> +<p>Ranch includes both TCP and SSL transport handlers, respectively <code>ranch_tcp</code> and <code>ranch_ssl</code>.</p> +<p>A listener can be started by calling the <code>ranch:start_listener/5</code> function. Before doing so however, you must ensure that the <code>ranch</code> application is started.</p> +<div class="listingblock"><div class="title">Starting the Ranch application</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">application:start</font></b>(<font color="#FF6600">ranch</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>You are then ready to start a listener. Let's call it <code>tcp_echo</code>. It will have a pool of 100 acceptors, use a TCP transport and forward connections to the <code>echo_protocol</code> handler.</p> +<div class="listingblock"><div class="title">Starting a listener for TCP connections on port 5555</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="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:start_listener</font></b>(<font color="#FF6600">tcp_echo</font>, + <font color="#FF6600">ranch_tcp</font>, #{<font color="#0000FF">socket_opts</font> <font color="#990000">=></font> [{<font color="#FF6600">port</font>, <font color="#993399">5555</font>}]}, + <font color="#FF6600">echo_protocol</font>, [] +)<font color="#990000">.</font></tt></pre> +</div></div> +<p>You can try this out by compiling and running the <code>tcp_echo</code> example in the examples directory. To do so, open a shell in the <em>examples/tcp_echo/</em> directory and run the following command:</p> +<div class="listingblock"><div class="title">Building and starting a Ranch example</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>$ make run</tt></pre> +</div></div> +<p>You can then connect to it using telnet and see the echo server reply everything you send to it. Then when you're done testing, you can use the <code>Ctrl+]</code> key to escape to the telnet command line and type <code>quit</code> to exit.</p> +<div class="listingblock"><div class="title">Connecting to the example listener with telnet</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>$ telnet localhost <font color="#993399">5555</font> +Trying <font color="#993399">127.0</font><font color="#990000">.</font><font color="#993399">0.1</font><font color="#990000">...</font> +Connected to localhost<font color="#990000">.</font> +Escape character is <font color="#FF0000">'^]'</font><font color="#990000">.</font> +Hello<font color="#990000">!</font> +Hello<font color="#990000">!</font> +It works<font color="#990000">!</font> +It works<font color="#990000">!</font> +<font color="#990000">^]</font> + +telnet<font color="#990000">></font> quit +Connection closed<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_stopping_a_listener">Stopping a listener</h2> +<p>All you need to stop a Ranch listener is to call the <code>ranch:stop_listener/1</code> function with the listener's name as argument. In the previous section we started the listener named <code>tcp_echo</code>. We can now stop it.</p> +<div class="listingblock"><div class="title">Stopping 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><b><font color="#000000">ranch:stop_listener</font></b>(<font color="#FF6600">tcp_echo</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_suspending_and_resuming_a_listener">Suspending and resuming a listener</h2> +<p>Listeners can be suspended and resumed by calling <code>ranch:suspend_listener/1</code> and <code>ranch:resume_listener/1</code>, respectively, with the name of the listener as argument.</p> +<p>Suspending a listener will cause it to stop listening and not accept new connections, but existing connection processes will not be stopped.</p> +<div class="listingblock"><div class="title">Suspending 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><b><font color="#000000">ranch:suspend_listener</font></b>(<font color="#FF6600">tcp_echo</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Resuming a listener will cause it to start listening and accept new connections again. It is worth mentioning, however, that if the listener is configured to listen on a random port, it will listen on a different port than before it was suspended.</p> +<div class="listingblock"><div class="title">Resuming 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><b><font color="#000000">ranch:resume_listener</font></b>(<font color="#FF6600">tcp_echo</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Whether a listener is currently running or suspended can be queried by calling <code>ranch:get_status/1</code> with the listener name as argument.</p> +<h2 id="_default_transport_options">Default transport options</h2> +<p>By default the socket will be set to return <code>binary</code> data, with the options <code>{active, false}</code>, <code>{packet, raw}</code>, <code>{reuseaddr, true}</code> set. These values can't be overridden when starting the listener, but they can be overridden using <code>Transport:setopts/2</code> in the protocol.</p> +<p>It will also set <code>{backlog, 1024}</code> and <code>{nodelay, true}</code>, which can be overridden at listener startup.</p> +<h2 id="_listening_on_a_random_port">Listening on a random port</h2> +<p>You do not have to specify a specific port to listen on. If you give the port number 0, or if you omit the port number entirely, Ranch will start listening on a random port.</p> +<p>You can retrieve this port number by calling <code>ranch:get_port/1</code>. The argument is the name of the listener you gave in <code>ranch:start_listener/5</code>.</p> +<div class="listingblock"><div class="title">Starting a listener for TCP connections 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="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:start_listener</font></b>(<font color="#FF6600">tcp_echo</font>, + <font color="#FF6600">ranch_tcp</font>, #{<font color="#0000FF">socket_opts</font> <font color="#990000">=></font> [{<font color="#FF6600">port</font>, <font color="#993399">0</font>}]}, + <font color="#FF6600">echo_protocol</font>, [] +)<font color="#990000">.</font> +<font color="#009900">Port</font> <font color="#990000">=</font> <b><font color="#000000">ranch:get_port</font></b>(<font color="#FF6600">tcp_echo</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_listening_on_privileged_ports">Listening on privileged ports</h2> +<p>Some systems limit access to ports below 1024 for security reasons. This can easily be identified by an <code>{error, eacces}</code> error when trying to open a listening socket on such a port.</p> +<p>The methods for listening on privileged ports vary between systems, please refer to your system's documentation for more information.</p> +<p>We recommend the use of port rewriting for systems with a single server, and load balancing for systems with multiple servers. Documenting these solutions is however out of the scope of this guide.</p> +<h2 id="_listening_on_a_unix_domain_socket">Listening on a UNIX Domain socket</h2> +<p>On UNIX systems, it is also possible to use Ranch to listen on a UNIX domain socket by specifying <code>{local, SocketFile}</code> for the <code>ip</code> socket option. In this case, the port must be set to 0 or omitted. The given file must not exist: Ranch must be able to create it.</p> +<div class="listingblock"><div class="title">Starting a listener for TCP connections on 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="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:start_listener</font></b>(<font color="#FF6600">tcp_echo</font>, + <font color="#FF6600">ranch_tcp</font>, #{<font color="#0000FF">socket_opts</font> <font color="#990000">=></font> [ + {<font color="#FF6600">ip</font>, {<font color="#FF6600">local</font>, <font color="#FF0000">"/tmp/ranch_echo.sock"</font>}}, + {<font color="#FF6600">port</font>, <font color="#993399">0</font>} + ]}, <font color="#FF6600">echo_protocol</font>, [] +)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_performing_additional_setup_steps_on_a_listening_socket">Performing additional setup steps on a listening socket</h2> +<p>If it is necessary to perform additional setup steps on the listening socket, it is possible to specify a function with the transport option <code>post_listen_callback</code>. This function will be called after the listening socket has been created but before accepting connections on it, with the socket as the single argument.</p> +<p>The function must return either the atom <code>ok</code>, after which the listener will start accepting connections on the socket, or a tuple <code>{error, Reason}</code> which will cause the listener to fail starting with <code>Reason</code>.</p> +<div class="listingblock"><div class="title">Setting permissions on a UNIX Domain socket 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="#009900">PostListenCb</font> <font color="#990000">=</font> <b><font color="#0000FF">fun</font></b> (<font color="#009900">Sock</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">ranch_tcp:sockname</font></b>(<font color="#009900">Sock</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">ok</font>, {<font color="#FF6600">local</font>, <font color="#009900">SockFile</font>}} <font color="#990000">-></font> + <b><font color="#000000">file:change_mode</font></b>(<font color="#009900">SockFile</font>, <font color="#993399">8#777</font>); + {<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">-></font> + <font color="#FF6600">ok</font>; + <font color="#009900">Error</font> <font color="#990000">=</font> {<font color="#FF6600">error</font>, <font color="#990000">_</font>} <font color="#990000">-></font> + <font color="#009900">Error</font> + <b><font color="#0000FF">end</font></b> +<b><font color="#0000FF">end</font></b>, + +{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:start_listener</font></b>(<font color="#FF6600">tcp_echo</font>, + <font color="#FF6600">ranch_tcp</font>, #{ + <font color="#0000FF">socket_opts</font> <font color="#990000">=></font> [ + {<font color="#FF6600">ip</font>, {<font color="#FF6600">local</font>, <font color="#FF0000">"/tmp/ranch_echo.sock"</font>}}, + {<font color="#FF6600">port</font>, <font color="#993399">0</font>}], + <font color="#0000FF">post_listen_callback</font> <font color="#990000">=></font> <font color="#009900">PostListenCb</font>}, + <font color="#FF6600">echo_protocol</font>, [] +)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_accepting_connections_on_an_existing_socket">Accepting connections on an existing socket</h2> +<p>If you want to accept connections on an existing socket, you can write a custom <code>ranch_transport</code> implementation that fetches or otherwise acquires a listening socket in the <code>listen/1</code> callback and returns it in the form of <code>{ok, ListenSocket}</code>.</p> +<p>The custom <code>listen/1</code> function must ensure that the listener process (usually the process calling it) is also made the controlling process of the socket it returns. Failing to do so will result in stop/start and suspend/resume not working properly for that listener.</p> +<h2 id="_limiting_the_number_of_concurrent_connections">Limiting the number of concurrent connections</h2> +<p>The <code>max_connections</code> transport option allows you to limit the number of concurrent connections per connection supervisor (see below). It defaults to 1024. Its purpose is to prevent your system from being overloaded and ensuring all the connections are handled optimally.</p> +<div class="listingblock"><div class="title">Customizing the maximum number of concurrent connections</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="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:start_listener</font></b>(<font color="#FF6600">tcp_echo</font>, + <font color="#FF6600">ranch_tcp</font>, #{<font color="#0000FF">socket_opts</font> <font color="#990000">=></font> [{<font color="#FF6600">port</font>, <font color="#993399">5555</font>}], <font color="#0000FF">max_connections</font> <font color="#990000">=></font> <font color="#993399">100</font>}, + <font color="#FF6600">echo_protocol</font>, [] +)<font color="#990000">.</font></tt></pre> +</div></div> +<p>You can disable this limit by setting its value to the atom <code>infinity</code>.</p> +<div class="listingblock"><div class="title">Disabling the limit for the number of connections</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="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:start_listener</font></b>(<font color="#FF6600">tcp_echo</font>, + <font color="#FF6600">ranch_tcp</font>, #{<font color="#0000FF">socket_opts</font> <font color="#990000">=></font> [{<font color="#FF6600">port</font>, <font color="#993399">5555</font>}], <font color="#0000FF">max_connections</font> <font color="#990000">=></font> <font color="#FF6600">infinity</font>}, + <font color="#FF6600">echo_protocol</font>, [] +)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The maximum number of connections is a soft limit. In practice, it can reach <code>max_connections</code> + the number of acceptors.</p> +<p>When the maximum number of connections is reached, Ranch will stop accepting connections. This will not result in further connections being rejected, as the kernel option allows queueing incoming connections. The size of this queue is determined by the <code>backlog</code> option and defaults to 1024. Ranch does not know about the number of connections that are in the backlog.</p> +<p>You may not always want connections to be counted when checking for <code>max_connections</code>. For example you might have a protocol where both short-lived and long-lived connections are possible. If the long-lived connections are mostly waiting for messages, then they don't consume much resources and can safely be removed from the count.</p> +<p>To remove the connection from the count, you must call the <code>ranch:remove_connection/1</code> from within the connection process, with the name of the listener as the only argument.</p> +<div class="listingblock"><div class="title">Removing a connection from the count of connections</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">ranch:remove_connection</font></b>(<font color="#009900">Ref</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>As seen in the chapter covering protocols, this reference is received as the first argument of the protocol's <code>start_link/3</code> callback.</p> +<p>You can modify the <code>max_connections</code> value on a running listener by using the <code>ranch:set_max_connections/2</code> function, with the name of the listener as first argument and the new value as the second.</p> +<div class="listingblock"><div class="title">Upgrading the maximum number of connections</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">ranch:set_max_connections</font></b>(<font color="#FF6600">tcp_echo</font>, <font color="#009900">MaxConns</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The change will occur immediately.</p> +<h2 id="_customizing_the_number_of_acceptor_processes">Customizing the number of acceptor processes</h2> +<p>By default Ranch will use 10 acceptor processes. Their role is to accept connections and spawn a connection process for every new connection.</p> +<p>This number can be tweaked to improve performance. A good number is typically between 10 or 100 acceptors. You must measure to find the best value for your application.</p> +<div class="listingblock"><div class="title">Specifying a custom number of acceptor processes</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="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:start_listener</font></b>(<font color="#FF6600">tcp_echo</font>, + <font color="#FF6600">ranch_tcp</font>, #{<font color="#0000FF">socket_opts</font> <font color="#990000">=></font> [{<font color="#FF6600">port</font>, <font color="#993399">5555</font>}], <font color="#0000FF">num_acceptors</font> <font color="#990000">=></font> <font color="#993399">42</font>}, + <font color="#FF6600">echo_protocol</font>, [] +)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_customizing_the_number_of_connection_supervisors">Customizing the number of connection supervisors</h2> +<p>By default Ranch will use one connection supervisor for each acceptor process (but not vice versa). Their task is to supervise the connection processes started by an acceptor. The number of connection supervisors can be tweaked.</p> +<p>Note that the association between the individual acceptors and connection supervisors is fixed, meaning that acceptors will always use the same connection supervisor to start connection processes.</p> +<div class="listingblock"><div class="title">Specifying a custom number of connection supervisors</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="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:start_listener</font></b>(<font color="#FF6600">tcp_echo</font>, + <font color="#FF6600">ranch_tcp</font>, #{<font color="#0000FF">socket_opts</font> <font color="#990000">=></font> [{<font color="#FF6600">port</font>, <font color="#993399">5555</font>}], <font color="#0000FF">num_conns_sups</font> <font color="#990000">=></font> <font color="#993399">42</font>}, + <font color="#FF6600">echo_protocol</font>, [] +)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_setting_connection_count_alarms">Setting connection count alarms</h2> +<p>The <code>alarms</code> transport option allows you to configure alarms which will be triggered when the number of connections tracked by one connection supervisor reaches or exceeds the defined threshold.</p> +<p>The <code>alarms</code> transport option takes a map with alarm names as keys and alarm options as values.</p> +<p>Any term is allowed as an alarm name.</p> +<p>Alarm options include the alarm type and a threshold that, when reached, triggers the given callback. A cooldown prevents the alarm from being triggered too often.</p> +<div class="listingblock"><div class="title">Log warnings when the number of connections exceeds 100</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">Alarms</font> <font color="#990000">=</font> #{ + <font color="#0000FF">my_alarm</font> <font color="#990000">=></font> #{ + <font color="#0000FF">type</font> <font color="#990000">=></font> <font color="#FF6600">num_connections</font>, + <font color="#0000FF">threshold</font> <font color="#990000">=></font> <font color="#993399">100</font>, + <font color="#0000FF">callback</font> <font color="#990000">=></font> <b><font color="#0000FF">fun</font></b>(<font color="#009900">Ref</font>, <font color="#009900">Name</font>, <font color="#009900">ConnSup</font>, <font color="#009900">ConnPids</font>]) <font color="#990000">-></font> + <b><font color="#000000">logger:warning</font></b>(<font color="#FF0000">"Warning (~s): "</font> + <font color="#FF0000">"Supervisor ~s of listener ~s "</font> + <font color="#FF0000">"has ~b connections"</font>, + [<font color="#009900">Name</font>, <font color="#009900">Ref</font>, <font color="#009900">ConnSup</font>, <b><font color="#000080">length</font></b>(<font color="#009900">ConnPids</font>)]) + <b><font color="#0000FF">end</font></b> + } +}, +{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:start_listener</font></b>(<font color="#FF6600">tcp_echo</font>, + <font color="#FF6600">ranch_tcp</font>, #{<font color="#0000FF">alarms</font> <font color="#990000">=></font> <font color="#009900">Alarms</font>, <font color="#0000FF">socket_opts</font> <font color="#990000">=></font> [{<font color="#FF6600">port</font>, <font color="#993399">5555</font>}]}, + <font color="#FF6600">echo_protocol</font>, [] +)<font color="#990000">.</font></tt></pre> +</div></div> +<p>In the example code, an alarm named <code>my_alarm</code> is defined, which will call the given function when the number of connections tracked by the connection supervisor reaches or exceeds 100. When the number of connections is still (or again) above 100 after the default cooldown period of 5 seconds, the alarm will trigger again.</p> +<h2 id="_when_running_out_of_file_descriptors">When running out of file descriptors</h2> +<p>Operating systems have limits on the number of sockets which can be opened by applications. When this maximum is reached the listener can no longer accept new connections. The accept rate of the listener will be automatically reduced, and a warning message will be logged.</p> +<div class="listingblock"><div class="content"><pre>=ERROR REPORT==== 13-Jan-2016::12:24:38 === +Ranch acceptor reducing accept rate: out of file descriptors</pre></div></div> +<p>If you notice messages like this you should increase the number of file-descriptors which can be opened by your application. How this should be done is operating-system dependent. Please consult the documentation of your operating system.</p> +<h2 id="_using_a_supervisor_for_connection_processes">Using a supervisor for connection processes</h2> +<p>Ranch allows you to define the type of process that will be used for the connection processes. By default it expects a <code>worker</code>. When the <code>connection_type</code> configuration value is set to <code>supervisor</code>, Ranch will consider that the connection process it manages is a supervisor and will reflect that in its supervision tree.</p> +<p>Connection processes of type <code>supervisor</code> can either handle the socket directly or through one of their children. In the latter case the start function for the connection process must return two pids: the pid of the supervisor you created (that will be supervised) and the pid of the protocol handling process (that will receive the socket).</p> +<p>Instead of returning <code>{ok, ConnPid}</code>, simply return <code>{ok, SupPid, ConnPid}</code>.</p> +<p>It is very important that the connection process be created under the supervisor process so that everything works as intended. If not, you will most likely experience issues when the supervised process is stopped.</p> +<h2 id="_upgrading">Upgrading</h2> +<p>Ranch allows you to upgrade the protocol options. This takes effect immediately and for all subsequent connections.</p> +<p>To upgrade the protocol options, call <code>ranch:set_protocol_options/2</code> with the name of the listener as first argument and the new options as the second.</p> +<div class="listingblock"><div class="title">Upgrading the protocol 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><b><font color="#000000">ranch:set_protocol_options</font></b>(<font color="#FF6600">tcp_echo</font>, <font color="#009900">NewOpts</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>All future connections will use the new options.</p> +<p>You can also retrieve the current options similarly by calling <code>ranch:get_protocol_options/1</code>.</p> +<div class="listingblock"><div class="title">Retrieving the current protocol 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">Opts</font> <font color="#990000">=</font> <b><font color="#000000">ranch:get_protocol_options</font></b>(<font color="#FF6600">tcp_echo</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_changing_transport_options">Changing transport options</h2> +<p>Ranch allows you to change the transport options of a listener with the <code>ranch:set_transport_options/2</code> function, for example to change the number of acceptors or to make it listen on a different port.</p> +<div class="listingblock"><div class="title">Changing the transport 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><b><font color="#000000">ranch:set_transport_options</font></b>(<font color="#FF6600">tcp_echo</font>, <font color="#009900">NewOpts</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>You can retrieve the current transport options by calling <code>ranch:get_transport_options/1</code>.</p> +<div class="listingblock"><div class="title">Retrieving the current transport 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">Opts</font> <font color="#990000">=</font> <b><font color="#000000">ranch:get_transport_options</font></b>(<font color="#FF6600">tcp_echo</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_obtaining_information_about_listeners">Obtaining information about listeners</h2> +<p>Ranch provides two functions for retrieving information about the listeners, for reporting and diagnostic purposes.</p> +<p>The <code>ranch:info/0</code> function will return detailed information about all listeners.</p> +<div class="listingblock"><div class="title">Retrieving detailed information</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">ranch:info</font></b>()<font color="#990000">.</font></tt></pre> +</div></div> +<p>The <code>ranch:procs/2</code> function will return all acceptor or listener processes for a given listener.</p> +<div class="listingblock"><div class="title">Get all acceptor processes</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">ranch:procs</font></b>(<font color="#FF6600">tcp_echo</font>, <font color="#FF6600">acceptors</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Get all connection processes</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">ranch:procs</font></b>(<font color="#FF6600">tcp_echo</font>, <font color="#FF6600">connections</font>)<font color="#990000">.</font></tt></pre> +</div></div> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/2.2/guide/introduction/"> + Introduction + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/2.2/guide/transports/"> + Transports + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/guide/migrating_from_1.5.asciidoc b/docs/en/ranch/2.2/guide/migrating_from_1.5.asciidoc new file mode 100644 index 00000000..a454f932 --- /dev/null +++ b/docs/en/ranch/2.2/guide/migrating_from_1.5.asciidoc @@ -0,0 +1,76 @@ +[appendix] +== Migrating from Ranch 1.5 to 1.6 + +Ranch 1.6 added the ability to suspend and resume listeners. +It also deprecates a number of features and add interfaces +that will be used in Ranch 2.0. + +Ranch 1.6 is compatible with Erlang/OTP 18.0 onward. Support +for older releases has been removed. + +=== Features added + +* Listeners can now be suspended/resumed without stopping existing + connection processes. This effectively closes the listening socket + and stops the acceptor processes. + +* Transport options can now be updated for suspended listeners. + +* The `Socket` argument given when the protocol starts has been + deprecated. In Ranch 2.0 the socket will be obtainable only + by calling `ranch:handshake/1,2`. + +* Ranch-specific transport options and socket options are now + better separated. When passing Ranch-specific transport options, + Ranch now expects to receive a map, in which case socket + options are passed in the `socket_opts` value. When there + are only socket options they can be passed to Ranch directly + as a convenience. + +* Any future transport option will only be added to the map + type. This includes transport options added in this release. + +* The transport option `ack_timeout` was renamed to `handshake_timeout` + in the map type. + +* The `cacerts` socket option is now silenced in error logs + just like the `certs` and `key` options. + +* The manual has been heavily updated and now features one + manual page per function and module, complete with a per-function + changelog, examples and more. + +=== Experimental features added + +* It is now possible to configure the restart intensity for + `ranch_sup` using the OTP application environment. This + feature will remain undocumented unless there is popular + demand for it. + +* Add the transport 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. + +=== Changed behaviors + +* Transport modules must now implement `Transport:handshake/2,3` + which deprecates and will replace `Transport:accept_ack/1` in + Ranch 2.0. It returns a new socket and can therefore be used + for implementing TLS upgrade mechanisms. + +=== New functions + +* The functions `ranch:suspend_listener/1` and `ranch:resume_listener/1` + were added. In addition the function `ranch:get_state/1` can be used + to obtain the running state of a listener. + +* A function `ranch:wait_for_connections/3` was added. + +* A function `ranch:handshake/1,2` was added to replace the + function `ranch:accept_ack/1`. + +=== Bugs fixed + +* The specs for the function `Transport:sendfile/2,4,5` have been + corrected. The type used for the filename was too restricting. diff --git a/docs/en/ranch/2.2/guide/migrating_from_1.5/index.html b/docs/en/ranch/2.2/guide/migrating_from_1.5/index.html new file mode 100644 index 00000000..627545a4 --- /dev/null +++ b/docs/en/ranch/2.2/guide/migrating_from_1.5/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: Migrating from Ranch 1.5 to 1.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 Ranch 1.5 to 1.6</span></h1> + +<p>Ranch 1.6 added the ability to suspend and resume listeners. It also deprecates a number of features and add interfaces that will be used in Ranch 2.0.</p> +<p>Ranch 1.6 is compatible with Erlang/OTP 18.0 onward. Support for older releases has been removed.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Listeners can now be suspended/resumed without stopping existing connection processes. This effectively closes the listening socket and stops the acceptor processes. +</li> +<li>Transport options can now be updated for suspended listeners. +</li> +<li>The <code>Socket</code> argument given when the protocol starts has been deprecated. In Ranch 2.0 the socket will be obtainable only by calling <code>ranch:handshake/1,2</code>. +</li> +<li>Ranch-specific transport options and socket options are now better separated. When passing Ranch-specific transport options, Ranch now expects to receive a map, in which case socket options are passed in the <code>socket_opts</code> value. When there are only socket options they can be passed to Ranch directly as a convenience. +</li> +<li>Any future transport option will only be added to the map type. This includes transport options added in this release. +</li> +<li>The transport option <code>ack_timeout</code> was renamed to <code>handshake_timeout</code> in the map type. +</li> +<li>The <code>cacerts</code> socket option is now silenced in error logs just like the <code>certs</code> and <code>key</code> options. +</li> +<li>The manual has been heavily updated and now features one manual page per function and module, complete with a per-function changelog, examples and more. +</li> +</ul> +<h2 id="_experimental_features_added">Experimental features added</h2> +<ul><li>It is now possible to configure the restart intensity for <code>ranch_sup</code> using the OTP application environment. This feature will remain undocumented unless there is popular demand for it. +</li> +<li>Add the transport 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. +</li> +</ul> +<h2 id="_changed_behaviors">Changed behaviors</h2> +<ul><li>Transport modules must now implement <code>Transport:handshake/2,3</code> which deprecates and will replace <code>Transport:accept_ack/1</code> in Ranch 2.0. It returns a new socket and can therefore be used for implementing TLS upgrade mechanisms. +</li> +</ul> +<h2 id="_new_functions">New functions</h2> +<ul><li>The functions <code>ranch:suspend_listener/1</code> and <code>ranch:resume_listener/1</code> were added. In addition the function <code>ranch:get_state/1</code> can be used to obtain the running state of a listener. +</li> +<li>A function <code>ranch:wait_for_connections/3</code> was added. +</li> +<li>A function <code>ranch:handshake/1,2</code> was added to replace the function <code>ranch:accept_ack/1</code>. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>The specs for the function <code>Transport:sendfile/2,4,5</code> have been corrected. The type used for the filename was too restricting. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.6/"> + Migrating from Ranch 1.6 to 1.7 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.x/"> + Migrating from Ranch 1.x + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/guide/migrating_from_1.6.asciidoc b/docs/en/ranch/2.2/guide/migrating_from_1.6.asciidoc new file mode 100644 index 00000000..f0c32e88 --- /dev/null +++ b/docs/en/ranch/2.2/guide/migrating_from_1.6.asciidoc @@ -0,0 +1,46 @@ +[appendix] +== Migrating from Ranch 1.6 to 1.7 + +Ranch 1.7 adds built-in support for the PROXY protocol. + +The PROXY protocol is a simple and efficient way for proxies +to transmit information about the client. + +While a third-party library already existed, it was not +entirely compatible with the Ranch interface, in particular +when socket active mode was involved. This new implementation +fixes that and supports the full protocol with as little +overhead as possible compared to normal operations: just one +extra function call. + +Ranch 1.7 is compatible with Erlang/OTP 19.0 onward. Support +for Erlang/OTP 18 has been removed. + +=== Features added + +* Full support for the PROXY protocol was added. + +=== New functions + +* Add the function `ranch:recv_proxy_header/2` to receive + the PROXY protocol header and parse it. It must be called + before `ranch:handshake/1,2`. + +* Add the functions `ranch_proxy_header:parse/1` and + `ranch_proxy_header:header/1,2` to parse and build a + PROXY protocol header, respectively. + +=== Bugs fixed + +* Fix a race condition when the listener is restarted + after `ranch_listener_sup` crashes. This resulted in + the original options being used even if the options + were updated at runtime. + +* Make the acceptors exit instead of crash when the + listening socket has been closed to prevent + unnecessary logs. + +* Fix an issue where listener information would not get + cleaned up when an embedded listener was stopped. This + was fixed in Ranch 1.6.2. diff --git a/docs/en/ranch/2.2/guide/migrating_from_1.6/index.html b/docs/en/ranch/2.2/guide/migrating_from_1.6/index.html new file mode 100644 index 00000000..bc0a7c10 --- /dev/null +++ b/docs/en/ranch/2.2/guide/migrating_from_1.6/index.html @@ -0,0 +1,202 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Migrating from Ranch 1.6 to 1.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 Ranch 1.6 to 1.7</span></h1> + +<p>Ranch 1.7 adds built-in support for the PROXY protocol.</p> +<p>The PROXY protocol is a simple and efficient way for proxies to transmit information about the client.</p> +<p>While a third-party library already existed, it was not entirely compatible with the Ranch interface, in particular when socket active mode was involved. This new implementation fixes that and supports the full protocol with as little overhead as possible compared to normal operations: just one extra function call.</p> +<p>Ranch 1.7 is compatible with Erlang/OTP 19.0 onward. Support for Erlang/OTP 18 has been removed.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Full support for the PROXY protocol was added. +</li> +</ul> +<h2 id="_new_functions">New functions</h2> +<ul><li>Add the function <code>ranch:recv_proxy_header/2</code> to receive the PROXY protocol header and parse it. It must be called before <code>ranch:handshake/1,2</code>. +</li> +<li>Add the functions <code>ranch_proxy_header:parse/1</code> and <code>ranch_proxy_header:header/1,2</code> to parse and build a PROXY protocol header, respectively. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>Fix a race condition when the listener is restarted after <code>ranch_listener_sup</code> crashes. This resulted in the original options being used even if the options were updated at runtime. +</li> +<li>Make the acceptors exit instead of crash when the listening socket has been closed to prevent unnecessary logs. +</li> +<li>Fix an issue where listener information would not get cleaned up when an embedded listener was stopped. This was fixed in Ranch 1.6.2. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.7/"> + Migrating from Ranch 1.7+ to Ranch 2.0 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.5/"> + Migrating from Ranch 1.5 to 1.6 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/guide/migrating_from_1.7.asciidoc b/docs/en/ranch/2.2/guide/migrating_from_1.7.asciidoc new file mode 100644 index 00000000..e9b1c96e --- /dev/null +++ b/docs/en/ranch/2.2/guide/migrating_from_1.7.asciidoc @@ -0,0 +1,163 @@ +[appendix] +== Migrating from Ranch 1.7+ to Ranch 2.0 + +Ranch 2.0 adds support for multiple connection supervisors. + +Ranch 1.x had a bottleneck because it used only a single +connection supervisor. This was more evident when many +connections were dropped at once as the supervisor couldn't +keep up and failed to accept new connections while cleaning +up the old ones. Ranch 2.0 behaves much better in this scenario +by default. Multiple connection supervisors also helps with +concurrently accepting new connections. + +Ranch 2.0 also adds experimental support for opening more +than one listening socket on a single port. + +Starting with Ranch 2.0 we are also providing a +https://github.com/juhlig/prometheus_ranch[Prometheus collector] +as a separate project as well as a +https://github.com/juhlig/prometheus_ranch/blob/master/dashboards/ranch-dashboard.json[Grafana dashboard]. + +Ranch 2.0 is compatible with Erlang/OTP 21.0 onward. Support +for Erlang/OTP 19 and 20 has been removed. + +=== Features added + +* Ranch now comes with a `ranch.appup` file necessary for + performing release upgrades. A test suite has been added + to confirm release upgrades work from one tag to the next. + Numerous fixes were made that will also improve error recovery. + Release upgrades will only be supported from Ranch 2.0 + onward. + +* The `num_conns_sups` option has been added. It allows + configuring the number of connection supervisors. It + now defaults to `num_accceptors`. The old behavior can + be obtained by setting this value to 1. + +* The `logger` option is no longer experimental. It now + defaults to `logger` instead of `error_logger`. + +* UNIX domain sockets are now supported. + +* The active N socket option is now supported. It requires + Erlang/OTP 21.3 or above for TLS, however. + +* Embedded listeners are now failing in a predictable + manner when `ranch_server` goes down. It is no longer + necessary to embed `ranch_sup` and the recommendation + is now to just start Ranch normally when using embedded + listeners. + +* Two steps handshake is now supported. This allows + obtaining TLS extensions and updating options before + resuming the handshake. The handshake can also be + canceled. + +=== Experimental features added + +* The experimental `num_listen_sockets` option has been + added. It allows opening more than one listening socket + per listener. It can only be used alongside the Linux + `SO_REUSEPORT` socket option or equivalent. It allows + working around a bottleneck in the kernel and maximizes + resource usage, leading to increased rates for accepting + new connections. + +=== Features removed + +* The `socket` option was removed. A more viable solution + is to define a custom transport module that returns a fresh + socket when `Transport:listen/1` is called. + +=== Changed behaviors + +* The callback function `Transport:listen/1` and its + implementations in `ranch_tcp` and `ranch_ssl` have changed + to accept a map of transport options instead of only + socket options. + +* The callback function `Transport:messages/0` return value + now includes the tag used for passive messages. + +* The `Socket` argument was removed from `Protocol:start_link/3`. + The socket must now be obtained by calling `ranch:handshake/1,2`. + +=== Added functions + +* The functions `ranch:handshake_continue/1,2` and + `ranch:handshake_cancel/1` can be used to perform + a two steps handshake. These functions may not be + supported by all transports. + +=== Changed functions + +* The `NumAcceptors` argument was removed from `ranch:start_listener/5` + and `ranch:child_spec/5` and moved to the transport options. + +* Ranch options can no longer be passed along with socket options + as a proplist. The only forms allowed are now the `ranch:opts()` + map or only socket options as-is. Individual transport options + are now validated as well. The `ranch:opts()` map must + be used when socket options also use a map. This applies to the + `ranch:start_listener/5`, `ranch:child_spec/5` and + `ranch:set_transport_options/2` functions. + +* The function `ranch:info/1,2` now returns a map containing + each listener's information rather than a list of key/values. + The key `num_acceptors` was removed as it can be found in the + transport options. + +* The function `ranch:set_transport_options/2` no longer requires + the listener to be suspended. Which options apply immediately, + on suspend/resume or on restart has been documented. Some work + has also been done to make these option changes more predictable. + +=== Removed functions + +* The function `ranch:accept_ack/1` has been removed in favor + of `ranch:handshake/1,2`. + +=== Bugs fixed + +* Calling `ranch:remove_connection/1` will now resume a sleeping + acceptor process when applicable. + +* Repeatedly calling `ranch:remove_connection/1` from a connection + process would crash the respective connection supervisor. This has + now been fixed. + +* When a connection process was failing to start, the socket was + not closed and this lead to leaking sockets. This is now corrected. + +=== Other changes + +* Connection draining has now been documented in the guide + following user feedback and discussions. + +* Ranch is now tested against https://concuerror.com/[Concuerror], + a model checking tool for debugging, testing and verifying + concurrent Erlang programs. Two tests have been added in this + release and more will follow in the future. + +* Ranch is now tested against `stampede`, a chaos monkey style + testing tool. Currently includes three scenarios: normal + TCP and TLS listeners and embedded TCP listener. This new + test suite helped uncover a misplaced `monitor/2` call + added during the development of Ranch 2.0 (we were using a + similar tool, `havoc`, at the time of finding that issue). + +* The supervisor for acceptors and the parent supervisor for + connection supervisors now have an adaptive restart + intensity limit set to `1 + ceil(math:log2(NumChildren))` + to allow room for errors when they have many children. + +* Ranch now uses stricter compiler options. Missing function + specs were added to internal modules. + +* Ranch now calls `ssl:handshake/1,2,3` instead of + `ssl:ssl_accept/1,2`. + +* The `ranch_ssl:ssl_opt()` type has been updated to conform + with Erlang/OTP 23.0. diff --git a/docs/en/ranch/2.2/guide/migrating_from_1.7/index.html b/docs/en/ranch/2.2/guide/migrating_from_1.7/index.html new file mode 100644 index 00000000..a59bc90a --- /dev/null +++ b/docs/en/ranch/2.2/guide/migrating_from_1.7/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: Migrating from Ranch 1.7+ to Ranch 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 Ranch 1.7+ to Ranch 2.0</span></h1> + +<p>Ranch 2.0 adds support for multiple connection supervisors.</p> +<p>Ranch 1.x had a bottleneck because it used only a single connection supervisor. This was more evident when many connections were dropped at once as the supervisor couldn't keep up and failed to accept new connections while cleaning up the old ones. Ranch 2.0 behaves much better in this scenario by default. Multiple connection supervisors also helps with concurrently accepting new connections.</p> +<p>Ranch 2.0 also adds experimental support for opening more than one listening socket on a single port.</p> +<p>Starting with Ranch 2.0 we are also providing a <a href="https://github.com/juhlig/prometheus_ranch">Prometheus collector</a> as a separate project as well as a <a href="https://github.com/juhlig/prometheus_ranch/blob/master/dashboards/ranch-dashboard.json">Grafana dashboard</a>.</p> +<p>Ranch 2.0 is compatible with Erlang/OTP 21.0 onward. Support for Erlang/OTP 19 and 20 has been removed.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Ranch now comes with a <code>ranch.appup</code> file necessary for performing release upgrades. A test suite has been added to confirm release upgrades work from one tag to the next. Numerous fixes were made that will also improve error recovery. Release upgrades will only be supported from Ranch 2.0 onward. +</li> +<li>The <code>num_conns_sups</code> option has been added. It allows configuring the number of connection supervisors. It now defaults to <code>num_accceptors</code>. The old behavior can be obtained by setting this value to 1. +</li> +<li>The <code>logger</code> option is no longer experimental. It now defaults to <code>logger</code> instead of <code>error_logger</code>. +</li> +<li>UNIX domain sockets are now supported. +</li> +<li>The active N socket option is now supported. It requires Erlang/OTP 21.3 or above for TLS, however. +</li> +<li>Embedded listeners are now failing in a predictable manner when <code>ranch_server</code> goes down. It is no longer necessary to embed <code>ranch_sup</code> and the recommendation is now to just start Ranch normally when using embedded listeners. +</li> +<li>Two steps handshake is now supported. This allows obtaining TLS extensions and updating options before resuming the handshake. The handshake can also be canceled. +</li> +</ul> +<h2 id="_experimental_features_added">Experimental features added</h2> +<ul><li>The experimental <code>num_listen_sockets</code> option has been added. It allows opening more than one listening socket per listener. It can only be used alongside the Linux <code>SO_REUSEPORT</code> socket option or equivalent. It allows working around a bottleneck in the kernel and maximizes resource usage, leading to increased rates for accepting new connections. +</li> +</ul> +<h2 id="_features_removed">Features removed</h2> +<ul><li>The <code>socket</code> option was removed. A more viable solution is to define a custom transport module that returns a fresh socket when <code>Transport:listen/1</code> is called. +</li> +</ul> +<h2 id="_changed_behaviors">Changed behaviors</h2> +<ul><li>The callback function <code>Transport:listen/1</code> and its implementations in <code>ranch_tcp</code> and <code>ranch_ssl</code> have changed to accept a map of transport options instead of only socket options. +</li> +<li>The callback function <code>Transport:messages/0</code> return value now includes the tag used for passive messages. +</li> +<li>The <code>Socket</code> argument was removed from <code>Protocol:start_link/3</code>. The socket must now be obtained by calling <code>ranch:handshake/1,2</code>. +</li> +</ul> +<h2 id="_added_functions">Added functions</h2> +<ul><li>The functions <code>ranch:handshake_continue/1,2</code> and <code>ranch:handshake_cancel/1</code> can be used to perform a two steps handshake. These functions may not be supported by all transports. +</li> +</ul> +<h2 id="_changed_functions">Changed functions</h2> +<ul><li>The <code>NumAcceptors</code> argument was removed from <code>ranch:start_listener/5</code> and <code>ranch:child_spec/5</code> and moved to the transport options. +</li> +<li>Ranch options can no longer be passed along with socket options as a proplist. The only forms allowed are now the <code>ranch:opts()</code> map or only socket options as-is. Individual transport options are now validated as well. The <code>ranch:opts()</code> map must be used when socket options also use a map. This applies to the <code>ranch:start_listener/5</code>, <code>ranch:child_spec/5</code> and <code>ranch:set_transport_options/2</code> functions. +</li> +<li>The function <code>ranch:info/1,2</code> now returns a map containing each listener's information rather than a list of key/values. The key <code>num_acceptors</code> was removed as it can be found in the transport options. +</li> +<li>The function <code>ranch:set_transport_options/2</code> no longer requires the listener to be suspended. Which options apply immediately, on suspend/resume or on restart has been documented. Some work has also been done to make these option changes more predictable. +</li> +</ul> +<h2 id="_removed_functions">Removed functions</h2> +<ul><li>The function <code>ranch:accept_ack/1</code> has been removed in favor of <code>ranch:handshake/1,2</code>. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>Calling <code>ranch:remove_connection/1</code> will now resume a sleeping acceptor process when applicable. +</li> +<li>Repeatedly calling <code>ranch:remove_connection/1</code> from a connection process would crash the respective connection supervisor. This has now been fixed. +</li> +<li>When a connection process was failing to start, the socket was not closed and this lead to leaking sockets. This is now corrected. +</li> +</ul> +<h2 id="_other_changes">Other changes</h2> +<ul><li>Connection draining has now been documented in the guide following user feedback and discussions. +</li> +<li>Ranch is now tested against <a href="https://concuerror.com/">Concuerror</a>, a model checking tool for debugging, testing and verifying concurrent Erlang programs. Two tests have been added in this release and more will follow in the future. +</li> +<li>Ranch is now tested against <code>stampede</code>, a chaos monkey style testing tool. Currently includes three scenarios: normal TCP and TLS listeners and embedded TCP listener. This new test suite helped uncover a misplaced <code>monitor/2</code> call added during the development of Ranch 2.0 (we were using a similar tool, <code>havoc</code>, at the time of finding that issue). +</li> +<li>The supervisor for acceptors and the parent supervisor for connection supervisors now have an adaptive restart intensity limit set to <code>1 + ceil(math:log2(NumChildren))</code> to allow room for errors when they have many children. +</li> +<li>Ranch now uses stricter compiler options. Missing function specs were added to internal modules. +</li> +<li>Ranch now calls <code>ssl:handshake/1,2,3</code> instead of <code>ssl:ssl_accept/1,2</code>. +</li> +<li>The <code>ranch_ssl:ssl_opt()</code> type has been updated to conform with Erlang/OTP 23.0. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_2.0/"> + Migrating from Ranch 2.0 to Ranch 2.1 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.6/"> + Migrating from Ranch 1.6 to 1.7 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/guide/migrating_from_1.x.asciidoc b/docs/en/ranch/2.2/guide/migrating_from_1.x.asciidoc new file mode 100644 index 00000000..44babf17 --- /dev/null +++ b/docs/en/ranch/2.2/guide/migrating_from_1.x.asciidoc @@ -0,0 +1,70 @@ +[appendix] +== Migrating from Ranch 1.x + +The changelog for Ranch releases before 1.6 can be found +in this section. + +=== 1.5.0 + +* Add transport functions getopts/2, getstat/1 and getstat/2 +* Fix ranch:info/0 and ranch:procs/2 in embedded mode +* Prevent ranch_conns_sup from stopping on unexpected messages + +=== 1.4.0 + +* Add new transport option num_acceptor +* Deprecate ranch:start_listener/6 in favor of start_listener/5 +* Deprecate ranch:child_spec/6 in favor of child_spec/5 + +=== 1.3.0 + +The version numbers 1.3.1 and 1.3.2 were later made to fix +small mistakes made during the 1.3.0 release process. They +do not include code changes. + +* Tested with OTP R16B+ on Linux, FreeBSD, OSX and Windows +* Add ssl to the list of dependencies +* Add ranch:info/0 and ranch:procs/2 to retrieve Ranch state information +* Allow configuring a listener with only SNI, without a default certificate +* Blacklist transport options instead of whitelist +** Unknown options are now allowed, but will result in a Dialyzer warning +* Add many transport options typespecs and documentation +* Don't silently drop the accept rate when running out of fds +* Prevent a race condition when stopping listeners +* Improve reporting for common errors, for example eaddrinuse +* Fix double removal of connections bug +** The number of active connections should now be exact +* Fix stuck acceptor bug when controlling_socket returned errors +* Numerous documentation and examples improvements + +=== 1.2.1 + +* Fix bug preventing node shutdown when SSL is used with OTP 17.1+ +* Tune restart intensity in all supervisors + +=== 1.2.0 + +* Allow the supervised process and the process owning the socket to be different +* Add many transport options (please refer to the documentation) +* Add function ranch:get_addr/1 to retrieve both IP and port of listener +* Don't pass Ranch-specific options down to transports +** Should make Dialyzer happy in user projects +** New types ranch:opt(), ranch_tcp:opt(), ranch_ssl:ssl_opt() and ranch_ssl:opt() +* Fix crash when filtering unknown options out +* Print a warning for each option filtered out +* Handle Transport:controlling_socket/2 errors and close the socket +* Handle Protocol:start_link/4 crashes to avoid killing all active connections +* Use Asciidoc for documentation +* Test Ranch across 14 Erlang versions on CircleCI +* Improve and document test suites with recent ct_helper improvements +* Fix a number of intermittent test issues + +=== 1.1.0 + +* Add Transport:secure/0 +* Add SSL partial_chain option +* Stop reporting errors on {error, closed} in accept_ack + +=== 1.0.0 + +* Initial release diff --git a/docs/en/ranch/2.2/guide/migrating_from_1.x/index.html b/docs/en/ranch/2.2/guide/migrating_from_1.x/index.html new file mode 100644 index 00000000..d4597651 --- /dev/null +++ b/docs/en/ranch/2.2/guide/migrating_from_1.x/index.html @@ -0,0 +1,275 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.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 Ranch 1.x</title> + + <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 Ranch 1.x</span></h1> + +<p>The changelog for Ranch releases before 1.6 can be found in this section.</p> +<h2 id="_1_5_0">1.5.0</h2> +<ul><li>Add transport functions getopts/2, getstat/1 and getstat/2 +</li> +<li>Fix ranch:info/0 and ranch:procs/2 in embedded mode +</li> +<li>Prevent ranch_conns_sup from stopping on unexpected messages +</li> +</ul> +<h2 id="_1_4_0">1.4.0</h2> +<ul><li>Add new transport option num_acceptor +</li> +<li>Deprecate ranch:start_listener/6 in favor of start_listener/5 +</li> +<li>Deprecate ranch:child_spec/6 in favor of child_spec/5 +</li> +</ul> +<h2 id="_1_3_0">1.3.0</h2> +<p>The version numbers 1.3.1 and 1.3.2 were later made to fix small mistakes made during the 1.3.0 release process. They do not include code changes.</p> +<ul><li>Tested with OTP R16B+ on Linux, FreeBSD, OSX and Windows +</li> +<li>Add ssl to the list of dependencies +</li> +<li>Add ranch:info/0 and ranch:procs/2 to retrieve Ranch state information +</li> +<li>Allow configuring a listener with only SNI, without a default certificate +</li> +<li>Blacklist transport options instead of whitelist +<ul><li>Unknown options are now allowed, but will result in a Dialyzer warning +</li> +</ul> +</li> +<li>Add many transport options typespecs and documentation +</li> +<li>Don't silently drop the accept rate when running out of fds +</li> +<li>Prevent a race condition when stopping listeners +</li> +<li>Improve reporting for common errors, for example eaddrinuse +</li> +<li>Fix double removal of connections bug +<ul><li>The number of active connections should now be exact +</li> +</ul> +</li> +<li>Fix stuck acceptor bug when controlling_socket returned errors +</li> +<li>Numerous documentation and examples improvements +</li> +</ul> +<h2 id="_1_2_1">1.2.1</h2> +<ul><li>Fix bug preventing node shutdown when SSL is used with OTP 17.1+ +</li> +<li>Tune restart intensity in all supervisors +</li> +</ul> +<h2 id="_1_2_0">1.2.0</h2> +<ul><li>Allow the supervised process and the process owning the socket to be different +</li> +<li>Add many transport options (please refer to the documentation) +</li> +<li>Add function ranch:get_addr/1 to retrieve both IP and port of listener +</li> +<li>Don't pass Ranch-specific options down to transports +<ul><li>Should make Dialyzer happy in user projects +</li> +<li>New types ranch:opt(), ranch_tcp:opt(), ranch_ssl:ssl_opt() and ranch_ssl:opt() +</li> +</ul> +</li> +<li>Fix crash when filtering unknown options out +</li> +<li>Print a warning for each option filtered out +</li> +<li>Handle Transport:controlling_socket/2 errors and close the socket +</li> +<li>Handle Protocol:start_link/4 crashes to avoid killing all active connections +</li> +<li>Use Asciidoc for documentation +</li> +<li>Test Ranch across 14 Erlang versions on CircleCI +</li> +<li>Improve and document test suites with recent ct_helper improvements +</li> +<li>Fix a number of intermittent test issues +</li> +</ul> +<h2 id="_1_1_0">1.1.0</h2> +<ul><li>Add Transport:secure/0 +</li> +<li>Add SSL partial_chain option +</li> +<li>Stop reporting errors on {error, closed} in accept_ack +</li> +</ul> +<h2 id="_1_0_0">1.0.0</h2> +<ul><li>Initial release +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.5/"> + Migrating from Ranch 1.5 to 1.6 + </a> + + + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/guide/migrating_from_2.0.asciidoc b/docs/en/ranch/2.2/guide/migrating_from_2.0.asciidoc new file mode 100644 index 00000000..498a581c --- /dev/null +++ b/docs/en/ranch/2.2/guide/migrating_from_2.0.asciidoc @@ -0,0 +1,70 @@ +[appendix] +== Migrating from Ranch 2.0 to Ranch 2.1 + +Ranch 2.1 adds counters and alarms. + +The https://github.com/juhlig/prometheus_ranch[Prometheus collector] +was updated to include accepted/terminated connections +metrics. + +Ranch 2.1 is compatible with Erlang/OTP 22.0 onward. Support +for Erlang/OTP 21 has been removed. + +=== Features added + +* Metrics are now provided by `ranch:info/0,1`. Currently + includes accepted/terminated connection counts per + connection supervisor. + +* Alarms can now be configured. The only alarm currently + available is `num_connections`. When the number of + connections goes over a configurable threshold Ranch + will call the given callback. This can be used to + programmatically shut down idle connections to + make up space for new connections, for example. + +* A `post_listen_callback` option has been added. It + receives sockets immediately after the `Transport:listen/1` + call. It can be used for some additional initialization + of the socket, such as setting file permissions on + Unix domain sockets. + +* It is now possible to use TLS-PSK authentication + without having to specify a default certificate + for TLS < 1.3. + +=== Experimental features added + +* The `inet_backend` option is now properly handled + and tested for TCP listeners. This allows using + the experimental `socket` backend. The `socket` + backend is now tested with Ranch. Note that + there are known issues and Windows support is not + currently implemented. + +=== Changed behaviors + +* Ranch will now remove unsupported SSL/TLS options + where applicable. A warning will be logged when + this happens. Options are only removed when they + are not compatible with the selected TLS version + and leaving them would prevent the listener from + starting. ++ + The following options are removed when using TLS + 1.1, 1.2 or 1.3: `beast_mitigation` and `padding_check`. ++ + The following options are removed when using TLS + 1.3 exclusively: `client_renegotiation`, + `next_protocols_advertised`, `psk_identity`, + `reuse_session`, `reuse_sessions`, + `secure_renegotiate` and `user_lookup_fun`. + +=== Added functions + +* The function `ranch_proxy_header:to_connection_info/1` + converts PROXY protocol information to the same + format as `ssl:connection_information/1`. Because + there is little overlap only the `protocol`, + `selected_cipher_suite` and `sni_hostname` will + be available, however. diff --git a/docs/en/ranch/2.2/guide/migrating_from_2.0/index.html b/docs/en/ranch/2.2/guide/migrating_from_2.0/index.html new file mode 100644 index 00000000..0734966f --- /dev/null +++ b/docs/en/ranch/2.2/guide/migrating_from_2.0/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: Migrating from Ranch 2.0 to Ranch 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 Ranch 2.0 to Ranch 2.1</span></h1> + +<p>Ranch 2.1 adds counters and alarms.</p> +<p>The <a href="https://github.com/juhlig/prometheus_ranch">Prometheus collector</a> was updated to include accepted/terminated connections metrics.</p> +<p>Ranch 2.1 is compatible with Erlang/OTP 22.0 onward. Support for Erlang/OTP 21 has been removed.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Metrics are now provided by <code>ranch:info/0,1</code>. Currently includes accepted/terminated connection counts per connection supervisor. +</li> +<li>Alarms can now be configured. The only alarm currently available is <code>num_connections</code>. When the number of connections goes over a configurable threshold Ranch will call the given callback. This can be used to programmatically shut down idle connections to make up space for new connections, for example. +</li> +<li>A <code>post_listen_callback</code> option has been added. It receives sockets immediately after the <code>Transport:listen/1</code> call. It can be used for some additional initialization of the socket, such as setting file permissions on Unix domain sockets. +</li> +<li>It is now possible to use TLS-PSK authentication without having to specify a default certificate for TLS < 1.3. +</li> +</ul> +<h2 id="_experimental_features_added">Experimental features added</h2> +<ul><li>The <code>inet_backend</code> option is now properly handled and tested for TCP listeners. This allows using the experimental <code>socket</code> backend. The <code>socket</code> backend is now tested with Ranch. Note that there are known issues and Windows support is not currently implemented. +</li> +</ul> +<h2 id="_changed_behaviors">Changed behaviors</h2> +<ul><li>Ranch will now remove unsupported SSL/TLS options where applicable. A warning will be logged when this happens. Options are only removed when they are not compatible with the selected TLS version and leaving them would prevent the listener from starting. +<p>The following options are removed when using TLS 1.1, 1.2 or 1.3: <code>beast_mitigation</code> and <code>padding_check</code>.</p> +<p>The following options are removed when using TLS 1.3 exclusively: <code>client_renegotiation</code>, <code>next_protocols_advertised</code>, <code>psk_identity</code>, <code>reuse_session</code>, <code>reuse_sessions</code>, <code>secure_renegotiate</code> and <code>user_lookup_fun</code>.</p> +</li> +</ul> +<h2 id="_added_functions">Added functions</h2> +<ul><li>The function <code>ranch_proxy_header:to_connection_info/1</code> converts PROXY protocol information to the same format as <code>ssl:connection_information/1</code>. Because there is little overlap only the <code>protocol</code>, <code>selected_cipher_suite</code> and <code>sni_hostname</code> will be available, however. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_2.1/"> + Migrating from Ranch 2.1 to Ranch 2.2 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.7/"> + Migrating from Ranch 1.7+ to Ranch 2.0 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/guide/migrating_from_2.1.asciidoc b/docs/en/ranch/2.2/guide/migrating_from_2.1.asciidoc new file mode 100644 index 00000000..7cec7c8e --- /dev/null +++ b/docs/en/ranch/2.2/guide/migrating_from_2.1.asciidoc @@ -0,0 +1,49 @@ +[appendix] +== Migrating from Ranch 2.1 to Ranch 2.2 + +Ranch 2.2 is a maintenance release containing a small number +of fixes and improvements. + +Ranch 2.2 is tested with Erlang/OTP 24.0 onward, although it +should be compatible with Erlang/OTP 22.0 and above. + +=== Features added + +* `DTLS` is now supported. + +* The `certs_keys` option from `ssl` is now accepted + and documented. + +* The `UNIQUE_ID` PROXY protocol header extension is + now supported. + +* The `ranch_transport` behavior has a new callback + `format_error/1` which allows finer grained formatting + of Ranch's error messages. The callback is currently + optional and will become required in Ranch 3.0. + +=== Changed behaviors + +* Ranch will now obfuscate certificates, keys and passwords + in the error message produced on listen error. + +* The exception reason when a connection process has failed + its handshake has been changed to `{shutdown, {Reason, PeerInfo}}` + where `PeerInfo` contains the peer name when available. + +* The `{packet, raw}` socket option is no longer set explicitly, + as this is already the default value. + +=== Bugs fixed + +* `ranch:stop_listener/1` will now return an error instead + of throwing an exception when the listener does not exist. + +* Fix `ranch:recv_proxy_header/2` for the upcoming Erlang/OTP 28. + +* Ensure that a user crash while stopping a listener does + not prevent a subsequent attempt to stop it. + +* Alarm option `threshold` was mispelled in Ranch 2.1. This + has been corrected. The wrong spelling `treshold` is still + accepted and will be removed in Ranch 3.0. diff --git a/docs/en/ranch/2.2/guide/migrating_from_2.1/index.html b/docs/en/ranch/2.2/guide/migrating_from_2.1/index.html new file mode 100644 index 00000000..2a33e82e --- /dev/null +++ b/docs/en/ranch/2.2/guide/migrating_from_2.1/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 Ranch 2.1 to Ranch 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 Ranch 2.1 to Ranch 2.2</span></h1> + +<p>Ranch 2.2 is a maintenance release containing a small number of fixes and improvements.</p> +<p>Ranch 2.2 is tested with Erlang/OTP 24.0 onward, although it should be compatible with Erlang/OTP 22.0 and above.</p> +<h2 id="_features_added">Features added</h2> +<ul><li><code>DTLS</code> is now supported. +</li> +<li>The <code>certs_keys</code> option from <code>ssl</code> is now accepted and documented. +</li> +<li>The <code>UNIQUE_ID</code> PROXY protocol header extension is now supported. +</li> +<li>The <code>ranch_transport</code> behavior has a new callback <code>format_error/1</code> which allows finer grained formatting of Ranch's error messages. The callback is currently optional and will become required in Ranch 3.0. +</li> +</ul> +<h2 id="_changed_behaviors">Changed behaviors</h2> +<ul><li>Ranch will now obfuscate certificates, keys and passwords in the error message produced on listen error. +</li> +<li>The exception reason when a connection process has failed its handshake has been changed to <code>{shutdown, {Reason, PeerInfo}}</code> where <code>PeerInfo</code> contains the peer name when available. +</li> +<li>The <code>{packet, raw}</code> socket option is no longer set explicitly, as this is already the default value. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li><code>ranch:stop_listener/1</code> will now return an error instead of throwing an exception when the listener does not exist. +</li> +<li>Fix <code>ranch:recv_proxy_header/2</code> for the upcoming Erlang/OTP 28. +</li> +<li>Ensure that a user crash while stopping a listener does not prevent a subsequent attempt to stop it. +</li> +<li>Alarm option <code>threshold</code> was mispelled in Ranch 2.1. This has been corrected. The wrong spelling <code>treshold</code> is still accepted and will be removed in Ranch 3.0. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/2.2/guide/internals/"> + Internals + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_2.0/"> + Migrating from Ranch 2.0 to Ranch 2.1 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/guide/parsers.asciidoc b/docs/en/ranch/2.2/guide/parsers.asciidoc new file mode 100644 index 00000000..7a9c5a53 --- /dev/null +++ b/docs/en/ranch/2.2/guide/parsers.asciidoc @@ -0,0 +1,92 @@ +== Writing parsers + +There are three kinds of protocols: + +* Text protocols +* Schema-less binary protocols +* Schema-based binary protocols + +This chapter introduces the first two kinds. It will not cover +more advanced topics such as continuations or parser generators. + +This chapter isn't specifically about Ranch, we assume here that +you know how to read data from the socket. The data you read and +the data that hasn't been parsed is saved in a buffer. Every +time you read from the socket, the data read is appended to the +buffer. What happens next depends on the kind of protocol. We +will only cover the first two. + +=== Parsing text + +Text protocols are generally line based. This means that we can't +do anything with them until we receive the full line. + +A simple way to get a full line is to use `binary:split/2,3`. + +.Using binary:split/2 to get a line of input + +[source,erlang] +case binary:split(Buffer, <<"\n">>) of + [_] -> + get_more_data(Buffer); + [Line, Rest] -> + handle_line(Line, Rest) +end. + +In the above example, we can have two results. Either there was +a line break in the buffer and we get it split into two parts, +the line and the rest of the buffer; or there was no line break +in the buffer and we need to get more data from the socket. + +Next, we need to parse the line. The simplest way is to again +split, here on space. The difference is that we want to split +on all spaces character, as we want to tokenize the whole string. + +.Using binary:split/3 to split text + +[source,erlang] +case binary:split(Line, <<" ">>, [global]) of + [<<"HELLO">>] -> + be_polite(); + [<<"AUTH">>, User, Password] -> + authenticate_user(User, Password); + [<<"QUIT">>, Reason] -> + quit(Reason) + %% ... +end. + +Pretty simple, right? Match on the command name, get the rest +of the tokens in variables and call the respective functions. + +After doing this, you will want to check if there is another +line in the buffer, and handle it immediately if any. +Otherwise wait for more data. + +=== Parsing binary + +Binary protocols can be more varied, although most of them are +pretty similar. The first four bytes of a frame tend to be +the size of the frame, which is followed by a certain number +of bytes for the type of frame and then various parameters. + +Sometimes the size of the frame includes the first four bytes, +sometimes not. Other times this size is encoded over two bytes. +And even other times little-endian is used instead of big-endian. + +The general idea stays the same though. + +.Using binary pattern matching to split frames + +[source,erlang] +<< Size:32, _/bits >> = Buffer, +case Buffer of + << Frame:Size/binary, Rest/bits >> -> + handle_frame(Frame, Rest); + _ -> + get_more_data(Buffer) +end. + +You will then need to parse this frame using binary pattern +matching, and handle it. Then you will want to check if there +is another frame fully received in the buffer, and handle it +immediately if any. Otherwise wait for more data. diff --git a/docs/en/ranch/2.2/guide/parsers/index.html b/docs/en/ranch/2.2/guide/parsers/index.html new file mode 100644 index 00000000..a1bd1128 --- /dev/null +++ b/docs/en/ranch/2.2/guide/parsers/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: Writing parsers</title> + + <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>Writing parsers</span></h1> + +<p>There are three kinds of protocols:</p> +<ul><li>Text protocols +</li> +<li>Schema-less binary protocols +</li> +<li>Schema-based binary protocols +</li> +</ul> +<p>This chapter introduces the first two kinds. It will not cover more advanced topics such as continuations or parser generators.</p> +<p>This chapter isn't specifically about Ranch, we assume here that you know how to read data from the socket. The data you read and the data that hasn't been parsed is saved in a buffer. Every time you read from the socket, the data read is appended to the buffer. What happens next depends on the kind of protocol. We will only cover the first two.</p> +<h2 id="_parsing_text">Parsing text</h2> +<p>Text protocols are generally line based. This means that we can't do anything with them until we receive the full line.</p> +<p>A simple way to get a full line is to use <code>binary:split/2,3</code>.</p> +<div class="listingblock"><div class="title">Using binary:split/2 to get a line of input</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">binary:split</font></b>(<font color="#009900">Buffer</font>, <font color="#990000"><<</font><font color="#FF0000">"\n"</font><font color="#990000">>></font>) <b><font color="#0000FF">of</font></b> + [<font color="#990000">_</font>] <font color="#990000">-></font> + <b><font color="#000000">get_more_data</font></b>(<font color="#009900">Buffer</font>); + [<font color="#009900">Line</font>, <font color="#009900">Rest</font>] <font color="#990000">-></font> + <b><font color="#000000">handle_line</font></b>(<font color="#009900">Line</font>, <font color="#009900">Rest</font>) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>In the above example, we can have two results. Either there was a line break in the buffer and we get it split into two parts, the line and the rest of the buffer; or there was no line break in the buffer and we need to get more data from the socket.</p> +<p>Next, we need to parse the line. The simplest way is to again split, here on space. The difference is that we want to split on all spaces character, as we want to tokenize the whole string.</p> +<div class="listingblock"><div class="title">Using binary:split/3 to split text</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">binary:split</font></b>(<font color="#009900">Line</font>, <font color="#990000"><<</font><font color="#FF0000">" "</font><font color="#990000">>></font>, [<font color="#FF6600">global</font>]) <b><font color="#0000FF">of</font></b> + [<font color="#990000"><<</font><font color="#FF0000">"HELLO"</font><font color="#990000">>></font>] <font color="#990000">-></font> + <b><font color="#000000">be_polite</font></b>(); + [<font color="#990000"><<</font><font color="#FF0000">"AUTH"</font><font color="#990000">>></font>, <font color="#009900">User</font>, <font color="#009900">Password</font>] <font color="#990000">-></font> + <b><font color="#000000">authenticate_user</font></b>(<font color="#009900">User</font>, <font color="#009900">Password</font>); + [<font color="#990000"><<</font><font color="#FF0000">"QUIT"</font><font color="#990000">>></font>, <font color="#009900">Reason</font>] <font color="#990000">-></font> + <b><font color="#000000">quit</font></b>(<font color="#009900">Reason</font>) + <i><font color="#9A1900">%% ...</font></i> +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>Pretty simple, right? Match on the command name, get the rest of the tokens in variables and call the respective functions.</p> +<p>After doing this, you will want to check if there is another line in the buffer, and handle it immediately if any. Otherwise wait for more data.</p> +<h2 id="_parsing_binary">Parsing binary</h2> +<p>Binary protocols can be more varied, although most of them are pretty similar. The first four bytes of a frame tend to be the size of the frame, which is followed by a certain number of bytes for the type of frame and then various parameters.</p> +<p>Sometimes the size of the frame includes the first four bytes, sometimes not. Other times this size is encoded over two bytes. And even other times little-endian is used instead of big-endian.</p> +<p>The general idea stays the same though.</p> +<div class="listingblock"><div class="title">Using binary pattern matching to split frames</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="#009900">Size</font><font color="#990000">:</font><font color="#993399">32</font>, <font color="#990000">_/</font><font color="#FF6600">bits</font> <font color="#990000">>></font> <font color="#990000">=</font> <font color="#009900">Buffer</font>, +<b><font color="#0000FF">case</font></b> <font color="#009900">Buffer</font> <b><font color="#0000FF">of</font></b> + <font color="#990000"><<</font> <font color="#009900">Frame</font><font color="#990000">:</font><font color="#009900">Size</font><font color="#990000">/</font><b><font color="#000080">binary</font></b>, <font color="#009900">Rest</font><font color="#990000">/</font><font color="#FF6600">bits</font> <font color="#990000">>></font> <font color="#990000">-></font> + <b><font color="#000000">handle_frame</font></b>(<font color="#009900">Frame</font>, <font color="#009900">Rest</font>); + <font color="#990000">_</font> <font color="#990000">-></font> + <b><font color="#000000">get_more_data</font></b>(<font color="#009900">Buffer</font>) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>You will then need to parse this frame using binary pattern matching, and handle it. Then you will want to check if there is another frame fully received in the buffer, and handle it immediately if any. Otherwise wait for more data.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/2.2/guide/embedded/"> + Embedded mode + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/2.2/guide/ssl_auth/"> + SSL client authentication + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/guide/protocols.asciidoc b/docs/en/ranch/2.2/guide/protocols.asciidoc new file mode 100644 index 00000000..8f55cea2 --- /dev/null +++ b/docs/en/ranch/2.2/guide/protocols.asciidoc @@ -0,0 +1,113 @@ +== Protocols + +A protocol handler starts a connection process and defines the +protocol logic executed in this process. + +=== Writing a protocol handler + +All protocol handlers must implement the `ranch_protocol` behavior +which defines a single callback, `start_link/3`. This callback is +responsible for spawning a new process for handling the connection. +It receives three arguments: the name of the listener, the +transport handler being used and the protocol options defined in +the call to `ranch:start_listener/5`. This callback must +return `{ok, Pid}`, with `Pid` the pid of the new process. + +The newly started process can then freely initialize itself. However, +it must call `ranch:handshake/1,2` before doing any socket operation. +This will ensure the connection process is the owner of the socket. +It expects the listener's name as argument. + +.Perform the socket handshake + +[source,erlang] +{ok, Socket} = ranch:handshake(Ref). + +If your protocol code requires specific socket options, you should +set them while initializing your connection process, after +calling `ranch:handshake/1,2`. You can use `Transport:setopts/2` +for that purpose. + +Following is the complete protocol code for the example found +in `examples/tcp_echo/`. + +.Protocol module that echoes everything it receives + +[source,erlang] +---- +-module(echo_protocol). +-behaviour(ranch_protocol). + +-export([start_link/3]). +-export([init/3]). + +start_link(Ref, Transport, Opts) -> + Pid = spawn_link(?MODULE, init, [Ref, Transport, Opts]), + {ok, Pid}. + +init(Ref, Transport, _Opts = []) -> + {ok, Socket} = ranch:handshake(Ref), + loop(Socket, Transport). + +loop(Socket, Transport) -> + case Transport:recv(Socket, 0, 5000) of + {ok, Data} -> + Transport:send(Socket, Data), + loop(Socket, Transport); + _ -> + ok = Transport:close(Socket) + end. +---- + +=== Using gen_statem and gen_server + +Special processes like the ones that use the `gen_statem` or `gen_server` +behaviours have the particularity of having their `start_link` call not +return until the `init` function returns. This is problematic, because +you won't be able to call `ranch:handshake/1,2` from the `init` callback +as this would cause a deadlock to happen. + +This problem can be addressed in several ways. + +==== gen_statem + +* Use state enter calls and place the `ranch:handshake/1,2` call in the enter + clause of the initial state. Check the `tcp_reverse` example for a complete + example. +* Use a `next_event` action in the return from `init/1` and place the + `ranch:handshake/1,2` call in the clause handling the event in the initial + state. +* Use the `gen_statem:enter_loop/4` function and start your process with + `proc_lib:spawn_link/3` or `proc_lib:start_link/3,4,5`. See below for an + example. + +.Using gen_statem:enter_loop/4 to start a protocol + +[source,erlang] +---- +-module(my_protocol). +-behaviour(gen_statem). +-behaviour(ranch_protocol). + +-export([start_link/3]). +-export([init/1]). +%% Exports of other gen_statem callbacks here. + +start_link(Ref, Transport, Opts) -> + {ok, proc_lib:spawn_link(?MODULE, init, [{Ref, Transport, Opts}])}. + +init({Ref, Transport, _Opts}) -> + %% Perform any required state initialization here. + {ok, Socket} = ranch:handshake(Ref), + ok = Transport:setopts(Socket, [{active, once}]), + gen_statem:enter_loop(?MODULE, [], state_name, {state_data, Socket, Transport}). + +%% Other gen_statem callbacks here. +---- + +==== gen_server + +* Use `{continue, Continue}` in the return from `init/1` and place the + `ranch:handshake/1,2` call in a corresponding `handle_continue/2` clause. +* Use the `gen_server:enter_loop/3` function and start your process with + `proc_lib:spawn_link/3` or `proc_lib:start_link/3,4,5`. diff --git a/docs/en/ranch/2.2/guide/protocols/index.html b/docs/en/ranch/2.2/guide/protocols/index.html new file mode 100644 index 00000000..28e1c0c7 --- /dev/null +++ b/docs/en/ranch/2.2/guide/protocols/index.html @@ -0,0 +1,262 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: 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>Protocols</span></h1> + +<p>A protocol handler starts a connection process and defines the protocol logic executed in this process.</p> +<h2 id="_writing_a_protocol_handler">Writing a protocol handler</h2> +<p>All protocol handlers must implement the <code>ranch_protocol</code> behavior which defines a single callback, <code>start_link/3</code>. This callback is responsible for spawning a new process for handling the connection. It receives three arguments: the name of the listener, the transport handler being used and the protocol options defined in the call to <code>ranch:start_listener/5</code>. This callback must return <code>{ok, Pid}</code>, with <code>Pid</code> the pid of the new process.</p> +<p>The newly started process can then freely initialize itself. However, it must call <code>ranch:handshake/1,2</code> before doing any socket operation. This will ensure the connection process is the owner of the socket. It expects the listener's name as argument.</p> +<div class="listingblock"><div class="title">Perform the socket handshake</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">Socket</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:handshake</font></b>(<font color="#009900">Ref</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>If your protocol code requires specific socket options, you should set them while initializing your connection process, after calling <code>ranch:handshake/1,2</code>. You can use <code>Transport:setopts/2</code> for that purpose.</p> +<p>Following is the complete protocol code for the example found in <code>examples/tcp_echo/</code>.</p> +<div class="listingblock"><div class="title">Protocol module that echoes everything it receives</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="#000080">-module</font></b>(<font color="#FF6600">echo_protocol</font>)<font color="#990000">.</font> +<b><font color="#000080">-behaviour</font></b>(<font color="#FF6600">ranch_protocol</font>)<font color="#990000">.</font> + +<b><font color="#000080">-export</font></b>([<b><font color="#000000">start_link</font></b><font color="#990000">/</font><font color="#993399">3</font>])<font color="#990000">.</font> +<b><font color="#000080">-export</font></b>([<b><font color="#000000">init</font></b><font color="#990000">/</font><font color="#993399">3</font>])<font color="#990000">.</font> + +<b><font color="#000000">start_link</font></b>(<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> + <font color="#009900">Pid</font> <font color="#990000">=</font> <b><font color="#000080">spawn_link</font></b>(<b><font color="#000080">?MODULE</font></b>, <font color="#FF6600">init</font>, [<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>]), + {<font color="#FF6600">ok</font>, <font color="#009900">Pid</font>}<font color="#990000">.</font> + +<b><font color="#000000">init</font></b>(<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">_Opts</font> <font color="#990000">=</font> []) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:handshake</font></b>(<font color="#009900">Ref</font>), + <b><font color="#000000">loop</font></b>(<font color="#009900">Socket</font>, <font color="#009900">Transport</font>)<font color="#990000">.</font> + +<b><font color="#000000">loop</font></b>(<font color="#009900">Socket</font>, <font color="#009900">Transport</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <font color="#009900">Transport</font><font color="#990000">:</font><b><font color="#000000">recv</font></b>(<font color="#009900">Socket</font>, <font color="#993399">0</font>, <font color="#993399">5000</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">ok</font>, <font color="#009900">Data</font>} <font color="#990000">-></font> + <font color="#009900">Transport</font><font color="#990000">:</font><b><font color="#000000">send</font></b>(<font color="#009900">Socket</font>, <font color="#009900">Data</font>), + <b><font color="#000000">loop</font></b>(<font color="#009900">Socket</font>, <font color="#009900">Transport</font>); + <font color="#990000">_</font> <font color="#990000">-></font> + <font color="#0000FF">ok</font> <font color="#990000">=</font> <font color="#009900">Transport</font><font color="#990000">:</font><b><font color="#000000">close</font></b>(<font color="#009900">Socket</font>) + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_using_gen_statem_and_gen_server">Using gen_statem and gen_server</h2> +<p>Special processes like the ones that use the <code>gen_statem</code> or <code>gen_server</code> behaviours have the particularity of having their <code>start_link</code> call not return until the <code>init</code> function returns. This is problematic, because you won't be able to call <code>ranch:handshake/1,2</code> from the <code>init</code> callback as this would cause a deadlock to happen.</p> +<p>This problem can be addressed in several ways.</p> +<h4 id="_gen_statem">gen_statem</h4> +<ul><li>Use state enter calls and place the <code>ranch:handshake/1,2</code> call in the enter clause of the initial state. Check the <code>tcp_reverse</code> example for a complete example. +</li> +<li>Use a <code>next_event</code> action in the return from <code>init/1</code> and place the <code>ranch:handshake/1,2</code> call in the clause handling the event in the initial state. +</li> +<li>Use the <code>gen_statem:enter_loop/4</code> function and start your process with <code>proc_lib:spawn_link/3</code> or <code>proc_lib:start_link/3,4,5</code>. See below for an example. +</li> +</ul> +<div class="listingblock"><div class="title">Using gen_statem:enter_loop/4 to start a protocol</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="#000080">-module</font></b>(<font color="#FF6600">my_protocol</font>)<font color="#990000">.</font> +<b><font color="#000080">-behaviour</font></b>(<font color="#FF6600">gen_statem</font>)<font color="#990000">.</font> +<b><font color="#000080">-behaviour</font></b>(<font color="#FF6600">ranch_protocol</font>)<font color="#990000">.</font> + +<b><font color="#000080">-export</font></b>([<b><font color="#000000">start_link</font></b><font color="#990000">/</font><font color="#993399">3</font>])<font color="#990000">.</font> +<b><font color="#000080">-export</font></b>([<b><font color="#000000">init</font></b><font color="#990000">/</font><font color="#993399">1</font>])<font color="#990000">.</font> +<i><font color="#9A1900">%% Exports of other gen_statem callbacks here.</font></i> + +<b><font color="#000000">start_link</font></b>(<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <b><font color="#000000">proc_lib:spawn_link</font></b>(<b><font color="#000080">?MODULE</font></b>, <font color="#FF6600">init</font>, [{<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>}])}<font color="#990000">.</font> + +<b><font color="#000000">init</font></b>({<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">_Opts</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Perform any required state initialization here.</font></i> + {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:handshake</font></b>(<font color="#009900">Ref</font>), + <font color="#0000FF">ok</font> <font color="#990000">=</font> <font color="#009900">Transport</font><font color="#990000">:</font><b><font color="#000000">setopts</font></b>(<font color="#009900">Socket</font>, [{<font color="#FF6600">active</font>, <font color="#FF6600">once</font>}]), + <b><font color="#000000">gen_statem:enter_loop</font></b>(<b><font color="#000080">?MODULE</font></b>, [], <font color="#FF6600">state_name</font>, {<font color="#FF6600">state_data</font>, <font color="#009900">Socket</font>, <font color="#009900">Transport</font>})<font color="#990000">.</font> + +<i><font color="#9A1900">%% Other gen_statem callbacks here.</font></i></tt></pre> +</div></div> +<h4 id="_gen_server">gen_server</h4> +<ul><li>Use <code>{continue, Continue}</code> in the return from <code>init/1</code> and place the <code>ranch:handshake/1,2</code> call in a corresponding <code>handle_continue/2</code> clause. +</li> +<li>Use the <code>gen_server:enter_loop/3</code> function and start your process with <code>proc_lib:spawn_link/3</code> or <code>proc_lib:start_link/3,4,5</code>. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/2.2/guide/transports/"> + Transports + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/2.2/guide/embedded/"> + Embedded mode + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/guide/ssl_auth.asciidoc b/docs/en/ranch/2.2/guide/ssl_auth.asciidoc new file mode 100644 index 00000000..f4364d06 --- /dev/null +++ b/docs/en/ranch/2.2/guide/ssl_auth.asciidoc @@ -0,0 +1,120 @@ +== SSL client authentication + +=== Purpose + +SSL client authentication is a mechanism allowing applications to +identify certificates. This allows your application to make sure that +the client is an authorized certificate, but makes no claim about +whether the user can be trusted. This can be combined with a password +based authentication to attain greater security. + +The server only needs to retain the certificate serial number and +the certificate issuer to authenticate the certificate. Together, +they can be used to uniquely identify a certificate. + +As Ranch allows the same protocol code to be used for both SSL and +non-SSL transports, you need to make sure you are in an SSL context +before attempting to perform an SSL client authentication. This +can be done by checking the return value of `Transport:name/0`. + +=== Obtaining client certificates + +You can obtain client certificates from various sources. You can +generate them yourself, or you can use a service like CAcert.org +which allows you to generate client and server certificates for +free. + +Following are the steps you need to take to create a CAcert.org +account, generate a certificate and install it in your favorite +browser. + +* Open http://cacert.org in your favorite browser +* Root Certificate link: install both certificates +* Join (Register an account) +* Verify your account (check your email inbox!) +* Log in +* Client Certificates: New +* Follow instructions to create the certificate +* Install the certificate in your browser + +You can optionally save the certificate for later use, for example +to extract the `IssuerID` information as will be detailed later on. + +=== Transport configuration + +The SSL transport does not request a client certificate by default. +You need to specify the `{verify, verify_peer}` option when starting +the listener to enable this behavior. + +.Configure a listener for SSL authentication + +[source,erlang] +{ok, _} = ranch:start_listener(my_ssl, + ranch_ssl, #{socket_opts => [ + {port, SSLPort}, + {certfile, PathToCertfile}, + {cacertfile, PathToCACertfile}, + {verify, verify_peer} + ]}, + my_protocol, [] +). + +In this example we set the required `port` and `certfile`, but also +the `cacertfile` containing the CACert.org root certificate, and +the option to request the client certificate. + +If you enable the `{verify, verify_peer}` option and the client does +not have a client certificate configured for your domain, then no +certificate will be sent. This allows you to use SSL for more than +just authenticated clients. + +=== Authentication + +To authenticate users, you must first save the certificate information +required. If you have your users' certificate files, you can simply +load the certificate and retrieve the information directly. + +.Retrieve the issuer ID from a certificate + +[source,erlang] +---- +certfile_to_issuer_id(Filename) -> + {ok, Data} = file:read_file(Filename), + [{'Certificate', Cert, not_encrypted}] = public_key:pem_decode(Data), + {ok, IssuerID} = public_key:pkix_issuer_id(Cert, self), + IssuerID. +---- + +The `IssuerID` variable contains both the certificate serial number +and the certificate issuer stored in a tuple, so this value alone can +be used to uniquely identify the user certificate. You can save this +value in a database, a configuration file or any other place where an +Erlang term can be stored and retrieved. + +To retrieve the `IssuerID` from a running connection, you need to first +retrieve the client certificate and then extract this information from +it. Ranch does not provide a function to retrieve the client certificate. +Instead you can use the `ssl:peercert/1` function. Once you have the +certificate, you can again use the `public_key:pkix_issuer_id/2` to +extract the `IssuerID` value. + +The following function returns the `IssuerID` or `false` if no client +certificate was found. This snippet is intended to be used from your +protocol code. + +.Retrieve the issuer ID from the certificate for the current connection + +[source,erlang] +---- +socket_to_issuer_id(Socket) -> + case ssl:peercert(Socket) of + {error, no_peercert} -> + false; + {ok, Cert} -> + {ok, IssuerID} = public_key:pkix_issuer_id(Cert, self), + IssuerID + end. +---- + +You then only need to match the `IssuerID` value to authenticate the +user. diff --git a/docs/en/ranch/2.2/guide/ssl_auth/index.html b/docs/en/ranch/2.2/guide/ssl_auth/index.html new file mode 100644 index 00000000..44eed333 --- /dev/null +++ b/docs/en/ranch/2.2/guide/ssl_auth/index.html @@ -0,0 +1,255 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: SSL client authentication</title> + + <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>SSL client authentication</span></h1> + +<h2 id="_purpose">Purpose</h2> +<p>SSL client authentication is a mechanism allowing applications to identify certificates. This allows your application to make sure that the client is an authorized certificate, but makes no claim about whether the user can be trusted. This can be combined with a password based authentication to attain greater security.</p> +<p>The server only needs to retain the certificate serial number and the certificate issuer to authenticate the certificate. Together, they can be used to uniquely identify a certificate.</p> +<p>As Ranch allows the same protocol code to be used for both SSL and non-SSL transports, you need to make sure you are in an SSL context before attempting to perform an SSL client authentication. This can be done by checking the return value of <code>Transport:name/0</code>.</p> +<h2 id="_obtaining_client_certificates">Obtaining client certificates</h2> +<p>You can obtain client certificates from various sources. You can generate them yourself, or you can use a service like CAcert.org which allows you to generate client and server certificates for free.</p> +<p>Following are the steps you need to take to create a CAcert.org account, generate a certificate and install it in your favorite browser.</p> +<ul><li>Open <a href="http://cacert.org">http://cacert.org</a> in your favorite browser +</li> +<li>Root Certificate link: install both certificates +</li> +<li>Join (Register an account) +</li> +<li>Verify your account (check your email inbox!) +</li> +<li>Log in +</li> +<li>Client Certificates: New +</li> +<li>Follow instructions to create the certificate +</li> +<li>Install the certificate in your browser +</li> +</ul> +<p>You can optionally save the certificate for later use, for example to extract the <code>IssuerID</code> information as will be detailed later on.</p> +<h2 id="_transport_configuration">Transport configuration</h2> +<p>The SSL transport does not request a client certificate by default. You need to specify the <code>{verify, verify_peer}</code> option when starting the listener to enable this behavior.</p> +<div class="listingblock"><div class="title">Configure a listener for SSL 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>{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:start_listener</font></b>(<font color="#FF6600">my_ssl</font>, + <font color="#FF6600">ranch_ssl</font>, #{<font color="#0000FF">socket_opts</font> <font color="#990000">=></font> [ + {<font color="#FF6600">port</font>, <font color="#009900">SSLPort</font>}, + {<font color="#FF6600">certfile</font>, <font color="#009900">PathToCertfile</font>}, + {<font color="#FF6600">cacertfile</font>, <font color="#009900">PathToCACertfile</font>}, + {<font color="#FF6600">verify</font>, <font color="#FF6600">verify_peer</font>} + ]}, + <font color="#FF6600">my_protocol</font>, [] +)<font color="#990000">.</font></tt></pre> +</div></div> +<p>In this example we set the required <code>port</code> and <code>certfile</code>, but also the <code>cacertfile</code> containing the CACert.org root certificate, and the option to request the client certificate.</p> +<p>If you enable the <code>{verify, verify_peer}</code> option and the client does not have a client certificate configured for your domain, then no certificate will be sent. This allows you to use SSL for more than just authenticated clients.</p> +<h2 id="_authentication">Authentication</h2> +<p>To authenticate users, you must first save the certificate information required. If you have your users' certificate files, you can simply load the certificate and retrieve the information directly.</p> +<div class="listingblock"><div class="title">Retrieve the issuer ID from a 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><b><font color="#000000">certfile_to_issuer_id</font></b>(<font color="#009900">Filename</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">Data</font>} <font color="#990000">=</font> <b><font color="#000000">file:read_file</font></b>(<font color="#009900">Filename</font>), + [{<font color="#FF6600">'Certificate'</font>, <font color="#009900">Cert</font>, <font color="#FF6600">not_encrypted</font>}] <font color="#990000">=</font> <b><font color="#000000">public_key:pem_decode</font></b>(<font color="#009900">Data</font>), + {<font color="#FF6600">ok</font>, <font color="#009900">IssuerID</font>} <font color="#990000">=</font> <b><font color="#000000">public_key:pkix_issuer_id</font></b>(<font color="#009900">Cert</font>, <b><font color="#000080">self</font></b>), + <font color="#009900">IssuerID</font><font color="#990000">.</font></tt></pre> +</div></div> +<p>The <code>IssuerID</code> variable contains both the certificate serial number and the certificate issuer stored in a tuple, so this value alone can be used to uniquely identify the user certificate. You can save this value in a database, a configuration file or any other place where an Erlang term can be stored and retrieved.</p> +<p>To retrieve the <code>IssuerID</code> from a running connection, you need to first retrieve the client certificate and then extract this information from it. Ranch does not provide a function to retrieve the client certificate. Instead you can use the <code>ssl:peercert/1</code> function. Once you have the certificate, you can again use the <code>public_key:pkix_issuer_id/2</code> to extract the <code>IssuerID</code> value.</p> +<p>The following function returns the <code>IssuerID</code> or <code>false</code> if no client certificate was found. This snippet is intended to be used from your protocol code.</p> +<div class="listingblock"><div class="title">Retrieve the issuer ID from the certificate for the current 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">socket_to_issuer_id</font></b>(<font color="#009900">Socket</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">ssl:peercert</font></b>(<font color="#009900">Socket</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">error</font>, <font color="#FF6600">no_peercert</font>} <font color="#990000">-></font> + <font color="#000080">false</font>; + {<font color="#FF6600">ok</font>, <font color="#009900">Cert</font>} <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">IssuerID</font>} <font color="#990000">=</font> <b><font color="#000000">public_key:pkix_issuer_id</font></b>(<font color="#009900">Cert</font>, <b><font color="#000080">self</font></b>), + <font color="#009900">IssuerID</font> + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>You then only need to match the <code>IssuerID</code> value to authenticate the user.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/2.2/guide/parsers/"> + Writing parsers + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/2.2/guide/connection_draining/"> + Connection draining + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/guide/transports.asciidoc b/docs/en/ranch/2.2/guide/transports.asciidoc new file mode 100644 index 00000000..bdccfc91 --- /dev/null +++ b/docs/en/ranch/2.2/guide/transports.asciidoc @@ -0,0 +1,182 @@ +== Transports + +A transport defines the interface to interact with a socket. + +Transports can be used for connecting, listening and accepting +connections, but also for receiving and sending data. Both +passive and active mode are supported, although all sockets +are initialized as passive. + +=== TCP transport + +The TCP transport is a thin wrapper around `gen_tcp`. + +=== SSL transport + +The SSL transport is a thin wrapper around `ssl`. + +Ranch depends on `ssl` by default so any necessary +dependencies will start when Ranch is started. It is +possible to remove the dependency when the SSL transport +will not be used. Refer to your release build tool's +documentation for more information. + +When embedding Ranch listeners that have an SSL transport, +your application must depend on the `ssl` application for +proper behavior. + +=== Sending and receiving data + +This section assumes that `Transport` is a valid transport handler +(like `ranch_tcp` or `ranch_ssl`) and `Socket` is a connected +socket obtained through the listener. + +You can send data to a socket by calling the `Transport:send/2` +function. The data can be given as `iodata()`, which is defined as +`binary() | iolist()`. All the following calls will work: + +.Sending data to the socket + +[source,erlang] +---- +Transport:send(Socket, <<"Ranch is cool!">>). +Transport:send(Socket, "Ranch is cool!"). +Transport:send(Socket, ["Ranch", ["is", "cool!"]]). +Transport:send(Socket, ["Ranch", [<<"is">>, "cool!"]]). +---- + +You can receive data either in passive or in active mode. Passive mode +means that you will perform a blocking `Transport:recv/3` call, while +active mode means that you will receive the data as a message. + +By default, all data will be received as binary. It is possible to +receive data as strings, although this is not recommended as binaries +are a more efficient construct, especially for binary protocols. + +Receiving data using passive mode requires a single function call. The +first argument is the socket, and the third argument is a timeout duration +before the call returns with `{error, timeout}`. + +The second argument is the amount of data in bytes that we want to receive. +The function will wait for data until it has received exactly this amount. +If you are not expecting a precise size, you can specify 0 which will make +this call return as soon as data was read, regardless of its size. + +.Receiving data from the socket in passive mode + +[source,erlang] +{ok, Data} = Transport:recv(Socket, 0, 5000). + +Active mode requires you to inform the socket that you want to receive +data as a message and to write the code to actually receive it. + +There are three kinds of active modes: `{active, once}`, `{active, N}` +and `{active, true}`. The first will send a single message before going +back to passive mode; the second will send `N` messages followed by +a `Passive` message when switching back to passive mode; the third +will send messages indefinitely. We recommend not using the `{active, true}` +mode as it could quickly flood your process mailbox. It's better to keep +the data in the socket and read it only when required. + +Four different messages can be received: + +* Incoming data: `{OK, Socket, Data}` +* Socket closed: `{Closed, Socket}` +* Socket error: `{Error, Socket, Reason}` +* Switch to passive mode: `{Passive, Socket}` + +The value of `OK`, `Closed`, `Error` and `Passive` can be different +depending on the transport being used. To be able to properly match +on them you must first call the `Transport:messages/0` function. + +.Retrieving the transport's active message identifiers + +[source,erlang] +{OK, Closed, Error, Passive} = Transport:messages(). + +To start receiving messages you will need to call the `Transport:setopts/2` +function, and do so every time you want to receive data. + +.Receiving messages from the socket in active mode + +[source,erlang] +---- +{OK, Closed, Error, Passive} = Transport:messages(), +Transport:setopts(Socket, [{active, once}]), +receive + {OK, Socket, Data} -> + io:format("data received: ~p~n", [Data]); + {Closed, Socket} -> + io:format("socket got closed!~n"); + {Error, Socket, Reason} -> + io:format("error happened: ~p~n", [Reason]) +end. +---- + +You can easily integrate active sockets with existing Erlang code as all +you really need is just a few more clauses when receiving messages. + +=== Sending files + +As in the previous section it is assumed `Transport` is a valid transport +handler and `Socket` is a connected socket obtained through the listener. + +To send a whole file, with name `Filename`, over a socket: + +.Sending a file by filename + +[source,erlang] +{ok, SentBytes} = Transport:sendfile(Socket, Filename). + +Or part of a file, with `Offset` greater than or equal to 0, `Bytes` number of +bytes and chunks of size `ChunkSize`: + +.Sending part of a file by filename in chunks + +[source,erlang] +Opts = [{chunk_size, ChunkSize}], +{ok, SentBytes} = Transport:sendfile(Socket, Filename, Offset, Bytes, Opts). + +To improve efficiency when sending multiple parts of the same file it is also +possible to use a file descriptor opened in raw mode: + +.Sending a file opened in raw mode + +[source,erlang] +{ok, RawFile} = file:open(Filename, [raw, read, binary]), +{ok, SentBytes} = Transport:sendfile(Socket, RawFile, Offset, Bytes, Opts). + +=== Upgrading a TCP socket to SSL + +A connected TCP socket can be upgraded to a SSL socket via the function +`ranch_ssl:handshake/3`. The socket *must* be in `{active, false}` mode +before telling the client that the server is ready to upgrade in order +to avoid race conditions. + +IMPORTANT: The new socket received from `ranch_ssl:handshake/3` must be +used via the `ranch_ssl` transport. + +.Performing a TLS handshake on a TCP socket +[source,erlang] +{ok, SslSocket} = ranch_ssl:handshake(TcpSocket, SslOpts, 5000). + +=== Writing a transport handler + +A transport handler is a module implementing the `ranch_transport` behavior. +It defines a certain number of callbacks that must be written in order to +allow transparent usage of the transport handler. + +The behavior doesn't define the socket options available when opening a +socket. These do not need to be common to all transports as it's easy enough +to write different initialization functions for the different transports that +will be used. With one exception though. The `setopts/2` function *must* +implement the `{active, once}` and the `{active, true}` options. + +If the transport handler doesn't have a native implementation of `sendfile/5` a +fallback is available, `ranch_transport:sendfile/6`. The extra first argument +is the transport's module. See `ranch_ssl` for an example. + +It is highly recommended for a custom transport handler to implement the +optional `format_error/1` callback, in order to provide a human-readable +diagnostic string. Implementing this callback will become mandatory in +Ranch 3.0. diff --git a/docs/en/ranch/2.2/guide/transports/index.html b/docs/en/ranch/2.2/guide/transports/index.html new file mode 100644 index 00000000..b2aa31d5 --- /dev/null +++ b/docs/en/ranch/2.2/guide/transports/index.html @@ -0,0 +1,293 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Transports</title> + + <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>Transports</span></h1> + +<p>A transport defines the interface to interact with a socket.</p> +<p>Transports can be used for connecting, listening and accepting connections, but also for receiving and sending data. Both passive and active mode are supported, although all sockets are initialized as passive.</p> +<h2 id="_tcp_transport">TCP transport</h2> +<p>The TCP transport is a thin wrapper around <code>gen_tcp</code>.</p> +<h2 id="_ssl_transport">SSL transport</h2> +<p>The SSL transport is a thin wrapper around <code>ssl</code>.</p> +<p>Ranch depends on <code>ssl</code> by default so any necessary dependencies will start when Ranch is started. It is possible to remove the dependency when the SSL transport will not be used. Refer to your release build tool's documentation for more information.</p> +<p>When embedding Ranch listeners that have an SSL transport, your application must depend on the <code>ssl</code> application for proper behavior.</p> +<h2 id="_sending_and_receiving_data">Sending and receiving data</h2> +<p>This section assumes that <code>Transport</code> is a valid transport handler (like <code>ranch_tcp</code> or <code>ranch_ssl</code>) and <code>Socket</code> is a connected socket obtained through the listener.</p> +<p>You can send data to a socket by calling the <code>Transport:send/2</code> function. The data can be given as <code>iodata()</code>, which is defined as <code>binary() | iolist()</code>. All the following calls will work:</p> +<div class="listingblock"><div class="title">Sending data to the 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="#009900">Transport</font><font color="#990000">:</font><b><font color="#000000">send</font></b>(<font color="#009900">Socket</font>, <font color="#990000"><<</font><font color="#FF0000">"Ranch is cool!"</font><font color="#990000">>></font>)<font color="#990000">.</font> +<font color="#009900">Transport</font><font color="#990000">:</font><b><font color="#000000">send</font></b>(<font color="#009900">Socket</font>, <font color="#FF0000">"Ranch is cool!"</font>)<font color="#990000">.</font> +<font color="#009900">Transport</font><font color="#990000">:</font><b><font color="#000000">send</font></b>(<font color="#009900">Socket</font>, [<font color="#FF0000">"Ranch"</font>, [<font color="#FF0000">"is"</font>, <font color="#FF0000">"cool!"</font>]])<font color="#990000">.</font> +<font color="#009900">Transport</font><font color="#990000">:</font><b><font color="#000000">send</font></b>(<font color="#009900">Socket</font>, [<font color="#FF0000">"Ranch"</font>, [<font color="#990000"><<</font><font color="#FF0000">"is"</font><font color="#990000">>></font>, <font color="#FF0000">"cool!"</font>]])<font color="#990000">.</font></tt></pre> +</div></div> +<p>You can receive data either in passive or in active mode. Passive mode means that you will perform a blocking <code>Transport:recv/3</code> call, while active mode means that you will receive the data as a message.</p> +<p>By default, all data will be received as binary. It is possible to receive data as strings, although this is not recommended as binaries are a more efficient construct, especially for binary protocols.</p> +<p>Receiving data using passive mode requires a single function call. The first argument is the socket, and the third argument is a timeout duration before the call returns with <code>{error, timeout}</code>.</p> +<p>The second argument is the amount of data in bytes that we want to receive. The function will wait for data until it has received exactly this amount. If you are not expecting a precise size, you can specify 0 which will make this call return as soon as data was read, regardless of its size.</p> +<div class="listingblock"><div class="title">Receiving data from the socket in passive 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>{<font color="#FF6600">ok</font>, <font color="#009900">Data</font>} <font color="#990000">=</font> <font color="#009900">Transport</font><font color="#990000">:</font><b><font color="#000000">recv</font></b>(<font color="#009900">Socket</font>, <font color="#993399">0</font>, <font color="#993399">5000</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Active mode requires you to inform the socket that you want to receive data as a message and to write the code to actually receive it.</p> +<p>There are three kinds of active modes: <code>{active, once}</code>, <code>{active, N}</code> and <code>{active, true}</code>. The first will send a single message before going back to passive mode; the second will send <code>N</code> messages followed by a <code>Passive</code> message when switching back to passive mode; the third will send messages indefinitely. We recommend not using the <code>{active, true}</code> mode as it could quickly flood your process mailbox. It's better to keep the data in the socket and read it only when required.</p> +<p>Four different messages can be received:</p> +<ul><li>Incoming data: <code>{OK, Socket, Data}</code> +</li> +<li>Socket closed: <code>{Closed, Socket}</code> +</li> +<li>Socket error: <code>{Error, Socket, Reason}</code> +</li> +<li>Switch to passive mode: <code>{Passive, Socket}</code> +</li> +</ul> +<p>The value of <code>OK</code>, <code>Closed</code>, <code>Error</code> and <code>Passive</code> can be different depending on the transport being used. To be able to properly match on them you must first call the <code>Transport:messages/0</code> function.</p> +<div class="listingblock"><div class="title">Retrieving the transport's active message identifiers</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">OK</font>, <font color="#009900">Closed</font>, <font color="#009900">Error</font>, <font color="#009900">Passive</font>} <font color="#990000">=</font> <font color="#009900">Transport</font><font color="#990000">:</font><b><font color="#000000">messages</font></b>()<font color="#990000">.</font></tt></pre> +</div></div> +<p>To start receiving messages you will need to call the <code>Transport:setopts/2</code> function, and do so every time you want to receive data.</p> +<div class="listingblock"><div class="title">Receiving messages from the socket in active 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>{<font color="#009900">OK</font>, <font color="#009900">Closed</font>, <font color="#009900">Error</font>, <font color="#009900">Passive</font>} <font color="#990000">=</font> <font color="#009900">Transport</font><font color="#990000">:</font><b><font color="#000000">messages</font></b>(), +<font color="#009900">Transport</font><font color="#990000">:</font><b><font color="#000000">setopts</font></b>(<font color="#009900">Socket</font>, [{<font color="#FF6600">active</font>, <font color="#FF6600">once</font>}]), +<b><font color="#0000FF">receive</font></b> + {<font color="#009900">OK</font>, <font color="#009900">Socket</font>, <font color="#009900">Data</font>} <font color="#990000">-></font> + <b><font color="#000000">io:format</font></b>(<font color="#FF0000">"data received: ~p~n"</font>, [<font color="#009900">Data</font>]); + {<font color="#009900">Closed</font>, <font color="#009900">Socket</font>} <font color="#990000">-></font> + <b><font color="#000000">io:format</font></b>(<font color="#FF0000">"socket got closed!~n"</font>); + {<font color="#009900">Error</font>, <font color="#009900">Socket</font>, <font color="#009900">Reason</font>} <font color="#990000">-></font> + <b><font color="#000000">io:format</font></b>(<font color="#FF0000">"error happened: ~p~n"</font>, [<font color="#009900">Reason</font>]) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>You can easily integrate active sockets with existing Erlang code as all you really need is just a few more clauses when receiving messages.</p> +<h2 id="_sending_files">Sending files</h2> +<p>As in the previous section it is assumed <code>Transport</code> is a valid transport handler and <code>Socket</code> is a connected socket obtained through the listener.</p> +<p>To send a whole file, with name <code>Filename</code>, over a socket:</p> +<div class="listingblock"><div class="title">Sending a file by filename</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">SentBytes</font>} <font color="#990000">=</font> <font color="#009900">Transport</font><font color="#990000">:</font><b><font color="#000000">sendfile</font></b>(<font color="#009900">Socket</font>, <font color="#009900">Filename</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Or part of a file, with <code>Offset</code> greater than or equal to 0, <code>Bytes</code> number of bytes and chunks of size <code>ChunkSize</code>:</p> +<div class="listingblock"><div class="title">Sending part of a file by filename in 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="#009900">Opts</font> <font color="#990000">=</font> [{<font color="#FF6600">chunk_size</font>, <font color="#009900">ChunkSize</font>}], +{<font color="#FF6600">ok</font>, <font color="#009900">SentBytes</font>} <font color="#990000">=</font> <font color="#009900">Transport</font><font color="#990000">:</font><b><font color="#000000">sendfile</font></b>(<font color="#009900">Socket</font>, <font color="#009900">Filename</font>, <font color="#009900">Offset</font>, <font color="#009900">Bytes</font>, <font color="#009900">Opts</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>To improve efficiency when sending multiple parts of the same file it is also possible to use a file descriptor opened in raw mode:</p> +<div class="listingblock"><div class="title">Sending a file opened in raw 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>{<font color="#FF6600">ok</font>, <font color="#009900">RawFile</font>} <font color="#990000">=</font> <b><font color="#000000">file:open</font></b>(<font color="#009900">Filename</font>, [<font color="#FF6600">raw</font>, <font color="#FF6600">read</font>, <b><font color="#000080">binary</font></b>]), +{<font color="#FF6600">ok</font>, <font color="#009900">SentBytes</font>} <font color="#990000">=</font> <font color="#009900">Transport</font><font color="#990000">:</font><b><font color="#000000">sendfile</font></b>(<font color="#009900">Socket</font>, <font color="#009900">RawFile</font>, <font color="#009900">Offset</font>, <font color="#009900">Bytes</font>, <font color="#009900">Opts</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_upgrading_a_tcp_socket_to_ssl">Upgrading a TCP socket to SSL</h2> +<p>A connected TCP socket can be upgraded to a SSL socket via the function <code>ranch_ssl:handshake/3</code>. The socket <strong>must</strong> be in <code>{active, false}</code> mode before telling the client that the server is ready to upgrade in order to avoid race conditions.</p> +<p>IMPORTANT: The new socket received from <code>ranch_ssl:handshake/3</code> must be used via the <code>ranch_ssl</code> transport.</p> +<div class="listingblock"><div class="title">Performing a TLS handshake on a TCP 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">SslSocket</font>} <font color="#990000">=</font> <b><font color="#000000">ranch_ssl:handshake</font></b>(<font color="#009900">TcpSocket</font>, <font color="#009900">SslOpts</font>, <font color="#993399">5000</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_writing_a_transport_handler">Writing a transport handler</h2> +<p>A transport handler is a module implementing the <code>ranch_transport</code> behavior. It defines a certain number of callbacks that must be written in order to allow transparent usage of the transport handler.</p> +<p>The behavior doesn't define the socket options available when opening a socket. These do not need to be common to all transports as it's easy enough to write different initialization functions for the different transports that will be used. With one exception though. The <code>setopts/2</code> function <strong>must</strong> implement the <code>{active, once}</code> and the <code>{active, true}</code> options.</p> +<p>If the transport handler doesn't have a native implementation of <code>sendfile/5</code> a fallback is available, <code>ranch_transport:sendfile/6</code>. The extra first argument is the transport's module. See <code>ranch_ssl</code> for an example.</p> +<p>It is highly recommended for a custom transport handler to implement the optional <code>format_error/1</code> callback, in order to provide a human-readable diagnostic string. Implementing this callback will become mandatory in Ranch 3.0.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/2.2/guide/listeners/"> + Listeners + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/2.2/guide/protocols/"> + Protocols + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/guide">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/guide">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/guide">1.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/ranch/2.2/manual/index.html b/docs/en/ranch/2.2/manual/index.html new file mode 100644 index 00000000..64f54a52 --- /dev/null +++ b/docs/en/ranch/2.2/manual/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: Ranch 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>Ranch Function Reference</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch - Socket acceptor pool for TCP protocols</p> +<h2 id="_description">Description</h2> +<p>Ranch is a socket acceptor pool for TCP protocols.</p> +<p>Ranch manages listeners which are a set of processes that accept and manage connections. The connection's transport and protocol modules are configured per listener. Listeners can be inspected and reconfigured without interruptions in service.</p> +<h2 id="_modules">Modules</h2> +<p>Functions:</p> +<ul><li><a href="ranch">ranch(3)</a> - Socket acceptor pool +</li> +<li><a href="ranch_proxy_header">ranch_proxy_header(3)</a> - PROXY protocol +</li> +</ul> +<p>Transports:</p> +<ul><li><a href="ranch_ssl">ranch_ssl(3)</a> - SSL transport +</li> +<li><a href="ranch_tcp">ranch_tcp(3)</a> - TCP transport +</li> +</ul> +<p>Behaviors:</p> +<ul><li><a href="ranch_protocol">ranch_protocol(3)</a> - Protocol modules +</li> +<li><a href="ranch_transport">ranch_transport(3)</a> - Transport modules +</li> +</ul> +<h2 id="_dependencies">Dependencies</h2> +<ul><li>ssl - Secure communication over sockets +</li> +</ul> +<p>All these applications must be started before the <code>ranch</code> application. To start Ranch 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">ranch</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_environment">Environment</h2> +<p>The <code>ranch</code> application defines one application environment configuration parameter.</p> +<dl><dt>profile (false)</dt> +<dd><p>When enabled, Ranch will start <code>eprof</code> profiling automatically.</p> +<p>You can use the <code>ranch_app:profile_output/0</code> function to stop profiling and output the results to the files <em>procs.profile</em> and <em>total.profile</em>. Do not use in production.</p> +</dd> +</dl> +<h2 id="_see_also">See also</h2> +<p>ssl(7)</p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.child_spec/index.html b/docs/en/ranch/2.2/manual/ranch.child_spec/index.html new file mode 100644 index 00000000..ce482394 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.child_spec/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: ranch:child_spec(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>ranch:child_spec(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:child_spec - Build child specifications for a new 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">child_spec</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch_ref</font></b>(), + <font color="#009900">Transport</font> <font color="#990000">::</font> <b><font color="#000000">module</font></b>(), + <font color="#009900">TransOpts</font> <font color="#990000">::</font> <b><font color="#000000">ranch:opts</font></b>(), + <font color="#009900">Protocol</font> <font color="#990000">::</font> <b><font color="#000000">module</font></b>(), + <font color="#009900">ProtoOpts</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()) + <font color="#990000">-></font> <b><font color="#000000">supervisor:child_spec</font></b>()</tt></pre> +</div></div> +<p>Build child specifications for a new listener which can be embedded directly in an application's supervision tree.</p> +<p>The actual listener is placed under a supervisor which monitors <code>ranch_server</code> via a proxy process and will restart the listener if <code>ranch_server</code> crashes.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name is used to refer to this listener in future calls, for example when updating the configuration.</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>Transport</dt> +<dd><p>The transport module that will be used by Ranch to accept connections and that will be passed to the protocol module along with the socket.</p> +<p>The interface of the transport module is documented in the <a href="../ranch_transport">ranch_transport(3)</a> manual.</p> +</dd> +<dt>TransportOpts</dt> +<dd><p>Transport options include the Ranch-specific options and the socket options. The listener's port number must be defined in the socket options.</p> +<p>The available options for the built-in Ranch transports are documented in the <a href="../ranch_tcp">ranch_tcp(3)</a> and <a href="../ranch_ssl">ranch_ssl(3)</a> manuals.</p> +</dd> +<dt>Protocol</dt> +<dd><p>The protocol module that will be used by Ranch after the connection has been accepted.</p> +<p>The interface of the protocol module is documented in the <a href="../ranch_protocol">ranch_protocol(3)</a> manual.</p> +</dd> +<dt>ProtocolOpts</dt> +<dd><p>The protocol options given when calling the protocol module. Please consult the documentation of the protocol module you are using for more details.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>Child specifications are returned.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The actual listener is placed under a supervisor in order to restart the listener if <code>ranch_server</code> crashes. +</li> +<li><strong>2.0</strong>: The <code>TransOpts</code> argument must no longer contain Ranch-specific options if given as a list. Use a map. +</li> +<li><strong>1.4</strong>: The <code>NumAcceptors</code> argument was moved to the transport options. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Embed 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><b><font color="#000080">-behavior</font></b>(<font color="#FF6600">supervisor</font>)<font color="#990000">.</font> + +<b><font color="#000000">init</font></b>(<font color="#990000">_</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, {#{<font color="#0000FF">strategy</font> <font color="#990000">=></font> <font color="#FF6600">one_for_one</font>}, [ + <b><font color="#000000">ranch:child_spec</font></b>(<font color="#FF6600">echo</font>, + <font color="#FF6600">ranch_tcp</font>, [{<font color="#FF6600">port</font>, <font color="#993399">5555</font>}], + <font color="#FF6600">echo_protocol</font>, [] + ) + ]}}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch.start_listener">ranch:start_listener(3)</a>, <a href="../ranch.stop_listener">ranch:stop_listener(3)</a>, <a href="../ranch">ranch(3)</a>, <a href="../ranch_tcp">ranch_tcp(3)</a>, <a href="../ranch_ssl">ranch_ssl(3)</a>, <a href="../ranch_transport">ranch_transport(3)</a>, <a href="../ranch_protocol">ranch_protocol(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.get_addr/index.html b/docs/en/ranch/2.2/manual/ranch.get_addr/index.html new file mode 100644 index 00000000..d6f4475c --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.get_addr/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: ranch:get_addr(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>ranch:get_addr(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:get_addr - Get the listening address</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_addr</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>()) + <font color="#990000">-></font> {<font color="#009900">IP</font> <font color="#990000">::</font> <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="#FF6600">local</font>, <font color="#009900">SocketFile</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()} + | {<font color="#000080">undefined</font>, <font color="#000080">undefined</font>}</tt></pre> +</div></div> +<p>Get the listening address.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The address of the listener is returned as a tuple of the form <code>{IP, Port}</code> when listening on a network interface, or <code>{local, SocketFile}</code> when listening on a UNIX Domain socket. When the listener is suspended, <code>{undefined, undefined}</code> will be returned.</p> +<p>The IP address is the IP of the network interface the socket is bound to.</p> +<p>The socket file is the path of a file on your system the socket is bound to.</p> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the listening port and IP</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">ranch:get_addr</font></b>(<font color="#FF6600">example</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Get the listening UNIX Domain socket 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">local</font>, <font color="#009900">SocketFile</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:get_addr</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="../ranch.start_listener">ranch:start_listener(3)</a>, <a href="../ranch.get_port">ranch:get_port(3)</a>, <a href="../ranch.info">ranch:info(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.get_max_connections/index.html b/docs/en/ranch/2.2/manual/ranch.get_max_connections/index.html new file mode 100644 index 00000000..ce7c953a --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.get_max_connections/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: ranch:get_max_connections(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>ranch:get_max_connections(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:get_max_connections - Get the max number of connections per connection supervisor</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_max_connections</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>()) + <font color="#990000">-></font> <font color="#009900">MaxConns</font> <font color="#990000">::</font> <b><font color="#000000">ranch:max_conns</font></b>()</tt></pre> +</div></div> +<p>Get the max number of connections per connection supervisor.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The maximum number of connections per connection supervisor is returned.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The maximum number of connections is now per connection supervisor. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the max number of connections per connection supervisor</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">MaxConns</font> <font color="#990000">=</font> <b><font color="#000000">ranch:get_max_connections</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="../ranch.get_protocol_options">ranch:get_protocol_options(3)</a>, <a href="../ranch.get_transport_options">ranch:get_transport_options(3)</a>, <a href="../ranch.set_max_connections">ranch:set_max_connections(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.get_port/index.html b/docs/en/ranch/2.2/manual/ranch.get_port/index.html new file mode 100644 index 00000000..b00ad175 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.get_port/index.html @@ -0,0 +1,188 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: ranch:get_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>ranch:get_port(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:get_port - Get the listening 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">get_port</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>()) + <font color="#990000">-></font> <font color="#009900">Port</font> <font color="#990000">::</font> <b><font color="#000000">inet:port_number</font></b>() | <font color="#000080">undefined</font></tt></pre> +</div></div> +<p>Get the listening port.</p> +<p>This function is particularly useful to retrieve the listening port number when it was not provided in the options and was chosen randomly instead.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The listening port is returned.</p> +<p>When the listener is suspended or using a UNIX Domain socket instead of a network interface, <code>undefined</code> will be returned.</p> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the listening 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">Port</font> <font color="#990000">=</font> <b><font color="#000000">ranch:get_port</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="../ranch.start_listener">ranch:start_listener(3)</a>, <a href="../ranch.get_addr">ranch:get_addr(3)</a>, <a href="../ranch.info">ranch:info(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.get_protocol_options/index.html b/docs/en/ranch/2.2/manual/ranch.get_protocol_options/index.html new file mode 100644 index 00000000..4a34f8fc --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.get_protocol_options/index.html @@ -0,0 +1,186 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: ranch:get_protocol_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>ranch:get_protocol_options(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:get_protocol_options - Get the current protocol options</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_protocol_options</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>()) + <font color="#990000">-></font> <font color="#009900">ProtoOpts</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Get the current protocol options.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The current protocol options are returned.</p> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the current protocol 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">ProtoOpts</font> <font color="#990000">=</font> <b><font color="#000000">ranch:get_protocol_options</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="../ranch.get_max_connections">ranch:get_max_connections(3)</a>, <a href="../ranch.get_transport_options">ranch:get_transport_options(3)</a>, <a href="../ranch.set_protocol_options">ranch:set_protocol_options(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.get_status/index.html b/docs/en/ranch/2.2/manual/ranch.get_status/index.html new file mode 100644 index 00000000..42b6dbb2 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.get_status/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: ranch:get_status(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>ranch:get_status(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:get_status - Get a listener's running state</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_status</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch_ref</font></b>()) <font color="#990000">-></font> <b><font color="#000080">running</font></b> | <font color="#FF6600">suspended</font></tt></pre> +</div></div> +<p>Get a listener's running state.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>An atom is returned indicating the running status of the listener.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.6</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get a listener's running state</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">ranch:get_status</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="../ranch.start_listener">ranch:start_listener(3)</a>, <a href="../ranch.stop_listener">ranch:stop_listener(3)</a>, <a href="../ranch.suspend_listener">ranch:suspend_listener(3)</a>, <a href="../ranch.resume_listener">ranch:resume_listener(3)</a>, <a href="../ranch.set_transport_options">ranch:set_transport_options(3)</a>, <a href="../ranch.wait_for_connections">ranch:wait_for_connections(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.get_transport_options/index.html b/docs/en/ranch/2.2/manual/ranch.get_transport_options/index.html new file mode 100644 index 00000000..4c58e5e2 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.get_transport_options/index.html @@ -0,0 +1,186 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: ranch:get_transport_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>ranch:get_transport_options(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:get_transport_options - Get the current transport options</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_transport_options</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>()) + <font color="#990000">-></font> <font color="#009900">TransOpts</font> <font color="#990000">::</font> <b><font color="#000000">ranch:transport_opts</font></b>(<b><font color="#000000">any</font></b>())</tt></pre> +</div></div> +<p>Get the current transport options.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The current transport options are returned.</p> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the current transport 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">TransOpts</font> <font color="#990000">=</font> <b><font color="#000000">ranch:get_transport_options</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="../ranch.get_max_connections">ranch:get_max_connections(3)</a>, <a href="../ranch.get_protocol_options">ranch:get_protocol_options(3)</a>, <a href="../ranch.set_transport_options">ranch:set_transport_options(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.handshake/index.html b/docs/en/ranch/2.2/manual/ranch.handshake/index.html new file mode 100644 index 00000000..28d318f3 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.handshake/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: ranch:handshake(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>ranch:handshake(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:handshake - Perform the transport handshake</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">handshake</font></b>(<font color="#009900">Ref</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font>} | {<font color="#FF6600">continue</font>, <font color="#009900">Info</font>} +<b><font color="#000000">handshake</font></b>(<font color="#009900">Ref</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font>} | {<font color="#FF6600">continue</font>, <font color="#009900">Info</font>} + +<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>() +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">Socket</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>()</tt></pre> +</div></div> +<p>Perform the transport handshake.</p> +<p>This function must be called by the protocol process in order to retrieve the socket for the connection. Ranch performs the handshake necessary to give control of the socket to this process and also does the transport handshake, for example setting up the TLS connection.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +<dt>Opts</dt> +<dd><p>Transport handshake options.</p> +<p>Allowed options depend on the transport module.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>An <code>ok</code> tuple is returned containing the socket for the connection by default.</p> +<p>Depending on configuration, a <code>continue</code> tuple can otherwise be returned when the handshake operation is paused. It contains data provided by the transport that can be used to inform further decisions before resuming the handshake, for example to provide new transport options. The handshake can be resumed using <a href="../ranch.handshake_continue">ranch:handshake_continue(3)</a> or canceled using <a href="../ranch.handshake_cancel">ranch:handshake_cancel(3)</a>.</p> +<p>This function will trigger an exception when an error occurs.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The <code>continue</code> tuple can now be returned. +</li> +<li><strong>1.6</strong>: Function introduced. Replaces <code>ranch:accept_ack/1</code>. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Initialize 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><b><font color="#000000">start_link</font></b>(<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> + <font color="#009900">Pid</font> <font color="#990000">=</font> <b><font color="#000000">proc_lib:spawn_link</font></b>(<b><font color="#000080">?MODULE</font></b>, <font color="#FF6600">init</font>, + [<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>]), + {<font color="#FF6600">ok</font>, <font color="#009900">Pid</font>}<font color="#990000">.</font> + +<b><font color="#000000">init</font></b>(<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:handshake</font></b>(<font color="#009900">Ref</font>), + <b><font color="#000000">loop</font></b>(<font color="#008080">#state</font>{<font color="#0000FF">ref</font><font color="#990000">=</font><font color="#009900">Ref</font>, <font color="#0000FF">socket</font><font color="#990000">=</font><font color="#009900">Socket</font>, + <font color="#0000FF">transport</font><font color="#990000">=</font><font color="#009900">Transport</font>, <font color="#0000FF">opts</font><font color="#990000">=</font><font color="#009900">Opts</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch.start_listener">ranch:start_listener(3)</a>, <a href="../ranch.handshake_continue">ranch:handshake_continue(3)</a>, <a href="../ranch.handshake_cancel">ranch:handshake_cancel(3)</a>, <a href="../ranch.recv_proxy_header">ranch:recv_proxy_header(3)</a>, <a href="../ranch.remove_connection">ranch:remove_connection(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.handshake_cancel/index.html b/docs/en/ranch/2.2/manual/ranch.handshake_cancel/index.html new file mode 100644 index 00000000..454177a1 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.handshake_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: ranch:handshake_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>ranch:handshake_cancel(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:handshake_cancel - Cancel the paused transport handshake</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">handshake_cancel</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>()) <font color="#990000">-></font> <font color="#FF6600">ok</font></tt></pre> +</div></div> +<p>Cancel the paused transport handshake.</p> +<p>This function may be called by the protocol process to cancel a paused handshake.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +<p>Allowed options depend on the transport module.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The return value depends on the transport module.</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">Cancel a paused transport handshake</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">start_link</font></b>(<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> + <font color="#009900">Pid</font> <font color="#990000">=</font> <b><font color="#000000">proc_lib:spawn_link</font></b>(<b><font color="#000080">?MODULE</font></b>, <font color="#FF6600">init</font>, + [<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>]), + {<font color="#FF6600">ok</font>, <font color="#009900">Pid</font>}<font color="#990000">.</font> + +<b><font color="#000000">init</font></b>(<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> + {<font color="#FF6600">continue</font>, <font color="#009900">_Info</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:handshake</font></b>(<font color="#009900">Ref</font>), + <b><font color="#000000">ranch:handshake_cancel</font></b>(<font color="#009900">Ref</font>), + <b><font color="#000080">exit</font></b>(<font color="#FF6600">handshake_cancelled</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch.handshake">ranch:handshake(3)</a>, <a href="../ranch.handshake_continue">ranch:handshake_continue(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.handshake_continue/index.html b/docs/en/ranch/2.2/manual/ranch.handshake_continue/index.html new file mode 100644 index 00000000..380e3958 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.handshake_continue/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: ranch:handshake_continue(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>ranch:handshake_continue(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:handshake_continue - Resume the paused transport handshake</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">handshake_continue</font></b>(<font color="#009900">Ref</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font>} +<b><font color="#000000">handshake_continue</font></b>(<font color="#009900">Ref</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font>} + +<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>() +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Resume the paused transport handshake.</p> +<p>This function must be called by the protocol process in order to resume a paused handshake.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +<dt>Opts</dt> +<dd><p>Transport handshake options.</p> +<p>Allowed options depend on the transport module.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>An <code>ok</code> tuple is returned containing the socket for the connection.</p> +<p>This function will trigger an exception when an error occurs.</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">Continue a paused transport handshake</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">start_link</font></b>(<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> + <font color="#009900">Pid</font> <font color="#990000">=</font> <b><font color="#000000">proc_lib:spawn_link</font></b>(<b><font color="#000080">?MODULE</font></b>, <font color="#FF6600">init</font>, + [<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>]), + {<font color="#FF6600">ok</font>, <font color="#009900">Pid</font>}<font color="#990000">.</font> + +<b><font color="#000000">init</font></b>(<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> + {<font color="#FF6600">continue</font>, <font color="#009900">_Info</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:handshake</font></b>(<font color="#009900">Ref</font>), + {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:handshake_continue</font></b>(<font color="#009900">Ref</font>), + <b><font color="#000000">loop</font></b>(<font color="#008080">#state</font>{<font color="#0000FF">ref</font><font color="#990000">=</font><font color="#009900">Ref</font>, <font color="#0000FF">socket</font><font color="#990000">=</font><font color="#009900">Socket</font>, + <font color="#0000FF">transport</font><font color="#990000">=</font><font color="#009900">Transport</font>, <font color="#0000FF">opts</font><font color="#990000">=</font><font color="#009900">Opts</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch.handshake">ranch:handshake(3)</a>, <a href="../ranch.handshake_cancel">ranch:handshake_cancel(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.info/index.html b/docs/en/ranch/2.2/manual/ranch.info/index.html new file mode 100644 index 00000000..42e0ce6e --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.info/index.html @@ -0,0 +1,249 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: ranch: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>ranch:info(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:info - Overview of Ranch listeners</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="#990000">-></font> #{<font color="#009900">Ref</font> <font color="#990000">:=</font> <font color="#009900">Info</font>} +<b><font color="#000000">info</font></b>(<font color="#009900">Ref</font>) <font color="#990000">-></font> <font color="#009900">Info</font> + +<font color="#009900">Info</font> <font color="#990000">::</font> #{<font color="#009900">Key</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>() <font color="#990000">:=</font> <font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>Overview of Ranch listeners.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>Returns detailed information about one or all Ranch listeners. The following keys are returned:</p> +<dl><dt>pid</dt> +<dd><p>Pid of the listener's top-level supervisor.</p> +</dd> +<dt>status</dt> +<dd><p>Listener status, either running or suspended.</p> +</dd> +<dt>ip</dt> +<dd><p>Interface Ranch listens on.</p> +</dd> +<dt>port</dt> +<dd><p>Port number Ranch listens on.</p> +</dd> +<dt>max_connections</dt> +<dd><p>Maximum number of connections per connection supervisor.</p> +</dd> +<dt>active_connections</dt> +<dd><p>Number of active connections.</p> +</dd> +<dt>all_connections</dt> +<dd><p>Number of connections, including those removed from the count.</p> +</dd> +<dt>transport</dt> +<dd><p>Transport module.</p> +</dd> +<dt>transport_options</dt> +<dd><p>Transport options.</p> +</dd> +<dt>protocol</dt> +<dd><p>Protocol module.</p> +</dd> +<dt>protocol_options</dt> +<dd><p>Protocol options.</p> +</dd> +<dt>metrics</dt> +<dd><p>Listener metrics.</p> +</dd> +</dl> +<h2 id="_metrics">Metrics</h2> +<p>Listener metrics are provided as a map, with the following keys:</p> +<dl><dt>{conns_sup, Index, accept}</dt> +<dd><p>Number of accepted connections, per connection supervisor.</p> +</dd> +<dt>{conns_sup, Index, terminate}</dt> +<dd><p>Number of terminated connection processes, per connection supervisor.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.1</strong>: Added accept/terminate metrics to the output of <code>ranch:info/0,1</code>. +</li> +<li><strong>2.0</strong>: The listener info is now returned as a map. +</li> +<li><strong>2.0</strong>: The <code>num_acceptors</code> key has been removed. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get information about all listeners</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">AllInfo</font> <font color="#990000">=</font> <b><font color="#000000">ranch:info</font></b>()<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Get information about a specific 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">Info</font> <font color="#990000">=</font> <b><font color="#000000">ranch:info</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="../ranch.get_addr">ranch:get_addr(3)</a>, <a href="../ranch.get_port">ranch:get_port(3)</a>, <a href="../ranch.procs">ranch:procs(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.procs/index.html b/docs/en/ranch/2.2/manual/ranch.procs/index.html new file mode 100644 index 00000000..9cf09222 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.procs/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: ranch:procs(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>ranch:procs(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:procs - Retrieve pids from a 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">procs</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>(), + <font color="#009900">Type</font> <font color="#990000">::</font> <font color="#FF6600">acceptors</font> | <font color="#FF6600">connections</font>) + <font color="#990000">-></font> <font color="#009900">Pids</font> <font color="#990000">::</font> [<b><font color="#000080">pid</font></b>()]</tt></pre> +</div></div> +<p>Retrieve pids from a listener.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +<dt>Type</dt> +<dd><p>The type of process that will be returned.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A list of pids is returned.</p> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get the pids of the acceptor processes</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">Pids</font> <font color="#990000">=</font> <b><font color="#000000">ranch:procs</font></b>(<font color="#FF6600">acceptors</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Get the pids of the connection processes</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">Pids</font> <font color="#990000">=</font> <b><font color="#000000">ranch:procs</font></b>(<font color="#FF6600">connections</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch.get_addr">ranch:get_addr(3)</a>, <a href="../ranch.get_port">ranch:get_port(3)</a>, <a href="../ranch.info">ranch:info(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.recv_proxy_header/index.html b/docs/en/ranch/2.2/manual/ranch.recv_proxy_header/index.html new file mode 100644 index 00000000..2d364de4 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.recv_proxy_header/index.html @@ -0,0 +1,207 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: ranch:recv_proxy_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>ranch:recv_proxy_header(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:recv_proxy_header - Receive the PROXY protocol 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">recv_proxy_header</font></b>(<b><font color="#000000">ranch:ref</font></b>(), <b><font color="#000000">timeout</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <b><font color="#000000">ranch_proxy_header:proxy_info</font></b>()} + | {<font color="#FF6600">error</font>, <font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>()} + | {<font color="#FF6600">error</font>, <font color="#FF6600">protocol_error</font>, <font color="#009900">HumanReadable</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>()}</tt></pre> +</div></div> +<p>Receive the PROXY protocol header.</p> +<p>This function must be called before <code>ranch:handshake/1,2</code> on newly accepted connections to read and parse the PROXY protocol header, if any.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +<dt>Timeout</dt> +<dd><p>Receive timeout in milliseconds.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>An <code>ok</code> tuple is returned containing PROXY header information on success.</p> +<p>An <code>error</code> 2-tuple is returned when a socket error occurs.</p> +<p>An <code>error</code> 3-tuple is returned when a protocol error occurs and Ranch was not able to parse the PROXY header information. The third element contains a human-readable description of the error.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.7</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive the PROXY protocol 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="#000000">start_link</font></b>(<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> + <font color="#009900">Pid</font> <font color="#990000">=</font> <b><font color="#000000">proc_lib:spawn_link</font></b>(<b><font color="#000080">?MODULE</font></b>, <font color="#FF6600">init</font>, + [<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>]), + {<font color="#FF6600">ok</font>, <font color="#009900">Pid</font>}<font color="#990000">.</font> + +<b><font color="#000000">init</font></b>(<font color="#009900">Ref</font>, <font color="#009900">Transport</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">ProxyInfo</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:recv_proxy_header</font></b>(<font color="#009900">Ref</font>, <font color="#993399">1000</font>), + {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:handshake</font></b>(<font color="#009900">Ref</font>), + <b><font color="#000000">loop</font></b>(<font color="#008080">#state</font>{<font color="#0000FF">ref</font><font color="#990000">=</font><font color="#009900">Ref</font>, <font color="#0000FF">socket</font><font color="#990000">=</font><font color="#009900">Socket</font>, <font color="#0000FF">transport</font><font color="#990000">=</font><font color="#009900">Transport</font>, + <font color="#0000FF">proxy_info</font><font color="#990000">=</font><font color="#009900">ProxyInfo</font>, <font color="#0000FF">opts</font><font color="#990000">=</font><font color="#009900">Opts</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch.start_listener">ranch:start_listener(3)</a>, <a href="../ranch.handshake">ranch:handshake(3)</a>, <a href="../ranch.remove_connection">ranch:remove_connection(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.remove_connection/index.html b/docs/en/ranch/2.2/manual/ranch.remove_connection/index.html new file mode 100644 index 00000000..8dc30238 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.remove_connection/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: ranch:remove_connection(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>ranch:remove_connection(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:remove_connection - Remove connection from the count</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">remove_connection</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>()) <font color="#990000">-></font> <font color="#FF6600">ok</font></tt></pre> +</div></div> +<p>Remove connection from the count.</p> +<p>This connection will no longer be included in the count when limiting the number of connections. This can be useful in a mixed environment where some connections are active and others are passive. Passive connections spend most of their time idling and are not consuming much resources.</p> +<p>This function may only be called from a connection process.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</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="_examples">Examples</h2> +<div class="listingblock"><div class="title">Remove the connection process from the count</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">ranch:remove_connection</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="../ranch.start_listener">ranch:start_listener(3)</a>, <a href="../ranch.handshake">ranch:handshake(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.resume_listener/index.html b/docs/en/ranch/2.2/manual/ranch.resume_listener/index.html new file mode 100644 index 00000000..1352d3d3 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.resume_listener/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: ranch:resume_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>ranch:resume_listener(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:resume_listener - Resume a suspended 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">resume_listener</font></b>(<font color="#009900">Ref</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>, <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>Resume a suspended listener.</p> +<p>Ranch will start listening for and accepting connections again. The function <a href="../ranch.set_transport_options">ranch:set_transport_options(3)</a> can be used to change the transport options before resuming the listener.</p> +<p>Nothing is done when the listener is already running.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned on success.</p> +<p>An error tuple is returned when the listener could not be restarted.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.6</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Resume 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">ranch:resume_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="../ranch.start_listener">ranch:start_listener(3)</a>, <a href="../ranch.stop_listener">ranch:stop_listener(3)</a>, <a href="../ranch.suspend_listener">ranch:suspend_listener(3)</a>, <a href="../ranch.get_status">ranch:get_status(3)</a>, <a href="../ranch.set_transport_options">ranch:set_transport_options(3)</a>, <a href="../ranch.wait_for_connections">ranch:wait_for_connections(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.set_max_connections/index.html b/docs/en/ranch/2.2/manual/ranch.set_max_connections/index.html new file mode 100644 index 00000000..45f33f0b --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.set_max_connections/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: ranch:set_max_connections(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>ranch:set_max_connections(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:set_max_connections - Set the max number of connections per connection supervisor</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_max_connections</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>(), + <font color="#009900">MaxConns</font> <font color="#990000">::</font> <b><font color="#000000">ranch:max_conns</font></b>()) + <font color="#990000">-></font> <font color="#FF6600">ok</font></tt></pre> +</div></div> +<p>Set the max number of connections per connection supervisor.</p> +<p>The change will be applied immediately. If the new value is smaller than the previous one, Ranch will wait for the extra connections to terminate and will not accept new connections until the number of connections goes below the limit.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +<dt>MaxConns</dt> +<dd><p>The new maximum number of connections per connection supervisor.</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>: The maximum number of connections is now per connection supervisor. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Set the max number of connections per connection supervisor</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">ranch:set_max_connections</font></b>(<font color="#FF6600">example</font>, <font color="#993399">10000</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch.get_max_connections">ranch:get_max_connections(3)</a>, <a href="../ranch.set_protocol_options">ranch:set_protocol_options(3)</a>, <a href="../ranch.set_transport_options">ranch:set_transport_options(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.set_protocol_options/index.html b/docs/en/ranch/2.2/manual/ranch.set_protocol_options/index.html new file mode 100644 index 00000000..4f5896b9 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.set_protocol_options/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: ranch:set_protocol_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>ranch:set_protocol_options(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:set_protocol_options - Set the protocol options</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_protocol_options</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>(), + <font color="#009900">ProtoOpts</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 the protocol options.</p> +<p>The change will be applied immediately for all new connections. Old connections will not receive the new options.</p> +<p>Note that the complete set of protocol options is replaced. To update a subset of the options, it is recommended to get the current protocol options using <a href="../ranch.get_protocol_options">ranch:get_protocol_options(3)</a>, update them and then set them back using this function.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +<dt>ProtoOpts</dt> +<dd><p>The new protocol options.</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="_examples">Examples</h2> +<div class="listingblock"><div class="title">Set the protocol 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><b><font color="#000000">ranch:set_protocol_options</font></b>(<font color="#FF6600">example</font>, <font color="#009900">ProtoOpts</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Update some of the protocol 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">ProtoOpts0</font> <font color="#990000">=</font> <b><font color="#000000">ranch:get_protocol_options</font></b>(<font color="#FF6600">example</font>), +<font color="#009900">ProtoOpts</font> <font color="#990000">=</font> <font color="#009900">ProtoOpts0</font>#{<font color="#0000FF">request_timeout</font> <font color="#990000">=></font> <font color="#993399">2000</font>}, +<b><font color="#000000">ranch:set_protocol_options</font></b>(<font color="#FF6600">example</font>, <font color="#009900">ProtoOpts</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch.get_protocol_options">ranch:get_protocol_options(3)</a>, <a href="../ranch.set_max_connections">ranch:set_max_connections(3)</a>, <a href="../ranch.set_transport_options">ranch:set_transport_options(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.set_transport_options/index.html b/docs/en/ranch/2.2/manual/ranch.set_transport_options/index.html new file mode 100644 index 00000000..4dff2a8e --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.set_transport_options/index.html @@ -0,0 +1,249 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: ranch:set_transport_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>ranch:set_transport_options(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:set_transport_options - Set the transport options</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_transport_options</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>(), + <font color="#009900">TransOpts</font> <font color="#990000">::</font> <b><font color="#000000">ranch:opts</font></b>()) + <font color="#990000">-></font> <font color="#FF6600">ok</font> | {<font color="#FF6600">error</font>, <font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000000">term</font></b>()}</tt></pre> +</div></div> +<p>Set the transport options.</p> +<p>The complete set of transport options is replaced. To update a subset of the transport options, it is recommended to get the current transport options using <a href="../ranch.get_transport_options">ranch:get_transport_options(3)</a>, update them and then set them back using this function.</p> +<p>Changes to the following options will take effect...</p> +<ul><li>immediately: +<ul><li><code>max_connections</code> +</li> +<li><code>handshake_timeout</code> +</li> +<li><code>shutdown</code> +</li> +</ul> +</li> +<li>only after the listener has been suspended and resumed: +<ul><li><code>num_acceptors</code> +</li> +<li><code>num_listen_sockets</code> +</li> +<li><code>post_listen_callback</code> +</li> +<li><code>socket_opts</code> +</li> +</ul> +</li> +<li>only when the entire listener is restarted: +<ul><li><code>connection_type</code> +</li> +<li><code>num_conns_sups</code> +</li> +<li><code>logger</code> +</li> +</ul> +</li> +</ul> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +<dt>TransOpts</dt> +<dd><p>The new transport options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned on success.</p> +<p>An error tuple is returned on failure, for example if the given transport options contain invalid values.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The restriction that the listener must be suspended has been removed. +</li> +<li><strong>2.0</strong>: The <code>TransOpts</code> argument must no longer contain Ranch-specific options if given as a list. Use a map. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Set the transport 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">Ref</font> <font color="#990000">=</font> <font color="#FF6600">example</font>, + +<font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:suspend_listener</font></b>(<font color="#009900">Ref</font>), +<font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:set_transport_options</font></b>(<font color="#009900">Ref</font>, <font color="#009900">TransOpts</font>), +<font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:resume_listener</font></b>(<font color="#009900">Ref</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Update the listener TCP port within the `socket_opts` transport option</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">Ref</font> <font color="#990000">=</font> <font color="#FF6600">example</font>, + +<font color="#009900">TransOpts0</font> <font color="#990000">=</font> <b><font color="#000000">ranch:get_transport_options</font></b>(<font color="#009900">Ref</font>), +#{<font color="#0000FF">socket_opts</font> <font color="#990000">=</font> <font color="#009900">SocketOpts0</font>} <font color="#990000">=</font> <font color="#009900">TransOpts0</font>, +<font color="#009900">SocketOpts</font> <font color="#990000">=</font> [{<font color="#FF6600">port</font>, <font color="#993399">12345</font>}|<b><font color="#000000">proplists:delete</font></b>(<font color="#FF6600">port</font>, <font color="#009900">SocketOpts0</font>)], +<font color="#009900">TransOpts</font> <font color="#990000">=</font> <font color="#009900">TransOpts0</font>#{<font color="#0000FF">socket_opts</font> <font color="#990000">=</font> <font color="#009900">SocketOpts</font>}, + +<font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:suspend_listener</font></b>(<font color="#009900">Ref</font>), +<font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:set_transport_options</font></b>(<font color="#009900">Ref</font>, <font color="#009900">TransOpts</font>), +<font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:resume_listener</font></b>(<font color="#009900">Ref</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch.suspend_listener">ranch:suspend_listener(3)</a>, <a href="../ranch.resume_listener">ranch:resume_listener(3)</a>, <a href="../ranch.get_transport_options">ranch:get_transport_options(3)</a>, <a href="../ranch.set_max_connections">ranch:set_max_connections(3)</a>, <a href="../ranch.set_protocol_options">ranch:set_protocol_options(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.start_listener/index.html b/docs/en/ranch/2.2/manual/ranch.start_listener/index.html new file mode 100644 index 00000000..592d7428 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.start_listener/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: ranch:start_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>ranch:start_listener(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:start_listener - Start a 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">start_listener</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch_ref</font></b>(), + <font color="#009900">Transport</font> <font color="#990000">::</font> <b><font color="#000000">module</font></b>(), + <font color="#009900">TransOpts</font> <font color="#990000">::</font> <b><font color="#000000">ranch:opts</font></b>(), + <font color="#009900">Protocol</font> <font color="#990000">::</font> <b><font color="#000000">module</font></b>(), + <font color="#009900">ProtoOpts</font> <font color="#990000">::</font> <b><font color="#000000">any</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 a listener.</p> +<p>A listener is a set of processes that accepts and manages connections using the given transport and protocol modules.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</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 configuration.</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>Transport</dt> +<dd><p>The transport module that will be used by Ranch to accept connections and that will be passed to the protocol module along with the socket.</p> +<p>The interface of the transport module is documented in the <a href="../ranch_transport">ranch_transport(3)</a> manual.</p> +</dd> +<dt>TransportOpts</dt> +<dd><p>Transport options include the Ranch-specific options and the socket options. The listener's port number must be defined in the socket options.</p> +<p>Socket options may be given directly if there are no Ranch-specific options.</p> +<p>The available options for the built-in Ranch transports are documented in the <a href="../ranch_tcp">ranch_tcp(3)</a> and <a href="../ranch_ssl">ranch_ssl(3)</a> manuals.</p> +</dd> +<dt>Protocol</dt> +<dd><p>The protocol module that will be used by Ranch after the connection has been accepted.</p> +<p>The interface of the protocol module is documented in the <a href="../ranch_protocol">ranch_protocol(3)</a> manual.</p> +</dd> +<dt>ProtocolOpts</dt> +<dd><p>The protocol options given when calling the protocol module. Please consult the documentation of the protocol module you are using for more details.</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 Ranch is already in use.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The <code>TransOpts</code> argument must no longer contain Ranch-specific options if given as a list. Use a map. +</li> +<li><strong>1.4</strong>: The <code>NumAcceptors</code> argument was moved to the transport options. +</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="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:start_listener</font></b>(<font color="#FF6600">example</font>, + <font color="#FF6600">ranch_tcp</font>, [{<font color="#FF6600">port</font>, <font color="#993399">8080</font>}], + <font color="#FF6600">cowboy_http2</font>, #{} +)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Start a listener with Ranch-specific 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="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">ranch:start_listener</font></b>(<font color="#FF6600">example</font>, + <font color="#FF6600">ranch_tcp</font>, #{ + <font color="#0000FF">num_acceptors</font> <font color="#990000">=></font> <font color="#993399">75</font>, + <font color="#0000FF">socket_opts</font> <font color="#990000">=></font> [{<font color="#FF6600">port</font>, <font color="#993399">8080</font>}] + }, + <font color="#FF6600">cowboy_http2</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">Ref</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">ranch:start_listener</font></b>(<font color="#009900">Ref</font>, + <font color="#FF6600">ranch_tcp</font>, #{}, + <font color="#FF6600">cowboy_http2</font>, #{} +), + +<font color="#009900">Port</font> <font color="#990000">=</font> <b><font color="#000000">ranch:get_port</font></b>(<font color="#009900">Ref</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch.stop_listener">ranch:stop_listener(3)</a>, <a href="../ranch.child_spec">ranch:child_spec(3)</a>, <a href="../ranch">ranch(3)</a>, <a href="../ranch_tcp">ranch_tcp(3)</a>, <a href="../ranch_ssl">ranch_ssl(3)</a>, <a href="../ranch_transport">ranch_transport(3)</a>, <a href="../ranch_protocol">ranch_protocol(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.stop_listener/index.html b/docs/en/ranch/2.2/manual/ranch.stop_listener/index.html new file mode 100644 index 00000000..f91c628c --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.stop_listener/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: ranch: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>ranch:stop_listener(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:stop_listener - Stop a 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">Ref</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>}</tt></pre> +</div></div> +<p>Stop a listener.</p> +<p>The listener is stopped gracefully, first by closing the listening port, then by stopping the connection processes. These processes are stopped according to the <code>shutdown</code> transport option, which may be set to brutally kill all connection processes or give them some time to stop properly.</p> +<p>In order for the connection processes to exit gracefully, they need to trap exit signals and stop before the configured shutdown timeout. If greater control over the shutdown is required the functions <a href="../ranch.suspend_listener">ranch:suspend_listener(3)</a> and <a href="../ranch.wait_for_connections">ranch:wait_for_connections(3)</a> can be used.</p> +<p>This function does not return until the listener is completely stopped.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned on success.</p> +<p>An error tuple is returned when the listener is not found.</p> +<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">ranch: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="../ranch.start_listener">ranch:start_listener(3)</a>, <a href="../ranch.child_spec">ranch:child_spec(3)</a>, <a href="../ranch.suspend_listener">ranch:suspend_listener(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.suspend_listener/index.html b/docs/en/ranch/2.2/manual/ranch.suspend_listener/index.html new file mode 100644 index 00000000..f115e2be --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.suspend_listener/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: ranch:suspend_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>ranch:suspend_listener(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:suspend_listener - Suspend a running 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">suspend_listener</font></b>(<font color="#009900">Ref</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>, <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>Suspend a running listener.</p> +<p>Ranch will stop listening for and accepting connections and the listening socket will be closed. Existing connections will continue undisturbed. The function <a href="../ranch.wait_for_connections">ranch:wait_for_connections(3)</a> can be used to wait for connections to be closed if necessary.</p> +<p>Some transport options can only be changed when the listener is suspended. Please consult the <a href="../ranch.set_transport_options">ranch:set_transport_options(3)</a> manual for more information.</p> +<p>Nothing is done when the listener is already suspended.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned on success.</p> +<p>An error tuple is returned when the listener could not be suspended.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.6</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Suspend 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">ranch:suspend_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="../ranch.start_listener">ranch:start_listener(3)</a>, <a href="../ranch.stop_listener">ranch:stop_listener(3)</a>, <a href="../ranch.resume_listener">ranch:resume_listener(3)</a>, <a href="../ranch.get_status">ranch:get_status(3)</a>, <a href="../ranch.set_transport_options">ranch:set_transport_options(3)</a>, <a href="../ranch.wait_for_connections">ranch:wait_for_connections(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch.wait_for_connections/index.html b/docs/en/ranch/2.2/manual/ranch.wait_for_connections/index.html new file mode 100644 index 00000000..ad62a841 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch.wait_for_connections/index.html @@ -0,0 +1,214 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: ranch:wait_for_connections(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>ranch:wait_for_connections(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch:wait_for_connections - Wait for a specific number of connections</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">wait_for_connections</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>(), + <font color="#009900">Operator</font>, + <font color="#009900">NumConns</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>()) + <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">Operator</font> <font color="#990000">::</font> <font color="#FF6600">'>'</font> | <font color="#FF6600">'>='</font> | <font color="#FF6600">'=='</font> | <font color="#FF6600">'=<'</font> | <font color="#FF6600">'<'</font></tt></pre> +</div></div> +<p>Wait for a specific number of connections.</p> +<p>This function waits until the number of connections on the given listener becomes higher than, equal to or lower than the given number. It never returns otherwise.</p> +<p>This function can be used to gracefully shutdown a listener by first suspending the listener and then waiting for connections to terminate before finally stopping the listener.</p> +<!-- @todo The suspend/wait/stop pattern should be tested.--> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Ref</dt> +<dd><p>The listener name.</p> +</dd> +<dt>Operator</dt> +<dd><p>The operator to use for the comparison.</p> +</dd> +<dt>NumConns</dt> +<dd><p>The number of connections to reach.</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>1.6</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Wait for at least 100 connections</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">ranch:wait_for_connections</font></b>(<font color="#FF6600">example</font>, <font color="#FF6600">'>='</font>, <font color="#993399">100</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Gracefully shutdown 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">Ref</font> <font color="#990000">=</font> <font color="#FF6600">example</font>, + +<font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:suspend_listener</font></b>(<font color="#009900">Ref</font>), +<b><font color="#000000">ranch:wait_for_connections</font></b>(<font color="#009900">Ref</font>, <font color="#FF6600">'=='</font>, <font color="#993399">0</font>), +<font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">ranch:stop_listener</font></b>(<font color="#009900">Ref</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch.stop_listener">ranch:stop_listener(3)</a>, <a href="../ranch.suspend_listener">ranch:suspend_listener(3)</a>, <a href="../ranch.resume_listener">ranch:resume_listener(3)</a>, <a href="../ranch">ranch(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch/index.html b/docs/en/ranch/2.2/manual/ranch/index.html new file mode 100644 index 00000000..e69a3c1e --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch/index.html @@ -0,0 +1,341 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: ranch(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>ranch(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch - Socket acceptor pool</p> +<h2 id="_description">Description</h2> +<p>The module <code>ranch</code> provides functions for starting and manipulating Ranch listeners.</p> +<h2 id="_exports">Exports</h2> +<p>Start/stop:</p> +<ul><li><a href="../ranch.start_listener">ranch:start_listener(3)</a> - Start a listener +</li> +<li><a href="../ranch.stop_listener">ranch:stop_listener(3)</a> - Stop a listener +</li> +<li><a href="../ranch.child_spec">ranch:child_spec(3)</a> - Build child specifications for a new listener +</li> +</ul> +<p>Suspend/resume:</p> +<ul><li><a href="../ranch.suspend_listener">ranch:suspend_listener(3)</a> - Suspend a running listener +</li> +<li><a href="../ranch.resume_listener">ranch:resume_listener(3)</a> - Resume a suspended listener +</li> +<li><a href="../ranch.get_status">ranch:get_status(3)</a> - Get a listener's running state +</li> +</ul> +<p>Connections:</p> +<ul><li><a href="../ranch.handshake">ranch:handshake(3)</a> - Perform the transport handshake +</li> +<li><a href="../ranch.handshake_continue">ranch:handshake_continue(3)</a> - Resume the paused transport handshake +</li> +<li><a href="../ranch.handshake_cancel">ranch:handshake_cancel(3)</a> - Cancel the paused transport handshake +</li> +<li><a href="../ranch.recv_proxy_header">ranch:recv_proxy_header(3)</a> - Receive the PROXY protocol header +</li> +<li><a href="../ranch.remove_connection">ranch:remove_connection(3)</a> - Remove connection from the count +</li> +</ul> +<p>Options:</p> +<ul><li><a href="../ranch.get_max_connections">ranch:get_max_connections(3)</a> - Get the max number of connections per connection supervisor +</li> +<li><a href="../ranch.get_protocol_options">ranch:get_protocol_options(3)</a> - Get the current protocol options +</li> +<li><a href="../ranch.get_transport_options">ranch:get_transport_options(3)</a> - Get the current transport options +</li> +<li><a href="../ranch.set_max_connections">ranch:set_max_connections(3)</a> - Set the max number of connections per connection supervisor +</li> +<li><a href="../ranch.set_protocol_options">ranch:set_protocol_options(3)</a> - Set the protocol options +</li> +<li><a href="../ranch.set_transport_options">ranch:set_transport_options(3)</a> - Set the transport options +</li> +</ul> +<p>Introspection:</p> +<ul><li><a href="../ranch.get_addr">ranch:get_addr(3)</a> - Get the listening address +</li> +<li><a href="../ranch.get_port">ranch:get_port(3)</a> - Get the listening port +</li> +<li><a href="../ranch.info">ranch:info(3)</a> - Overview of Ranch listeners +</li> +<li><a href="../ranch.procs">ranch:procs(3)</a> - Retrieve pids from a listener +</li> +<li><a href="../ranch.wait_for_connections">ranch:wait_for_connections(3)</a> - Wait for a specific number of connections +</li> +</ul> +<h2 id="_types">Types</h2> +<h3 id="_max_conns">max_conns()</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">max_conns</font></b>() <font color="#990000">=</font> <b><font color="#000000">non_neg_integer</font></b>() | <font color="#FF6600">infinity</font></tt></pre> +</div></div> +<p>Maximum number of connections allowed per connection supervisor.</p> +<p>This is a soft limit. The actual number of connections might be slightly above the limit due to concurrency when accepting new connections. Some connections may also be removed from this count explicitly by the user code.</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">any</font></b>() | <b><font color="#000000">transport_opts</font></b>(<b><font color="#000000">any</font></b>())</tt></pre> +</div></div> +<p>Transport or socket options.</p> +<h3 id="_ref">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">ref</font></b>() <font color="#990000">=</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Unique name used to refer to a listener.</p> +<h3 id="_transport_opts_socketopts">transport_opts(SocketOpts)</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">transport_opts</font></b>(<font color="#009900">SocketOpts</font>) <font color="#990000">=</font> #{ + <font color="#0000FF">alarms</font> <font color="#990000">=></font> #{ + <b><font color="#000000">term</font></b>() <font color="#990000">=></font> #{ + <font color="#FF6600">type</font> <font color="#990000">:=</font> <font color="#FF6600">num_connections</font>, + <font color="#FF6600">threshold</font> <font color="#990000">:=</font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#FF6600">callback</font> <font color="#990000">:=</font> <b><font color="#0000FF">fun</font></b>((<b><font color="#000000">ref</font></b>(), <b><font color="#000000">term</font></b>(), <b><font color="#000080">pid</font></b>(), [<b><font color="#000080">pid</font></b>()]) <font color="#990000">-></font> <b><font color="#000000">any</font></b>()), + <font color="#0000FF">cooldown</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_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">handshake_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">max_connections</font> <font color="#990000">=></font> <b><font color="#000000">max_conns</font></b>(), + <font color="#0000FF">logger</font> <font color="#990000">=></font> <b><font color="#000000">module</font></b>(), + <font color="#0000FF">num_acceptors</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <font color="#0000FF">num_conns_sups</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <font color="#0000FF">post_listen_callback</font> <font color="#990000">=></font> <b><font color="#0000FF">fun</font></b>((<b><font color="#000000">term</font></b>()) <font color="#990000">-></font> <font color="#FF6600">ok</font> | {<font color="#FF6600">error</font>, <b><font color="#000000">term</font></b>()}), + <font color="#000080">shutdown</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>() | <font color="#FF6600">brutal_kill</font>, + <font color="#0000FF">socket_opts</font> <font color="#990000">=></font> <font color="#009900">SocketOpts</font> +}</tt></pre> +</div></div> +<p>Transport options.</p> +<p>The transport options are a combination of Ranch-specific options and transport-specific socket options.</p> +<p>None of the options are required.</p> +<dl><dt>alarms (#{})</dt> +<dd><p>Alarms to call a function when the number of connections tracked by one connection supervisor reaches or exceeds a defined threshold.</p> +<p>The map keys are the alarm names, which can be any <code>term</code>. The associated values are the respective alarm options, again in a map with the following keys:</p> +<dl><dt>type</dt> +<dd><p>Must be set to <code>num_connections</code>.</p> +</dd> +<dt>threshold</dt> +<dd><p>Threshold value, which must be a <code>non_neg_integer</code>. When the number of connections tracked by a single connection supervisor reaches or exceeds this value, The alarm will trigger and call the function defined in the <code>callback</code> key (see below).</p> +</dd> +<dt>callback</dt> +<dd><p>The alarm function, which takes the listener name, the alarm name, the pid of the connection supervisor and a list of the pids of all connection processes under that supervisor as arguments. The return value is ignored.</p> +</dd> +<dt>cooldown (5000)</dt> +<dd><p>The minimum time after which the alarm can be triggered again, in milliseconds.</p> +</dd> +</dl> +</dd> +<dt>connection_type (worker)</dt> +<dd><p>Type of process that will handle the connection.</p> +</dd> +<dt>handshake_timeout (5000)</dt> +<dd><p>Maximum allowed time for the <code>ranch:handshake/1,2</code> call to finish.</p> +</dd> +<dt>logger (logger)</dt> +<dd><p>The module that will be used to write log messages.</p> +</dd> +<dt>max_connections (1024)</dt> +<dd><p>Maximum number of active connections per connection supervisor. Soft limit. Use <code>infinity</code> to disable the limit entirely.</p> +</dd> +<dt>num_acceptors (10)</dt> +<dd><p>Number of processes that accept connections.</p> +</dd> +<dt>num_conns_sups - see below</dt> +<dd><p>Number of processes that supervise connection processes. If not specified, defaults to be equal to <code>num_acceptors</code>.</p> +</dd> +<dt>post_listen_callback (fun(_ListenSock) -> ok end)</dt> +<dd><p>A function which will be called after a listen socket has been successfully created, with the socket as argument. It can be used to perform any necessary setup steps on the socket.</p> +<p>If the callback function returns <code>ok</code>, the listener will start accepting connections on the socket. If it returns <code>{error, Reason}</code>, the listener will fail to start.</p> +</dd> +<dt>shutdown (5000)</dt> +<dd><p>Maximum allowed time for children to stop on listener shutdown.</p> +</dd> +<dt>socket_opts</dt> +<dd><p>Socket options to be used by <code>Transport:listen/1</code>. Please refer to the documentation of the transport module you are using for more details.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.1</strong>: The <code>post_listen_callback</code> transport option was added. +</li> +<li><strong>2.0</strong>: The type <code>transport_opts(SocketOpts)</code> was added. +</li> +<li><strong>2.0</strong>: The function <code>ranch:accept_ack/1</code> was removed in favor of <a href="../ranch.handshake">ranch:handshake(3)</a>. +</li> +<li><strong>2.0</strong>: The option <code>max_connections</code> is now per connection supervisor. +</li> +<li><strong>2.0</strong>: The <code>num_conns_sup</code> option was added. +</li> +<li><strong>2.0</strong>: The <code>socket</code> option was removed. +</li> +<li><strong>2.0</strong>: The <code>logger</code> option is no longer experimental. It now defaults to <code>logger</code> instead of <code>error_logger</code>. +</li> +<li><strong>2.0</strong>: The <code>opt()</code> type was removed. +</li> +<li><strong>1.6</strong>: The experimental <code>logger</code> option was added. +</li> +<li><strong>1.6</strong>: The <code>opt()</code> type was deprecated in favor of the new <code>opts()</code> type. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">ranch(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch_app/index.html b/docs/en/ranch/2.2/manual/ranch_app/index.html new file mode 100644 index 00000000..6c81e66c --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch_app/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: ranch(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>ranch(7)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch - Socket acceptor pool for TCP protocols</p> +<h2 id="_description">Description</h2> +<p>Ranch is a socket acceptor pool for TCP protocols.</p> +<p>Ranch manages listeners which are a set of processes that accept and manage connections. The connection's transport and protocol modules are configured per listener. Listeners can be inspected and reconfigured without interruptions in service.</p> +<h2 id="_modules">Modules</h2> +<p>Functions:</p> +<ul><li><a href="../ranch">ranch(3)</a> - Socket acceptor pool +</li> +<li><a href="../ranch_proxy_header">ranch_proxy_header(3)</a> - PROXY protocol +</li> +</ul> +<p>Transports:</p> +<ul><li><a href="../ranch_ssl">ranch_ssl(3)</a> - SSL transport +</li> +<li><a href="../ranch_tcp">ranch_tcp(3)</a> - TCP transport +</li> +</ul> +<p>Behaviors:</p> +<ul><li><a href="../ranch_protocol">ranch_protocol(3)</a> - Protocol modules +</li> +<li><a href="../ranch_transport">ranch_transport(3)</a> - Transport modules +</li> +</ul> +<h2 id="_dependencies">Dependencies</h2> +<ul><li>ssl - Secure communication over sockets +</li> +</ul> +<p>All these applications must be started before the <code>ranch</code> application. To start Ranch 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">ranch</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_environment">Environment</h2> +<p>The <code>ranch</code> application defines one application environment configuration parameter.</p> +<dl><dt>profile (false)</dt> +<dd><p>When enabled, Ranch will start <code>eprof</code> profiling automatically.</p> +<p>You can use the <code>ranch_app:profile_output/0</code> function to stop profiling and output the results to the files <em>procs.profile</em> and <em>total.profile</em>. Do not use in production.</p> +</dd> +</dl> +<h2 id="_see_also">See also</h2> +<p>ssl(7)</p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch_protocol/index.html b/docs/en/ranch/2.2/manual/ranch_protocol/index.html new file mode 100644 index 00000000..05716bac --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch_protocol/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: ranch_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>ranch_protocol(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch_protocol - Protocol modules</p> +<h2 id="_description">Description</h2> +<p>The module <code>ranch_protocol</code> defines the interface used by Ranch protocols.</p> +<h2 id="_callbacks">Callbacks</h2> +<p>Ranch protocols 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">start_link</font></b>(<font color="#009900">Ref</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>(), + <font color="#009900">Transport</font> <font color="#990000">::</font> <b><font color="#000000">module</font></b>(), + <font color="#009900">ProtoOpts</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()) + <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="#FF6600">ok</font>, <font color="#009900">SupPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>(), <font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>()}</tt></pre> +</div></div> +<p>Start a new connection process.</p> +<p>The only purpose of this callback is to start a process that will handle the socket. It must spawn the process, link and then return the new pid. This function will always be called from inside a supervisor.</p> +<p>This callback can also return two pids. The first pid is the pid of the process that will be supervised. The second pid is the pid of the process that will receive ownership of the socket. This second process must be a child of the first. This form is only available when <code>connection_type</code> is set to <code>supervisor</code>.</p> +<p>If any other value is returned, the supervisor will close the socket and assume no process has been started.</p> +<p>Do not perform any operations in this callback, as this would block the supervisor responsible for starting connection processes and degrade performance severely.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The second argument <code>Socket</code> was removed. +</li> +<li><strong>1.6</strong>: The second argument <code>Socket</code> was deprecated. Call <a href="../ranch.handshake">ranch:handshake(3)</a> to obtain the socket. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch.handshake">ranch:handshake(3)</a>, <a href="..">ranch(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch_proxy_header.header/index.html b/docs/en/ranch/2.2/manual/ranch_proxy_header.header/index.html new file mode 100644 index 00000000..f8b715d4 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch_proxy_header.header/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: ranch_proxy_header: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>ranch_proxy_header:header(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch_proxy_header:header - Build a PROXY protocol 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">ProxyInfo</font>) <font color="#990000">-></font> <b><font color="#000000">header</font></b>(<font color="#009900">ProxyInfo</font>, #{}) +<b><font color="#000000">header</font></b>(<font color="#009900">ProxyInfo</font>, <font color="#009900">BuildOpts</font>) <font color="#990000">-></font> <b><font color="#000000">iodata</font></b>() + +<font color="#009900">ProxyInfo</font> <font color="#990000">::</font> <b><font color="#000000">ranch_proxy_header:proxy_info</font></b>() +<font color="#009900">BuildOpts</font> <font color="#990000">::</font> #{ + <font color="#0000FF">checksum</font> <font color="#990000">=></font> <font color="#FF6600">crc32c</font>, + <font color="#0000FF">padding</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>() <i><font color="#9A1900">%% >= 3</font></i> +}</tt></pre> +</div></div> +<p>Build a PROXY protocol header.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ProxyInfo</dt> +<dd><p>The proxy information to encode.</p> +</dd> +<dt>BuildOpts</dt> +<dd><p>Options to control whether to add a checksum or padding should be included in the encoded PROXY protocol header.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The PROXY protocol header is returned.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.7</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Build a PROXY protocol 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">ProxyInfo</font> <font color="#990000">=</font> #{ + <font color="#0000FF">version</font> <font color="#990000">=></font> <font color="#993399">2</font>, + <b><font color="#000080">command</font></b> <font color="#990000">=></font> <font color="#FF6600">proxy</font>, + + <font color="#0000FF">transport_family</font> <font color="#990000">=></font> <font color="#FF6600">ipv4</font>, + <font color="#0000FF">transport_protocol</font> <font color="#990000">=></font> <font color="#FF6600">stream</font>, + + <font color="#0000FF">src_address</font> <font color="#990000">=></font> {<font color="#993399">192</font>, <font color="#993399">168</font>, <font color="#993399">1</font>, <font color="#993399">11</font>}, + <font color="#0000FF">src_port</font> <font color="#990000">=></font> <font color="#993399">54321</font>, + <font color="#0000FF">dest_address</font> <font color="#990000">=></font> {<font color="#993399">192</font>, <font color="#993399">168</font>, <font color="#993399">1</font>, <font color="#993399">42</font>}, + <font color="#0000FF">dest_port</font> <font color="#990000">=></font> <font color="#993399">443</font> +}, +<font color="#009900">Data</font> <font color="#990000">=</font> <b><font color="#000000">ranch_proxy_header:parse</font></b>(<font color="#009900">ProxyInfo</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Build a PROXY protocol header with checksum and padding</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">Data</font> <font color="#990000">=</font> <b><font color="#000000">ranch_proxy_header:parse</font></b>(<font color="#009900">ProxyInfo</font>, #{ + <font color="#0000FF">checksum</font> <font color="#990000">=></font> <font color="#FF6600">crc32c</font>, + <font color="#0000FF">padding</font> <font color="#990000">=></font> <font color="#993399">7</font> +})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch_proxy_header.header">ranch_proxy_header:header(3)</a>, <a href="../ranch_proxy_header">ranch_proxy_header(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch_proxy_header.parse/index.html b/docs/en/ranch/2.2/manual/ranch_proxy_header.parse/index.html new file mode 100644 index 00000000..6fd237c0 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch_proxy_header.parse/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: ranch_proxy_header:parse(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>ranch_proxy_header:parse(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch_proxy_header:parse - Parse a PROXY protocol 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</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>, <b><font color="#000000">ranch_proxy_header:proxy_info</font></b>(), <font color="#009900">Rest</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">error</font>, <font color="#009900">HumanReadable</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>()}</tt></pre> +</div></div> +<p>Parse a PROXY protocol header.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Data</dt> +<dd><p>The PROXY protocol header optionally followed by more data.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>An <code>ok</code> tuple is returned on success, containing the proxy information found in the header and the rest of the data if more was provided.</p> +<p>An <code>error</code> tuple is returned when a protocol error is detected. It contains a human readable message about the error.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.7</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Parse the PROXY protocol 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="#FF6600">ok</font> <font color="#009900">ProxyInfo</font>, <font color="#009900">Rest</font>} <font color="#990000">=</font> <b><font color="#000000">ranch_proxy_header:parse</font></b>(<font color="#009900">Data</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch_proxy_header.header">ranch_proxy_header:header(3)</a>, <a href="../ranch_proxy_header.to_connection_info">ranch_proxy_header:to_connection_info(3)</a>, <a href="../ranch_proxy_header">ranch_proxy_header(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch_proxy_header.to_connection_info/index.html b/docs/en/ranch/2.2/manual/ranch_proxy_header.to_connection_info/index.html new file mode 100644 index 00000000..5def48bc --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch_proxy_header.to_connection_info/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: ranch_proxy_header:to_connection_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>ranch_proxy_header:to_connection_info(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch_proxy_header:to_connection_info - Convert proxy_info() to ssl:connection_info()</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">to_connection_info</font></b>(<font color="#009900">ProxyInfo</font> <font color="#990000">::</font> <b><font color="#000000">proxy_info</font></b>()) + <font color="#990000">-></font> <b><font color="#000000">ssl:connection_info</font></b>()</tt></pre> +</div></div> +<p>Convert <code>ranch_proxy_header:proxy_info()</code> information to the <code>ssl:connection_info()</code> format returned by <code>ssl:connection_information/1,2</code>.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ProxyInfo</dt> +<dd><p>The PROXY protocol information.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>Connection information is returned as a proplist.</p> +<p>Because the PROXY protocol header includes limited information, only the keys <code>protocol</code>, <code>selected_cipher_suite</code> and <code>sni_hostname</code> will be returned, at most. All keys are optional.</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">Convert the PROXY protocol information</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">ConnInfo</font> <font color="#990000">=</font> <b><font color="#000000">ranch_proxy_header:to_connection_info</font></b>(<font color="#009900">ProxyInfo</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch_proxy_header.parse">ranch_proxy_header:parse(3)</a>, <a href="../ranch_proxy_header">ranch_proxy_header(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch_proxy_header/index.html b/docs/en/ranch/2.2/manual/ranch_proxy_header/index.html new file mode 100644 index 00000000..9e734d51 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch_proxy_header/index.html @@ -0,0 +1,283 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: ranch_proxy_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>ranch_proxy_header(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch_proxy_header - PROXY protocol</p> +<h2 id="_description">Description</h2> +<p>The module <code>ranch_proxy_header</code> provides functions for parsing and building the PROXY protocol header.</p> +<h2 id="_exports">Exports</h2> +<ul><li><a href="../ranch_proxy_header.parse">ranch_proxy_header:parse(3)</a> - Parse a PROXY protocol header +</li> +<li><a href="../ranch_proxy_header.header">ranch_proxy_header:header(3)</a> - Build a PROXY protocol header +</li> +<li><a href="../ranch_proxy_header.to_connection_info">ranch_proxy_header:to_connection_info(3)</a> - Convert proxy_info() to ssl:connection_info() +</li> +</ul> +<h2 id="_types">Types</h2> +<h3 id="_proxy_info">proxy_info()</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">proxy_info</font></b>() <font color="#990000">=</font> #{ + <i><font color="#9A1900">%% Mandatory part.</font></i> + <font color="#FF6600">version</font> <font color="#990000">:=</font> <font color="#993399">1</font> | <font color="#993399">2</font>, + <font color="#FF6600">command</font> <font color="#990000">:=</font> <font color="#FF6600">local</font> | <font color="#FF6600">proxy</font>, + <font color="#0000FF">transport_family</font> <font color="#990000">=></font> <font color="#000080">undefined</font> | <font color="#FF6600">ipv4</font> | <font color="#FF6600">ipv6</font> | <font color="#FF6600">unix</font>, + <font color="#0000FF">transport_protocol</font> <font color="#990000">=></font> <font color="#000080">undefined</font> | <font color="#FF6600">stream</font> | <font color="#FF6600">dgram</font>, + + <i><font color="#9A1900">%% Addresses.</font></i> + <font color="#0000FF">src_address</font> <font color="#990000">=></font> <b><font color="#000000">inet:ip_address</font></b>() | <b><font color="#000080">binary</font></b>(), + <font color="#0000FF">src_port</font> <font color="#990000">=></font> <b><font color="#000000">inet:port_number</font></b>(), + <font color="#0000FF">dest_address</font> <font color="#990000">=></font> <b><font color="#000000">inet:ip_address</font></b>() | <b><font color="#000080">binary</font></b>(), + <font color="#0000FF">dest_port</font> <font color="#990000">=></font> <b><font color="#000000">inet:port_number</font></b>(), + + <i><font color="#9A1900">%% Extra TLV-encoded data.</font></i> + <font color="#0000FF">alpn</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% US-ASCII.</font></i> + <font color="#0000FF">authority</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% UTF-8.</font></i> + <font color="#0000FF">unique_id</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% Opaque byte sequence of up to 128 bytes.</font></i> + <font color="#0000FF">netns</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% US-ASCII.</font></i> + <font color="#0000FF">ssl</font> <font color="#990000">=></font> #{ + <font color="#FF6600">client</font> <font color="#990000">:=</font> [<font color="#FF6600">ssl</font> | <font color="#FF6600">cert_conn</font> | <font color="#FF6600">cert_sess</font>], + <font color="#FF6600">verified</font> <font color="#990000">:=</font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">version</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% US-ASCII.</font></i> + <font color="#0000FF">cipher</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% US-ASCII.</font></i> + <font color="#0000FF">sig_alg</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% US-ASCII.</font></i> + <font color="#0000FF">key_alg</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>(), <i><font color="#9A1900">%% US-ASCII.</font></i> + <font color="#0000FF">cn</font> <font color="#990000">=></font> <b><font color="#000080">binary</font></b>() <i><font color="#9A1900">%% UTF-8.</font></i> + }, + + <i><font color="#9A1900">%% Unknown TLVs can't be parsed so the raw data is given.</font></i> + <font color="#0000FF">raw_tlvs</font> <font color="#990000">=></font> [{<font color="#993399">0</font><font color="#990000">..</font><font color="#993399">255</font>, <b><font color="#000080">binary</font></b>()}] +}<font color="#990000">.</font></tt></pre> +</div></div> +<p>The PROXY protocol information.</p> +<p>The following fields may be found, although most of them are optional:</p> +<dl><dt>version</dt> +<dd><p>The PROXY protocol version used.</p> +</dd> +<dt>command</dt> +<dd><p><code>proxy</code> is used for proxied connections. <code>local</code> for non-proxied connections. Those do not have any additional information.</p> +</dd> +<dt>transport_family</dt> +<dd><p>The transport family of the original connection.</p> +</dd> +<dt>transport_protocol</dt> +<dd><p>The transport protocol of the original connection.</p> +</dd> +<dt>src_address</dt> +<dd><p>The source address of the original connection. This is the original address of the client.</p> +</dd> +<dt>src_port</dt> +<dd><p>The source port of the original connection. This is the port the client opened on its end for the connection. It is not defined for UNIX domain sockets.</p> +</dd> +<dt>dest_address</dt> +<dd><p>The destination address of the original connection.</p> +</dd> +<dt>dest_port</dt> +<dd><p>The destination port of the original connection. It is not defined for UNIX domain sockets.</p> +</dd> +<dt>alpn</dt> +<dd><p>The upper layer protocol in use over the connection. This is typically negotiated via the ALPN extension for TLS.</p> +</dd> +<dt>authority</dt> +<dd><p>The host name serving as authority for the connection. This is typically passed using the SNI extension for TLS.</p> +</dd> +<dt>unique_id</dt> +<dd><p>An opaque byte sequence of up to 128 bytes generated by the upstream proxy that uniquely identifies the connection.</p> +</dd> +<dt>netns</dt> +<dd><p>The namespace's name for the original connection.</p> +</dd> +<dt>ssl</dt> +<dd><p>Various information pertaining to the original SSL/TLS connection.</p> +<dl><dt>client</dt> +<dd><p>A list containing a number of flags. <code>ssl</code> indicates that the client connected over SSL/TLS. <code>cert_conn</code> indicates that the client provided a certificate over the original connection. <code>cert_sess</code> indicates that the client provided a certificate at least once over the TLS session this connection belongs to.</p> +</dd> +<dt>verified</dt> +<dd><p>Whether the client presented a certificate and it was successfully verified.</p> +</dd> +<dt>version</dt> +<dd><p>The US-ASCII string containing the SSL/TLS version used for the original connection.</p> +</dd> +<dt>cipher</dt> +<dd><p>The US-ASCII string name of the cipher used.</p> +</dd> +<dt>sig_alg</dt> +<dd><p>The US-ASCII string name of the algorithm used to sign the certificate provided by the client.</p> +</dd> +<dt>key_alg</dt> +<dd><p>The US-ASCII string name of the algorithm used to generate the key of the certificate provided by the client.</p> +</dd> +<dt>cn</dt> +<dd><p>The UTF-8 string representation of the Common Name field of the client certificate's Distinguished Name.</p> +</dd> +</dl> +</dd> +<dt>raw_tlvs</dt> +<dd><p>The non-standard TLVs that Ranch was not able to parse.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.2</strong>: The <code>unique_id</code> TLV was added. +</li> +<li><strong>1.7</strong>: Module introduced. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">ranch(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch_ssl/index.html b/docs/en/ranch/2.2/manual/ranch_ssl/index.html new file mode 100644 index 00000000..cf75cf97 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch_ssl/index.html @@ -0,0 +1,393 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: ranch_ssl(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>ranch_ssl(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch_ssl - SSL transport</p> +<h2 id="_description">Description</h2> +<p>The module <code>ranch_ssl</code> implements an SSL Ranch transport.</p> +<h2 id="_exports">Exports</h2> +<p>The module <code>ranch_ssl</code> implements the interface defined by <a href="../ranch_transport">ranch_transport(3)</a>.</p> +<h2 id="_types">Types</h2> +<h3 id="_opt">opt()</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">opt</font></b>() <font color="#990000">::</font> <b><font color="#000000">ranch_tcp:opt</font></b>() | <b><font color="#000000">ssl_opt</font></b>()</tt></pre> +</div></div> +<p>Listen options.</p> +<p>The TCP options are defined in <a href="../ranch_tcp">ranch_tcp(3)</a>.</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">opt</font></b>()]</tt></pre> +</div></div> +<p>List of listen options.</p> +<h3 id="_ssl_opt">ssl_opt()</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">ssl_opt</font></b>() <font color="#990000">=</font> {<font color="#FF6600">alpn_preferred_protocols</font>, [<b><font color="#000080">binary</font></b>()]} + | {<font color="#FF6600">anti_replay</font>, <font color="#FF6600">'10k'</font> | <font color="#FF6600">'100k'</font> | {<b><font color="#000080">integer</font></b>(), <b><font color="#000080">integer</font></b>(), <b><font color="#000080">integer</font></b>()}} + | {<font color="#FF6600">beast_mitigation</font>, <font color="#FF6600">one_n_minus_one</font> | <font color="#FF6600">zero_n</font> | <font color="#FF6600">disabled</font>} + | {<font color="#FF6600">cacertfile</font>, <b><font color="#000000">file:filename</font></b>()} + | {<font color="#FF6600">cacerts</font>, [<b><font color="#000000">public_key:der_encoded</font></b>()]} + | {<font color="#FF6600">cert</font>, <b><font color="#000000">public_key:der_encoded</font></b>()} + | {<font color="#FF6600">certs_keys</font>, [#{<font color="#0000FF">cert</font> <font color="#990000">=></font> <b><font color="#000000">public_key:der_encoded</font></b>(), + <font color="#0000FF">key</font> <font color="#990000">=></font> <b><font color="#000000">ssl:key</font></b>(), + <font color="#0000FF">certfile</font> <font color="#990000">=></font> <b><font color="#000000">file:filename</font></b>(), + <font color="#0000FF">keyfile</font> <font color="#990000">=></font> <b><font color="#000000">file:filename</font></b>(), + <font color="#0000FF">key_pem_password</font> <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>() | <b><font color="#0000FF">fun</font></b>(() <font color="#990000">-></font> <b><font color="#000000">iodata</font></b>())}]} + | {<font color="#FF6600">certfile</font>, <b><font color="#000000">file:filename</font></b>()} + | {<font color="#FF6600">ciphers</font>, <b><font color="#000000">ssl:ciphers</font></b>()} + | {<font color="#FF6600">client_renegotiation</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">crl_cache</font>, [<b><font color="#000000">any</font></b>()]} + | {<font color="#FF6600">crl_check</font>, <b><font color="#000000">boolean</font></b>() | <font color="#FF6600">peer</font> | <font color="#FF6600">best_effort</font>} + | {<font color="#FF6600">depth</font>, <b><font color="#000080">integer</font></b>()} + | {<font color="#FF6600">dh</font>, <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">dhfile</font>, <b><font color="#000000">file:filename</font></b>()} + | {<font color="#FF6600">eccs</font>, [<b><font color="#000000">ssl:named_curve</font></b>()]} + | {<font color="#FF6600">fail_if_no_peer_cert</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">handshake</font>, <font color="#FF6600">hello</font> | <font color="#FF6600">full</font>} + | {<font color="#FF6600">hibernate_after</font>, <b><font color="#000000">timeout</font></b>()} + | {<font color="#FF6600">honor_cipher_order</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">honor_ecc_order</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">key</font>, <b><font color="#000000">ssl:key</font></b>()} + | {<font color="#FF6600">key_update_at</font>, <b><font color="#000000">pos_integer</font></b>()} + | {<font color="#FF6600">keyfile</font>, <b><font color="#000000">file:filename</font></b>()} + | {<font color="#FF6600">log_alert</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">log_level</font>, <b><font color="#000000">logger:level</font></b>()} + | {<font color="#FF6600">max_handshake_size</font>, <b><font color="#000080">integer</font></b>()} + | {<font color="#FF6600">middlebox_comp_mode</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">next_protocols_advertised</font>, [<b><font color="#000080">binary</font></b>()]} + | {<font color="#FF6600">padding_check</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">partial_chain</font>, <b><font color="#0000FF">fun</font></b>()} + | {<font color="#FF6600">password</font>, <b><font color="#000000">string</font></b>()} + | {<font color="#FF6600">protocol</font>, <font color="#FF6600">tls</font> | <font color="#FF6600">dtls</font>} + | {<font color="#FF6600">psk_identity</font>, <b><font color="#000000">string</font></b>()} + | {<font color="#FF6600">reuse_session</font>, <b><font color="#0000FF">fun</font></b>()} + | {<font color="#FF6600">reuse_sessions</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">secure_renegotiate</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">session_tickets</font>, <font color="#FF6600">disabled</font> | <font color="#FF6600">stateful</font> | <font color="#FF6600">stateless</font>} + | {<font color="#FF6600">signature_algs</font>, [{<b><font color="#000000">ssl:hash</font></b>(), <b><font color="#000000">ssl:sign_algo</font></b>()}]} + | {<font color="#FF6600">signature_algs_cert</font>, [<b><font color="#000000">ssl:sign_scheme</font></b>()]} + | {<font color="#FF6600">sni_fun</font>, <b><font color="#0000FF">fun</font></b>()} + | {<font color="#FF6600">sni_hosts</font>, [{<b><font color="#000000">string</font></b>(), <b><font color="#000000">ssl_opt</font></b>()}]} + | {<font color="#FF6600">supported_groups</font>, [<b><font color="#000000">ssl:group</font></b>()]} + | {<font color="#FF6600">user_lookup_fun</font>, {<b><font color="#0000FF">fun</font></b>(), <b><font color="#000000">any</font></b>()}} + | {<font color="#FF6600">verify</font>, <font color="#FF6600">verify_none</font> | <font color="#FF6600">verify_peer</font>} + | {<font color="#FF6600">verify_fun</font>, {<b><font color="#0000FF">fun</font></b>(), <b><font color="#000000">any</font></b>()}} + | {<font color="#FF6600">versions</font>, [<b><font color="#000000">ssl:protocol_version</font></b>()]}</tt></pre> +</div></div> +<p>SSL-specific listen options.</p> +<p>Specifying a certificate is mandatory, either through the <code>cert</code> or <code>certfile</code> option, or by configuring SNI. None of the other options are required.</p> +<p>The default value is given next to the option name:</p> +<dl><dt>alpn_preferred_protocols</dt> +<dd><p>Perform Application-Layer Protocol Negotiation with the given list of preferred protocols.</p> +</dd> +<dt>anti_replay</dt> +<dd><p>Configures the server's built-in anti replay feature based on Bloom filters.</p> +</dd> +<dt>beast_mitigation (one_n_minus_one)</dt> +<dd><p>Change the BEAST mitigation strategy for SSL-3.0 and TLS-1.0 to interoperate with legacy software.</p> +</dd> +<dt>cacertfile</dt> +<dd><p>Path to PEM encoded trusted certificates file used to verify peer certificates.</p> +</dd> +<dt>cacerts</dt> +<dd><p>List of DER encoded trusted certificates.</p> +</dd> +<dt>cert</dt> +<dd><p>DER encoded user certificate.</p> +</dd> +<dt>certs_keys</dt> +<dd><p>A list of a certificate (or possible a certificate and its chain) and the associated key of the certificate, that may be used to authenticate the client or the server.</p> +</dd> +<dt>certfile</dt> +<dd><p>Path to the PEM encoded user certificate file. May also contain the private key.</p> +</dd> +<dt>ciphers</dt> +<dd><p>List of ciphers that clients are allowed to use.</p> +</dd> +<dt>client_renegotiation (true)</dt> +<dd><p>Whether to allow client-initiated renegotiation.</p> +</dd> +<dt>crl_cache ({ssl_crl_cache, {internal, []}})</dt> +<dd><p>Customize the module used to cache Certificate Revocation Lists.</p> +</dd> +<dt>crl_check (false)</dt> +<dd><p>Whether to perform CRL check on all certificates in the chain during validation.</p> +</dd> +<dt>depth (1)</dt> +<dd><p>Maximum of intermediate certificates allowed in the certification path.</p> +</dd> +<dt>dh</dt> +<dd><p>DER encoded Diffie-Hellman parameters.</p> +</dd> +<dt>dhfile</dt> +<dd><p>Path to the PEM encoded Diffie-Hellman parameters file.</p> +</dd> +<dt>eccs</dt> +<dd><p>List of named ECC curves.</p> +</dd> +<dt>fail_if_no_peer_cert (false)</dt> +<dd><p>Whether to refuse the connection if the client sends an empty certificate.</p> +</dd> +<dt>handshake (full)</dt> +<dd><p>If <code>hello</code> is specified for this option, the handshake is paused after receiving the client hello message. The handshake can then be resumed via <code>handshake_continue/3</code>, or cancelled via <code>handshake_cancel/1</code>.</p> +<p>This option cannot be given to <code>ranch:handshake/1,2</code>.</p> +</dd> +<dt>hibernate_after (undefined)</dt> +<dd><p>Time in ms after which SSL socket processes go into hibernation to reduce memory usage.</p> +</dd> +<dt>honor_cipher_order (false)</dt> +<dd><p>If true, use the server's preference for cipher selection. If false, use the client's preference.</p> +</dd> +<dt>honor_ecc_order (false)</dt> +<dd><p>If true, use the server's preference for ECC curve selection. If false, use the client's preference.</p> +</dd> +<dt>key</dt> +<dd><p>DER encoded user private key.</p> +</dd> +<dt>key_update_at</dt> +<dd><p>Configures the maximum amount of bytes that can be sent on a TLS 1.3 connection before an automatic key update is performed.</p> +</dd> +<dt>keyfile</dt> +<dd><p>Path to the PEM encoded private key file, if different from the certfile.</p> +</dd> +<dt>log_alert (true)</dt> +<dd><p>If false, error reports will not be displayed.</p> +</dd> +<dt>log_level</dt> +<dd><p>Specifies the log level for TLS/DTLS.</p> +</dd> +<dt>max_handshake_size (256*1024)</dt> +<dd><p>Used to limit the size of valid TLS handshake packets to avoid DoS attacks.</p> +</dd> +<dt>middlebox_comp_mode (true)</dt> +<dd><p>Configures the middlebox compatibility mode on a TLS 1.3 connection.</p> +</dd> +<dt>next_protocols_advertised</dt> +<dd><p>List of protocols to send to the client if it supports the Next Protocol extension.</p> +</dd> +<dt>padding_check</dt> +<dd><p>Allow disabling the block cipher padding check for TLS-1.0 to be able to interoperate with legacy software.</p> +</dd> +<dt>partial_chain</dt> +<dd><p>Claim an intermediate CA in the chain as trusted.</p> +</dd> +<dt>password</dt> +<dd><p>Password to the private key file, if password protected.</p> +</dd> +<dt>protocol (tls)</dt> +<dd><p>Choose TLS or DTLS protocol for the transport layer security.</p> +</dd> +<dt>psk_identity</dt> +<dd><p>Provide the given PSK identity hint to the client during the handshake.</p> +</dd> +<dt>reuse_session</dt> +<dd><p>Custom policy to decide whether a session should be reused.</p> +</dd> +<dt>reuse_sessions (false)</dt> +<dd><p>Whether to allow session reuse.</p> +</dd> +<dt>secure_renegotiate (false)</dt> +<dd><p>Whether to reject renegotiation attempts that do not conform to RFC5746.</p> +</dd> +<dt>session_tickets</dt> +<dd><p>Configures the session ticket functionality.</p> +</dd> +<dt>signature_algs</dt> +<dd><p>The TLS signature algorithm extension may be used, from TLS 1.2, to negotiate which signature algorithm to use during the TLS handshake.</p> +</dd> +<dt>signature_algs_cert</dt> +<dd><p>List of signature schemes for the signature_algs_cert extension introduced in TLS 1.3, in order to make special requirements on signatures used in certificates.</p> +</dd> +<dt>sni_fun</dt> +<dd><p>Function called when the client requests a host using Server Name Indication. Returns options to apply.</p> +</dd> +<dt>sni_hosts</dt> +<dd><p>Options to apply for the host that matches what the client requested with Server Name Indication.</p> +</dd> +<dt>supported_groups([x25519, x448, secp256r1, secp384r1])</dt> +<dd><p>TLS 1.3 introduces the <code>supported_groups</code> extension that is used for negotiating the Diffie-Hellman parameters in a TLS 1.3 handshake. Both client and server can specify a list of parameters that they are willing to use.</p> +</dd> +<dt>user_lookup_fun</dt> +<dd><p>Function called to determine the shared secret when using PSK, or provide parameters when using SRP.</p> +</dd> +<dt>verify (verify_none)</dt> +<dd><p>Use <code>verify_peer</code> to request a certificate from the client.</p> +</dd> +<dt>verify_fun</dt> +<dd><p>Custom policy to decide whether a client certificate is valid.</p> +</dd> +<dt>versions</dt> +<dd><p>TLS protocol versions that will be supported.</p> +</dd> +</dl> +<p>Note that the client will not send a certificate unless the value for the <code>verify</code> option is set to <code>verify_peer</code>. This means that <code>fail_if_no_peer_cert</code> only applies when combined with the <code>verify</code> option. The <code>verify_fun</code> option allows greater control over the client certificate validation.</p> +<p>The options <code>sni_fun</code> and <code>sni_hosts</code> are mutually exclusive.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The <code>ssl_opt()</code> type was updated for OTP-23.0. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">ranch(7)</a>, <a href="../ranch_transport">ranch_transport(3)</a>, <a href="../ranch_tcp">ranch_tcp(3)</a>, ssl(3)</p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch_tcp/index.html b/docs/en/ranch/2.2/manual/ranch_tcp/index.html new file mode 100644 index 00000000..147c9b9a --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch_tcp/index.html @@ -0,0 +1,287 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: ranch_tcp(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>ranch_tcp(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch_tcp - TCP transport</p> +<h2 id="_description">Description</h2> +<p>The module <code>ranch_tcp</code> implements a TCP Ranch transport.</p> +<p>The function <code>sendfile</code> may not work correctly when used against files stored in a VirtualBox shared folder.</p> +<h2 id="_exports">Exports</h2> +<p>The module <code>ranch_tcp</code> implements the interface defined by <a href="../ranch_transport">ranch_transport(3)</a>.</p> +<h2 id="_types">Types</h2> +<h3 id="_opt">opt()</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">opt</font></b>() <font color="#990000">=</font> {<font color="#FF6600">backlog</font>, <b><font color="#000000">non_neg_integer</font></b>()} + | {<font color="#FF6600">buffer</font>, <b><font color="#000000">non_neg_integer</font></b>()} + | {<font color="#FF6600">delay_send</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">dontroute</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">exit_on_close</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">fd</font>, <b><font color="#000000">non_neg_integer</font></b>()} + | {<font color="#FF6600">high_msgq_watermark</font>, <b><font color="#000000">non_neg_integer</font></b>()} + | {<font color="#FF6600">high_watermark</font>, <b><font color="#000000">non_neg_integer</font></b>()} + | <font color="#FF6600">inet</font> + | <font color="#FF6600">inet6</font> + | {<font color="#FF6600">ip</font>, <b><font color="#000000">inet:ip_address</font></b>() | <b><font color="#000000">inet:local_address</font></b>()} + | {<font color="#FF6600">ipv6_v6only</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">keepalive</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">linger</font>, {<b><font color="#000000">boolean</font></b>(), <b><font color="#000000">non_neg_integer</font></b>()}} + | {<font color="#FF6600">low_msgq_watermark</font>, <b><font color="#000000">non_neg_integer</font></b>()} + | {<font color="#FF6600">low_watermark</font>, <b><font color="#000000">non_neg_integer</font></b>()} + | {<font color="#FF6600">nodelay</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">port</font>, <b><font color="#000000">inet:port_number</font></b>()} + | {<b><font color="#000080">priority</font></b>, <b><font color="#000080">integer</font></b>()} + | {<font color="#FF6600">raw</font>, <b><font color="#000000">non_neg_integer</font></b>(), <b><font color="#000000">non_neg_integer</font></b>(), <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">recbuf</font>, <b><font color="#000000">non_neg_integer</font></b>()} + | {<font color="#FF6600">send_timeout</font>, <b><font color="#000000">timeout</font></b>()} + | {<font color="#FF6600">send_timeout_close</font>, <b><font color="#000000">boolean</font></b>()} + | {<font color="#FF6600">sndbuf</font>, <b><font color="#000000">non_neg_integer</font></b>()} + | {<font color="#FF6600">tos</font>, <b><font color="#000080">integer</font></b>()}</tt></pre> +</div></div> +<p>Listen options.</p> +<p>Note that additional options may be set by the protocol module using <code>Transport:setopts/2</code>.</p> +<p>None of the options are required.</p> +<p>Please consult the <code>gen_tcp</code> and <code>inet</code> manuals for a more thorough description of these options. This manual only aims to provide a short description along with what the defaults are. Defaults may be different in Ranch compared to <code>gen_tcp</code>. Defaults are given next to the option name:</p> +<dl><dt>backlog (1024)</dt> +<dd><p>Max length of the queue of pending connections.</p> +</dd> +<dt>buffer</dt> +<dd><p>Size of the buffer used by the Erlang driver. Default is system-dependent.</p> +</dd> +<dt>delay_send (false)</dt> +<dd><p>Always queue data before sending, to send fewer, larger packets over the network.</p> +</dd> +<dt>dontroute (false)</dt> +<dd><p>Don't send via a gateway, only send to directly connected hosts.</p> +</dd> +<dt>exit_on_close (true)</dt> +<dd><p>Disable to allow sending data after a close has been detected.</p> +</dd> +<dt>fd</dt> +<dd><p>File descriptor of the socket, if it was opened externally.</p> +</dd> +<dt>high_msgq_watermark (8192)</dt> +<dd><p>Limit in the amount of data in the socket message queue before the queue becomes busy.</p> +</dd> +<dt>high_watermark (8192)</dt> +<dd><p>Limit in the amount of data in the ERTS socket implementation's queue before the socket becomes busy.</p> +</dd> +<dt>inet</dt> +<dd><p>Set up the socket for IPv4.</p> +</dd> +<dt>inet6</dt> +<dd><p>Set up the socket for IPv6.</p> +</dd> +<dt>ip</dt> +<dd><p>Interface to listen on. Listen on all network interfaces by default.</p> +</dd> +</dl> +<p>On UNIX systems, it is also possible to use a UNIX Domain socket file by specifying <code>{local, SocketFile}</code>.</p> +<dl><dt>ipv6_v6only (false)</dt> +<dd><p>Listen on IPv4 and IPv6 (false) or only on IPv6 (true). Use with inet6.</p> +</dd> +<dt>keepalive (false)</dt> +<dd><p>Enable sending of keep-alive messages.</p> +</dd> +<dt>linger ({false, 0})</dt> +<dd><p>Whether to wait and how long to flush data sent before closing the socket.</p> +</dd> +<dt>low_msgq_watermark (4096)</dt> +<dd><p>Amount of data in the socket message queue before the queue leaves busy state.</p> +</dd> +<dt>low_watermark (4096)</dt> +<dd><p>Amount of data in the ERTS socket implementation's queue before the socket leaves busy state.</p> +</dd> +<dt>nodelay (true)</dt> +<dd><p>Whether to enable TCP_NODELAY.</p> +</dd> +<dt>port (0)</dt> +<dd><p>TCP port number to listen on. 0 means a random port will be used.</p> +</dd> +<dt>priority (0)</dt> +<dd><p>Priority value for all packets to be sent on this socket.</p> +</dd> +<dt>recbuf</dt> +<dd><p>Minimum size of the socket's receive buffer. Default is system-dependent.</p> +</dd> +<dt>send_timeout (30000)</dt> +<dd><p>How long the send call may wait for confirmation before returning.</p> +</dd> +<dt>send_timeout_close (true)</dt> +<dd><p>Whether to close the socket when the confirmation wasn't received.</p> +</dd> +<dt>sndbuf</dt> +<dd><p>Minimum size of the socket's send buffer. Default is system-dependent.</p> +</dd> +<dt>tos</dt> +<dd><p>Value for the IP_TOS IP level option. Use with caution.</p> +</dd> +</dl> +<p>In addition, the <code>raw</code> option can be used to set system-specific options by specifying the protocol level, the option number and the actual option value specified as a binary. This option is not portable. Use with caution.</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">opt</font></b>()]</tt></pre> +</div></div> +<p>List of listen options.</p> +<h2 id="_see_also">See also</h2> +<p><a href="..">ranch(7)</a>, <a href="../ranch_transport">ranch_transport(3)</a>, <a href="../ranch_ssl">ranch_ssl(3)</a>, gen_tcp(3), inet(3)</p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch_transport.sendfile/index.html b/docs/en/ranch/2.2/manual/ranch_transport.sendfile/index.html new file mode 100644 index 00000000..618e62d2 --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch_transport.sendfile/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: ranch_transport:sendfile(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>ranch_transport:sendfile(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch_transport:sendfile - Send a file on the 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">sendfile</font></b>(<font color="#009900">Transport</font> <font color="#990000">::</font> <b><font color="#000000">module</font></b>(), + <font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">ranch_transport:socket</font></b>(), + <font color="#009900">File</font> <font color="#990000">::</font> <b><font color="#000000">file:name_all</font></b>() | <b><font color="#000000">file:fd</font></b>(), + <font color="#009900">Offset</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#009900">Bytes</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">ranch_transport:sendfile_opts</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">SentBytes</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>()} | {<font color="#FF6600">error</font>, <b><font color="#000080">atom</font></b>()}</tt></pre> +</div></div> +<p>Send a file on the socket.</p> +<p>The file may be sent full or in parts, and may be specified by its filename or by an already open file descriptor.</p> +<p>This function emulates the function <code>file:sendfile/2,4,5</code> and may be used when transports are not manipulating TCP directly.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Transport</dt> +<dd><p>The transport module.</p> +</dd> +<dt>Socket</dt> +<dd><p>The socket.</p> +</dd> +<dt>File</dt> +<dd><p>The filename or file descriptor for the file to be sent.</p> +</dd> +<dt>Offset</dt> +<dd><p>Start position in the file, in bytes.</p> +</dd> +<dt>Bytes</dt> +<dd><p>Length in bytes.</p> +</dd> +<dt>Opts</dt> +<dd><p>Additional options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The number of bytes actually sent is returned on success inside an <code>ok</code> tuple.</p> +<p>An <code>error</code> tuple is returned otherwise.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.6</strong>: The type of the <code>File</code> argument was extended. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Implement Transport:sendfile using the fallback</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">Socket</font>, <font color="#009900">Filename</font>) <font color="#990000">-></font> + <b><font color="#000000">sendfile</font></b>(<font color="#009900">Socket</font>, <font color="#009900">Filename</font>, <font color="#993399">0</font>, <font color="#993399">0</font>, [])<font color="#990000">.</font> + +<b><font color="#000000">sendfile</font></b>(<font color="#009900">Socket</font>, <font color="#009900">File</font>, <font color="#009900">Offset</font>, <font color="#009900">Bytes</font>) <font color="#990000">-></font> + <b><font color="#000000">sendfile</font></b>(<font color="#009900">Socket</font>, <font color="#009900">File</font>, <font color="#009900">Offset</font>, <font color="#009900">Bytes</font>, [])<font color="#990000">.</font> + +<b><font color="#000000">sendfile</font></b>(<font color="#009900">Socket</font>, <font color="#009900">File</font>, <font color="#009900">Offset</font>, <font color="#009900">Bytes</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> + <b><font color="#000000">ranch_transport:sendfile</font></b>(<b><font color="#000080">?MODULE</font></b>, <font color="#009900">Socket</font>, + <font color="#009900">File</font>, <font color="#009900">Offset</font>, <font color="#009900">Bytes</font>, <font color="#009900">Opts</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../ranch_transport">ranch_transport(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/ranch/2.2/manual/ranch_transport/index.html b/docs/en/ranch/2.2/manual/ranch_transport/index.html new file mode 100644 index 00000000..5988ef9c --- /dev/null +++ b/docs/en/ranch/2.2/manual/ranch_transport/index.html @@ -0,0 +1,440 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: ranch_transport(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>ranch_transport(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>ranch_transport - Transport modules</p> +<h2 id="_description">Description</h2> +<p>The module <code>ranch_transport</code> defines the interface used by Ranch transports.</p> +<h2 id="_callbacks">Callbacks</h2> +<p>Ranch transports implement the following interface:</p> +<h3 id="_accept">accept</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">accept</font></b>(<font color="#009900">LSocket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>(), <font color="#009900">Timeout</font> <font color="#990000">::</font> <b><font color="#000000">timeout</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>()} + | {<font color="#FF6600">error</font>, <font color="#FF6600">closed</font> | <font color="#FF6600">timeout</font> | <b><font color="#000080">atom</font></b>()}</tt></pre> +</div></div> +<p>Use the listening socket returned by <code>listen/1</code> to accept a new connection. The timeout is specified in milliseconds.</p> +<h3 id="_close">close</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">close</font></b>(<font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>()) <font color="#990000">-></font> <font color="#FF6600">ok</font></tt></pre> +</div></div> +<p>Close the socket.</p> +<h3 id="_controlling_process">controlling_process</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">controlling_process</font></b>(<font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>(), <font color="#009900">Pid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>()) + <font color="#990000">-></font> <font color="#FF6600">ok</font> | {<font color="#FF6600">error</font>, <font color="#FF6600">closed</font> | <font color="#FF6600">not_owner</font> | <b><font color="#000080">atom</font></b>()}</tt></pre> +</div></div> +<p>Assign a new controlling process to the socket. The controlling process is the process that is linked to and receives messages from the socket.</p> +<h3 id="_format_error">format_error</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">format_error</font></b>(<font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000000">term</font></b>()) + <font color="#990000">-></font> <font color="#009900">ReasonString</font> <font color="#990000">::</font> <b><font color="#000000">string</font></b>()</tt></pre> +</div></div> +<p>Format a listen error into a human-readable diagnostic string.</p> +<p>This callback is optional, but implementing it is highly recommended. It will become mandatory in Ranch 3.0.</p> +<h3 id="_getopts">getopts</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">getopts</font></b>(<font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>(), <font color="#009900">SockOpts</font> <font color="#990000">::</font> [<b><font color="#000080">atom</font></b>()]) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <b><font color="#000000">any</font></b>()} | {<font color="#FF6600">error</font>, <b><font color="#000080">atom</font></b>()}</tt></pre> +</div></div> +<p>Get one or more options for the socket.</p> +<h3 id="_getstat">getstat</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">getstat</font></b>(<font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">SockStatValues</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()} | {<font color="#FF6600">error</font>, <b><font color="#000080">atom</font></b>()}</tt></pre> +</div></div> +<p>Get all statistics for the socket.</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">getstat</font></b>(<font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>(), <font color="#009900">SockStats</font> <font color="#990000">::</font> [<b><font color="#000080">atom</font></b>()]) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">SockStatValues</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()} | {<font color="#FF6600">error</font>, <b><font color="#000080">atom</font></b>()}</tt></pre> +</div></div> +<p>Get one or more statistic options for the socket.</p> +<h3 id="_handshake">handshake</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">handshake</font></b>(<font color="#009900">Socket0</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>(), + <font color="#009900">Timeout</font> <font color="#990000">::</font> <b><font color="#000000">timeout</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>()} + | {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>(), <font color="#009900">Info</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()} + | {<font color="#FF6600">error</font>, <b><font color="#000000">any</font></b>()} + +<b><font color="#000000">handshake</font></b>(<font color="#009900">Socket0</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>(), + <font color="#009900">SockOpts</font> <font color="#990000">::</font> <b><font color="#000000">opts</font></b>(), + <font color="#009900">Timeout</font> <font color="#990000">::</font> <b><font color="#000000">timeout</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>()} + | {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>(), <font color="#009900">Info</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()} + | {<font color="#FF6600">error</font>, <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>Perform the transport-level handshake.</p> +<p>This function will be called by connection processes before performing any socket operation. It allows transports that require extra initialization to perform their task and return a socket that is ready to use.</p> +<p>If the handshake is completed by this call, the function will return <code>{ok, Socket}</code>. However, some transports (notably, <code>ranch_ssl</code> if <code>{handshake, hello}</code> is specified in the socket options) may pause the handshake at a certain point and return <code>{ok, Socket, Info}</code> instead, in order to allow for additional decisions to be made before resuming the handshake with <code>handshake_continue/3</code> or cancelling it with <code>handshake_cancel/1</code>.</p> +<p>This function may also be used to upgrade a connection from a transport to another depending on the capabilities of the transports. For example a <code>ranch_tcp</code> socket may be upgraded to a <code>ranch_ssl</code> one using this function.</p> +<h3 id="_handshake_continue">handshake_continue</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">handshake_continue</font></b>(<font color="#009900">Socket0</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>(), + <font color="#009900">Timeout</font> <font color="#990000">::</font> <b><font color="#000000">timeout</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>()} + | {<font color="#FF6600">error</font>, <b><font color="#000000">any</font></b>()} + +<b><font color="#000000">handshake_continue</font></b>(<font color="#009900">Socket0</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>(), + <font color="#009900">SockOpts</font> <font color="#990000">::</font> <b><font color="#000000">opts</font></b>(), + <font color="#009900">Timeout</font> <font color="#990000">::</font> <b><font color="#000000">timeout</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>()} + | {<font color="#FF6600">error</font>, <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>Resume the paused transport-level handshake and return a socket that is ready to use.</p> +<p>This function will be called by connection processes to resume a paused handshake.</p> +<h3 id="_handshake_cancel">handshake_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">handshake_cancel</font></b>(<font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>()) <font color="#990000">-></font> <font color="#FF6600">ok</font></tt></pre> +</div></div> +<p>Cancel the paused transport-level handshake.</p> +<h3 id="_listen">listen</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">listen</font></b>(<font color="#009900">TransportOpts</font> <font color="#990000">::</font> <b><font color="#000000">ranch:transport_opts</font></b>(<b><font color="#000000">any</font></b>())) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">LSocket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>()} | {<font color="#FF6600">error</font>, <b><font color="#000080">atom</font></b>()}</tt></pre> +</div></div> +<p>Create a socket that listens on the port given in the socket options.</p> +<p>The port may not be specified or may be set to 0, which means a random available port number will be chosen.</p> +<h3 id="_messages">messages</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">messages</font></b>() + <font color="#990000">-></font> {<font color="#009900">OK</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>(), + <font color="#009900">Closed</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>(), + <font color="#009900">Error</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>(), + <font color="#009900">Passive</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>()}</tt></pre> +</div></div> +<p>Return the tuple keys for the messages sent by the socket.</p> +<h3 id="_name">name</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="#000080">name</font></b>() <font color="#990000">-></font> <font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>()</tt></pre> +</div></div> +<p>Return the name of the transport.</p> +<h3 id="_peername">peername</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">peername</font></b>(<font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, {<b><font color="#000000">inet:ip_address</font></b>(), <b><font color="#000000">inet:port_number</font></b>()}} + | {<font color="#FF6600">local</font>, <b><font color="#000080">binary</font></b>()} | {<font color="#FF6600">error</font>, <b><font color="#000080">atom</font></b>()}<font color="#990000">.</font></tt></pre> +</div></div> +<p>Return the address and port number for the other end of the connection.</p> +<p>For UNIX Domain sockets the return value will be <code>{local, PeerSocket}</code>, with <code>PeerSocket</code> typically an empty binary.</p> +<h3 id="_recv">recv</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">recv</font></b>(<font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>(), + <font color="#009900">Length</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#009900">Timeout</font> <font color="#990000">::</font> <b><font color="#000000">timeout</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Packet</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()} + | {<font color="#FF6600">error</font>, <font color="#FF6600">closed</font> | <font color="#FF6600">timeout</font> | <b><font color="#000080">atom</font></b>()}</tt></pre> +</div></div> +<p>Receive a packet from the socket in passive mode.</p> +<p>Attempting to receive data from a socket that is in active mode will return an error.</p> +<p>A length of 0 will return the data available on the socket as soon as possible, regardless of length.</p> +<p>While it is possible to use the timeout value <code>infinity</code>, it is highly discouraged as it could cause your process to get stuck waiting for data that will never come. This may happen when a socket becomes half-open due to a crash of the remote endpoint. Wi-Fi going down is another common culprit.</p> +<h3 id="_secure">secure</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">secure</font></b>() <font color="#990000">-></font> <b><font color="#000000">boolean</font></b>()</tt></pre> +</div></div> +<p>Return whether the transport can be used for secure connections.</p> +<h3 id="_send">send</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">send</font></b>(<font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>(), <font color="#009900">Packet</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>()) + <font color="#990000">-></font> <font color="#FF6600">ok</font> | {<font color="#FF6600">error</font>, <b><font color="#000080">atom</font></b>()}</tt></pre> +</div></div> +<p>Send a packet on the socket.</p> +<h3 id="_sendfile">sendfile</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">sendfile</font></b>(<font color="#009900">Socket</font>, <font color="#009900">File</font>) + <font color="#990000">-></font> <b><font color="#000000">sendfile</font></b>(<font color="#009900">Socket</font>, <font color="#009900">File</font>, <font color="#993399">0</font>, <font color="#993399">0</font>, []) + +<b><font color="#000000">sendfile</font></b>(<font color="#009900">Socket</font>, <font color="#009900">File</font>, <font color="#009900">Offset</font>, <font color="#009900">Bytes</font>) + <font color="#990000">-></font> <b><font color="#000000">sendfile</font></b>(<font color="#009900">Socket</font>, <font color="#009900">File</font>, <font color="#009900">Offset</font>, <font color="#009900">Bytes</font>, []) + +<b><font color="#000000">sendfile</font></b>(<font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>(), + <font color="#009900">File</font> <font color="#990000">::</font> <b><font color="#000000">file:name_all</font></b>() | <b><font color="#000000">file:fd</font></b>(), + <font color="#009900">Offset</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#009900">Bytes</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">sendfile_opts</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">SentBytes</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>()} | {<font color="#FF6600">error</font>, <b><font color="#000080">atom</font></b>()}</tt></pre> +</div></div> +<p>Send a file on the socket.</p> +<p>The file may be sent full or in parts, and may be specified by its filename or by an already open file descriptor.</p> +<p>Transports that manipulate TCP directly may use the <code>file:sendfile/2,4,5</code> function, which calls the <code>sendfile</code> syscall where applicable (on Linux, for example). Other transports can use the <code>sendfile/6</code> function exported from this module.</p> +<h3 id="_setopts">setopts</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">setopts</font></b>(<font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>(), <font color="#009900">SockOpts</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()) + <font color="#990000">-></font> <font color="#FF6600">ok</font> | {<font color="#FF6600">error</font>, <b><font color="#000080">atom</font></b>()}</tt></pre> +</div></div> +<p>Set one or more options for the socket.</p> +<h3 id="_shutdown">shutdown</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="#000080">shutdown</font>(<font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>(), + <font color="#009900">How</font> <font color="#990000">::</font> <font color="#FF6600">read</font> | <font color="#FF6600">write</font> | <font color="#FF6600">read_write</font>) + <font color="#990000">-></font> <font color="#FF6600">ok</font> | {<font color="#FF6600">error</font>, <b><font color="#000080">atom</font></b>()}</tt></pre> +</div></div> +<p>Close the socket for reading and/or writing.</p> +<h3 id="_sockname">sockname</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">sockname</font></b>(<font color="#009900">Socket</font> <font color="#990000">::</font> <b><font color="#000000">socket</font></b>()) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, {<b><font color="#000000">inet:ip_address</font></b>(), <b><font color="#000000">inet:port_number</font></b>()}} + | {<font color="#FF6600">error</font>, <b><font color="#000080">atom</font></b>()}<font color="#990000">.</font></tt></pre> +</div></div> +<p>Return the address and port number for the local end of the connection.</p> +<p>For UNIX Domain sockets the return value will be <code>{local, SocketFile}</code>.</p> +<h2 id="_exports">Exports</h2> +<p>The following function can be used when implementing transport modules:</p> +<ul><li><a href="../ranch_transport.sendfile">ranch_transport:sendfile(3)</a> - Send a file on the socket +</li> +</ul> +<h2 id="_types">Types</h2> +<h3 id="_sendfile_opts">sendfile_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">sendfile_opts</font></b>() <font color="#990000">::</font> [{<font color="#FF6600">chunk_size</font>, <b><font color="#000000">non_neg_integer</font></b>()}]</tt></pre> +</div></div> +<p>Options accepted by the sendfile function and callbacks:</p> +<dl><dt>chunk_size (8191)</dt> +<dd><p>The chunk size, in bytes.</p> +</dd> +</dl> +<h3 id="_socket">socket()</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">socket</font></b>() <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>The socket.</p> +<p>The exact type will vary depending on the transport module.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.2</strong>: The callback <code>format_error/1</code> was added. +</li> +<li><strong>2.0</strong>: The callback <code>listen/1</code> has changed to accept a map of transport options instead of socket options. +</li> +<li><strong>2.0</strong>: The callback <code>messages/0</code> return value was updated to include the passive message for <code>{active, N}</code>. +</li> +<li><strong>1.6</strong>: The <code>socket()</code> type was added for documentation purposes. +</li> +<li><strong>1.6</strong>: The type of the sendfile filename was extended. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">ranch(7)</a>, <a href="../ranch_tcp">ranch_tcp(3)</a>, <a href="../ranch_ssl">ranch_ssl(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Ranch + 2.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/ranch/2.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/ranch/2.2/manual">2.2</a></li> + + <li><a href="/docs/en/ranch/2.1/manual">2.1</a></li> + + <li><a href="/docs/en/ranch/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/ranch/1.8/manual">1.8</a></li> + + <li><a href="/docs/en/ranch/1.7/manual">1.7</a></li> + + <li><a href="/docs/en/ranch/1.6/manual">1.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/index.html b/docs/index.html index c6717d87..2a1dbb18 100644 --- a/docs/index.html +++ b/docs/index.html @@ -219,6 +219,13 @@ <ul> + <li><a href="/docs/en/ranch/2.2/guide">Ranch 2.2 User Guide</a></li> + + + <li><a href="/docs/en/ranch/2.2/manual">Ranch 2.2 Function Reference</a></li> + + + <li><a href="/docs/en/ranch/2.1/guide">Ranch 2.1 User Guide</a></li> diff --git a/docs/index.xml b/docs/index.xml index defcfc87..af2fba02 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -161,6 +161,18 @@ Supported platforms Ranch is tested and supported on Linux, FreeBSD, macOS and W </item> <item> + <title>Introduction</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/introduction/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/introduction/</guid> + <description>Ranch is a socket acceptor pool for TCP protocols. +Ranch aims to provide everything you need to accept TCP connections with a small code base and low latency while being easy to use directly as an application or to embed into your own. +Prerequisites It is assumed the developer already knows Erlang and has some experience with socket programming and TCP protocols. +Supported platforms Ranch is tested and supported on Linux, FreeBSD, macOS and Windows.</description> + </item> + + <item> <title>The modern Web</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/modern_web/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -358,6 +370,16 @@ The listener takes care of supervising all the acceptor and connection processes </item> <item> + <title>Listeners</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/listeners/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/listeners/</guid> + <description>A listener is a set of processes whose role is to listen on a port for new connections. It manages a pool of acceptor processes, each of them indefinitely accepting connections. When it does, it starts a new process executing the protocol handler code. All the socket programming is abstracted through the use of transport handlers. +The listener takes care of supervising all the acceptor and connection processes, allowing developers to focus on building their application.</description> + </item> + + <item> <title>Starting and stopping</title> <link>https://ninenines.eu/docs/en/gun/1.0/guide/start/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -651,6 +673,19 @@ Ranch depends on ssl by default so any necessary dependencies will start when Ra </item> <item> + <title>Transports</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/transports/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/transports/</guid> + <description>A transport defines the interface to interact with a socket. +Transports can be used for connecting, listening and accepting connections, but also for receiving and sending data. Both passive and active mode are supported, although all sockets are initialized as passive. +TCP transport The TCP transport is a thin wrapper around gen_tcp. +SSL transport The SSL transport is a thin wrapper around ssl. +Ranch depends on ssl by default so any necessary dependencies will start when Ranch is started.</description> + </item> + + <item> <title>Connection</title> <link>https://ninenines.eu/docs/en/gun/1.0/guide/connect/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -767,6 +802,16 @@ Writing a protocol handler All protocol handlers must implement the ranch_protoc </item> <item> + <title>Protocols</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/protocols/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/protocols/</guid> + <description>A protocol handler starts a connection process and defines the protocol logic executed in this process. +Writing a protocol handler All protocol handlers must implement the ranch_protocol behavior which defines a single callback, start_link/3. This callback is responsible for spawning a new process for handling the connection. It receives three arguments: the name of the listener, the transport handler being used and the protocol options defined in the call to ranch:start_listener/5.</description> + </item> + + <item> <title>Getting started</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/getting_started/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -959,6 +1004,16 @@ However, just as for non-embedded listeners that were started via ranch:start_li </item> <item> + <title>Embedded mode</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/embedded/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/embedded/</guid> + <description>Embedded mode allows you to insert Ranch listeners directly in your supervision tree. This allows for greater fault tolerance control by permitting the shutdown of a listener due to the failure of another part of the application and vice versa. +However, just as for non-embedded listeners that were started via ranch:start_listener/5, it is required that the ranch application is running before you can start embedded listeners. Furthermore, this also means that embedded listeners will restart when ranch_sup fails.</description> + </item> + + <item> <title>Flow diagram</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/flow_diagram/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1164,6 +1219,17 @@ This chapter isn&apos;t specifically about Ranch, we assume here that you kn </item> <item> + <title>Writing parsers</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/parsers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/parsers/</guid> + <description>There are three kinds of protocols: +Text protocols Schema-less binary protocols Schema-based binary protocols This chapter introduces the first two kinds. It will not cover more advanced topics such as continuations or parser generators. +This chapter isn&apos;t specifically about Ranch, we assume here that you know how to read data from the socket. The data you read and the data that hasn&apos;t been parsed is saved in a buffer.</description> + </item> + + <item> <title>Changes since Gun 1.3</title> <link>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.3/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1342,6 +1408,16 @@ The server only needs to retain the certificate serial number and the certificat </item> <item> + <title>SSL client authentication</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/ssl_auth/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/ssl_auth/</guid> + <description>Purpose SSL client authentication is a mechanism allowing applications to identify certificates. This allows your application to make sure that the client is an authorized certificate, but makes no claim about whether the user can be trusted. This can be combined with a password based authentication to attain greater security. +The server only needs to retain the certificate serial number and the certificate issuer to authenticate the certificate. Together, they can be used to uniquely identify a certificate.</description> + </item> + + <item> <title>Routing</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/routing/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1446,6 +1522,16 @@ For this purpose, you should first suspend the listener you wish to stop gracefu </item> <item> + <title>Connection draining</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/connection_draining/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/connection_draining/</guid> + <description>Stopping a Ranch listener via ranch:stop_listener/1 will invariably kill all connection processes the listener hosts. However, you may want to stop a listener in a graceful fashion, ie by not accepting any new connections, but allowing the existing connection processes to exit by themselves instead of being killed. +For this purpose, you should first suspend the listener you wish to stop gracefully, and then wait for its connection count to drop to zero.</description> + </item> + + <item> <title>Internals</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/internals/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1652,6 +1738,16 @@ Note that for everything related to efficiency and performance, you should perfo </item> <item> + <title>Internals</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/internals/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/internals/</guid> + <description>This chapter may not apply to embedded Ranch as embedding allows you to use an architecture specific to your application, which may or may not be compatible with the description of the Ranch application. +Note that for everything related to efficiency and performance, you should perform the benchmarks yourself to get the numbers that matter to you. Generic benchmarks found on the web may or may not be of use to you, you can never know until you benchmark your own system.</description> + </item> + + <item> <title>Migrating from Gun 1.1 to 1.2</title> <link>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.1/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1795,6 +1891,17 @@ Features added Metrics are now provided by ranch:info/0,1. Currently includes ac </item> <item> + <title>Migrating from Ranch 2.1 to Ranch 2.2</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_2.1/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_2.1/</guid> + <description>Ranch 2.2 is a maintenance release containing a small number of fixes and improvements. +Ranch 2.2 is tested with Erlang/OTP 24.0 onward, although it should be compatible with Erlang/OTP 22.0 and above. +Features added DTLS is now supported. The certs_keys option from ssl is now accepted and documented. The UNIQUE_ID PROXY protocol header extension is now supported. The ranch_transport behavior has a new callback format_error/1 which allows finer grained formatting of Ranch&apos;s error messages.</description> + </item> + + <item> <title>Changes since Ranch 1.6</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.6/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1817,14 +1924,14 @@ Because the plain crc32 checksum is not supported by the PROXY protocol, the con </item> <item> - <title>Migrating from Ranch 1.7 to 1.8</title> - <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.7/</link> + <title>Changes since Ranch 1.8</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.8/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.7/</guid> - <description>Ranch 1.8 is a compatibility update for Erlang/OTP 24. -Ranch 1.8 is compatible with Erlang/OTP 21.0 onward. Support for Erlang/OTP 19 and 20 has been removed. -Bugs fixed An issue with the PROXY protocol was fixed in Ranch 1.7.1. The wrong CRC32 algorithm was used and would cause checksum verification to fail when used. The configuration value when building PROXY headers has been changed to crc32c to reflect the correct algorithm.</description> + <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.8/</guid> + <description>Ranch 1.8 is the last Ranch 1.x release series. Only compatibility fixes are to be released moving forward. Support for Ranch 1.8 will be discontinued when Cowboy 3.0 is released. +The following patch releases have been issued: +Ranch 1.8.1 Fix ranch:recv_proxy_header/2 for the upcoming Erlang/OTP 28. Erlang.mk has been updated. </description> </item> <item> @@ -2026,6 +2133,18 @@ Ranch 1.x had a bottleneck because it used only a single connection supervisor. </item> <item> + <title>Migrating from Ranch 2.0 to Ranch 2.1</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_2.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_2.0/</guid> + <description>Ranch 2.1 adds counters and alarms. +The Prometheus collector was updated to include accepted/terminated connections metrics. +Ranch 2.1 is compatible with Erlang/OTP 22.0 onward. Support for Erlang/OTP 21 has been removed. +Features added Metrics are now provided by ranch:info/0,1. Currently includes accepted/terminated connection counts per connection supervisor. Alarms can now be configured. The only alarm currently available is num_connections. When the number of connections goes over a configurable threshold Ranch will call the given callback.</description> + </item> + + <item> <title>Migrating from Ranch 1.5 to 1.6</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.5/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2048,14 +2167,14 @@ While a third-party library already existed, it was not entirely compatible with </item> <item> - <title>Migrating from Ranch 1.6 to 1.7</title> - <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.6/</link> + <title>Migrating from Ranch 1.7 to 1.8</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.7/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.6/</guid> - <description>Ranch 1.7 adds built-in support for the PROXY protocol. -The PROXY protocol is a simple and efficient way for proxies to transmit information about the client. -While a third-party library already existed, it was not entirely compatible with the Ranch interface, in particular when socket active mode was involved. This new implementation fixes that and supports the full protocol with as little overhead as possible compared to normal operations: just one extra function call.</description> + <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.7/</guid> + <description>Ranch 1.8 is a compatibility update for Erlang/OTP 24. +Ranch 1.8 is compatible with Erlang/OTP 21.0 onward. Support for Erlang/OTP 19 and 20 has been removed. +Bugs fixed An issue with the PROXY protocol was fixed in Ranch 1.7.1. The wrong CRC32 algorithm was used and would cause checksum verification to fail when used. The configuration value when building PROXY headers has been changed to crc32c to reflect the correct algorithm.</description> </item> <item> @@ -2178,6 +2297,16 @@ While a third-party library already existed, it was not entirely compatible with </item> <item> + <title>Migrating from Ranch 1.7+ to Ranch 2.0</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.7/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.7/</guid> + <description>Ranch 2.0 adds support for multiple connection supervisors. +Ranch 1.x had a bottleneck because it used only a single connection supervisor. This was more evident when many connections were dropped at once as the supervisor couldn&apos;t keep up and failed to accept new connections while cleaning up the old ones. Ranch 2.0 behaves much better in this scenario by default. Multiple connection supervisors also helps with concurrently accepting new connections.</description> + </item> + + <item> <title>Migrating from Ranch 1.5 to 1.6</title> <link>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.5/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2189,14 +2318,14 @@ Features added Listeners can now be suspended/resumed without stopping existing </item> <item> - <title>Migrating from Ranch 1.5 to 1.6</title> - <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.5/</link> + <title>Migrating from Ranch 1.6 to 1.7</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.6/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.5/</guid> - <description>Ranch 1.6 added the ability to suspend and resume listeners. It also deprecates a number of features and add interfaces that will be used in Ranch 2.0. -Ranch 1.6 is compatible with Erlang/OTP 18.0 onward. Support for older releases has been removed. -Features added Listeners can now be suspended/resumed without stopping existing connection processes. This effectively closes the listening socket and stops the acceptor processes. Transport options can now be updated for suspended listeners.</description> + <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.6/</guid> + <description>Ranch 1.7 adds built-in support for the PROXY protocol. +The PROXY protocol is a simple and efficient way for proxies to transmit information about the client. +While a third-party library already existed, it was not entirely compatible with the Ranch interface, in particular when socket active mode was involved. This new implementation fixes that and supports the full protocol with as little overhead as possible compared to normal operations: just one extra function call.</description> </item> <item> @@ -2409,6 +2538,17 @@ Features added Listeners can now be suspended/resumed without stopping existing </item> <item> + <title>Migrating from Ranch 1.6 to 1.7</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.6/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.6/</guid> + <description>Ranch 1.7 adds built-in support for the PROXY protocol. +The PROXY protocol is a simple and efficient way for proxies to transmit information about the client. +While a third-party library already existed, it was not entirely compatible with the Ranch interface, in particular when socket active mode was involved. This new implementation fixes that and supports the full protocol with as little overhead as possible compared to normal operations: just one extra function call.</description> + </item> + + <item> <title>Migrating from Ranch 1.x</title> <link>https://ninenines.eu/docs/en/ranch/2.0/guide/migrating_from_1.x/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2419,21 +2559,22 @@ Features added Listeners can now be suspended/resumed without stopping existing </item> <item> - <title>Migrating from Ranch 1.x</title> - <link>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.x/</link> + <title>Migrating from Ranch 1.5 to 1.6</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.5/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.x/</guid> - <description>The changelog for Ranch releases before 1.6 can be found in this section. -1.5.0 Add transport functions getopts/2, getstat/1 and getstat/2 Fix ranch:info/0 and ranch:procs/2 in embedded mode Prevent ranch_conns_sup from stopping on unexpected messages 1.4.0 Add new transport option num_acceptor Deprecate ranch:start_listener/6 in favor of start_listener/5 Deprecate ranch:child_spec/6 in favor of child_spec/5 1.3.0 The version numbers 1.3.1 and 1.3.2 were later made to fix small mistakes made during the 1.</description> + <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.5/</guid> + <description>Ranch 1.6 added the ability to suspend and resume listeners. It also deprecates a number of features and add interfaces that will be used in Ranch 2.0. +Ranch 1.6 is compatible with Erlang/OTP 18.0 onward. Support for older releases has been removed. +Features added Listeners can now be suspended/resumed without stopping existing connection processes. This effectively closes the listening socket and stops the acceptor processes. Transport options can now be updated for suspended listeners.</description> </item> <item> <title>Migrating from Ranch 1.x</title> - <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.x/</link> + <link>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.x/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.x/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.x/</guid> <description>The changelog for Ranch releases before 1.6 can be found in this section. 1.5.0 Add transport functions getopts/2, getstat/1 and getstat/2 Fix ranch:info/0 and ranch:procs/2 in embedded mode Prevent ranch_conns_sup from stopping on unexpected messages 1.4.0 Add new transport option num_acceptor Deprecate ranch:start_listener/6 in favor of start_listener/5 Deprecate ranch:child_spec/6 in favor of child_spec/5 1.3.0 The version numbers 1.3.1 and 1.3.2 were later made to fix small mistakes made during the 1.</description> </item> @@ -2586,6 +2727,17 @@ In the context of HTTP, multipart is most often used with the multipart/form-dat </item> <item> + <title>Migrating from Ranch 1.5 to 1.6</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.5/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.5/</guid> + <description>Ranch 1.6 added the ability to suspend and resume listeners. It also deprecates a number of features and add interfaces that will be used in Ranch 2.0. +Ranch 1.6 is compatible with Erlang/OTP 18.0 onward. Support for older releases has been removed. +Features added Listeners can now be suspended/resumed without stopping existing connection processes. This effectively closes the listening socket and stops the acceptor processes. Transport options can now be updated for suspended listeners.</description> + </item> + + <item> <title>Migrating from Ranch 1.x</title> <link>https://ninenines.eu/docs/en/ranch/2.1/guide/migrating_from_1.x/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2596,6 +2748,16 @@ In the context of HTTP, multipart is most often used with the multipart/form-dat </item> <item> + <title>Migrating from Ranch 1.x</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.x/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.x/</guid> + <description>The changelog for Ranch releases before 1.6 can be found in this section. +1.5.0 Add transport functions getopts/2, getstat/1 and getstat/2 Fix ranch:info/0 and ranch:procs/2 in embedded mode Prevent ranch_conns_sup from stopping on unexpected messages 1.4.0 Add new transport option num_acceptor Deprecate ranch:start_listener/6 in favor of start_listener/5 Deprecate ranch:child_spec/6 in favor of child_spec/5 1.3.0 The version numbers 1.3.1 and 1.3.2 were later made to fix small mistakes made during the 1.</description> + </item> + + <item> <title>REST principles</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/rest_principles/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2673,6 +2835,16 @@ We will first attempt to define REST and will look at what it means in the conte </item> <item> + <title>Migrating from Ranch 1.x</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.x/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.x/</guid> + <description>The changelog for Ranch releases before 1.6 can be found in this section. +1.5.0 Add transport functions getopts/2, getstat/1 and getstat/2 Fix ranch:info/0 and ranch:procs/2 in embedded mode Prevent ranch_conns_sup from stopping on unexpected messages 1.4.0 Add new transport option num_acceptor Deprecate ranch:start_listener/6 in favor of start_listener/5 Deprecate ranch:child_spec/6 in favor of child_spec/5 1.3.0 The version numbers 1.3.1 and 1.3.2 were later made to fix small mistakes made during the 1.</description> + </item> + + <item> <title>REST handlers</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/rest_handlers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14227,6 +14399,20 @@ ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</descrip </item> <item> + <title>Ranch Function Reference</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/</guid> + <description>Name ranch - Socket acceptor pool for TCP protocols +Description Ranch is a socket acceptor pool for TCP protocols. +Ranch manages listeners which are a set of processes that accept and manage connections. The connection&apos;s transport and protocol modules are configured per listener. Listeners can be inspected and reconfigured without interruptions in service. +Modules Functions: +ranch(3) - Socket acceptor pool ranch_proxy_header(3) - PROXY protocol Transports: +ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</description> + </item> + + <item> <title>Ranch User Guide</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14250,7 +14436,7 @@ ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</descrip <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/</guid> - <description>Interface Introduction Listeners Transports Protocols Embedded mode How to Writing parsers SSL client authentication Advanced Internals Additional information Upcoming changes in Ranch 2.0 Migrating from Ranch 1.7 to 1.8 Migrating from Ranch 1.6 to 1.7 Migrating from Ranch 1.5 to 1.6 Migrating from Ranch 1.x </description> + <description>Interface Introduction Listeners Transports Protocols Embedded mode How to Writing parsers SSL client authentication Advanced Internals Additional information Upcoming changes in Ranch 2.0 Changes since Ranch 1.8 Migrating from Ranch 1.7 to 1.8 Migrating from Ranch 1.6 to 1.7 Migrating from Ranch 1.5 to 1.6 Migrating from Ranch 1.x </description> </item> <item> @@ -14272,6 +14458,15 @@ ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</descrip </item> <item> + <title>Ranch User Guide</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/</guid> + <description>Interface Introduction Listeners Transports Protocols Embedded mode How to Writing parsers SSL client authentication Connection draining Advanced Internals Additional information Migrating from Ranch 2.1 to 2.2 Migrating from Ranch 2.0 to 2.1 Migrating from Ranch 1.7 to 2.0 Migrating from Ranch 1.6 to 1.7 Migrating from Ranch 1.5 to 1.6 Migrating from Ranch 1.</description> + </item> + + <item> <title>ranch(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14342,6 +14537,20 @@ ranch:handshake(3) - Perform the transport handshake ranch:handshake_continue(3 </item> <item> + <title>ranch(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch/</guid> + <description>Name ranch - Socket acceptor pool +Description The module ranch provides functions for starting and manipulating Ranch listeners. +Exports Start/stop: +ranch:start_listener(3) - Start a listener ranch:stop_listener(3) - Stop a listener ranch:child_spec(3) - Build child specifications for a new listener Suspend/resume: +ranch:suspend_listener(3) - Suspend a running listener ranch:resume_listener(3) - Resume a suspended listener ranch:get_status(3) - Get a listener&apos;s running state Connections: +ranch:handshake(3) - Perform the transport handshake ranch:handshake_continue(3) - Resume the paused transport handshake ranch:handshake_cancel(3) - Cancel the paused transport handshake ranch:recv_proxy_header(3) - Receive the PROXY protocol header ranch:remove_connection(3) - Remove connection from the count Options:</description> + </item> + + <item> <title>ranch(7)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_app/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14412,6 +14621,20 @@ ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</descrip </item> <item> + <title>ranch(7)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_app/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_app/</guid> + <description>Name ranch - Socket acceptor pool for TCP protocols +Description Ranch is a socket acceptor pool for TCP protocols. +Ranch manages listeners which are a set of processes that accept and manage connections. The connection&apos;s transport and protocol modules are configured per listener. Listeners can be inspected and reconfigured without interruptions in service. +Modules Functions: +ranch(3) - Socket acceptor pool ranch_proxy_header(3) - PROXY protocol Transports: +ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</description> + </item> + + <item> <title>ranch:child_spec(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.child_spec/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14472,6 +14695,18 @@ Arguments Ref The listener name is used to refer to this listener in future call </item> <item> + <title>ranch:child_spec(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.child_spec/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.child_spec/</guid> + <description>Name ranch:child_spec - Build child specifications for a new listener +Description child_spec(Ref :: ranch_ref(), Transport :: module(), TransOpts :: ranch:opts(), Protocol :: module(), ProtoOpts :: any()) -&gt; supervisor:child_spec() Build child specifications for a new listener which can be embedded directly in an application&apos;s supervision tree. +The actual listener is placed under a supervisor which monitors ranch_server via a proxy process and will restart the listener if ranch_server crashes. +Arguments Ref The listener name is used to refer to this listener in future calls, for example when updating the configuration.</description> + </item> + + <item> <title>ranch:get_addr(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_addr/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14538,6 +14773,18 @@ Arguments Ref The listener name. </item> <item> + <title>ranch:get_addr(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_addr/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_addr/</guid> + <description>Name ranch:get_addr - Get the listening address +Description get_addr(Ref :: ranch:ref()) -&gt; {IP :: inet:ip_address(), Port :: inet:port_number()} | {local, SocketFile :: binary()} | {undefined, undefined} Get the listening address. +Arguments Ref The listener name. + Return value The address of the listener is returned as a tuple of the form {IP, Port} when listening on a network interface, or {local, SocketFile} when listening on a UNIX Domain socket.</description> + </item> + + <item> <title>ranch:get_max_connections(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_max_connections/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14603,6 +14850,19 @@ Changelog 2.0: The maximum number of connections is now per connection superviso </item> <item> + <title>ranch:get_max_connections(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_max_connections/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_max_connections/</guid> + <description>Name ranch:get_max_connections - Get the max number of connections per connection supervisor +Description get_max_connections(Ref :: ranch:ref()) -&gt; MaxConns :: ranch:max_conns() Get the max number of connections per connection supervisor. +Arguments Ref The listener name. + Return value The maximum number of connections per connection supervisor is returned. +Changelog 2.0: The maximum number of connections is now per connection supervisor. Examples Get the max number of connections per connection supervisor MaxConns = ranch:get_max_connections(example).</description> + </item> + + <item> <title>ranch:get_port(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_port/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14673,6 +14933,20 @@ When the listener is suspended or using a UNIX Domain socket instead of a networ </item> <item> + <title>ranch:get_port(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_port/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_port/</guid> + <description>Name ranch:get_port - Get the listening port +Description get_port(Ref :: ranch:ref()) -&gt; Port :: inet:port_number() | undefined Get the listening port. +This function is particularly useful to retrieve the listening port number when it was not provided in the options and was chosen randomly instead. +Arguments Ref The listener name. + Return value The listening port is returned. +When the listener is suspended or using a UNIX Domain socket instead of a network interface, undefined will be returned.</description> + </item> + + <item> <title>ranch:get_protocol_options(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_protocol_options/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14738,6 +15012,19 @@ Examples Get the current protocol options ProtoOpts = ranch:get_protocol_options </item> <item> + <title>ranch:get_protocol_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_protocol_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_protocol_options/</guid> + <description>Name ranch:get_protocol_options - Get the current protocol options +Description get_protocol_options(Ref :: ranch:ref()) -&gt; ProtoOpts :: any() Get the current protocol options. +Arguments Ref The listener name. + Return value The current protocol options are returned. +Examples Get the current protocol options ProtoOpts = ranch:get_protocol_options(example). See also ranch:get_max_connections(3), ranch:get_transport_options(3), ranch:set_protocol_options(3), ranch(3)</description> + </item> + + <item> <title>ranch:get_status(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_status/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14803,6 +15090,19 @@ Changelog 1.6: Function introduced. Examples Get a listener&apos;s running </item> <item> + <title>ranch:get_status(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_status/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_status/</guid> + <description>Name ranch:get_status - Get a listener&apos;s running state +Description get_status(Ref :: ranch_ref()) -&gt; running | suspended Get a listener&apos;s running state. +Arguments Ref The listener name. + Return value An atom is returned indicating the running status of the listener. +Changelog 1.6: Function introduced. Examples Get a listener&apos;s running state ranch:get_status(example). See also ranch:start_listener(3), ranch:stop_listener(3), ranch:suspend_listener(3), ranch:resume_listener(3), ranch:set_transport_options(3), ranch:wait_for_connections(3), ranch(3)</description> + </item> + + <item> <title>ranch:get_transport_options(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_transport_options/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14868,6 +15168,19 @@ Examples Get the current transport options TransOpts = ranch:get_transport_optio </item> <item> + <title>ranch:get_transport_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_transport_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_transport_options/</guid> + <description>Name ranch:get_transport_options - Get the current transport options +Description get_transport_options(Ref :: ranch:ref()) -&gt; TransOpts :: ranch:transport_opts(any()) Get the current transport options. +Arguments Ref The listener name. + Return value The current transport options are returned. +Examples Get the current transport options TransOpts = ranch:get_transport_options(example). See also ranch:get_max_connections(3), ranch:get_protocol_options(3), ranch:set_transport_options(3), ranch(3)</description> + </item> + + <item> <title>ranch:handshake(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.handshake/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14923,6 +15236,17 @@ This function must be called by the protocol process in order to retrieve the so </item> <item> + <title>ranch:handshake(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.handshake/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.handshake/</guid> + <description>Name ranch:handshake - Perform the transport handshake +Description handshake(Ref) -&gt; {ok, Socket} | {continue, Info} handshake(Ref, Opts) -&gt; {ok, Socket} | {continue, Info} Ref :: ranch:ref() Opts :: any() Socket :: any() Info :: any() Perform the transport handshake. +This function must be called by the protocol process in order to retrieve the socket for the connection. Ranch performs the handshake necessary to give control of the socket to this process and also does the transport handshake, for example setting up the TLS connection.</description> + </item> + + <item> <title>ranch:handshake_cancel(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.handshake_cancel/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14953,6 +15277,21 @@ Changelog 2.0: Function introduced. Examples Cancel a paused transport handsha </item> <item> + <title>ranch:handshake_cancel(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.handshake_cancel/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.handshake_cancel/</guid> + <description>Name ranch:handshake_cancel - Cancel the paused transport handshake +Description handshake_cancel(Ref :: ranch:ref()) -&gt; ok Cancel the paused transport handshake. +This function may be called by the protocol process to cancel a paused handshake. +Arguments Ref The listener name. +Allowed options depend on the transport module. + Return value The return value depends on the transport module. +Changelog 2.0: Function introduced. Examples Cancel a paused transport handshake start_link(Ref, Transport, Opts) -&gt; Pid = proc_lib:spawn_link(?</description> + </item> + + <item> <title>ranch:handshake_continue(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.handshake_continue/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14983,6 +15322,21 @@ Allowed options depend on the transport module. </item> <item> + <title>ranch:handshake_continue(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.handshake_continue/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.handshake_continue/</guid> + <description>Name ranch:handshake_continue - Resume the paused transport handshake +Description handshake_continue(Ref) -&gt; {ok, Socket} handshake_continue(Ref, Opts) -&gt; {ok, Socket} Ref :: ranch:ref() Opts :: any() Socket :: any() Resume the paused transport handshake. +This function must be called by the protocol process in order to resume a paused handshake. +Arguments Ref The listener name. + Opts Transport handshake options. +Allowed options depend on the transport module. + Return value An ok tuple is returned containing the socket for the connection.</description> + </item> + + <item> <title>ranch:info(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15058,6 +15412,21 @@ pid Pid of the listener&apos;s top-level supervisor. </item> <item> + <title>ranch:info(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.info/</guid> + <description>Name ranch:info - Overview of Ranch listeners +Description info() -&gt; #{Ref := Info} info(Ref) -&gt; Info Info :: #{Key :: atom() := Value :: any()} Overview of Ranch listeners. +Arguments Ref The listener name. + Return value Returns detailed information about one or all Ranch listeners. The following keys are returned: +pid Pid of the listener&apos;s top-level supervisor. + status Listener status, either running or suspended. + ip Interface Ranch listens on.</description> + </item> + + <item> <title>ranch:procs(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.procs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15128,6 +15497,20 @@ Examples Get the pids of the acceptor processes Pids = ranch:procs(acceptors). </item> <item> + <title>ranch:procs(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.procs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.procs/</guid> + <description>Name ranch:procs - Retrieve pids from a listener +Description procs(Ref :: ranch:ref(), Type :: acceptors | connections) -&gt; Pids :: [pid()] Retrieve pids from a listener. +Arguments Ref The listener name. + Type The type of process that will be returned. + Return value A list of pids is returned. +Examples Get the pids of the acceptor processes Pids = ranch:procs(acceptors). Get the pids of the connection processes Pids = ranch:procs(connections).</description> + </item> + + <item> <title>ranch:recv_proxy_header(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch.recv_proxy_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15184,6 +15567,20 @@ Arguments Ref The listener name. </item> <item> + <title>ranch:recv_proxy_header(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.recv_proxy_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.recv_proxy_header/</guid> + <description>Name ranch:recv_proxy_header - Receive the PROXY protocol header +Description recv_proxy_header(ranch:ref(), timeout()) -&gt; {ok, ranch_proxy_header:proxy_info()} | {error, Reason :: atom()} | {error, protocol_error, HumanReadable :: atom()} Receive the PROXY protocol header. +This function must be called before ranch:handshake/1,2 on newly accepted connections to read and parse the PROXY protocol header, if any. +Arguments Ref The listener name. + Timeout Receive timeout in milliseconds. + Return value An ok tuple is returned containing PROXY header information on success.</description> + </item> + + <item> <title>ranch:remove_connection(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.remove_connection/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15244,6 +15641,18 @@ This function may only be called from a connection process.</description> </item> <item> + <title>ranch:remove_connection(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.remove_connection/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.remove_connection/</guid> + <description>Name ranch:remove_connection - Remove connection from the count +Description remove_connection(Ref :: ranch:ref()) -&gt; ok Remove connection from the count. +This connection will no longer be included in the count when limiting the number of connections. This can be useful in a mixed environment where some connections are active and others are passive. Passive connections spend most of their time idling and are not consuming much resources. +This function may only be called from a connection process.</description> + </item> + + <item> <title>ranch:resume_listener(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.resume_listener/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15314,6 +15723,20 @@ Arguments Ref The listener name. </item> <item> + <title>ranch:resume_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.resume_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.resume_listener/</guid> + <description>Name ranch:resume_listener - Resume a suspended listener +Description resume_listener(Ref :: ranch_ref()) -&gt; ok | {error, any()} Resume a suspended listener. +Ranch will start listening for and accepting connections again. The function ranch:set_transport_options(3) can be used to change the transport options before resuming the listener. +Nothing is done when the listener is already running. +Arguments Ref The listener name. + Return value The atom ok is returned on success.</description> + </item> + + <item> <title>ranch:set_max_connections(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.set_max_connections/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15372,6 +15795,17 @@ The change will be applied immediately. If the new value is smaller than the pre </item> <item> + <title>ranch:set_max_connections(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.set_max_connections/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.set_max_connections/</guid> + <description>Name ranch:set_max_connections - Set the max number of connections per connection supervisor +Description set_max_connections(Ref :: ranch:ref(), MaxConns :: ranch:max_conns()) -&gt; ok Set the max number of connections per connection supervisor. +The change will be applied immediately. If the new value is smaller than the previous one, Ranch will wait for the extra connections to terminate and will not accept new connections until the number of connections goes below the limit.</description> + </item> + + <item> <title>ranch:set_protocol_options(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.set_protocol_options/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15444,6 +15878,18 @@ Note that the complete set of protocol options is replaced. To update a subset o </item> <item> + <title>ranch:set_protocol_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.set_protocol_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.set_protocol_options/</guid> + <description>Name ranch:set_protocol_options - Set the protocol options +Description set_protocol_options(Ref :: ranch:ref(), ProtoOpts :: any()) -&gt; ok Set the protocol options. +The change will be applied immediately for all new connections. Old connections will not receive the new options. +Note that the complete set of protocol options is replaced. To update a subset of the options, it is recommended to get the current protocol options using ranch:get_protocol_options(3), update them and then set them back using this function.</description> + </item> + + <item> <title>ranch:set_transport_options(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.set_transport_options/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15513,6 +15959,18 @@ Changes to the following options will take effect.</description> </item> <item> + <title>ranch:set_transport_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.set_transport_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.set_transport_options/</guid> + <description>Name ranch:set_transport_options - Set the transport options +Description set_transport_options(Ref :: ranch:ref(), TransOpts :: ranch:opts()) -&gt; ok | {error, Reason :: term()} Set the transport options. +The complete set of transport options is replaced. To update a subset of the transport options, it is recommended to get the current transport options using ranch:get_transport_options(3), update them and then set them back using this function. +Changes to the following options will take effect.</description> + </item> + + <item> <title>ranch:start_listener(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.start_listener/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15573,6 +16031,18 @@ Arguments Ref The listener name is used to refer to this listener in future call </item> <item> + <title>ranch:start_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.start_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.start_listener/</guid> + <description>Name ranch:start_listener - Start a listener +Description start_listener(Ref :: ranch_ref(), Transport :: module(), TransOpts :: ranch:opts(), Protocol :: module(), ProtoOpts :: any()) -&gt; {ok, ListenerPid :: pid()} | {error, any()} Start a listener. +A listener is a set of processes that accepts and manages connections using the given transport and protocol modules. +Arguments Ref The listener name is used to refer to this listener in future calls, for example when stopping it or when updating the configuration.</description> + </item> + + <item> <title>ranch:stop_listener(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.stop_listener/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15633,6 +16103,18 @@ In order for the connection processes to exit gracefully, they need to trap exit </item> <item> + <title>ranch:stop_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.stop_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.stop_listener/</guid> + <description>Name ranch:stop_listener - Stop a listener +Description stop_listener(Ref :: ranch_ref()) -&gt; ok | {error, not_found} Stop a listener. +The listener is stopped gracefully, first by closing the listening port, then by stopping the connection processes. These processes are stopped according to the shutdown transport option, which may be set to brutally kill all connection processes or give them some time to stop properly. +In order for the connection processes to exit gracefully, they need to trap exit signals and stop before the configured shutdown timeout.</description> + </item> + + <item> <title>ranch:suspend_listener(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.suspend_listener/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15693,6 +16175,18 @@ Some transport options can only be changed when the listener is suspended. Pleas </item> <item> + <title>ranch:suspend_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.suspend_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.suspend_listener/</guid> + <description>Name ranch:suspend_listener - Suspend a running listener +Description suspend_listener(Ref :: ranch_ref()) -&gt; ok | {error, any()} Suspend a running listener. +Ranch will stop listening for and accepting connections and the listening socket will be closed. Existing connections will continue undisturbed. The function ranch:wait_for_connections(3) can be used to wait for connections to be closed if necessary. +Some transport options can only be changed when the listener is suspended. Please consult the ranch:set_transport_options(3) manual for more information.</description> + </item> + + <item> <title>ranch:wait_for_connections(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.wait_for_connections/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15753,6 +16247,18 @@ This function can be used to gracefully shutdown a listener by first suspending </item> <item> + <title>ranch:wait_for_connections(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.wait_for_connections/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.wait_for_connections/</guid> + <description>Name ranch:wait_for_connections - Wait for a specific number of connections +Description wait_for_connections(Ref :: ranch:ref(), Operator, NumConns :: non_neg_integer()) -&gt; ok Operator :: '&gt;' | '&gt;=' | '==' | '=&lt;' | '&lt;' Wait for a specific number of connections. +This function waits until the number of connections on the given listener becomes higher than, equal to or lower than the given number. It never returns otherwise. +This function can be used to gracefully shutdown a listener by first suspending the listener and then waiting for connections to terminate before finally stopping the listener.</description> + </item> + + <item> <title>ranch_protocol(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_protocol/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15818,6 +16324,19 @@ The only purpose of this callback is to start a process that will handle the soc </item> <item> + <title>ranch_protocol(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_protocol/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_protocol/</guid> + <description>Name ranch_protocol - Protocol modules +Description The module ranch_protocol defines the interface used by Ranch protocols. +Callbacks Ranch protocols implement the following interface: +start_link(Ref :: ranch:ref(), Transport :: module(), ProtoOpts :: any()) -&gt; {ok, ConnPid :: pid()} | {ok, SupPid :: pid(), ConnPid :: pid()} Start a new connection process. +The only purpose of this callback is to start a process that will handle the socket. It must spawn the process, link and then return the new pid.</description> + </item> + + <item> <title>ranch_proxy_header(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch_proxy_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15862,6 +16381,17 @@ Exports ranch_proxy_header:parse(3) - Parse a PROXY protocol header ranch_proxy </item> <item> + <title>ranch_proxy_header(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header/</guid> + <description>Name ranch_proxy_header - PROXY protocol +Description The module ranch_proxy_header provides functions for parsing and building the PROXY protocol header. +Exports ranch_proxy_header:parse(3) - Parse a PROXY protocol header ranch_proxy_header:header(3) - Build a PROXY protocol header ranch_proxy_header:to_connection_info(3) - Convert proxy_info() to ssl:connection_info() Types proxy_info() proxy_info() = #{ %% Mandatory part. version := 1 | 2, command := local | proxy, transport_family =&gt; undefined | ipv4 | ipv6 | unix, transport_protocol =&gt; undefined | stream | dgram, %% Addresses.</description> + </item> + + <item> <title>ranch_proxy_header:header(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch_proxy_header.header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15914,6 +16444,19 @@ Arguments ProxyInfo The proxy information to encode. </item> <item> + <title>ranch_proxy_header:header(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header.header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header.header/</guid> + <description>Name ranch_proxy_header:header - Build a PROXY protocol header +Description header(ProxyInfo) -&gt; header(ProxyInfo, #{}) header(ProxyInfo, BuildOpts) -&gt; iodata() ProxyInfo :: ranch_proxy_header:proxy_info() BuildOpts :: #{ checksum =&gt; crc32c, padding =&gt; pos_integer() %% &gt;= 3 } Build a PROXY protocol header. +Arguments ProxyInfo The proxy information to encode. + BuildOpts Options to control whether to add a checksum or padding should be included in the encoded PROXY protocol header. + Return value The PROXY protocol header is returned.</description> + </item> + + <item> <title>ranch_proxy_header:parse(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch_proxy_header.parse/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15966,6 +16509,19 @@ An error tuple is returned when a protocol error is detected.</description> </item> <item> + <title>ranch_proxy_header:parse(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header.parse/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header.parse/</guid> + <description>Name ranch_proxy_header:parse - Parse a PROXY protocol header +Description parse(Data :: binary()) -&gt; {ok, ranch_proxy_header:proxy_info(), Rest :: binary()} | {error, HumanReadable :: atom()} Parse a PROXY protocol header. +Arguments Data The PROXY protocol header optionally followed by more data. + Return value An ok tuple is returned on success, containing the proxy information found in the header and the rest of the data if more was provided. +An error tuple is returned when a protocol error is detected.</description> + </item> + + <item> <title>ranch_proxy_header:to_connection_info(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_proxy_header.to_connection_info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15980,6 +16536,20 @@ Changelog 2.1: Function introduced. Examples Convert the PROXY protocol inform </item> <item> + <title>ranch_proxy_header:to_connection_info(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header.to_connection_info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header.to_connection_info/</guid> + <description>Name ranch_proxy_header:to_connection_info - Convert proxy_info() to ssl:connection_info() +Description to_connection_info(ProxyInfo :: proxy_info()) -&gt; ssl:connection_info() Convert ranch_proxy_header:proxy_info() information to the ssl:connection_info() format returned by ssl:connection_information/1,2. +Arguments ProxyInfo The PROXY protocol information. + Return value Connection information is returned as a proplist. +Because the PROXY protocol header includes limited information, only the keys protocol, selected_cipher_suite and sni_hostname will be returned, at most. All keys are optional. +Changelog 2.1: Function introduced. Examples Convert the PROXY protocol information ConnInfo = ranch_proxy_header:to_connection_info(ProxyInfo).</description> + </item> + + <item> <title>ranch_ssl(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_ssl/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16055,6 +16625,21 @@ ssl_opt() ssl_opt() = {alpn_preferred_protocols, [binary()]} | {anti_replay,  </item> <item> + <title>ranch_ssl(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_ssl/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_ssl/</guid> + <description>Name ranch_ssl - SSL transport +Description The module ranch_ssl implements an SSL Ranch transport. +Exports The module ranch_ssl implements the interface defined by ranch_transport(3). +Types opt() opt() :: ranch_tcp:opt() | ssl_opt() Listen options. +The TCP options are defined in ranch_tcp(3). +opts() opts() :: [opt()] List of listen options. +ssl_opt() ssl_opt() = {alpn_preferred_protocols, [binary()]} | {anti_replay, '10k' | '100k' | {integer(), integer(), integer()}} | {beast_mitigation, one_n_minus_one | zero_n | disabled} | {cacertfile, file:filename()} | {cacerts, [public_key:der_encoded()]} | {cert, public_key:der_encoded()} | {certs_keys, [#{cert =&gt; public_key:der_encoded(), key =&gt; ssl:key(), certfile =&gt; file:filename(), keyfile =&gt; file:filename(), key_pem_password =&gt; iodata() | fun(() -&gt; iodata())}]} | {certfile, file:filename()} | {ciphers, ssl:ciphers()} | {client_renegotiation, boolean()} | {crl_cache, [any()]} | {crl_check, boolean() | peer | best_effort} | {depth, integer()} | {dh, binary()} | {dhfile, file:filename()} | {eccs, [ssl:named_curve()]} | {fail_if_no_peer_cert, boolean()} | {handshake, hello | full} | {hibernate_after, timeout()} | {honor_cipher_order, boolean()} | {honor_ecc_order, boolean()} | {key, ssl:key()} | {key_update_at, pos_integer()} | {keyfile, file:filename()} | {log_alert, boolean()} | {log_level, logger:level()} | {max_handshake_size, integer()} | {middlebox_comp_mode, boolean()} | {next_protocols_advertised, [binary()]} | {padding_check, boolean()} | {partial_chain, fun()} | {password, string()} | {protocol, tls | dtls} | {psk_identity, string()} | {reuse_session, fun()} | {reuse_sessions, boolean()} | {secure_renegotiate, boolean()} | {session_tickets, disabled | stateful | stateless} | {signature_algs, [{ssl:hash(), ssl:sign_algo()}]} | {signature_algs_cert, [ssl:sign_scheme()]} | {sni_fun, fun()} | {sni_hosts, [{string(), ssl_opt()}]} | {supported_groups, [ssl:group()]} | {user_lookup_fun, {fun(), any()}} | {verify, verify_none | verify_peer} | {verify_fun, {fun(), any()}} | {versions, [ssl:protocol_version()]} SSL-specific listen options.</description> + </item> + + <item> <title>ranch_tcp(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_tcp/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16120,6 +16705,19 @@ Types opt() opt() = {backlog, non_neg_integer()} | {buffer, non_neg_integer()} | </item> <item> + <title>ranch_tcp(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_tcp/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_tcp/</guid> + <description>Name ranch_tcp - TCP transport +Description The module ranch_tcp implements a TCP Ranch transport. +The function sendfile may not work correctly when used against files stored in a VirtualBox shared folder. +Exports The module ranch_tcp implements the interface defined by ranch_transport(3). +Types opt() opt() = {backlog, non_neg_integer()} | {buffer, non_neg_integer()} | {delay_send, boolean()} | {dontroute, boolean()} | {exit_on_close, boolean()} | {fd, non_neg_integer()} | {high_msgq_watermark, non_neg_integer()} | {high_watermark, non_neg_integer()} | inet | inet6 | {ip, inet:ip_address() | inet:local_address()} | {ipv6_v6only, boolean()} | {keepalive, boolean()} | {linger, {boolean(), non_neg_integer()}} | {low_msgq_watermark, non_neg_integer()} | {low_watermark, non_neg_integer()} | {nodelay, boolean()} | {port, inet:port_number()} | {priority, integer()} | {raw, non_neg_integer(), non_neg_integer(), binary()} | {recbuf, non_neg_integer()} | {send_timeout, timeout()} | {send_timeout_close, boolean()} | {sndbuf, non_neg_integer()} | {tos, integer()} Listen options.</description> + </item> + + <item> <title>ranch_transport(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_transport/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16185,6 +16783,19 @@ close close(Socket :: socket()) -&gt; ok Close the socket.</description> </item> <item> + <title>ranch_transport(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_transport/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_transport/</guid> + <description>Name ranch_transport - Transport modules +Description The module ranch_transport defines the interface used by Ranch transports. +Callbacks Ranch transports implement the following interface: +accept accept(LSocket :: socket(), Timeout :: timeout()) -&gt; {ok, Socket :: socket()} | {error, closed | timeout | atom()} Use the listening socket returned by listen/1 to accept a new connection. The timeout is specified in milliseconds. +close close(Socket :: socket()) -&gt; ok Close the socket.</description> + </item> + + <item> <title>ranch_transport:sendfile(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_transport.sendfile/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16244,5 +16855,17 @@ The file may be sent full or in parts, and may be specified by its filename or b This function emulates the function file:sendfile/2,4,5 and may be used when transports are not manipulating TCP directly.</description> </item> + <item> + <title>ranch_transport:sendfile(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_transport.sendfile/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_transport.sendfile/</guid> + <description>Name ranch_transport:sendfile - Send a file on the socket +Description sendfile(Transport :: module(), Socket :: ranch_transport:socket(), File :: file:name_all() | file:fd(), Offset :: non_neg_integer(), Bytes :: non_neg_integer(), Opts :: ranch_transport:sendfile_opts()) -&gt; {ok, SentBytes :: non_neg_integer()} | {error, atom()} Send a file on the socket. +The file may be sent full or in parts, and may be specified by its filename or by an already open file descriptor. +This function emulates the function file:sendfile/2,4,5 and may be used when transports are not manipulating TCP directly.</description> + </item> + </channel> </rss>
\ No newline at end of file diff --git a/donate/index.html b/donate/index.html index 656041cb..44f6b33f 100644 --- a/donate/index.html +++ b/donate/index.html @@ -921,6 +921,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <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"> @@ -2930,6 +2962,78 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + </div> </div> </div> diff --git a/erlanger-playbook/index.html b/erlanger-playbook/index.html index b7e3e829..44d1f89f 100644 --- a/erlanger-playbook/index.html +++ b/erlanger-playbook/index.html @@ -961,6 +961,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <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"> @@ -2970,6 +3002,78 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + </div> </div> </div> @@ -196,10 +196,10 @@ <a class="btn btn-large" href="https://github.com/ninenines/ranch">Source Code</a> - <a class="btn btn-large" href="/docs/en/ranch/2.1/guide/">User Guide</a> + <a class="btn btn-large" href="/docs/en/ranch/2.2/guide/">User Guide</a> - <a class="btn btn-large" href="/docs/en/ranch/2.1/manual/">Manual</a> + <a class="btn btn-large" href="/docs/en/ranch/2.2/manual/">Manual</a> </p> @@ -1061,6 +1061,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <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> @@ -3054,6 +3086,78 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + </div></div> </div> @@ -162,6 +162,18 @@ Supported platforms Ranch is tested and supported on Linux, FreeBSD, macOS and W </item> <item> + <title>Introduction</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/introduction/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/introduction/</guid> + <description>Ranch is a socket acceptor pool for TCP protocols. +Ranch aims to provide everything you need to accept TCP connections with a small code base and low latency while being easy to use directly as an application or to embed into your own. +Prerequisites It is assumed the developer already knows Erlang and has some experience with socket programming and TCP protocols. +Supported platforms Ranch is tested and supported on Linux, FreeBSD, macOS and Windows.</description> + </item> + + <item> <title>The modern Web</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/modern_web/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -359,6 +371,16 @@ The listener takes care of supervising all the acceptor and connection processes </item> <item> + <title>Listeners</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/listeners/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/listeners/</guid> + <description>A listener is a set of processes whose role is to listen on a port for new connections. It manages a pool of acceptor processes, each of them indefinitely accepting connections. When it does, it starts a new process executing the protocol handler code. All the socket programming is abstracted through the use of transport handlers. +The listener takes care of supervising all the acceptor and connection processes, allowing developers to focus on building their application.</description> + </item> + + <item> <title>Starting and stopping</title> <link>https://ninenines.eu/docs/en/gun/1.0/guide/start/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -652,6 +674,19 @@ Ranch depends on ssl by default so any necessary dependencies will start when Ra </item> <item> + <title>Transports</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/transports/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/transports/</guid> + <description>A transport defines the interface to interact with a socket. +Transports can be used for connecting, listening and accepting connections, but also for receiving and sending data. Both passive and active mode are supported, although all sockets are initialized as passive. +TCP transport The TCP transport is a thin wrapper around gen_tcp. +SSL transport The SSL transport is a thin wrapper around ssl. +Ranch depends on ssl by default so any necessary dependencies will start when Ranch is started.</description> + </item> + + <item> <title>Connection</title> <link>https://ninenines.eu/docs/en/gun/1.0/guide/connect/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -768,6 +803,16 @@ Writing a protocol handler All protocol handlers must implement the ranch_protoc </item> <item> + <title>Protocols</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/protocols/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/protocols/</guid> + <description>A protocol handler starts a connection process and defines the protocol logic executed in this process. +Writing a protocol handler All protocol handlers must implement the ranch_protocol behavior which defines a single callback, start_link/3. This callback is responsible for spawning a new process for handling the connection. It receives three arguments: the name of the listener, the transport handler being used and the protocol options defined in the call to ranch:start_listener/5.</description> + </item> + + <item> <title>Getting started</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/getting_started/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -960,6 +1005,16 @@ However, just as for non-embedded listeners that were started via ranch:start_li </item> <item> + <title>Embedded mode</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/embedded/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/embedded/</guid> + <description>Embedded mode allows you to insert Ranch listeners directly in your supervision tree. This allows for greater fault tolerance control by permitting the shutdown of a listener due to the failure of another part of the application and vice versa. +However, just as for non-embedded listeners that were started via ranch:start_listener/5, it is required that the ranch application is running before you can start embedded listeners. Furthermore, this also means that embedded listeners will restart when ranch_sup fails.</description> + </item> + + <item> <title>Flow diagram</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/flow_diagram/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1165,6 +1220,17 @@ This chapter isn&apos;t specifically about Ranch, we assume here that you kn </item> <item> + <title>Writing parsers</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/parsers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/parsers/</guid> + <description>There are three kinds of protocols: +Text protocols Schema-less binary protocols Schema-based binary protocols This chapter introduces the first two kinds. It will not cover more advanced topics such as continuations or parser generators. +This chapter isn&apos;t specifically about Ranch, we assume here that you know how to read data from the socket. The data you read and the data that hasn&apos;t been parsed is saved in a buffer.</description> + </item> + + <item> <title>Changes since Gun 1.3</title> <link>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.3/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1343,6 +1409,16 @@ The server only needs to retain the certificate serial number and the certificat </item> <item> + <title>SSL client authentication</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/ssl_auth/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/ssl_auth/</guid> + <description>Purpose SSL client authentication is a mechanism allowing applications to identify certificates. This allows your application to make sure that the client is an authorized certificate, but makes no claim about whether the user can be trusted. This can be combined with a password based authentication to attain greater security. +The server only needs to retain the certificate serial number and the certificate issuer to authenticate the certificate. Together, they can be used to uniquely identify a certificate.</description> + </item> + + <item> <title>Routing</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/routing/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1447,6 +1523,16 @@ For this purpose, you should first suspend the listener you wish to stop gracefu </item> <item> + <title>Connection draining</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/connection_draining/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/connection_draining/</guid> + <description>Stopping a Ranch listener via ranch:stop_listener/1 will invariably kill all connection processes the listener hosts. However, you may want to stop a listener in a graceful fashion, ie by not accepting any new connections, but allowing the existing connection processes to exit by themselves instead of being killed. +For this purpose, you should first suspend the listener you wish to stop gracefully, and then wait for its connection count to drop to zero.</description> + </item> + + <item> <title>Internals</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/internals/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1653,6 +1739,16 @@ Note that for everything related to efficiency and performance, you should perfo </item> <item> + <title>Internals</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/internals/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/internals/</guid> + <description>This chapter may not apply to embedded Ranch as embedding allows you to use an architecture specific to your application, which may or may not be compatible with the description of the Ranch application. +Note that for everything related to efficiency and performance, you should perform the benchmarks yourself to get the numbers that matter to you. Generic benchmarks found on the web may or may not be of use to you, you can never know until you benchmark your own system.</description> + </item> + + <item> <title>Migrating from Gun 1.1 to 1.2</title> <link>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.1/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1796,6 +1892,17 @@ Features added Metrics are now provided by ranch:info/0,1. Currently includes ac </item> <item> + <title>Migrating from Ranch 2.1 to Ranch 2.2</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_2.1/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_2.1/</guid> + <description>Ranch 2.2 is a maintenance release containing a small number of fixes and improvements. +Ranch 2.2 is tested with Erlang/OTP 24.0 onward, although it should be compatible with Erlang/OTP 22.0 and above. +Features added DTLS is now supported. The certs_keys option from ssl is now accepted and documented. The UNIQUE_ID PROXY protocol header extension is now supported. The ranch_transport behavior has a new callback format_error/1 which allows finer grained formatting of Ranch&apos;s error messages.</description> + </item> + + <item> <title>Changes since Ranch 1.6</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.6/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1818,14 +1925,14 @@ Because the plain crc32 checksum is not supported by the PROXY protocol, the con </item> <item> - <title>Migrating from Ranch 1.7 to 1.8</title> - <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.7/</link> + <title>Changes since Ranch 1.8</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.8/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.7/</guid> - <description>Ranch 1.8 is a compatibility update for Erlang/OTP 24. -Ranch 1.8 is compatible with Erlang/OTP 21.0 onward. Support for Erlang/OTP 19 and 20 has been removed. -Bugs fixed An issue with the PROXY protocol was fixed in Ranch 1.7.1. The wrong CRC32 algorithm was used and would cause checksum verification to fail when used. The configuration value when building PROXY headers has been changed to crc32c to reflect the correct algorithm.</description> + <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.8/</guid> + <description>Ranch 1.8 is the last Ranch 1.x release series. Only compatibility fixes are to be released moving forward. Support for Ranch 1.8 will be discontinued when Cowboy 3.0 is released. +The following patch releases have been issued: +Ranch 1.8.1 Fix ranch:recv_proxy_header/2 for the upcoming Erlang/OTP 28. Erlang.mk has been updated. </description> </item> <item> @@ -2027,6 +2134,18 @@ Ranch 1.x had a bottleneck because it used only a single connection supervisor. </item> <item> + <title>Migrating from Ranch 2.0 to Ranch 2.1</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_2.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_2.0/</guid> + <description>Ranch 2.1 adds counters and alarms. +The Prometheus collector was updated to include accepted/terminated connections metrics. +Ranch 2.1 is compatible with Erlang/OTP 22.0 onward. Support for Erlang/OTP 21 has been removed. +Features added Metrics are now provided by ranch:info/0,1. Currently includes accepted/terminated connection counts per connection supervisor. Alarms can now be configured. The only alarm currently available is num_connections. When the number of connections goes over a configurable threshold Ranch will call the given callback.</description> + </item> + + <item> <title>Migrating from Ranch 1.5 to 1.6</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.5/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2049,14 +2168,14 @@ While a third-party library already existed, it was not entirely compatible with </item> <item> - <title>Migrating from Ranch 1.6 to 1.7</title> - <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.6/</link> + <title>Migrating from Ranch 1.7 to 1.8</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.7/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.6/</guid> - <description>Ranch 1.7 adds built-in support for the PROXY protocol. -The PROXY protocol is a simple and efficient way for proxies to transmit information about the client. -While a third-party library already existed, it was not entirely compatible with the Ranch interface, in particular when socket active mode was involved. This new implementation fixes that and supports the full protocol with as little overhead as possible compared to normal operations: just one extra function call.</description> + <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.7/</guid> + <description>Ranch 1.8 is a compatibility update for Erlang/OTP 24. +Ranch 1.8 is compatible with Erlang/OTP 21.0 onward. Support for Erlang/OTP 19 and 20 has been removed. +Bugs fixed An issue with the PROXY protocol was fixed in Ranch 1.7.1. The wrong CRC32 algorithm was used and would cause checksum verification to fail when used. The configuration value when building PROXY headers has been changed to crc32c to reflect the correct algorithm.</description> </item> <item> @@ -2179,6 +2298,16 @@ While a third-party library already existed, it was not entirely compatible with </item> <item> + <title>Migrating from Ranch 1.7+ to Ranch 2.0</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.7/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.7/</guid> + <description>Ranch 2.0 adds support for multiple connection supervisors. +Ranch 1.x had a bottleneck because it used only a single connection supervisor. This was more evident when many connections were dropped at once as the supervisor couldn&apos;t keep up and failed to accept new connections while cleaning up the old ones. Ranch 2.0 behaves much better in this scenario by default. Multiple connection supervisors also helps with concurrently accepting new connections.</description> + </item> + + <item> <title>Migrating from Ranch 1.5 to 1.6</title> <link>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.5/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2190,14 +2319,14 @@ Features added Listeners can now be suspended/resumed without stopping existing </item> <item> - <title>Migrating from Ranch 1.5 to 1.6</title> - <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.5/</link> + <title>Migrating from Ranch 1.6 to 1.7</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.6/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.5/</guid> - <description>Ranch 1.6 added the ability to suspend and resume listeners. It also deprecates a number of features and add interfaces that will be used in Ranch 2.0. -Ranch 1.6 is compatible with Erlang/OTP 18.0 onward. Support for older releases has been removed. -Features added Listeners can now be suspended/resumed without stopping existing connection processes. This effectively closes the listening socket and stops the acceptor processes. Transport options can now be updated for suspended listeners.</description> + <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.6/</guid> + <description>Ranch 1.7 adds built-in support for the PROXY protocol. +The PROXY protocol is a simple and efficient way for proxies to transmit information about the client. +While a third-party library already existed, it was not entirely compatible with the Ranch interface, in particular when socket active mode was involved. This new implementation fixes that and supports the full protocol with as little overhead as possible compared to normal operations: just one extra function call.</description> </item> <item> @@ -2410,6 +2539,17 @@ Features added Listeners can now be suspended/resumed without stopping existing </item> <item> + <title>Migrating from Ranch 1.6 to 1.7</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.6/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.6/</guid> + <description>Ranch 1.7 adds built-in support for the PROXY protocol. +The PROXY protocol is a simple and efficient way for proxies to transmit information about the client. +While a third-party library already existed, it was not entirely compatible with the Ranch interface, in particular when socket active mode was involved. This new implementation fixes that and supports the full protocol with as little overhead as possible compared to normal operations: just one extra function call.</description> + </item> + + <item> <title>Migrating from Ranch 1.x</title> <link>https://ninenines.eu/docs/en/ranch/2.0/guide/migrating_from_1.x/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2420,21 +2560,22 @@ Features added Listeners can now be suspended/resumed without stopping existing </item> <item> - <title>Migrating from Ranch 1.x</title> - <link>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.x/</link> + <title>Migrating from Ranch 1.5 to 1.6</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.5/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.x/</guid> - <description>The changelog for Ranch releases before 1.6 can be found in this section. -1.5.0 Add transport functions getopts/2, getstat/1 and getstat/2 Fix ranch:info/0 and ranch:procs/2 in embedded mode Prevent ranch_conns_sup from stopping on unexpected messages 1.4.0 Add new transport option num_acceptor Deprecate ranch:start_listener/6 in favor of start_listener/5 Deprecate ranch:child_spec/6 in favor of child_spec/5 1.3.0 The version numbers 1.3.1 and 1.3.2 were later made to fix small mistakes made during the 1.</description> + <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.5/</guid> + <description>Ranch 1.6 added the ability to suspend and resume listeners. It also deprecates a number of features and add interfaces that will be used in Ranch 2.0. +Ranch 1.6 is compatible with Erlang/OTP 18.0 onward. Support for older releases has been removed. +Features added Listeners can now be suspended/resumed without stopping existing connection processes. This effectively closes the listening socket and stops the acceptor processes. Transport options can now be updated for suspended listeners.</description> </item> <item> <title>Migrating from Ranch 1.x</title> - <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.x/</link> + <link>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.x/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.x/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.x/</guid> <description>The changelog for Ranch releases before 1.6 can be found in this section. 1.5.0 Add transport functions getopts/2, getstat/1 and getstat/2 Fix ranch:info/0 and ranch:procs/2 in embedded mode Prevent ranch_conns_sup from stopping on unexpected messages 1.4.0 Add new transport option num_acceptor Deprecate ranch:start_listener/6 in favor of start_listener/5 Deprecate ranch:child_spec/6 in favor of child_spec/5 1.3.0 The version numbers 1.3.1 and 1.3.2 were later made to fix small mistakes made during the 1.</description> </item> @@ -2587,6 +2728,17 @@ In the context of HTTP, multipart is most often used with the multipart/form-dat </item> <item> + <title>Migrating from Ranch 1.5 to 1.6</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.5/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.5/</guid> + <description>Ranch 1.6 added the ability to suspend and resume listeners. It also deprecates a number of features and add interfaces that will be used in Ranch 2.0. +Ranch 1.6 is compatible with Erlang/OTP 18.0 onward. Support for older releases has been removed. +Features added Listeners can now be suspended/resumed without stopping existing connection processes. This effectively closes the listening socket and stops the acceptor processes. Transport options can now be updated for suspended listeners.</description> + </item> + + <item> <title>Migrating from Ranch 1.x</title> <link>https://ninenines.eu/docs/en/ranch/2.1/guide/migrating_from_1.x/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2597,6 +2749,16 @@ In the context of HTTP, multipart is most often used with the multipart/form-dat </item> <item> + <title>Migrating from Ranch 1.x</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.x/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.x/</guid> + <description>The changelog for Ranch releases before 1.6 can be found in this section. +1.5.0 Add transport functions getopts/2, getstat/1 and getstat/2 Fix ranch:info/0 and ranch:procs/2 in embedded mode Prevent ranch_conns_sup from stopping on unexpected messages 1.4.0 Add new transport option num_acceptor Deprecate ranch:start_listener/6 in favor of start_listener/5 Deprecate ranch:child_spec/6 in favor of child_spec/5 1.3.0 The version numbers 1.3.1 and 1.3.2 were later made to fix small mistakes made during the 1.</description> + </item> + + <item> <title>REST principles</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/rest_principles/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2674,6 +2836,16 @@ We will first attempt to define REST and will look at what it means in the conte </item> <item> + <title>Migrating from Ranch 1.x</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.x/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.x/</guid> + <description>The changelog for Ranch releases before 1.6 can be found in this section. +1.5.0 Add transport functions getopts/2, getstat/1 and getstat/2 Fix ranch:info/0 and ranch:procs/2 in embedded mode Prevent ranch_conns_sup from stopping on unexpected messages 1.4.0 Add new transport option num_acceptor Deprecate ranch:start_listener/6 in favor of start_listener/5 Deprecate ranch:child_spec/6 in favor of child_spec/5 1.3.0 The version numbers 1.3.1 and 1.3.2 were later made to fix small mistakes made during the 1.</description> + </item> + + <item> <title>REST handlers</title> <link>https://ninenines.eu/docs/en/cowboy/2.10/guide/rest_handlers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14895,6 +15067,18 @@ Description This chapter aims to list all HTTP status codes that Cowboy may retu </item> <item> + <title>Ranch 2.2</title> + <link>https://ninenines.eu/articles/ranch-2.2.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/articles/ranch-2.2.0/</guid> + <description>Ranch 2.2.0 has been released! +Ranch 2.2 is a maintenance release containing a small number of fixes and improvements. +The key addition in this release is the support for DTLS which has been added to the test suites. +Ranch 2.2 is tested with Erlang/OTP 24.0 onward, although it should be compatible with Erlang/OTP 22.0 and above. It is tested and supported on Linux, macOS and Windows, but should also work on BSD.</description> + </item> + + <item> <title>Ranch Function Reference</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14965,6 +15149,20 @@ ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</descrip </item> <item> + <title>Ranch Function Reference</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/</guid> + <description>Name ranch - Socket acceptor pool for TCP protocols +Description Ranch is a socket acceptor pool for TCP protocols. +Ranch manages listeners which are a set of processes that accept and manage connections. The connection&apos;s transport and protocol modules are configured per listener. Listeners can be inspected and reconfigured without interruptions in service. +Modules Functions: +ranch(3) - Socket acceptor pool ranch_proxy_header(3) - PROXY protocol Transports: +ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</description> + </item> + + <item> <title>Ranch User Guide</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -14988,7 +15186,7 @@ ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</descrip <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/</guid> - <description>Interface Introduction Listeners Transports Protocols Embedded mode How to Writing parsers SSL client authentication Advanced Internals Additional information Upcoming changes in Ranch 2.0 Migrating from Ranch 1.7 to 1.8 Migrating from Ranch 1.6 to 1.7 Migrating from Ranch 1.5 to 1.6 Migrating from Ranch 1.x </description> + <description>Interface Introduction Listeners Transports Protocols Embedded mode How to Writing parsers SSL client authentication Advanced Internals Additional information Upcoming changes in Ranch 2.0 Changes since Ranch 1.8 Migrating from Ranch 1.7 to 1.8 Migrating from Ranch 1.6 to 1.7 Migrating from Ranch 1.5 to 1.6 Migrating from Ranch 1.x </description> </item> <item> @@ -15010,6 +15208,15 @@ ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</descrip </item> <item> + <title>Ranch User Guide</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/guide/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/guide/</guid> + <description>Interface Introduction Listeners Transports Protocols Embedded mode How to Writing parsers SSL client authentication Connection draining Advanced Internals Additional information Migrating from Ranch 2.1 to 2.2 Migrating from Ranch 2.0 to 2.1 Migrating from Ranch 1.7 to 2.0 Migrating from Ranch 1.6 to 1.7 Migrating from Ranch 1.5 to 1.6 Migrating from Ranch 1.</description> + </item> + + <item> <title>ranch(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15080,6 +15287,20 @@ ranch:handshake(3) - Perform the transport handshake ranch:handshake_continue(3 </item> <item> + <title>ranch(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch/</guid> + <description>Name ranch - Socket acceptor pool +Description The module ranch provides functions for starting and manipulating Ranch listeners. +Exports Start/stop: +ranch:start_listener(3) - Start a listener ranch:stop_listener(3) - Stop a listener ranch:child_spec(3) - Build child specifications for a new listener Suspend/resume: +ranch:suspend_listener(3) - Suspend a running listener ranch:resume_listener(3) - Resume a suspended listener ranch:get_status(3) - Get a listener&apos;s running state Connections: +ranch:handshake(3) - Perform the transport handshake ranch:handshake_continue(3) - Resume the paused transport handshake ranch:handshake_cancel(3) - Cancel the paused transport handshake ranch:recv_proxy_header(3) - Receive the PROXY protocol header ranch:remove_connection(3) - Remove connection from the count Options:</description> + </item> + + <item> <title>ranch(7)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_app/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15150,6 +15371,20 @@ ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</descrip </item> <item> + <title>ranch(7)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_app/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_app/</guid> + <description>Name ranch - Socket acceptor pool for TCP protocols +Description Ranch is a socket acceptor pool for TCP protocols. +Ranch manages listeners which are a set of processes that accept and manage connections. The connection&apos;s transport and protocol modules are configured per listener. Listeners can be inspected and reconfigured without interruptions in service. +Modules Functions: +ranch(3) - Socket acceptor pool ranch_proxy_header(3) - PROXY protocol Transports: +ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</description> + </item> + + <item> <title>ranch:child_spec(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.child_spec/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15210,6 +15445,18 @@ Arguments Ref The listener name is used to refer to this listener in future call </item> <item> + <title>ranch:child_spec(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.child_spec/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.child_spec/</guid> + <description>Name ranch:child_spec - Build child specifications for a new listener +Description child_spec(Ref :: ranch_ref(), Transport :: module(), TransOpts :: ranch:opts(), Protocol :: module(), ProtoOpts :: any()) -&gt; supervisor:child_spec() Build child specifications for a new listener which can be embedded directly in an application&apos;s supervision tree. +The actual listener is placed under a supervisor which monitors ranch_server via a proxy process and will restart the listener if ranch_server crashes. +Arguments Ref The listener name is used to refer to this listener in future calls, for example when updating the configuration.</description> + </item> + + <item> <title>ranch:get_addr(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_addr/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15276,6 +15523,18 @@ Arguments Ref The listener name. </item> <item> + <title>ranch:get_addr(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_addr/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_addr/</guid> + <description>Name ranch:get_addr - Get the listening address +Description get_addr(Ref :: ranch:ref()) -&gt; {IP :: inet:ip_address(), Port :: inet:port_number()} | {local, SocketFile :: binary()} | {undefined, undefined} Get the listening address. +Arguments Ref The listener name. + Return value The address of the listener is returned as a tuple of the form {IP, Port} when listening on a network interface, or {local, SocketFile} when listening on a UNIX Domain socket.</description> + </item> + + <item> <title>ranch:get_max_connections(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_max_connections/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15341,6 +15600,19 @@ Changelog 2.0: The maximum number of connections is now per connection superviso </item> <item> + <title>ranch:get_max_connections(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_max_connections/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_max_connections/</guid> + <description>Name ranch:get_max_connections - Get the max number of connections per connection supervisor +Description get_max_connections(Ref :: ranch:ref()) -&gt; MaxConns :: ranch:max_conns() Get the max number of connections per connection supervisor. +Arguments Ref The listener name. + Return value The maximum number of connections per connection supervisor is returned. +Changelog 2.0: The maximum number of connections is now per connection supervisor. Examples Get the max number of connections per connection supervisor MaxConns = ranch:get_max_connections(example).</description> + </item> + + <item> <title>ranch:get_port(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_port/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15411,6 +15683,20 @@ When the listener is suspended or using a UNIX Domain socket instead of a networ </item> <item> + <title>ranch:get_port(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_port/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_port/</guid> + <description>Name ranch:get_port - Get the listening port +Description get_port(Ref :: ranch:ref()) -&gt; Port :: inet:port_number() | undefined Get the listening port. +This function is particularly useful to retrieve the listening port number when it was not provided in the options and was chosen randomly instead. +Arguments Ref The listener name. + Return value The listening port is returned. +When the listener is suspended or using a UNIX Domain socket instead of a network interface, undefined will be returned.</description> + </item> + + <item> <title>ranch:get_protocol_options(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_protocol_options/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15476,6 +15762,19 @@ Examples Get the current protocol options ProtoOpts = ranch:get_protocol_options </item> <item> + <title>ranch:get_protocol_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_protocol_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_protocol_options/</guid> + <description>Name ranch:get_protocol_options - Get the current protocol options +Description get_protocol_options(Ref :: ranch:ref()) -&gt; ProtoOpts :: any() Get the current protocol options. +Arguments Ref The listener name. + Return value The current protocol options are returned. +Examples Get the current protocol options ProtoOpts = ranch:get_protocol_options(example). See also ranch:get_max_connections(3), ranch:get_transport_options(3), ranch:set_protocol_options(3), ranch(3)</description> + </item> + + <item> <title>ranch:get_status(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_status/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15541,6 +15840,19 @@ Changelog 1.6: Function introduced. Examples Get a listener&apos;s running </item> <item> + <title>ranch:get_status(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_status/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_status/</guid> + <description>Name ranch:get_status - Get a listener&apos;s running state +Description get_status(Ref :: ranch_ref()) -&gt; running | suspended Get a listener&apos;s running state. +Arguments Ref The listener name. + Return value An atom is returned indicating the running status of the listener. +Changelog 1.6: Function introduced. Examples Get a listener&apos;s running state ranch:get_status(example). See also ranch:start_listener(3), ranch:stop_listener(3), ranch:suspend_listener(3), ranch:resume_listener(3), ranch:set_transport_options(3), ranch:wait_for_connections(3), ranch(3)</description> + </item> + + <item> <title>ranch:get_transport_options(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_transport_options/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15606,6 +15918,19 @@ Examples Get the current transport options TransOpts = ranch:get_transport_optio </item> <item> + <title>ranch:get_transport_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_transport_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_transport_options/</guid> + <description>Name ranch:get_transport_options - Get the current transport options +Description get_transport_options(Ref :: ranch:ref()) -&gt; TransOpts :: ranch:transport_opts(any()) Get the current transport options. +Arguments Ref The listener name. + Return value The current transport options are returned. +Examples Get the current transport options TransOpts = ranch:get_transport_options(example). See also ranch:get_max_connections(3), ranch:get_protocol_options(3), ranch:set_transport_options(3), ranch(3)</description> + </item> + + <item> <title>ranch:handshake(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.handshake/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15661,6 +15986,17 @@ This function must be called by the protocol process in order to retrieve the so </item> <item> + <title>ranch:handshake(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.handshake/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.handshake/</guid> + <description>Name ranch:handshake - Perform the transport handshake +Description handshake(Ref) -&gt; {ok, Socket} | {continue, Info} handshake(Ref, Opts) -&gt; {ok, Socket} | {continue, Info} Ref :: ranch:ref() Opts :: any() Socket :: any() Info :: any() Perform the transport handshake. +This function must be called by the protocol process in order to retrieve the socket for the connection. Ranch performs the handshake necessary to give control of the socket to this process and also does the transport handshake, for example setting up the TLS connection.</description> + </item> + + <item> <title>ranch:handshake_cancel(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.handshake_cancel/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15691,6 +16027,21 @@ Changelog 2.0: Function introduced. Examples Cancel a paused transport handsha </item> <item> + <title>ranch:handshake_cancel(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.handshake_cancel/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.handshake_cancel/</guid> + <description>Name ranch:handshake_cancel - Cancel the paused transport handshake +Description handshake_cancel(Ref :: ranch:ref()) -&gt; ok Cancel the paused transport handshake. +This function may be called by the protocol process to cancel a paused handshake. +Arguments Ref The listener name. +Allowed options depend on the transport module. + Return value The return value depends on the transport module. +Changelog 2.0: Function introduced. Examples Cancel a paused transport handshake start_link(Ref, Transport, Opts) -&gt; Pid = proc_lib:spawn_link(?</description> + </item> + + <item> <title>ranch:handshake_continue(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.handshake_continue/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15721,6 +16072,21 @@ Allowed options depend on the transport module. </item> <item> + <title>ranch:handshake_continue(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.handshake_continue/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.handshake_continue/</guid> + <description>Name ranch:handshake_continue - Resume the paused transport handshake +Description handshake_continue(Ref) -&gt; {ok, Socket} handshake_continue(Ref, Opts) -&gt; {ok, Socket} Ref :: ranch:ref() Opts :: any() Socket :: any() Resume the paused transport handshake. +This function must be called by the protocol process in order to resume a paused handshake. +Arguments Ref The listener name. + Opts Transport handshake options. +Allowed options depend on the transport module. + Return value An ok tuple is returned containing the socket for the connection.</description> + </item> + + <item> <title>ranch:info(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15796,6 +16162,21 @@ pid Pid of the listener&apos;s top-level supervisor. </item> <item> + <title>ranch:info(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.info/</guid> + <description>Name ranch:info - Overview of Ranch listeners +Description info() -&gt; #{Ref := Info} info(Ref) -&gt; Info Info :: #{Key :: atom() := Value :: any()} Overview of Ranch listeners. +Arguments Ref The listener name. + Return value Returns detailed information about one or all Ranch listeners. The following keys are returned: +pid Pid of the listener&apos;s top-level supervisor. + status Listener status, either running or suspended. + ip Interface Ranch listens on.</description> + </item> + + <item> <title>ranch:procs(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.procs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15866,6 +16247,20 @@ Examples Get the pids of the acceptor processes Pids = ranch:procs(acceptors). </item> <item> + <title>ranch:procs(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.procs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.procs/</guid> + <description>Name ranch:procs - Retrieve pids from a listener +Description procs(Ref :: ranch:ref(), Type :: acceptors | connections) -&gt; Pids :: [pid()] Retrieve pids from a listener. +Arguments Ref The listener name. + Type The type of process that will be returned. + Return value A list of pids is returned. +Examples Get the pids of the acceptor processes Pids = ranch:procs(acceptors). Get the pids of the connection processes Pids = ranch:procs(connections).</description> + </item> + + <item> <title>ranch:recv_proxy_header(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch.recv_proxy_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15922,6 +16317,20 @@ Arguments Ref The listener name. </item> <item> + <title>ranch:recv_proxy_header(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.recv_proxy_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.recv_proxy_header/</guid> + <description>Name ranch:recv_proxy_header - Receive the PROXY protocol header +Description recv_proxy_header(ranch:ref(), timeout()) -&gt; {ok, ranch_proxy_header:proxy_info()} | {error, Reason :: atom()} | {error, protocol_error, HumanReadable :: atom()} Receive the PROXY protocol header. +This function must be called before ranch:handshake/1,2 on newly accepted connections to read and parse the PROXY protocol header, if any. +Arguments Ref The listener name. + Timeout Receive timeout in milliseconds. + Return value An ok tuple is returned containing PROXY header information on success.</description> + </item> + + <item> <title>ranch:remove_connection(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.remove_connection/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -15982,6 +16391,18 @@ This function may only be called from a connection process.</description> </item> <item> + <title>ranch:remove_connection(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.remove_connection/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.remove_connection/</guid> + <description>Name ranch:remove_connection - Remove connection from the count +Description remove_connection(Ref :: ranch:ref()) -&gt; ok Remove connection from the count. +This connection will no longer be included in the count when limiting the number of connections. This can be useful in a mixed environment where some connections are active and others are passive. Passive connections spend most of their time idling and are not consuming much resources. +This function may only be called from a connection process.</description> + </item> + + <item> <title>ranch:resume_listener(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.resume_listener/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16052,6 +16473,20 @@ Arguments Ref The listener name. </item> <item> + <title>ranch:resume_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.resume_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.resume_listener/</guid> + <description>Name ranch:resume_listener - Resume a suspended listener +Description resume_listener(Ref :: ranch_ref()) -&gt; ok | {error, any()} Resume a suspended listener. +Ranch will start listening for and accepting connections again. The function ranch:set_transport_options(3) can be used to change the transport options before resuming the listener. +Nothing is done when the listener is already running. +Arguments Ref The listener name. + Return value The atom ok is returned on success.</description> + </item> + + <item> <title>ranch:set_max_connections(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.set_max_connections/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16110,6 +16545,17 @@ The change will be applied immediately. If the new value is smaller than the pre </item> <item> + <title>ranch:set_max_connections(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.set_max_connections/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.set_max_connections/</guid> + <description>Name ranch:set_max_connections - Set the max number of connections per connection supervisor +Description set_max_connections(Ref :: ranch:ref(), MaxConns :: ranch:max_conns()) -&gt; ok Set the max number of connections per connection supervisor. +The change will be applied immediately. If the new value is smaller than the previous one, Ranch will wait for the extra connections to terminate and will not accept new connections until the number of connections goes below the limit.</description> + </item> + + <item> <title>ranch:set_protocol_options(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.set_protocol_options/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16182,6 +16628,18 @@ Note that the complete set of protocol options is replaced. To update a subset o </item> <item> + <title>ranch:set_protocol_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.set_protocol_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.set_protocol_options/</guid> + <description>Name ranch:set_protocol_options - Set the protocol options +Description set_protocol_options(Ref :: ranch:ref(), ProtoOpts :: any()) -&gt; ok Set the protocol options. +The change will be applied immediately for all new connections. Old connections will not receive the new options. +Note that the complete set of protocol options is replaced. To update a subset of the options, it is recommended to get the current protocol options using ranch:get_protocol_options(3), update them and then set them back using this function.</description> + </item> + + <item> <title>ranch:set_transport_options(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.set_transport_options/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16251,6 +16709,18 @@ Changes to the following options will take effect.</description> </item> <item> + <title>ranch:set_transport_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.set_transport_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.set_transport_options/</guid> + <description>Name ranch:set_transport_options - Set the transport options +Description set_transport_options(Ref :: ranch:ref(), TransOpts :: ranch:opts()) -&gt; ok | {error, Reason :: term()} Set the transport options. +The complete set of transport options is replaced. To update a subset of the transport options, it is recommended to get the current transport options using ranch:get_transport_options(3), update them and then set them back using this function. +Changes to the following options will take effect.</description> + </item> + + <item> <title>ranch:start_listener(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.start_listener/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16311,6 +16781,18 @@ Arguments Ref The listener name is used to refer to this listener in future call </item> <item> + <title>ranch:start_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.start_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.start_listener/</guid> + <description>Name ranch:start_listener - Start a listener +Description start_listener(Ref :: ranch_ref(), Transport :: module(), TransOpts :: ranch:opts(), Protocol :: module(), ProtoOpts :: any()) -&gt; {ok, ListenerPid :: pid()} | {error, any()} Start a listener. +A listener is a set of processes that accepts and manages connections using the given transport and protocol modules. +Arguments Ref The listener name is used to refer to this listener in future calls, for example when stopping it or when updating the configuration.</description> + </item> + + <item> <title>ranch:stop_listener(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.stop_listener/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16371,6 +16853,18 @@ In order for the connection processes to exit gracefully, they need to trap exit </item> <item> + <title>ranch:stop_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.stop_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.stop_listener/</guid> + <description>Name ranch:stop_listener - Stop a listener +Description stop_listener(Ref :: ranch_ref()) -&gt; ok | {error, not_found} Stop a listener. +The listener is stopped gracefully, first by closing the listening port, then by stopping the connection processes. These processes are stopped according to the shutdown transport option, which may be set to brutally kill all connection processes or give them some time to stop properly. +In order for the connection processes to exit gracefully, they need to trap exit signals and stop before the configured shutdown timeout.</description> + </item> + + <item> <title>ranch:suspend_listener(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.suspend_listener/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16431,6 +16925,18 @@ Some transport options can only be changed when the listener is suspended. Pleas </item> <item> + <title>ranch:suspend_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.suspend_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.suspend_listener/</guid> + <description>Name ranch:suspend_listener - Suspend a running listener +Description suspend_listener(Ref :: ranch_ref()) -&gt; ok | {error, any()} Suspend a running listener. +Ranch will stop listening for and accepting connections and the listening socket will be closed. Existing connections will continue undisturbed. The function ranch:wait_for_connections(3) can be used to wait for connections to be closed if necessary. +Some transport options can only be changed when the listener is suspended. Please consult the ranch:set_transport_options(3) manual for more information.</description> + </item> + + <item> <title>ranch:wait_for_connections(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.wait_for_connections/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16491,6 +16997,18 @@ This function can be used to gracefully shutdown a listener by first suspending </item> <item> + <title>ranch:wait_for_connections(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.wait_for_connections/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.wait_for_connections/</guid> + <description>Name ranch:wait_for_connections - Wait for a specific number of connections +Description wait_for_connections(Ref :: ranch:ref(), Operator, NumConns :: non_neg_integer()) -&gt; ok Operator :: '&gt;' | '&gt;=' | '==' | '=&lt;' | '&lt;' Wait for a specific number of connections. +This function waits until the number of connections on the given listener becomes higher than, equal to or lower than the given number. It never returns otherwise. +This function can be used to gracefully shutdown a listener by first suspending the listener and then waiting for connections to terminate before finally stopping the listener.</description> + </item> + + <item> <title>ranch_protocol(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_protocol/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16556,6 +17074,19 @@ The only purpose of this callback is to start a process that will handle the soc </item> <item> + <title>ranch_protocol(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_protocol/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_protocol/</guid> + <description>Name ranch_protocol - Protocol modules +Description The module ranch_protocol defines the interface used by Ranch protocols. +Callbacks Ranch protocols implement the following interface: +start_link(Ref :: ranch:ref(), Transport :: module(), ProtoOpts :: any()) -&gt; {ok, ConnPid :: pid()} | {ok, SupPid :: pid(), ConnPid :: pid()} Start a new connection process. +The only purpose of this callback is to start a process that will handle the socket. It must spawn the process, link and then return the new pid.</description> + </item> + + <item> <title>ranch_proxy_header(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch_proxy_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16600,6 +17131,17 @@ Exports ranch_proxy_header:parse(3) - Parse a PROXY protocol header ranch_proxy </item> <item> + <title>ranch_proxy_header(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header/</guid> + <description>Name ranch_proxy_header - PROXY protocol +Description The module ranch_proxy_header provides functions for parsing and building the PROXY protocol header. +Exports ranch_proxy_header:parse(3) - Parse a PROXY protocol header ranch_proxy_header:header(3) - Build a PROXY protocol header ranch_proxy_header:to_connection_info(3) - Convert proxy_info() to ssl:connection_info() Types proxy_info() proxy_info() = #{ %% Mandatory part. version := 1 | 2, command := local | proxy, transport_family =&gt; undefined | ipv4 | ipv6 | unix, transport_protocol =&gt; undefined | stream | dgram, %% Addresses.</description> + </item> + + <item> <title>ranch_proxy_header:header(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch_proxy_header.header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16652,6 +17194,19 @@ Arguments ProxyInfo The proxy information to encode. </item> <item> + <title>ranch_proxy_header:header(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header.header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header.header/</guid> + <description>Name ranch_proxy_header:header - Build a PROXY protocol header +Description header(ProxyInfo) -&gt; header(ProxyInfo, #{}) header(ProxyInfo, BuildOpts) -&gt; iodata() ProxyInfo :: ranch_proxy_header:proxy_info() BuildOpts :: #{ checksum =&gt; crc32c, padding =&gt; pos_integer() %% &gt;= 3 } Build a PROXY protocol header. +Arguments ProxyInfo The proxy information to encode. + BuildOpts Options to control whether to add a checksum or padding should be included in the encoded PROXY protocol header. + Return value The PROXY protocol header is returned.</description> + </item> + + <item> <title>ranch_proxy_header:parse(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch_proxy_header.parse/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16704,6 +17259,19 @@ An error tuple is returned when a protocol error is detected.</description> </item> <item> + <title>ranch_proxy_header:parse(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header.parse/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header.parse/</guid> + <description>Name ranch_proxy_header:parse - Parse a PROXY protocol header +Description parse(Data :: binary()) -&gt; {ok, ranch_proxy_header:proxy_info(), Rest :: binary()} | {error, HumanReadable :: atom()} Parse a PROXY protocol header. +Arguments Data The PROXY protocol header optionally followed by more data. + Return value An ok tuple is returned on success, containing the proxy information found in the header and the rest of the data if more was provided. +An error tuple is returned when a protocol error is detected.</description> + </item> + + <item> <title>ranch_proxy_header:to_connection_info(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_proxy_header.to_connection_info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16718,6 +17286,20 @@ Changelog 2.1: Function introduced. Examples Convert the PROXY protocol inform </item> <item> + <title>ranch_proxy_header:to_connection_info(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header.to_connection_info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header.to_connection_info/</guid> + <description>Name ranch_proxy_header:to_connection_info - Convert proxy_info() to ssl:connection_info() +Description to_connection_info(ProxyInfo :: proxy_info()) -&gt; ssl:connection_info() Convert ranch_proxy_header:proxy_info() information to the ssl:connection_info() format returned by ssl:connection_information/1,2. +Arguments ProxyInfo The PROXY protocol information. + Return value Connection information is returned as a proplist. +Because the PROXY protocol header includes limited information, only the keys protocol, selected_cipher_suite and sni_hostname will be returned, at most. All keys are optional. +Changelog 2.1: Function introduced. Examples Convert the PROXY protocol information ConnInfo = ranch_proxy_header:to_connection_info(ProxyInfo).</description> + </item> + + <item> <title>ranch_ssl(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_ssl/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16793,6 +17375,21 @@ ssl_opt() ssl_opt() = {alpn_preferred_protocols, [binary()]} | {anti_replay,  </item> <item> + <title>ranch_ssl(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_ssl/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_ssl/</guid> + <description>Name ranch_ssl - SSL transport +Description The module ranch_ssl implements an SSL Ranch transport. +Exports The module ranch_ssl implements the interface defined by ranch_transport(3). +Types opt() opt() :: ranch_tcp:opt() | ssl_opt() Listen options. +The TCP options are defined in ranch_tcp(3). +opts() opts() :: [opt()] List of listen options. +ssl_opt() ssl_opt() = {alpn_preferred_protocols, [binary()]} | {anti_replay, '10k' | '100k' | {integer(), integer(), integer()}} | {beast_mitigation, one_n_minus_one | zero_n | disabled} | {cacertfile, file:filename()} | {cacerts, [public_key:der_encoded()]} | {cert, public_key:der_encoded()} | {certs_keys, [#{cert =&gt; public_key:der_encoded(), key =&gt; ssl:key(), certfile =&gt; file:filename(), keyfile =&gt; file:filename(), key_pem_password =&gt; iodata() | fun(() -&gt; iodata())}]} | {certfile, file:filename()} | {ciphers, ssl:ciphers()} | {client_renegotiation, boolean()} | {crl_cache, [any()]} | {crl_check, boolean() | peer | best_effort} | {depth, integer()} | {dh, binary()} | {dhfile, file:filename()} | {eccs, [ssl:named_curve()]} | {fail_if_no_peer_cert, boolean()} | {handshake, hello | full} | {hibernate_after, timeout()} | {honor_cipher_order, boolean()} | {honor_ecc_order, boolean()} | {key, ssl:key()} | {key_update_at, pos_integer()} | {keyfile, file:filename()} | {log_alert, boolean()} | {log_level, logger:level()} | {max_handshake_size, integer()} | {middlebox_comp_mode, boolean()} | {next_protocols_advertised, [binary()]} | {padding_check, boolean()} | {partial_chain, fun()} | {password, string()} | {protocol, tls | dtls} | {psk_identity, string()} | {reuse_session, fun()} | {reuse_sessions, boolean()} | {secure_renegotiate, boolean()} | {session_tickets, disabled | stateful | stateless} | {signature_algs, [{ssl:hash(), ssl:sign_algo()}]} | {signature_algs_cert, [ssl:sign_scheme()]} | {sni_fun, fun()} | {sni_hosts, [{string(), ssl_opt()}]} | {supported_groups, [ssl:group()]} | {user_lookup_fun, {fun(), any()}} | {verify, verify_none | verify_peer} | {verify_fun, {fun(), any()}} | {versions, [ssl:protocol_version()]} SSL-specific listen options.</description> + </item> + + <item> <title>ranch_tcp(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_tcp/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16858,6 +17455,19 @@ Types opt() opt() = {backlog, non_neg_integer()} | {buffer, non_neg_integer()} | </item> <item> + <title>ranch_tcp(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_tcp/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_tcp/</guid> + <description>Name ranch_tcp - TCP transport +Description The module ranch_tcp implements a TCP Ranch transport. +The function sendfile may not work correctly when used against files stored in a VirtualBox shared folder. +Exports The module ranch_tcp implements the interface defined by ranch_transport(3). +Types opt() opt() = {backlog, non_neg_integer()} | {buffer, non_neg_integer()} | {delay_send, boolean()} | {dontroute, boolean()} | {exit_on_close, boolean()} | {fd, non_neg_integer()} | {high_msgq_watermark, non_neg_integer()} | {high_watermark, non_neg_integer()} | inet | inet6 | {ip, inet:ip_address() | inet:local_address()} | {ipv6_v6only, boolean()} | {keepalive, boolean()} | {linger, {boolean(), non_neg_integer()}} | {low_msgq_watermark, non_neg_integer()} | {low_watermark, non_neg_integer()} | {nodelay, boolean()} | {port, inet:port_number()} | {priority, integer()} | {raw, non_neg_integer(), non_neg_integer(), binary()} | {recbuf, non_neg_integer()} | {send_timeout, timeout()} | {send_timeout_close, boolean()} | {sndbuf, non_neg_integer()} | {tos, integer()} Listen options.</description> + </item> + + <item> <title>ranch_transport(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_transport/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16923,6 +17533,19 @@ close close(Socket :: socket()) -&gt; ok Close the socket.</description> </item> <item> + <title>ranch_transport(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_transport/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_transport/</guid> + <description>Name ranch_transport - Transport modules +Description The module ranch_transport defines the interface used by Ranch transports. +Callbacks Ranch transports implement the following interface: +accept accept(LSocket :: socket(), Timeout :: timeout()) -&gt; {ok, Socket :: socket()} | {error, closed | timeout | atom()} Use the listening socket returned by listen/1 to accept a new connection. The timeout is specified in milliseconds. +close close(Socket :: socket()) -&gt; ok Close the socket.</description> + </item> + + <item> <title>ranch_transport:sendfile(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_transport.sendfile/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -16982,5 +17605,17 @@ The file may be sent full or in parts, and may be specified by its filename or b This function emulates the function file:sendfile/2,4,5 and may be used when transports are not manipulating TCP directly.</description> </item> + <item> + <title>ranch_transport:sendfile(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_transport.sendfile/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_transport.sendfile/</guid> + <description>Name ranch_transport:sendfile - Send a file on the socket +Description sendfile(Transport :: module(), Socket :: ranch_transport:socket(), File :: file:name_all() | file:fd(), Offset :: non_neg_integer(), Bytes :: non_neg_integer(), Opts :: ranch_transport:sendfile_opts()) -&gt; {ok, SentBytes :: non_neg_integer()} | {error, atom()} Send a file on the socket. +The file may be sent full or in parts, and may be specified by its filename or by an already open file descriptor. +This function emulates the function file:sendfile/2,4,5 and may be used when transports are not manipulating TCP directly.</description> + </item> + </channel> </rss>
\ No newline at end of file diff --git a/services/index.html b/services/index.html index da847f4e..0b9c92ac 100644 --- a/services/index.html +++ b/services/index.html @@ -947,6 +947,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <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"> @@ -2956,6 +2988,78 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + </div> </div> </div> diff --git a/sitemap.xml b/sitemap.xml index e462fbf6..dae2fa70 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -47,6 +47,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/introduction/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/guide/modern_web/</loc> </url> @@ -123,6 +127,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/listeners/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/guide/start/</loc> </url> @@ -219,6 +227,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/transports/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.0/guide/connect/</loc> </url> @@ -263,6 +275,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/protocols/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/guide/getting_started/</loc> </url> @@ -335,6 +351,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/embedded/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/guide/flow_diagram/</loc> </url> @@ -407,6 +427,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/parsers/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.3/</loc> </url> @@ -475,6 +499,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/ssl_auth/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/guide/routing/</loc> </url> @@ -511,6 +539,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/connection_draining/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/guide/internals/</loc> </url> @@ -587,6 +619,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/internals/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.1/</loc> </url> @@ -635,6 +671,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_2.1/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.6/</loc> </url> @@ -643,7 +683,7 @@ </url> <url> - <loc>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.7/</loc> + <loc>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.8/</loc> </url> <url> @@ -723,6 +763,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_2.0/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.5/</loc> </url> @@ -731,7 +775,7 @@ </url> <url> - <loc>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.6/</loc> + <loc>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.7/</loc> </url> <url> @@ -779,11 +823,15 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.7/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.5/</loc> </url> <url> - <loc>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.5/</loc> + <loc>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.6/</loc> </url> <url> @@ -859,15 +907,19 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.6/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/2.0/guide/migrating_from_1.x/</loc> </url> <url> - <loc>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.x/</loc> + <loc>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.5/</loc> </url> <url> - <loc>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.x/</loc> + <loc>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.x/</loc> </url> <url> @@ -927,10 +979,18 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.5/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/2.1/guide/migrating_from_1.x/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.x/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/guide/rest_principles/</loc> </url> @@ -959,6 +1019,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/migrating_from_1.x/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/cowboy/2.10/guide/rest_handlers/</loc> </url> @@ -5091,6 +5155,10 @@ </url> <url> + <loc>https://ninenines.eu/articles/ranch-2.2.0/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/</loc> </url> @@ -5111,6 +5179,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/guide/</loc> </url> @@ -5131,6 +5203,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/guide/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch/</loc> </url> @@ -5151,6 +5227,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_app/</loc> </url> @@ -5171,6 +5251,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_app/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.child_spec/</loc> </url> @@ -5191,6 +5275,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.child_spec/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_addr/</loc> </url> @@ -5211,6 +5299,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_addr/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_max_connections/</loc> </url> @@ -5231,6 +5323,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_max_connections/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_port/</loc> </url> @@ -5251,6 +5347,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_port/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_protocol_options/</loc> </url> @@ -5271,6 +5371,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_protocol_options/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_status/</loc> </url> @@ -5291,6 +5395,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_status/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_transport_options/</loc> </url> @@ -5311,6 +5419,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.get_transport_options/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.handshake/</loc> </url> @@ -5331,6 +5443,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.handshake/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.handshake_cancel/</loc> </url> @@ -5339,6 +5455,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.handshake_cancel/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.handshake_continue/</loc> </url> @@ -5347,6 +5467,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.handshake_continue/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.info/</loc> </url> @@ -5367,6 +5491,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.info/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.procs/</loc> </url> @@ -5387,6 +5515,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.procs/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch.recv_proxy_header/</loc> </url> @@ -5403,6 +5535,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.recv_proxy_header/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.remove_connection/</loc> </url> @@ -5423,6 +5559,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.remove_connection/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.resume_listener/</loc> </url> @@ -5443,6 +5583,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.resume_listener/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.set_max_connections/</loc> </url> @@ -5463,6 +5607,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.set_max_connections/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.set_protocol_options/</loc> </url> @@ -5483,6 +5631,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.set_protocol_options/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.set_transport_options/</loc> </url> @@ -5503,6 +5655,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.set_transport_options/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.start_listener/</loc> </url> @@ -5523,6 +5679,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.start_listener/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.stop_listener/</loc> </url> @@ -5543,6 +5703,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.stop_listener/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.suspend_listener/</loc> </url> @@ -5563,6 +5727,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.suspend_listener/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.wait_for_connections/</loc> </url> @@ -5583,6 +5751,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch.wait_for_connections/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_protocol/</loc> </url> @@ -5603,6 +5775,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_protocol/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch_proxy_header/</loc> </url> @@ -5619,6 +5795,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch_proxy_header.header/</loc> </url> @@ -5635,6 +5815,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header.header/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch_proxy_header.parse/</loc> </url> @@ -5651,10 +5835,18 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header.parse/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_proxy_header.to_connection_info/</loc> </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_proxy_header.to_connection_info/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_ssl/</loc> </url> @@ -5675,6 +5867,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_ssl/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_tcp/</loc> </url> @@ -5695,6 +5891,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_tcp/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_transport/</loc> </url> @@ -5715,6 +5915,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_transport/</loc> + </url> + + <url> <loc>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_transport.sendfile/</loc> </url> @@ -5735,6 +5939,10 @@ </url> <url> + <loc>https://ninenines.eu/docs/en/ranch/2.2/manual/ranch_transport.sendfile/</loc> + </url> + + <url> <loc>https://ninenines.eu/tags/</loc> </url> |