123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="x-ua-compatible" content="ie=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <meta name="generator" content="ExDoc v0.18.3">
- <title>KomutanWeb – komutan v0.1.0</title>
- <link rel="stylesheet" href="dist/app-480ffdc169.css" />
-
- <script src="dist/sidebar_items-fdb4f87f8a.js"></script>
-
-
-
-
- </head>
- <body data-type="modules">
- <script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>
- <div class="main">
- <button class="sidebar-button sidebar-toggle">
- <span class="icon-menu" aria-hidden="true"></span>
- <span class="sr-only">Toggle Sidebar</span>
- </button>
- <button class="sidebar-button night-mode-toggle">
- <span class="icon-theme" aria-hidden="true"></span>
- <span class="sr-only">Toggle Theme</span>
- </button>
- <section class="sidebar">
-
- <a href="api-reference.html" class="sidebar-projectLink">
- <div class="sidebar-projectDetails">
- <h1 class="sidebar-projectName">
- komutan
- </h1>
- <h2 class="sidebar-projectVersion">
- v0.1.0
- </h2>
- </div>
-
- </a>
- <form class="sidebar-search" action="search.html">
- <button type="submit" class="search-button">
- <span class="icon-search" aria-hidden="true"></span>
- </button>
- <input name="q" type="text" id="search-list" class="search-input" placeholder="Search" aria-label="Search" autocomplete="off" />
- </form>
- <ul class="sidebar-listNav">
- <li><a id="extras-list" href="#full-list">Pages</a></li>
-
- <li><a id="modules-list" href="#full-list">Modules</a></li>
-
-
-
- </ul>
- <div class="gradient"></div>
- <ul id="full-list" class="sidebar-fullList"></ul>
- </section>
- <section class="content">
- <div class="content-outer">
- <div id="content" class="content-inner">
- <h1>
- <small class="visible-xs">komutan v0.1.0</small>
- KomutanWeb
-
- </h1>
-
-
- <section id="summary" class="details-list">
- <h1 class="section-heading">
- <a class="hover-link" href="#summary">
- <span class="icon-link" aria-hidden="true"></span>
- <span class="sr-only">Link to this section</span>
- </a>
- Summary
- </h1>
-
-
- <div class="summary-functions summary">
- <h2>
- <a href="#functions">Functions</a>
- </h2>
- <div class="summary-row">
- <div class="summary-signature">
- <a href="#start/2">start(type, args)</a>
- </div>
-
- <div class="summary-synopsis"><p>Called when an application is started</p>
- </div>
-
- </div>
- </div>
-
- </section>
-
-
-
- <section id="functions" class="details-list">
- <h1 class="section-heading">
- <a class="hover-link" href="#functions">
- <span class="icon-link" aria-hidden="true"></span>
- <span class="sr-only">Link to this section</span>
- </a>
- Functions
- </h1>
- <div class="detail" id="start/2">
-
-
- <div class="detail-header">
- <a href="#start/2" class="detail-link" title="Link to this function">
- <span class="icon-link" aria-hidden="true"></span>
- <span class="sr-only">Link to this function</span>
- </a>
- <span class="signature">start(type, args)</span>
-
-
-
- </div>
- <section class="docstring">
- <p>Called when an application is started.</p>
- <p>This function is called when an application is started using
- <a href="https://hexdocs.pm/elixir/Application.html#start/2"><code class="inline">Application.start/2</code></a> (and functions on top of that, such as
- <a href="https://hexdocs.pm/elixir/Application.html#ensure_started/2"><code class="inline">Application.ensure_started/2</code></a>). This function should start the top-level
- process of the application (which should be the top supervisor of the
- application’s supervision tree if the application follows the OTP design
- principles around supervision).</p>
- <p><code class="inline">start_type</code> defines how the application is started:</p>
- <ul>
- <li><code class="inline">:normal</code> - used if the startup is a normal startup or if the application
- is distributed and is started on the current node because of a failover
- from another node and the application specification key <code class="inline">:start_phases</code>
- is <code class="inline">:undefined</code>.
- </li>
- <li><code class="inline">{:takeover, node}</code> - used if the application is distributed and is
- started on the current node because of a failover on the node <code class="inline">node</code>.
- </li>
- <li><code class="inline">{:failover, node}</code> - used if the application is distributed and is
- started on the current node because of a failover on node <code class="inline">node</code>, and the
- application specification key <code class="inline">:start_phases</code> is not <code class="inline">:undefined</code>.
- </li>
- </ul>
- <p><code class="inline">start_args</code> are the arguments passed to the application in the <code class="inline">:mod</code>
- specification key (e.g., <code class="inline">mod: {MyApp, [:my_args]}</code>).</p>
- <p>This function should either return <code class="inline">{:ok, pid}</code> or <code class="inline">{:ok, pid, state}</code> if
- startup is successful. <code class="inline">pid</code> should be the PID of the top supervisor. <code class="inline">state</code>
- can be an arbitrary term, and if omitted will default to <code class="inline">[]</code>; if the
- application is later stopped, <code class="inline">state</code> is passed to the <code class="inline">stop/1</code> callback (see
- the documentation for the <code class="inline">c:stop/1</code> callback for more information).</p>
- <p><code class="inline">use Application</code> provides no default implementation for the <a href="#start/2"><code class="inline">start/2</code></a>
- callback.</p>
- <p>Callback implementation for <a href="https://hexdocs.pm/elixir/Application.html#c:start/2"><code class="inline">Application.start/2</code></a>.</p>
- </section>
- </div>
- </section>
-
-
- <footer class="footer">
- <p>
- <span class="line">
- Built using
- <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.18.3),
- </span>
- <span class="line">
- designed by
- <a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.
- </span>
- </p>
- </footer>
- </div>
- </div>
- </section>
- </div>
- <script src="dist/app-9bd040e5e5.js"></script>
-
-
-
-
- </body>
- </html>
|