diff options
Diffstat (limited to 'docs/en/ranch')
19 files changed, 84 insertions, 38 deletions
diff --git a/docs/en/ranch/1.2/guide/embedded/index.html b/docs/en/ranch/1.2/guide/embedded/index.html index 605e5f98..13418002 100644 --- a/docs/en/ranch/1.2/guide/embedded/index.html +++ b/docs/en/ranch/1.2/guide/embedded/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: Embedded mode</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> @@ -120,13 +120,13 @@ more details on how Ranch does it.</p></div> <nav style="margin:1em 0"> - <a style="float:left" href="http://ninenines.eu/docs/en/ranch/1.2/guide/protocols/"> + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/1.2/guide/protocols/"> Protocols </a> - <a style="float:right" href="http://ninenines.eu/docs/en/ranch/1.2/guide/parsers/"> + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/1.2/guide/parsers/"> Writing parsers </a> diff --git a/docs/en/ranch/1.2/guide/index.html b/docs/en/ranch/1.2/guide/index.html index 660570ce..08552458 100644 --- a/docs/en/ranch/1.2/guide/index.html +++ b/docs/en/ranch/1.2/guide/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: Ranch User Guide</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> diff --git a/docs/en/ranch/1.2/guide/internals/index.html b/docs/en/ranch/1.2/guide/internals/index.html index 84554e20..b43eed8f 100644 --- a/docs/en/ranch/1.2/guide/internals/index.html +++ b/docs/en/ranch/1.2/guide/internals/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: Internals</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> @@ -165,7 +165,7 @@ http://www.gnu.org/software/src-highlite --> <nav style="margin:1em 0"> - <a style="float:left" href="http://ninenines.eu/docs/en/ranch/1.2/guide/ssl_auth/"> + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/1.2/guide/ssl_auth/"> SSL client authentication </a> diff --git a/docs/en/ranch/1.2/guide/introduction/index.html b/docs/en/ranch/1.2/guide/introduction/index.html index b45d8fa4..4afe8227 100644 --- a/docs/en/ranch/1.2/guide/introduction/index.html +++ b/docs/en/ranch/1.2/guide/introduction/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: Introduction</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> @@ -106,7 +106,7 @@ modifications but there is no guarantee that it will work as expected.</p></div> - <a style="float:right" href="http://ninenines.eu/docs/en/ranch/1.2/guide/listeners/"> + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/1.2/guide/listeners/"> Listeners </a> diff --git a/docs/en/ranch/1.2/guide/listeners.asciidoc b/docs/en/ranch/1.2/guide/listeners.asciidoc index ef2d49c7..a776a584 100644 --- a/docs/en/ranch/1.2/guide/listeners.asciidoc +++ b/docs/en/ranch/1.2/guide/listeners.asciidoc @@ -4,7 +4,7 @@ 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 user of transport handlers. +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. @@ -203,6 +203,24 @@ ranch:set_max_connections(tcp_echo, MaxConns). The change will occur immediately. +=== 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 diff --git a/docs/en/ranch/1.2/guide/listeners/index.html b/docs/en/ranch/1.2/guide/listeners/index.html index c817a99c..ead3c4b8 100644 --- a/docs/en/ranch/1.2/guide/listeners/index.html +++ b/docs/en/ranch/1.2/guide/listeners/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: Listeners</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> @@ -73,7 +73,7 @@ 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 user of transport handlers.</p></div>
+programming is abstracted through the use of transport handlers.</p></div>
<div class="paragraph"><p>The listener takes care of supervising all the acceptor and connection
processes, allowing developers to focus on building their application.</p></div>
<div class="sect1">
@@ -302,6 +302,25 @@ http://www.gnu.org/software/src-highlite --> </div>
</div>
<div class="sect1">
+<h2 id="_when_running_out_of_file_descriptors">When running out of file descriptors</h2>
+<div class="sectionbody">
+<div class="paragraph"><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>
+<div class="listingblock">
+<div class="content">
+<pre><code>=ERROR REPORT==== 13-Jan-2016::12:24:38 ===
+Ranch acceptor reducing accept rate: out of file descriptors</code></pre>
+</div></div>
+<div class="paragraph"><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></div>
+</div>
+</div>
+<div class="sect1">
<h2 id="_using_a_supervisor_for_connection_processes">Using a supervisor for connection processes</h2>
<div class="sectionbody">
<div class="paragraph"><p>Ranch allows you to define the type of process that will be used
@@ -359,13 +378,13 @@ http://www.gnu.org/software/src-highlite --> <nav style="margin:1em 0"> - <a style="float:left" href="http://ninenines.eu/docs/en/ranch/1.2/guide/introduction/"> + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/1.2/guide/introduction/"> Introduction </a> - <a style="float:right" href="http://ninenines.eu/docs/en/ranch/1.2/guide/transports/"> + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/1.2/guide/transports/"> Transports </a> diff --git a/docs/en/ranch/1.2/guide/parsers/index.html b/docs/en/ranch/1.2/guide/parsers/index.html index 524d645f..c6a2ddab 100644 --- a/docs/en/ranch/1.2/guide/parsers/index.html +++ b/docs/en/ranch/1.2/guide/parsers/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: Writing parsers</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> @@ -181,13 +181,13 @@ immediately if any. Otherwise wait for more data.</p></div> <nav style="margin:1em 0"> - <a style="float:left" href="http://ninenines.eu/docs/en/ranch/1.2/guide/embedded/"> + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/1.2/guide/embedded/"> Embedded mode </a> - <a style="float:right" href="http://ninenines.eu/docs/en/ranch/1.2/guide/ssl_auth/"> + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/1.2/guide/ssl_auth/"> SSL client authentication </a> diff --git a/docs/en/ranch/1.2/guide/protocols/index.html b/docs/en/ranch/1.2/guide/protocols/index.html index 7cb1b338..e2f313f9 100644 --- a/docs/en/ranch/1.2/guide/protocols/index.html +++ b/docs/en/ranch/1.2/guide/protocols/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: Protocols</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> @@ -201,13 +201,13 @@ http://www.gnu.org/software/src-highlite --> <nav style="margin:1em 0"> - <a style="float:left" href="http://ninenines.eu/docs/en/ranch/1.2/guide/transports/"> + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/1.2/guide/transports/"> Transports </a> - <a style="float:right" href="http://ninenines.eu/docs/en/ranch/1.2/guide/embedded/"> + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/1.2/guide/embedded/"> Embedded mode </a> diff --git a/docs/en/ranch/1.2/guide/ssl_auth/index.html b/docs/en/ranch/1.2/guide/ssl_auth/index.html index ee3b1edb..cd38f30a 100644 --- a/docs/en/ranch/1.2/guide/ssl_auth/index.html +++ b/docs/en/ranch/1.2/guide/ssl_auth/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: SSL client authentication</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> @@ -230,13 +230,13 @@ user.</p></div> <nav style="margin:1em 0"> - <a style="float:left" href="http://ninenines.eu/docs/en/ranch/1.2/guide/parsers/"> + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/1.2/guide/parsers/"> Writing parsers </a> - <a style="float:right" href="http://ninenines.eu/docs/en/ranch/1.2/guide/internals/"> + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/1.2/guide/internals/"> Internals </a> diff --git a/docs/en/ranch/1.2/guide/transports/index.html b/docs/en/ranch/1.2/guide/transports/index.html index 4b6d05dc..682cd26b 100644 --- a/docs/en/ranch/1.2/guide/transports/index.html +++ b/docs/en/ranch/1.2/guide/transports/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: Transports</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> @@ -261,13 +261,13 @@ is the transport’s module. See <code>ranch_ssl</code> for an example.</p>< <nav style="margin:1em 0"> - <a style="float:left" href="http://ninenines.eu/docs/en/ranch/1.2/guide/listeners/"> + <a style="float:left" href="https://ninenines.eu/docs/en/ranch/1.2/guide/listeners/"> Listeners </a> - <a style="float:right" href="http://ninenines.eu/docs/en/ranch/1.2/guide/protocols/"> + <a style="float:right" href="https://ninenines.eu/docs/en/ranch/1.2/guide/protocols/"> Protocols </a> diff --git a/docs/en/ranch/1.2/index.html b/docs/en/ranch/1.2/index.html index c1eedb2f..ea24e654 100644 --- a/docs/en/ranch/1.2/index.html +++ b/docs/en/ranch/1.2/index.html @@ -1 +1 @@ -<!DOCTYPE html><html><head><link rel="canonical" href="http://ninenines.eu/docs/"/><meta http-equiv="content-type" content="text/html; charset=utf-8" /><meta http-equiv="refresh" content="0;url=http://ninenines.eu/docs/" /></head></html>
\ No newline at end of file +<!DOCTYPE html><html><head><link rel="canonical" href="https://ninenines.eu/docs/"/><meta http-equiv="content-type" content="text/html; charset=utf-8" /><meta http-equiv="refresh" content="0;url=https://ninenines.eu/docs/" /></head></html>
\ No newline at end of file diff --git a/docs/en/ranch/1.2/manual/index.html b/docs/en/ranch/1.2/manual/index.html index 0ee1cd10..83666bc9 100644 --- a/docs/en/ranch/1.2/manual/index.html +++ b/docs/en/ranch/1.2/manual/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: Ranch Function Reference</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> diff --git a/docs/en/ranch/1.2/manual/ranch/index.html b/docs/en/ranch/1.2/manual/ranch/index.html index ec646294..7a16695c 100644 --- a/docs/en/ranch/1.2/manual/ranch/index.html +++ b/docs/en/ranch/1.2/manual/ranch/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: ranch(3)</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> @@ -185,7 +185,7 @@ Ranch that it initialized properly and let it perform any additional operations before the socket can be safely used.</p></div>
</div>
<div class="sect2">
-<h3 id="_child_spec_ref_nbacceptors_transport_transopts_protocol_protoopts_8594_supervisor_child_spec">child_spec(Ref, NbAcceptors, Transport, TransOpts, Protocol, ProtoOpts) → supervisor:child_spec()</h3>
+<h3 id="_child_spec_ref_numacceptors_transport_transopts_protocol_protoopts_8594_supervisor_child_spec">child_spec(Ref, NumAcceptors, Transport, TransOpts, Protocol, ProtoOpts) → supervisor:child_spec()</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
Ref = ref()
@@ -196,7 +196,7 @@ Listener name. </p>
</dd>
<dt class="hdlist1">
-NbAcceptors = non_neg_integer()
+NumAcceptors = non_neg_integer()
</dt>
<dd>
<p>
@@ -405,7 +405,7 @@ New protocol options. Old connections will not receive the new options.</p></div>
</div>
<div class="sect2">
-<h3 id="_start_listener_ref_nbacceptors_transport_transopts_protocol_protoopts_8594_ok_pid_error_badarg">start_listener(Ref, NbAcceptors, Transport, TransOpts, Protocol, ProtoOpts) → {ok, pid()} | {error, badarg}</h3>
+<h3 id="_start_listener_ref_numacceptors_transport_transopts_protocol_protoopts_8594_ok_pid_error_badarg">start_listener(Ref, NumAcceptors, Transport, TransOpts, Protocol, ProtoOpts) → {ok, pid()} | {error, badarg}</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
Ref = ref()
@@ -416,7 +416,7 @@ Listener name. </p>
</dd>
<dt class="hdlist1">
-NbAcceptors = non_neg_integer()
+NumAcceptors = non_neg_integer()
</dt>
<dd>
<p>
diff --git a/docs/en/ranch/1.2/manual/ranch_app/index.html b/docs/en/ranch/1.2/manual/ranch_app/index.html index 69de0340..24123477 100644 --- a/docs/en/ranch/1.2/manual/ranch_app/index.html +++ b/docs/en/ranch/1.2/manual/ranch_app/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: ranch(7)</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> diff --git a/docs/en/ranch/1.2/manual/ranch_protocol/index.html b/docs/en/ranch/1.2/manual/ranch_protocol/index.html index 80c1043a..27eb6c9d 100644 --- a/docs/en/ranch/1.2/manual/ranch_protocol/index.html +++ b/docs/en/ranch/1.2/manual/ranch_protocol/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: ranch_protocol(3)</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> diff --git a/docs/en/ranch/1.2/manual/ranch_ssl/index.html b/docs/en/ranch/1.2/manual/ranch_ssl/index.html index 4cbea083..9fe7c6a6 100644 --- a/docs/en/ranch/1.2/manual/ranch_ssl/index.html +++ b/docs/en/ranch/1.2/manual/ranch_ssl/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: ranch_ssl(3)</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> diff --git a/docs/en/ranch/1.2/manual/ranch_tcp/index.html b/docs/en/ranch/1.2/manual/ranch_tcp/index.html index d1a201e1..44e289c5 100644 --- a/docs/en/ranch/1.2/manual/ranch_tcp/index.html +++ b/docs/en/ranch/1.2/manual/ranch_tcp/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: ranch_tcp(3)</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> @@ -106,6 +106,7 @@ http://www.gnu.org/software/src-highlite --> | <span style="color: #FF6600">inet</span>
| <span style="color: #FF6600">inet6</span>
| {<span style="color: #FF6600">ip</span>, <span style="font-weight: bold"><span style="color: #000000">inet:ip_address</span></span>()}
+ | {<span style="color: #FF6600">ipv6_v6only</span>, <span style="font-weight: bold"><span style="color: #000000">boolean</span></span>()}
| {<span style="color: #FF6600">keepalive</span>, <span style="font-weight: bold"><span style="color: #000000">boolean</span></span>()}
| {<span style="color: #FF6600">linger</span>, {<span style="font-weight: bold"><span style="color: #000000">boolean</span></span>(), <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>()}}
| {<span style="color: #FF6600">low_msgq_watermark</span>, <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>()}
@@ -229,6 +230,14 @@ ip </p>
</dd>
<dt class="hdlist1">
+ipv6_v6only (false)
+</dt>
+<dd>
+<p>
+ Listen on IPv4 and IPv6 (false) or only on IPv6 (true). Use with inet6.
+</p>
+</dd>
+<dt class="hdlist1">
keepalive (false)
</dt>
<dd>
diff --git a/docs/en/ranch/1.2/manual/ranch_transport/index.html b/docs/en/ranch/1.2/manual/ranch_transport/index.html index ad1784fd..9bfb4786 100644 --- a/docs/en/ranch/1.2/manual/ranch_transport/index.html +++ b/docs/en/ranch/1.2/manual/ranch_transport/index.html @@ -11,7 +11,7 @@ <title>Nine Nines: ranch_transport(3)</title> - <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> <link href="/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/99s.css" rel="stylesheet"> diff --git a/docs/en/ranch/index.html b/docs/en/ranch/index.html index c1eedb2f..ea24e654 100644 --- a/docs/en/ranch/index.html +++ b/docs/en/ranch/index.html @@ -1 +1 @@ -<!DOCTYPE html><html><head><link rel="canonical" href="http://ninenines.eu/docs/"/><meta http-equiv="content-type" content="text/html; charset=utf-8" /><meta http-equiv="refresh" content="0;url=http://ninenines.eu/docs/" /></head></html>
\ No newline at end of file +<!DOCTYPE html><html><head><link rel="canonical" href="https://ninenines.eu/docs/"/><meta http-equiv="content-type" content="text/html; charset=utf-8" /><meta http-equiv="refresh" content="0;url=https://ninenines.eu/docs/" /></head></html>
\ No newline at end of file |