aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/gun_app.asciidoc
blob: c3690958518c5b3888adaeb9e197e88657d7e1cf (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
= gun(7)

== Name

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

* link:man:gun(3)[gun(3)] - Asynchronous HTTP client

== Dependencies

* link:man:cowlib(7)[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:

[source,erlang]
----
{ok, _} = application:ensure_all_started(gun).
----

== Environment

The `gun` application does not define any application
environment configuration parameters.

== See also

link:man:cowlib(7)[cowlib(7)]