diff options
author | Loïc Hoguin <[email protected]> | 2018-06-13 09:54:12 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2018-06-13 09:54:12 +0200 |
commit | 92b54aacc0de5446dd5497c39897b0bbff72e626 (patch) | |
tree | c3a98cfec636d1271f5804e5c19b35b208bba00d /docs/en/ranch/1.4/manual/ranch_protocol/index.html | |
parent | 8b5c3dc972b99f174750123c9e4abc96259c34a9 (diff) | |
download | ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.tar.gz ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.tar.bz2 ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.zip |
Rebuild using Asciideck
Diffstat (limited to 'docs/en/ranch/1.4/manual/ranch_protocol/index.html')
-rw-r--r-- | docs/en/ranch/1.4/manual/ranch_protocol/index.html | 90 |
1 files changed, 21 insertions, 69 deletions
diff --git a/docs/en/ranch/1.4/manual/ranch_protocol/index.html b/docs/en/ranch/1.4/manual/ranch_protocol/index.html index 333d8fe8..a54db606 100644 --- a/docs/en/ranch/1.4/manual/ranch_protocol/index.html +++ b/docs/en/ranch/1.4/manual/ranch_protocol/index.html @@ -62,83 +62,33 @@ <h1 class="lined-header"><span>ranch_protocol(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>ranch_protocol - behaviour for protocol modules</p></div> -</div> -</div> -<div class="sect1"> +<p>ranch_protocol - behaviour for protocol modules</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The <code>ranch_protocol</code> behaviour defines the interface used -by Ranch protocols.</p></div> -</div> -</div> -<div class="sect1"> +<p>The <code>ranch_protocol</code> behaviour defines the interface used by Ranch protocols.</p> <h2 id="_types">Types</h2> -<div class="sectionbody"> -<div class="paragraph"><p>None.</p></div> -</div> -</div> -<div class="sect1"> +<p>None.</p> <h2 id="_callbacks">Callbacks</h2> -<div class="sectionbody"> -<div class="sect2"> -<h3 id="_start_link_ref_socket_transport_protoopts_8594_ok_pid_ok_pid_pid">start_link(Ref, Socket, Transport, ProtoOpts) → {ok, pid()} | {ok, pid(), pid()}</h3> -<div class="dlist"><dl> -<dt class="hdlist1"> -Ref = ranch:ref() -</dt> -<dd> -<p> -Listener name. -</p> +<h3 id="_start_link_ref__socket__transport__protoopts______ok__pid_______ok__pid____pid">start_link(Ref, Socket, Transport, ProtoOpts) -> {ok, pid()} | {ok, pid(), pid()}</h3> +<dl><dt>Ref = ranch:ref()</dt> +<dd><p>Listener name.</p> </dd> -<dt class="hdlist1"> -Socket = any() -</dt> -<dd> -<p> -Socket for this connection. -</p> +<dt>Socket = any()</dt> +<dd><p>Socket for this connection.</p> </dd> -<dt class="hdlist1"> -Transport = module() -</dt> -<dd> -<p> -Transport module for this socket. -</p> +<dt>Transport = module()</dt> +<dd><p>Transport module for this socket.</p> </dd> -<dt class="hdlist1"> -ProtoOpts = any() -</dt> -<dd> -<p> -Protocol options. -</p> +<dt>ProtoOpts = any()</dt> +<dd><p>Protocol options.</p> </dd> -</dl></div> -<div class="paragraph"><p>Start a new connection process for the given socket.</p></div> -<div class="paragraph"><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></div> -<div class="paragraph"><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></div> -<div class="paragraph"><p>If any other value is returned, the supervisor will close the -socket and assume no process has been started.</p></div> -<div class="paragraph"><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></div> -</div> -</div> -</div> +</dl> +<p>Start a new connection process for the given socket.</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> + @@ -173,6 +123,8 @@ processes and degrade performance severely.</p></div> + <li><a href="/docs/en/ranch/1.5/manual">1.5</a></li> + <li><a href="/docs/en/ranch/1.4/manual">1.4</a></li> <li><a href="/docs/en/ranch/1.3/manual">1.3</a></li> |