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/cowboy/2.0/manual/cowboy.set_env | |
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/cowboy/2.0/manual/cowboy.set_env')
-rw-r--r-- | docs/en/cowboy/2.0/manual/cowboy.set_env/index.html | 124 |
1 files changed, 33 insertions, 91 deletions
diff --git a/docs/en/cowboy/2.0/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.0/manual/cowboy.set_env/index.html index 1852ba03..13b12f32 100644 --- a/docs/en/cowboy/2.0/manual/cowboy.set_env/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy.set_env/index.html @@ -62,117 +62,59 @@ <h1 class="lined-header"><span>cowboy:set_env(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>cowboy:set_env - Update a listener’s environment value</p></div> -</div> -</div> -<div class="sect1"> +<p>cowboy:set_env - Update a listener's environment value</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="font-weight: bold"><span style="color: #000000">set_env</span></span>(<span style="color: #009900">Name</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">ranch:ref</span></span>(), - <span style="color: #009900">Key</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">atom</span></span>(), - <span style="color: #009900">Value</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">any</span></span>()) - <span style="color: #990000">-></span> <span style="color: #FF6600">ok</span></tt></pre></div></div> -<div class="paragraph"><p>Set or update an environment value for a previously started -listener.</p></div> -<div class="paragraph"><p>This is most useful for updating the routes dynamically, -without having to restart the listener.</p></div> -<div class="paragraph"><p>The new value will only be available to new connections. -Pre-existing connections will still use the old value.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">set_env</font></b>(<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000000">ranch:ref</font></b>(), + <font color="#009900">Key</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>(), + <font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()) + <font color="#990000">-></font> <font color="#FF6600">ok</font></tt></pre> +</div></div> +<p>Set or update an environment value for a previously started listener.</p> +<p>This is most useful for updating the routes dynamically, without having to restart the listener.</p> +<p>The new value will only be available to new connections. Pre-existing connections will still use the old value.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -Name -</dt> -<dd> -<p> -The name of the listener to update. -</p> -<div class="paragraph"><p>The name of the listener is the first argument given to the -<a href="../cowboy.start_clear">cowboy:start_clear(3)</a>, -<a href="../cowboy.start_tls">cowboy:start_tls(3)</a> or -<a href="../ranch.start_listener">ranch:start_listener(3)</a> function.</p></div> +<dl><dt>Name</dt> +<dd><p>The name of the listener to update.</p> +<p>The name of the listener is the first argument given to the <a href="../cowboy.start_clear">cowboy:start_clear(3)</a>, <a href="../cowboy.start_tls">cowboy:start_tls(3)</a> or <a href="../ranch.start_listener">ranch:start_listener(3)</a> function.</p> </dd> -<dt class="hdlist1"> -Key -</dt> -<dd> -<p> -The key in the environment map. Common keys include <code>dispatch</code> -and <code>middlewares</code>. -</p> +<dt>Key</dt> +<dd><p>The key in the environment map. Common keys include <code>dispatch</code> and <code>middlewares</code>.</p> </dd> -<dt class="hdlist1"> -Value -</dt> -<dd> -<p> -The new value. -</p> -<div class="paragraph"><p>The type of the value differs depending on the key.</p></div> +<dt>Value</dt> +<dd><p>The new value.</p> +<p>The type of the value differs depending on the key.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The atom <code>ok</code> is returned on success.</p></div> -<div class="paragraph"><p>An <code>exit:badarg</code> exception is thrown when the listener does -not exist.</p></div> -</div> -</div> -<div class="sect1"> +<p>The atom <code>ok</code> is returned on success.</p> +<p>An <code>exit:badarg</code> exception is thrown when the listener does not exist.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Update a listener’s routes</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Update a listener's routes</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="color: #009900">Dispatch</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">cowboy_router:compile</span></span>([ - {<span style="color: #FF6600">'_'</span>, [ - {<span style="color: #FF0000">"/"</span>, <span style="color: #FF6600">toppage_h</span>, []}, - {<span style="color: #FF0000">"/ws"</span>, <span style="color: #FF6600">websocket_h</span>, []} +<pre><tt><font color="#009900">Dispatch</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_router:compile</font></b>([ + {<font color="#FF6600">'_'</font>, [ + {<font color="#FF0000">"/"</font>, <font color="#FF6600">toppage_h</font>, []}, + {<font color="#FF0000">"/ws"</font>, <font color="#FF6600">websocket_h</font>, []} ]} ]), -<span style="font-weight: bold"><span style="color: #000000">cowboy:set_env</span></span>(<span style="color: #FF6600">example</span>, <span style="color: #FF6600">dispatch</span>, <span style="color: #009900">Dispatch</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<b><font color="#000000">cowboy:set_env</font></b>(<font color="#FF6600">example</font>, <font color="#FF6600">dispatch</font>, <font color="#009900">Dispatch</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../cowboy">cowboy(3)</a>, -<a href="../cowboy.start_clear">cowboy:start_clear(3)</a>, -<a href="../cowboy.start_tls">cowboy:start_tls(3)</a>, -<a href="../ranch.set_protocol_options">ranch:set_protocol_options(3)</a></p></div> -</div> -</div> +<p><a href="../cowboy">cowboy(3)</a>, <a href="../cowboy.start_clear">cowboy:start_clear(3)</a>, <a href="../cowboy.start_tls">cowboy:start_tls(3)</a>, <a href="../ranch.set_protocol_options">ranch:set_protocol_options(3)</a></p> + |