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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
|
<!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: ranch_transport(3)</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>ranch_transport(3)</span></h1>
<div class="sect1">
<h2 id="_name">Name</h2>
<div class="sectionbody">
<div class="paragraph"><p>ranch_transport - behaviour for transport modules</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_description">Description</h2>
<div class="sectionbody">
<div class="paragraph"><p>The <code>ranch_transport</code> behaviour defines the interface used
by Ranch transports.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_types">Types</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_sendfile_opts_chunk_size_non_neg_integer">sendfile_opts() = [{chunk_size, non_neg_integer()}]</h3>
<div class="paragraph"><p>Options used by the sendfile function and callbacks.</p></div>
<div class="paragraph"><p>Allows configuring the chunk size, in bytes. Defaults to 8191 bytes.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_callbacks">Callbacks</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_accept_lsocket_timeout_8594_ok_csocket_error_closed_timeout_atom">accept(LSocket, Timeout) → {ok, CSocket} | {error, closed | timeout | atom()}</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
LSocket = CSocket = any()
</dt>
<dd>
<p>
Listening socket.
</p>
</dd>
<dt class="hdlist1">
Timeout = timeout()
</dt>
<dd>
<p>
Accept timeout.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Accept a connection on the given listening socket.</p></div>
<div class="paragraph"><p>The <code>accept_ack</code> callback will be used to initialize the socket
after accepting the connection. This is most useful when the
transport is not raw TCP, like with SSL for example.</p></div>
</div>
<div class="sect2">
<h3 id="_accept_ack_csocket_timeout_8594_ok">accept_ack(CSocket, Timeout) → ok</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
CSocket = any()
</dt>
<dd>
<p>
Socket for this connection.
</p>
</dd>
<dt class="hdlist1">
Timeout = timeout()
</dt>
<dd>
<p>
Ack timeout.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Perform post-accept initialization of the connection.</p></div>
<div class="paragraph"><p>This function will be called by connection processes
before performing any socket operation. It allows
transports that require extra initialization to perform
their task and make the socket ready to use.</p></div>
</div>
<div class="sect2">
<h3 id="_close_socket_8594_ok">close(Socket) → ok</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
Socket = any()
</dt>
<dd>
<p>
Socket opened with listen/1 or accept/2.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Close the given socket.</p></div>
</div>
<div class="sect2">
<h3 id="_controlling_process_socket_pid_8594_ok_error_closed_not_owner_atom">controlling_process(Socket, Pid) → ok | {error, closed | not_owner | atom()}</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
Socket = any()
</dt>
<dd>
<p>
Socket opened with listen/1 or accept/2.
</p>
</dd>
<dt class="hdlist1">
Pid = pid()
</dt>
<dd>
<p>
Pid of the new owner of the socket.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Change the controlling process for the given socket.</p></div>
<div class="paragraph"><p>The controlling process is the process that is allowed to
perform operations on the socket, and that will receive
messages from the socket when active mode is used. When
the controlling process dies, the socket is closed.</p></div>
</div>
<div class="sect2">
<h3 id="_listen_transopts_8594_ok_lsocket_error_atom">listen(TransOpts) → {ok, LSocket} | {error, atom()}</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
TransOpts = any()
</dt>
<dd>
<p>
Transport options.
</p>
</dd>
<dt class="hdlist1">
LSocket = any()
</dt>
<dd>
<p>
Listening socket.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Listen for connections on the given port.</p></div>
<div class="paragraph"><p>The port is given as part of the transport options under
the key <code>port</code>. Any other option is transport dependent.</p></div>
<div class="paragraph"><p>The socket returned by this call can then be used to
accept connections. It is not possible to send or receive
data from the listening socket.</p></div>
</div>
<div class="sect2">
<h3 id="_messages_8594_ok_closed_error">messages() → {OK, Closed, Error}</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
OK = Closed = Error = atom()
</dt>
<dd>
<p>
Tuple names.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Return the atoms used to identify messages sent in active mode.</p></div>
</div>
<div class="sect2">
<h3 id="_name_8594_name">name() → Name</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
Name = atom()
</dt>
<dd>
<p>
Transport module name.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Return the name of the transport.</p></div>
</div>
<div class="sect2">
<h3 id="_peername_csocket_8594_ok_ip_port_error_atom">peername(CSocket) → {ok, {IP, Port}} | {error, atom()}</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
CSocket = any()
</dt>
<dd>
<p>
Socket for this connection.
</p>
</dd>
<dt class="hdlist1">
IP = inet:ip_address()
</dt>
<dd>
<p>
IP of the remote endpoint.
</p>
</dd>
<dt class="hdlist1">
Port = inet:port_number()
</dt>
<dd>
<p>
Port of the remote endpoint.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Return the IP and port of the remote endpoint.</p></div>
</div>
<div class="sect2">
<h3 id="_recv_csocket_length_timeout_8594_ok_packet_error_closed_timeout_atom">recv(CSocket, Length, Timeout) → {ok, Packet} | {error, closed | timeout | atom()}</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
CSocket = any()
</dt>
<dd>
<p>
Socket for this connection.
</p>
</dd>
<dt class="hdlist1">
Length = non_neg_integer()
</dt>
<dd>
<p>
Requested length.
</p>
</dd>
<dt class="hdlist1">
Timeout = timeout()
</dt>
<dd>
<p>
Receive timeout.
</p>
</dd>
<dt class="hdlist1">
Packet = iodata() | any()
</dt>
<dd>
<p>
Data received.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Receive data from the given socket when in passive mode.</p></div>
<div class="paragraph"><p>Trying to receive data from a socket that is in active mode
will return an error.</p></div>
<div class="paragraph"><p>A length of 0 will return any data available on the socket.</p></div>
<div class="paragraph"><p>While it is possible to use the timeout value <code>infinity</code>,
this is highly discouraged as this could cause your process
to get stuck waiting for data that will never come. This may
happen when a socket becomes half-open due to a crash of the
remote endpoint. Wi-Fi going down is another common culprit
of this issue.</p></div>
</div>
<div class="sect2">
<h3 id="_send_csocket_packet_8594_ok_error_atom">send(CSocket, Packet) → ok | {error, atom()}</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
CSocket = any()
</dt>
<dd>
<p>
Socket for this connection.
</p>
</dd>
<dt class="hdlist1">
Packet = iodata()
</dt>
<dd>
<p>
Data to be sent.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Send data to the given socket.</p></div>
</div>
<div class="sect2">
<h3 id="_sendfile_csocket_file_8594_sendfile_csocket_file_0_0">sendfile(CSocket, File) → sendfile(CSocket, File, 0, 0, [])</h3>
<div class="paragraph"><p>Alias of <code>ranch_transport:sendfile/5</code>.</p></div>
</div>
<div class="sect2">
<h3 id="_sendfile_csocket_file_offset_bytes_8594_sendfile_csocket_file_offset_bytes">sendfile(CSocket, File, Offset, Bytes) → sendfile(CSocket, File, Offset, Bytes, [])</h3>
<div class="paragraph"><p>Alias of <code>ranch_transport:sendfile/5</code>.</p></div>
</div>
<div class="sect2">
<h3 id="_sendfile_csocket_file_offset_bytes_sfopts_8594_ok_sentbytes_error_atom">sendfile(CSocket, File, Offset, Bytes, SfOpts) → {ok, SentBytes} | {error, atom()}</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
CSocket = any()
</dt>
<dd>
<p>
Socket for this connection.
</p>
</dd>
<dt class="hdlist1">
File = file:filename_all() | file:fd()
</dt>
<dd>
<p>
Filename or file descriptor for the file to be sent.
</p>
</dd>
<dt class="hdlist1">
Offset = non_neg_integer()
</dt>
<dd>
<p>
Begin sending at this position in the file.
</p>
</dd>
<dt class="hdlist1">
Bytes = non_neg_integer()
</dt>
<dd>
<p>
Send this many bytes.
</p>
</dd>
<dt class="hdlist1">
SentBytes = non_neg_integer()
</dt>
<dd>
<p>
This many bytes were sent.
</p>
</dd>
<dt class="hdlist1">
SfOpts = sendfile_opts()
</dt>
<dd>
<p>
Sendfile options.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Send data from a file to the given socket.</p></div>
<div class="paragraph"><p>The file may be sent full or in parts, and may be specified
by its filename or by an already open file descriptor.</p></div>
<div class="paragraph"><p>Transports that manipulate TCP directly may use the
<code>file:sendfile/{2,4,5}</code> function, which calls the sendfile
syscall where applicable (on Linux, for example). Other
transports can use the <code>sendfile/6</code> function exported from
this module.</p></div>
</div>
<div class="sect2">
<h3 id="_setopts_csocket_sockopts_8594_ok_error_atom">setopts(CSocket, SockOpts) → ok | {error, atom()}</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
CSocket = any()
</dt>
<dd>
<p>
Socket for this connection.
</p>
</dd>
<dt class="hdlist1">
SockOpts = any()
</dt>
<dd>
<p>
Socket options.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Change options for the given socket.</p></div>
<div class="paragraph"><p>This is mainly useful for switching to active or passive mode
or to set protocol-specific options.</p></div>
</div>
<div class="sect2">
<h3 id="_shutdown_csocket_how_8594_ok_error_atom">shutdown(CSocket, How) → ok | {error, atom()}</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
CSocket = any()
</dt>
<dd>
<p>
Socket for this connection.
</p>
</dd>
<dt class="hdlist1">
How = read | write | read_write
</dt>
<dd>
<p>
Which side(s) of the socket to close.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Immediately close the socket in one or two directions.</p></div>
</div>
<div class="sect2">
<h3 id="_sockname_socket_8594_ok_ip_port_error_atom">sockname(Socket) → {ok, {IP, Port}} | {error, atom()}</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
Socket = any()
</dt>
<dd>
<p>
Socket opened with listen/1 or accept/2.
</p>
</dd>
<dt class="hdlist1">
IP = inet:ip_address()
</dt>
<dd>
<p>
IP of the local endpoint.
</p>
</dd>
<dt class="hdlist1">
Port = inet:port_number()
</dt>
<dd>
<p>
Port of the local endpoint.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Return the IP and port of the local endpoint.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_exports">Exports</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_sendfile_transport_csocket_file_offset_bytes_sfopts_8594_ok_sentbytes_error_atom">sendfile(Transport, CSocket, File, Offset, Bytes, SfOpts) → {ok, SentBytes} | {error, atom()}</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
Transport = module()
</dt>
<dd>
<p>
Transport module for this socket.
</p>
</dd>
<dt class="hdlist1">
CSocket = any()
</dt>
<dd>
<p>
Socket for this connection.
</p>
</dd>
<dt class="hdlist1">
File = file:filename_all() | file:fd()
</dt>
<dd>
<p>
Filename or file descriptor for the file to be sent.
</p>
</dd>
<dt class="hdlist1">
Offset = non_neg_integer()
</dt>
<dd>
<p>
Begin sending at this position in the file.
</p>
</dd>
<dt class="hdlist1">
Bytes = non_neg_integer()
</dt>
<dd>
<p>
Send this many bytes.
</p>
</dd>
<dt class="hdlist1">
SentBytes = non_neg_integer()
</dt>
<dd>
<p>
This many bytes were sent.
</p>
</dd>
<dt class="hdlist1">
SfOpts = sendfile_opts()
</dt>
<dd>
<p>
Sendfile options.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Send data from a file to the given socket.</p></div>
<div class="paragraph"><p>This function emulates the function <code>file:sendfile/{2,4,5}</code>
and may be used when transports are not manipulating TCP
directly.</p></div>
</div>
</div>
</div>
</div>
<div class="span3 sidecol">
<h3>
Ranch
1.3
Function Reference
</h3>
<ul>
<li><a href="/docs/en/ranch/1.3/guide">User Guide</a></li>
<li><a href="/docs/en/ranch/1.3/manual">Function Reference</a></li>
</ul>
<h4 id="docs-nav">Navigation</h4>
<h4>Version select</h4>
<ul>
<li><a href="/docs/en/ranch/1.4/manual">1.4</a></li>
<li><a href="/docs/en/ranch/1.3/manual">1.3</a></li>
<li><a href="/docs/en/ranch/1.2/manual">1.2</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>
|
