diff options
Diffstat (limited to 'docs/en/gun/1.0/manual/gun_app/index.html')
| -rw-r--r-- | docs/en/gun/1.0/manual/gun_app/index.html | 62 |
1 files changed, 49 insertions, 13 deletions
diff --git a/docs/en/gun/1.0/manual/gun_app/index.html b/docs/en/gun/1.0/manual/gun_app/index.html index 429cc0dd..de6942c4 100644 --- a/docs/en/gun/1.0/manual/gun_app/index.html +++ b/docs/en/gun/1.0/manual/gun_app/index.html @@ -7,8 +7,6 @@ <meta name="description" content=""> <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - <meta name="generator" content="Hugo 0.37.1" /> - <title>Nine Nines: gun(7)</title> <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> @@ -67,22 +65,54 @@ <div class="sect1"> <h2 id="_name">Name</h2> <div class="sectionbody"> -<div class="paragraph"><p>gun - Erlang HTTP client with support for HTTP/1.1, HTTP/2 and Websocket.</p></div> +<div class="paragraph"><p>gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP</p></div> +</div> +</div> +<div class="sect1"> +<h2 id="_description">Description</h2> +<div class="sectionbody"> +<div class="paragraph"><p>Gun is an HTTP client for Erlang/OTP with support for the +HTTP/1.1, HTTP/2 and Websocket protocols.</p></div> +<div class="paragraph"><p>Gun aims to provide an easy to use, asynchronous and +always-connected client. It maintains a permanent connection +to the server and reconnects automatically when necessary.</p></div> +</div> +</div> +<div class="sect1"> +<h2 id="_modules">Modules</h2> +<div class="sectionbody"> +<div class="ulist"><ul> +<li> +<p> +<a href="../gun">gun(3)</a> - Asynchronous HTTP client +</p> +</li> +</ul></div> </div> </div> <div class="sect1"> <h2 id="_dependencies">Dependencies</h2> <div class="sectionbody"> -<div class="paragraph"><p>The <code>gun</code> application uses the Erlang applications <code>ranch</code> -for abstracting TCP and TLS over a common interface, and -the <code>ssl</code> application for TLS support, required for HTTPS -and secure HTTP/2 support. In addition, Gun requires the <code>crypto</code> -application (a dependency of <code>ssl</code>) for Websocket.</p></div> -<div class="paragraph"><p>These dependencies must be started for the <code>gun</code> -application to work. In an embedded environment -this means that they need to be started with the -<code>application:start/{1,2}</code> function before the <code>gun</code> -application is started.</p></div> +<div class="ulist"><ul> +<li> +<p> +<a href="../cowlib">cowlib(7)</a> - Support library for manipulating Web protocols +</p> +</li> +<li> +<p> +ssl - Secure communication over sockets +</p> +</li> +</ul></div> +<div class="paragraph"><p>All these applications must be started before the <code>gun</code> +application. To start Gun and all dependencies at once:</p></div> +<div class="listingblock"> +<div class="content"><!-- Generator: GNU source-highlight +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<span style="color: #FF6600">ok</span>, <span style="color: #990000">_</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">application:ensure_all_started</span></span>(<span style="color: #FF6600">gun</span>)<span style="color: #990000">.</span></tt></pre></div></div> </div> </div> <div class="sect1"> @@ -92,6 +122,12 @@ application is started.</p></div> environment configuration parameters.</p></div> </div> </div> +<div class="sect1"> +<h2 id="_see_also">See also</h2> +<div class="sectionbody"> +<div class="paragraph"><p><a href="../cowlib">cowlib(7)</a></p></div> +</div> +</div> |