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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
= gun(3)
== Name
gun - Asynchronous HTTP client
== Description
The `gun` module provides an asynchronous interface for
connecting and communicating with Web servers over HTTP,
HTTP/2 or Websocket.
== Exports
Connection:
* link:man:gun:open(3)[gun:open(3)] - Open a connection to the given host and port
* link:man:gun:open_unix(3)[gun:open_unix(3)] - Open a connection to the given Unix domain socket
// @todo * link:man:gun:shutdown(3)[gun:shutdown(3)] - Gracefully close the connection
* link:man:gun:close(3)[gun:close(3)] - Brutally close the connection
* link:man:gun:info(3)[gun:info(3)] - Obtain information about the connection
Requests:
* link:man:gun:get(3)[gun:get(3)] - Get a resource representation
* link:man:gun:head(3)[gun:head(3)] - Get headers of a resource representation
* link:man:gun:options(3)[gun:options(3)] - Query the capabilities of the server or a resource
* link:man:gun:patch(3)[gun:patch(3)] - Apply a set of changes to a resource
* link:man:gun:post(3)[gun:post(3)] - Process the enclosed representation according to a resource's own semantics
* link:man:gun:put(3)[gun:put(3)] - Create or replace a resource
* link:man:gun:delete(3)[gun:delete(3)] - Delete a resource
* link:man:gun:request(3)[gun:request(3)] - Perform the given request
* link:man:gun:data(3)[gun:data(3)] - Stream the body of a request
Messages:
* link:man:gun:await(3)[gun:await(3)] - Wait for a response
* link:man:gun:await_body(3)[gun:await_body(3)] - Wait for the complete response body
* link:man:gun:await_up(3)[gun:await(3)] - Wait for the connection to be up
* link:man:gun:flush(3)[gun:flush(3)] - Flush all messages related to a connection or a stream
Streams:
* link:man:gun:cancel(3)[gun:cancel(3)] - Cancel the given stream
Websocket:
* link:man:gun:ws_upgrade(3)[gun:ws_upgrade(3)] - Upgrade to Websocket
* link:man:gun:ws_send(3)[gun:ws_send(3)] - Send one or more Websocket frame(s)
== Messages
Gun will inform the calling process of events asynchronously
by sending any of the following messages:
Connection:
* link:man:gun_up(3)[gun_up(3)] - The connection is up
* link:man:gun_down(3)[gun_down(3)] - The connection is down
* link:man:gun_upgrade(3)[gun_upgrade(3)] - Successful protocol upgrade
* link:man:gun_error(3)[gun_error(3)] - Stream or connection-wide error
Responses:
* link:man:gun_push(3)[gun_push(3)] - Server-initiated push
* link:man:gun_inform(3)[gun_inform(3)] - Informational response
* link:man:gun_response(3)[gun_response(3)] - Response
* link:man:gun_data(3)[gun_data(3)] - Response body
* link:man:gun_trailers(3)[gun_trailers(3)] - Response trailers
Websocket:
* link:man:gun_ws(3)[gun_ws(3)] - Websocket frame
The response messages will be sent to the process that opened
the connection by default. The `reply_to` request option can
be used to redirect request-specific messages to a different
process.
== Types
=== http_opts()
[source,erlang]
----
http_opts() :: #{
keepalive => timeout(),
transform_header_name => fun((binary()) -> binary()),
version => 'HTTP/1.1' | 'HTTP/1.0'
}
----
Configuration for the HTTP protocol.
The default value is given next to the option name:
// @todo Document content_handlers and gun_sse_h.
keepalive (5000)::
Time between pings in milliseconds. Since the HTTP protocol has
no standardized way to ping the server, Gun will simply send an
empty line when the connection is idle. Gun only makes a best
effort here as servers usually have configurable limits to drop
idle connections. Use `infinity` to disable.
transform_header_name - see below::
A function that will be applied to all header names before they
are sent to the server. Gun assumes that all header names are in
lower case. This function is useful if you, for example, need to
re-case header names in the event that the server incorrectly
considers the case of header names to be significant.
version (`'HTTP/1.1'`)::
HTTP version to use.
=== http2_opts()
[source,erlang]
----
http2_opts() :: #{
keepalive => timeout()
}
----
Configuration for the HTTP/2 protocol.
The default value is given next to the option name:
// @todo Document content_handlers and gun_sse_h.
keepalive (5000)::
Time between pings in milliseconds.
// @todo Allow and document max_frame_size_sent.
=== opts()
[source,erlang]
----
opts() :: #{
connect_timeout => timeout(),
http_opts => http_opts(),
http2_opts => http2_opts(),
protocols => [http | http2],
retry => non_neg_integer(),
retry_timeout => pos_integer(),
trace => boolean(),
transport => tcp | ssl,
transport_opts => [gen_tcp:connect_option()] | [ssl:connect_option()],
ws_opts => ws_opts()
}
----
Configuration for the connection.
The default value is given next to the option name:
connect_timeout (infinity)::
Connection timeout.
http_opts (#{})::
Options specific to the HTTP protocol.
http2_opts (#{})::
Options specific to the HTTP/2 protocol.
protocols - see below::
Ordered list of preferred protocols. When the transport is `tcp`,
this list must contain exactly one protocol. When the transport
is `ssl`, this list must contain at least one protocol and will be
used to negotiate a protocol via ALPN. When the server does not
support ALPN then `http` will always be used. Defaults to
`[http]` when the transport is `tcp`, and `[http2, http]` when the
transport is `ssl`.
retry (5)::
Number of times Gun will try to reconnect on failure before giving up.
retry_timeout (5000)::
Time between retries in milliseconds.
trace (false)::
Whether to enable `dbg` tracing of the connection process. Should
only be used during debugging.
transport - see below::
Whether to use SSL or plain TCP. The default varies depending on the
port used. Port 443 defaults to `ssl`. All other ports default to `tcp`.
transport_opts ([])::
Transport options. They are TCP options or SSL options depending on
the selected transport.
ws_opts (#{})::
Options specific to the Websocket protocol.
=== req_opts()
[source,erlang]
----
req_opts() :: #{
reply_to => pid()
}
----
Configuration for a particular request.
The default value is given next to the option name:
reply_to (`self()`)::
The pid of the process that will receive the response messages.
=== ws_opts()
[source,erlang]
----
ws_opts() :: #{
compress => boolean()
}
----
Configuration for the Websocket protocol.
The default value is given next to the option name:
compress => boolean()::
Whether to enable permessage-deflate compression. This does
not guarantee that compression will be used as it is the
server that ultimately decides. Defaults to false.
// @todo Document default_protocol, protocols and user_opts.
== See also
link:man:gun(7)[gun(7)]
|
