diff options
author | Loïc Hoguin <[email protected]> | 2021-09-09 12:15:32 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2021-09-09 12:15:32 +0200 |
commit | 992831c7a516b5183c2af06260829d41aa45267c (patch) | |
tree | 4e874d3aa4fff73455fce70c5a184c171858d02f /docs/en/ranch/1.5/guide/embedded/index.html | |
parent | 48f39402181d959cad88cb3f460210c007169f50 (diff) | |
download | ninenines.eu-992831c7a516b5183c2af06260829d41aa45267c.tar.gz ninenines.eu-992831c7a516b5183c2af06260829d41aa45267c.tar.bz2 ninenines.eu-992831c7a516b5183c2af06260829d41aa45267c.zip |
Ranch 2.1.0
Diffstat (limited to 'docs/en/ranch/1.5/guide/embedded/index.html')
-rw-r--r-- | docs/en/ranch/1.5/guide/embedded/index.html | 202 |
1 files changed, 0 insertions, 202 deletions
diff --git a/docs/en/ranch/1.5/guide/embedded/index.html b/docs/en/ranch/1.5/guide/embedded/index.html deleted file mode 100644 index 92bce4ec..00000000 --- a/docs/en/ranch/1.5/guide/embedded/index.html +++ /dev/null @@ -1,202 +0,0 @@ -<!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: Embedded mode</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>Embedded mode</span></h1> - -<p>Embedded mode allows you to insert Ranch listeners directly in your supervision tree. This allows for greater fault tolerance control by permitting the shutdown of a listener due to the failure of another part of the application and vice versa.</p> -<h2 id="_embedding">Embedding</h2> -<p>To embed Ranch in your application you can simply add the child specs to your supervision tree. This can all be done in the <code>init/1</code> function of one of your application supervisors.</p> -<p>Ranch requires at the minimum two kinds of child specs for embedding. First, you need to add <code>ranch_sup</code> to your supervision tree, only once, regardless of the number of listeners you will use. Then you need to add the child specs for each listener.</p> -<p>Ranch has a convenience function for getting the listeners child specs called <code>ranch:child_spec/5</code>, that works like <code>ranch:start_listener/5</code>, except that it doesn't start anything, it only returns child specs.</p> -<p>As for <code>ranch_sup</code>, the child spec is simple enough to not require a convenience function.</p> -<p>The following example adds both <code>ranch_sup</code> and one listener to another application's supervision tree.</p> -<div class="listingblock"><div class="title">Embed Ranch directly in your supervision tree</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><b><font color="#000000">init</font></b>([]) <font color="#990000">-></font> - <font color="#009900">RanchSupSpec</font> <font color="#990000">=</font> {<font color="#FF6600">ranch_sup</font>, {<font color="#FF6600">ranch_sup</font>, <font color="#FF6600">start_link</font>, []}, - <font color="#FF6600">permanent</font>, <font color="#993399">5000</font>, <font color="#FF6600">supervisor</font>, [<font color="#FF6600">ranch_sup</font>]}, - <font color="#009900">ListenerSpec</font> <font color="#990000">=</font> <b><font color="#000000">ranch:child_spec</font></b>(<font color="#FF6600">echo</font>, <font color="#993399">100</font>, - <font color="#FF6600">ranch_tcp</font>, [{<font color="#FF6600">port</font>, <font color="#993399">5555</font>}], - <font color="#FF6600">echo_protocol</font>, [] - ), - {<font color="#FF6600">ok</font>, {{<font color="#FF6600">one_for_one</font>, <font color="#993399">10</font>, <font color="#993399">10</font>}, [<font color="#009900">RanchSupSpec</font>, <font color="#009900">ListenerSpec</font>]}}<font color="#990000">.</font></tt></pre> -</div></div> -<p>Remember, you can add as many listener child specs as needed, but only one <code>ranch_sup</code> spec!</p> -<p>It is recommended that your architecture makes sure that all listeners are restarted if <code>ranch_sup</code> fails. See the Ranch internals chapter for more details on how Ranch does it.</p> - - - - - - - - - - - - <nav style="margin:1em 0"> - - <a style="float:left" href="https://ninenines.eu/docs/en/ranch/1.5/guide/protocols/"> - Protocols - </a> - - - - <a style="float:right" href="https://ninenines.eu/docs/en/ranch/1.5/guide/parsers/"> - Writing parsers - </a> - - </nav> - - - - -</div> - -<div class="span3 sidecol"> - - -<h3> - Ranch - 1.5 - - User Guide -</h3> - -<ul> - - <li><a href="/docs/en/ranch/1.5/guide">User Guide</a></li> - - - <li><a href="/docs/en/ranch/1.5/manual">Function Reference</a></li> - - -</ul> - -<h4 id="docs-nav">Navigation</h4> - -<h4>Version select</h4> -<ul> - - - - <li><a href="/docs/en/ranch/2.0/guide">2.0</a></li> - - <li><a href="/docs/en/ranch/1.8/guide">1.8</a></li> - - <li><a href="/docs/en/ranch/1.7/guide">1.7</a></li> - - <li><a href="/docs/en/ranch/1.6/guide">1.6</a></li> - - <li><a href="/docs/en/ranch/1.5/guide">1.5</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> - - |