KomutanWeb.html 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="x-ua-compatible" content="ie=edge">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <meta name="generator" content="ExDoc v0.18.3">
  8. <title>KomutanWeb – komutan v0.1.0</title>
  9. <link rel="stylesheet" href="dist/app-480ffdc169.css" />
  10. <script src="dist/sidebar_items-fdb4f87f8a.js"></script>
  11. </head>
  12. <body data-type="modules">
  13. <script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>
  14. <div class="main">
  15. <button class="sidebar-button sidebar-toggle">
  16. <span class="icon-menu" aria-hidden="true"></span>
  17. <span class="sr-only">Toggle Sidebar</span>
  18. </button>
  19. <button class="sidebar-button night-mode-toggle">
  20. <span class="icon-theme" aria-hidden="true"></span>
  21. <span class="sr-only">Toggle Theme</span>
  22. </button>
  23. <section class="sidebar">
  24. <a href="api-reference.html" class="sidebar-projectLink">
  25. <div class="sidebar-projectDetails">
  26. <h1 class="sidebar-projectName">
  27. komutan
  28. </h1>
  29. <h2 class="sidebar-projectVersion">
  30. v0.1.0
  31. </h2>
  32. </div>
  33. </a>
  34. <form class="sidebar-search" action="search.html">
  35. <button type="submit" class="search-button">
  36. <span class="icon-search" aria-hidden="true"></span>
  37. </button>
  38. <input name="q" type="text" id="search-list" class="search-input" placeholder="Search" aria-label="Search" autocomplete="off" />
  39. </form>
  40. <ul class="sidebar-listNav">
  41. <li><a id="extras-list" href="#full-list">Pages</a></li>
  42. <li><a id="modules-list" href="#full-list">Modules</a></li>
  43. </ul>
  44. <div class="gradient"></div>
  45. <ul id="full-list" class="sidebar-fullList"></ul>
  46. </section>
  47. <section class="content">
  48. <div class="content-outer">
  49. <div id="content" class="content-inner">
  50. <h1>
  51. <small class="visible-xs">komutan v0.1.0</small>
  52. KomutanWeb
  53. </h1>
  54. <section id="summary" class="details-list">
  55. <h1 class="section-heading">
  56. <a class="hover-link" href="#summary">
  57. <span class="icon-link" aria-hidden="true"></span>
  58. <span class="sr-only">Link to this section</span>
  59. </a>
  60. Summary
  61. </h1>
  62. <div class="summary-functions summary">
  63. <h2>
  64. <a href="#functions">Functions</a>
  65. </h2>
  66. <div class="summary-row">
  67. <div class="summary-signature">
  68. <a href="#start/2">start(type, args)</a>
  69. </div>
  70. <div class="summary-synopsis"><p>Called when an application is started</p>
  71. </div>
  72. </div>
  73. </div>
  74. </section>
  75. <section id="functions" class="details-list">
  76. <h1 class="section-heading">
  77. <a class="hover-link" href="#functions">
  78. <span class="icon-link" aria-hidden="true"></span>
  79. <span class="sr-only">Link to this section</span>
  80. </a>
  81. Functions
  82. </h1>
  83. <div class="detail" id="start/2">
  84. <div class="detail-header">
  85. <a href="#start/2" class="detail-link" title="Link to this function">
  86. <span class="icon-link" aria-hidden="true"></span>
  87. <span class="sr-only">Link to this function</span>
  88. </a>
  89. <span class="signature">start(type, args)</span>
  90. </div>
  91. <section class="docstring">
  92. <p>Called when an application is started.</p>
  93. <p>This function is called when an application is started using
  94. <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
  95. <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
  96. process of the application (which should be the top supervisor of the
  97. application’s supervision tree if the application follows the OTP design
  98. principles around supervision).</p>
  99. <p><code class="inline">start_type</code> defines how the application is started:</p>
  100. <ul>
  101. <li><code class="inline">:normal</code> - used if the startup is a normal startup or if the application
  102. is distributed and is started on the current node because of a failover
  103. from another node and the application specification key <code class="inline">:start_phases</code>
  104. is <code class="inline">:undefined</code>.
  105. </li>
  106. <li><code class="inline">{:takeover, node}</code> - used if the application is distributed and is
  107. started on the current node because of a failover on the node <code class="inline">node</code>.
  108. </li>
  109. <li><code class="inline">{:failover, node}</code> - used if the application is distributed and is
  110. started on the current node because of a failover on node <code class="inline">node</code>, and the
  111. application specification key <code class="inline">:start_phases</code> is not <code class="inline">:undefined</code>.
  112. </li>
  113. </ul>
  114. <p><code class="inline">start_args</code> are the arguments passed to the application in the <code class="inline">:mod</code>
  115. specification key (e.g., <code class="inline">mod: {MyApp, [:my_args]}</code>).</p>
  116. <p>This function should either return <code class="inline">{:ok, pid}</code> or <code class="inline">{:ok, pid, state}</code> if
  117. startup is successful. <code class="inline">pid</code> should be the PID of the top supervisor. <code class="inline">state</code>
  118. can be an arbitrary term, and if omitted will default to <code class="inline">[]</code>; if the
  119. application is later stopped, <code class="inline">state</code> is passed to the <code class="inline">stop/1</code> callback (see
  120. the documentation for the <code class="inline">c:stop/1</code> callback for more information).</p>
  121. <p><code class="inline">use Application</code> provides no default implementation for the <a href="#start/2"><code class="inline">start/2</code></a>
  122. callback.</p>
  123. <p>Callback implementation for <a href="https://hexdocs.pm/elixir/Application.html#c:start/2"><code class="inline">Application.start/2</code></a>.</p>
  124. </section>
  125. </div>
  126. </section>
  127. <footer class="footer">
  128. <p>
  129. <span class="line">
  130. Built using
  131. <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.18.3),
  132. </span>
  133. <span class="line">
  134. designed by
  135. <a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.
  136. </span>
  137. </p>
  138. </footer>
  139. </div>
  140. </div>
  141. </section>
  142. </div>
  143. <script src="dist/app-9bd040e5e5.js"></script>
  144. </body>
  145. </html>