diff options
Diffstat (limited to 'docs/en/gun/1.0/manual/gun_up')
-rw-r--r-- | docs/en/gun/1.0/manual/gun_up/index.html | 101 |
1 files changed, 26 insertions, 75 deletions
diff --git a/docs/en/gun/1.0/manual/gun_up/index.html b/docs/en/gun/1.0/manual/gun_up/index.html index ea61a339..0d0257ba 100644 --- a/docs/en/gun/1.0/manual/gun_up/index.html +++ b/docs/en/gun/1.0/manual/gun_up/index.html @@ -62,96 +62,47 @@ <h1 class="lined-header"><span>gun_up(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun_up - The connection is up</p></div> -</div> -</div> -<div class="sect1"> +<p>gun_up - The connection is up</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>{<span style="color: #FF6600">gun_up</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">Protocol</span>} - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">Protocol</span> <span style="color: #990000">::</span> <span style="color: #FF6600">http</span> | <span style="color: #FF6600">http2</span></tt></pre></div></div> -<div class="paragraph"><p>The connection is up.</p></div> -<div class="paragraph"><p>This message informs the owner process that the connection or -reconnection completed.</p></div> -<div class="paragraph"><p>Gun will now start processing the messages it received while -waiting for the connection to be up. If this is a reconnection, -then this may not be desirable for all requests. Those requests -should be cancelled when the connection goes down, and any -subsequent messages ignored.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">gun_up</font>, <font color="#009900">ConnPid</font>, <font color="#009900">Protocol</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Protocol</font> <font color="#990000">::</font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font></tt></pre> +</div></div> +<p>The connection is up.</p> +<p>This message informs the owner process that the connection or reconnection completed.</p> +<p>Gun will now start processing the messages it received while waiting for the connection to be up. If this is a reconnection, then this may not be desirable for all requests. Those requests should be cancelled when the connection goes down, and any subsequent messages ignored.</p> <h2 id="_elements">Elements</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -Protocol -</dt> -<dd> -<p> -The protocol selected for this connection. It can be used -to determine the capabilities of the server. -</p> +<dt>Protocol</dt> +<dd><p>The protocol selected for this connection. It can be used to determine the capabilities of the server.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Message introduced. -</p> +<ul><li><strong>1.0</strong>: Message introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Receive a gun_up message in a gen_server</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Receive a gun_up message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt><span style="font-weight: bold"><span style="color: #000000">handle_info</span></span>({<span style="color: #FF6600">gun_up</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">_Protocol</span>}, - <span style="color: #009900">State</span><span style="color: #990000">=</span><span style="color: #008080">#state</span>{<span style="color: #0000FF">conn_pid</span><span style="color: #990000">=</span><span style="color: #009900">ConnPid</span>}) <span style="color: #990000">-></span> - <span style="font-style: italic"><span style="color: #9A1900">%% Do something.</span></span> - {<span style="color: #FF6600">noreply</span>, <span style="color: #009900">State</span>}<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_up</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_Protocol</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.open">gun:open(3)</a>, -<a href="../gun.open_unix">gun:open_unix(3)</a>, -<a href="../gun.await_up">gun:await_up(3)</a>, -<a href="../gun_down">gun_down(3)</a>, -<a href="../gun_error">gun_error(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a>, <a href="../gun_down">gun_down(3)</a>, <a href="../gun_error">gun_error(3)</a></p> + |