From 2b588340af501825f3ab03f2e76dba0353c98fae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 4 Jun 2018 12:59:26 +0200 Subject: Update documentation for Gun 1.0 --- docs/en/gun/1.0/manual/gun_app/index.html | 62 ++++++++++++++++++++++++------- 1 file changed, 49 insertions(+), 13 deletions(-) (limited to 'docs/en/gun/1.0/manual/gun_app') 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 @@ - - Nine Nines: gun(7) @@ -67,22 +65,54 @@

Name

-

gun - Erlang HTTP client with support for HTTP/1.1, HTTP/2 and Websocket.

+

gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP

+
+
+
+

Description

+
+

Gun is an HTTP client for Erlang/OTP with support for the +HTTP/1.1, HTTP/2 and Websocket protocols.

+

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.

+
+
+
+

Modules

+
+
    +
  • +

    +gun(3) - Asynchronous HTTP client +

    +
    • +

Dependencies

-

The gun application uses the Erlang applications ranch -for abstracting TCP and TLS over a common interface, and -the ssl application for TLS support, required for HTTPS -and secure HTTP/2 support. In addition, Gun requires the crypto -application (a dependency of ssl) for Websocket.

-

These dependencies must be started for the gun -application to work. In an embedded environment -this means that they need to be started with the -application:start/{1,2} function before the gun -application is started.

+
    +
  • +

    +cowlib(7) - Support library for manipulating Web protocols +

    +
    • +
  • +

    +ssl - Secure communication over sockets +

    +
    • +
+

All these applications must be started before the gun +application. To start Gun and all dependencies at once:

+
+
+
{ok, _} = application:ensure_all_started(gun).
@@ -92,6 +122,12 @@ application is started.

environment configuration parameters.

+
+

See also

+
+

cowlib(7)

+
+
-- cgit v1.2.3