diff options
Diffstat (limited to 'docs/en/cowboy/2.9/manual/cowboy.set_env/index.html')
| -rw-r--r-- | docs/en/cowboy/2.9/manual/cowboy.set_env/index.html | 211 |
1 files changed, 211 insertions, 0 deletions
diff --git a/docs/en/cowboy/2.9/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.9/manual/cowboy.set_env/index.html new file mode 100644 index 00000000..39ce7c5a --- /dev/null +++ b/docs/en/cowboy/2.9/manual/cowboy.set_env/index.html @@ -0,0 +1,211 @@ +<!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: cowboy:set_env(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>cowboy:set_env(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy:set_env - Update a listener's environment value</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_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> +<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>Key</dt> +<dd><p>The key in the environment map. Common keys include <code>dispatch</code> and <code>middlewares</code>.</p> +</dd> +<dt>Value</dt> +<dd><p>The new value.</p> +<p>The type of the value differs depending on the key.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<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> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Update a listener's routes</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">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>, []} + ]} +]), + +<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> +<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 class="span3 sidecol"> + + +<h3> + Cowboy + 2.9 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.9/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.9/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + + <li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li> + + <li><a href="/docs/en/cowboy/2.4/manual">2.4</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> + + |