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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<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.30.2" />
<title>Nine Nines: Supported protocols</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'>
<link href="/css/99s.css?r=1" rel="stylesheet">
<link rel="shortcut icon" href="/img/ico/favicon.ico">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png">
<link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png">
</head>
<body class="">
<header id="page-head">
<div id="topbar" class="container">
<div class="row">
<div class="span2">
<h1 id="logo"><a href="/" title="99s">99s</a></h1>
</div>
<div class="span10">
<div id="side-header">
<nav>
<ul>
<li><a title="Hear my thoughts" href="/articles">Articles</a></li>
<li><a title="Watch my talks" href="/talks">Talks</a></li>
<li class="active"><a title="Read the docs" href="/docs">Documentation</a></li>
<li><a title="Request my services" href="/services">Consulting & Training</a></li>
</ul>
</nav>
<ul id="social">
<li>
<a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a>
</li>
<li>
<a title="Keep in touch!" href="http://twitter.com/lhoguin"><img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png"></a>
</li>
<li>
<a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a>
</li>
</ul>
</div>
</div>
</div>
</div>
</header>
<div id="contents" class="two_col">
<div class="container">
<div class="row">
<div id="docs" class="span9 maincol">
<h1 class="lined-header"><span>Supported protocols</span></h1>
<div class="paragraph"><p>This chapter describes the protocols supported and the
operations available to them.</p></div>
<div class="sect1">
<h2 id="_http_1_1">HTTP/1.1</h2>
<div class="sectionbody">
<div class="paragraph"><p>HTTP/1.1 is a text request-response protocol. The client
sends a request, the server sends back a response.</p></div>
<div class="paragraph"><p>Gun provides convenience functions for performing GET, HEAD,
OPTIONS, POST, PATCH, PUT, and DELETE requests. All these
functions are aliases of <code>gun:request/{4,5,6}</code> for each respective
methods. Gun also provides a <code>gun:data/4</code> function for streaming
the request body.</p></div>
<div class="paragraph"><p>Gun will send a <code>gun_response</code> message for every response
received, followed by zero or more <code>gun_data</code> messages for
the response body. If something goes wrong, a <code>gun_error</code>
will be sent instead.</p></div>
<div class="paragraph"><p>Gun provides convenience functions for dealing with messages.
The <code>gun:await/{2,3,4}</code> function waits for a response to the given
request, and the <code>gun:await_body/{2,3,4}</code> function for the
response’s body. The <code>gun:flush/1</code> function can be used to clear all
messages related to a request or a connection from the mailbox
of the process.</p></div>
<div class="paragraph"><p>The function <code>gun:cancel/2</code> can be used to silence the
response to a request previously sent if it is no longer
needed. When using HTTP/1.1 there is no multiplexing so
Gun will have to receive the response fully before any
other response can be received.</p></div>
<div class="paragraph"><p>Finally, Gun can upgrade an HTTP/1.1 connection to Websocket.
It provides the <code>gun:ws_upgrade/{2,3,4}</code> function for that
purpose. A <code>gun_ws_upgrade</code> message will be sent on success;
a <code>gun_response</code> message otherwise.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_http_2">HTTP/2</h2>
<div class="sectionbody">
<div class="paragraph"><p>HTTP/2 is a binary protocol based on HTTP, compatible with
the HTTP semantics, that reduces the complexity of parsing
requests and responses, compresses the HTTP headers and
allows the server to push multiple responses to a single
request.</p></div>
<div class="paragraph"><p>The HTTP/2 interface is very similar to HTTP/1.1, so this
section instead focuses on the differences in the interface
for the two protocols.</p></div>
<div class="paragraph"><p>Because a HTTP/2 server can push multiple responses to a
single request, Gun might send <code>gun_push</code> messages for
every push received. They can be ignored safely if they
are not needed.</p></div>
<div class="paragraph"><p>The <code>gun:cancel/2</code> function will use the HTTP/2 stream
cancellation mechanism which allows Gun to inform the
server to stop sending a response for this particular
request, saving resources.</p></div>
<div class="paragraph"><p>It is not possible to upgrade an HTTP/2 connection to Websocket
due to protocol limitations.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_websocket">Websocket</h2>
<div class="sectionbody">
<div class="paragraph"><p>Websocket is a binary protocol built on top of HTTP that
allows asynchronous concurrent communication between the
client and the server. A Websocket server can push data to
the client at any time.</p></div>
<div class="paragraph"><p>Websocket is only available as a connection upgrade over
an HTTP/1.1 connection.</p></div>
<div class="paragraph"><p>Once the Websocket connection is established, the only
operation available on this connection is sending Websocket
frames using <code>gun:ws_send/2</code>.</p></div>
<div class="paragraph"><p>Gun will send a <code>gun_ws</code> message for every frame received.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_summary">Summary</h2>
<div class="sectionbody">
<div class="paragraph"><p>The two following tables summarize the supported operations
and the messages Gun sends depending on the connection’s
current protocol.</p></div>
<div class="tableblock">
<table rules="all"
width="100%"
frame="border"
cellspacing="0" cellpadding="4">
<col width="25%" />
<col width="25%" />
<col width="25%" />
<col width="25%" />
<thead>
<tr>
<th align="left" valign="top"> Operation </th>
<th align="center" valign="top"> HTTP/1.1 </th>
<th align="center" valign="top"> HTTP/2 </th>
<th align="center" valign="top"> Websocket</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table">delete</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">get</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">head</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">options</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">patch</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">post</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">put</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">request</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">data</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">await</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">await_body</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">flush</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">cancel</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">ws_upgrade</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">ws_send</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
</tr>
</tbody>
</table>
</div>
<div class="tableblock">
<table rules="all"
width="100%"
frame="border"
cellspacing="0" cellpadding="4">
<col width="25%" />
<col width="25%" />
<col width="25%" />
<col width="25%" />
<thead>
<tr>
<th align="left" valign="top"> Message </th>
<th align="center" valign="top"> HTTP/1.1 </th>
<th align="center" valign="top"> HTTP/2 </th>
<th align="center" valign="top"> Websocket</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table">gun_push</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">gun_response</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">gun_data</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">gun_error (StreamRef)</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">gun_error</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">gun_ws_upgrade</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">gun_ws</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
<td align="center" valign="top"><p class="table">no</p></td>
<td align="center" valign="top"><p class="table">yes</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<nav style="margin:1em 0">
<a style="float:left" href="https://ninenines.eu/docs/en/gun/1.0/guide/start/">
Starting and stopping
</a>
<a style="float:right" href="https://ninenines.eu/docs/en/gun/1.0/guide/connect/">
Connection
</a>
</nav>
</div>
<div class="span3 sidecol">
<h3>
Gun
1.0
User Guide
</h3>
<ul>
<li><a href="/docs/en/gun/1.0/guide">User Guide</a></li>
<li><a href="/docs/en/gun/1.0/manual">Function Reference</a></li>
</ul>
<h4 id="docs-nav">Navigation</h4>
<h4>Version select</h4>
<ul>
<li><a href="/docs/en/gun/1.0/guide">1.0</a></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="span6">
<p id="scroll-top"><a href="#">↑ Scroll to top</a></p>
<nav>
<ul>
<li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li>
</ul>
</nav>
</div>
<div class="span6 credits">
<p><img src="/img/footer_logo.png"></p>
<p>Copyright © Loïc Hoguin 2012-2016</p>
</div>
</div>
</div>
</footer>
<script src="/js/custom.js"></script>
</body>
</html>
|
