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
|
<!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">
<title>Nine Nines: ranch(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=7" 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="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(3)</span></h1>
<h2 id="_name">Name</h2>
<p>ranch - socket acceptor pool</p>
<h2 id="_description">Description</h2>
<p>The <code>ranch</code> module provides functions for starting and manipulating Ranch listeners.</p>
<h2 id="_types">Types</h2>
<h3 id="_max_conns_____non_neg_integer_____infinity">max_conns() = non_neg_integer() | infinity</h3>
<p>Maximum number of connections allowed on this listener.</p>
<p>This is a soft limit. The actual number of connections might be slightly above the limit due to concurrency when accepting new connections. Some connections may also be removed from this count explicitly by the user code.</p>
<h3 id="_opt">opt()</h3>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#000000">opt</font></b>() <font color="#990000">=</font> {<font color="#FF6600">ack_timeout</font>, <b><font color="#000000">timeout</font></b>()}
| {<font color="#FF6600">connection_type</font>, <font color="#FF6600">worker</font> | <font color="#FF6600">supervisor</font>}
| {<font color="#FF6600">max_connections</font>, <b><font color="#000000">max_conns</font></b>()}
| {<font color="#FF6600">num_acceptors</font>, <b><font color="#000000">pos_integer</font></b>()}
| {<font color="#000080">shutdown</font>, <b><font color="#000000">timeout</font></b>() | <font color="#FF6600">brutal_kill</font>}
| {<font color="#FF6600">socket</font>, <b><font color="#000000">any</font></b>()}</tt></pre>
</div></div>
<p>Ranch-specific transport options.</p>
<p>These options are not passed on to the transports. They are used by Ranch while setting up the listeners.</p>
<h3 id="_ref_____any">ref() = any()</h3>
<p>Unique name used to refer to a listener.</p>
<h2 id="_option_descriptions">Option descriptions</h2>
<p>None of the options are required.</p>
<dl><dt>ack_timeout (5000)</dt>
<dd><p>Maximum allowed time for the <code>ranch:accept_ack/1</code> call to finish.</p>
</dd>
<dt>connection_type (worker)</dt>
<dd><p>Type of process that will handle the connection.</p>
</dd>
<dt>max_connections (1024)</dt>
<dd><p>Maximum number of active connections. Soft limit. Using <code>infinity</code> will disable the limit entirely.</p>
</dd>
<dt>num_acceptors (10)</dt>
<dd><p>Number of processes that accept connections.</p>
</dd>
<dt>shutdown (5000)</dt>
<dd><p>Maximum allowed time for children to stop on listener shutdown.</p>
</dd>
<dt>socket</dt>
<dd><p>Listening socket opened externally to be used instead of calling <code>Transport:listen/1</code>.</p>
</dd>
</dl>
<h2 id="_exports">Exports</h2>
<h3 id="_accept_ack_ref_____ok">accept_ack(Ref) -> ok</h3>
<dl><dt>Ref = ref()</dt>
<dd><p>Listener name.</p>
</dd>
</dl>
<p>Acknowledge that the connection is accepted.</p>
<p>This function MUST be used by a connection process to inform Ranch that it initialized properly and let it perform any additional operations before the socket can be safely used.</p>
<h3 id="_child_spec_ref__numacceptors__transport__transopts__protocol__protoopts_____supervisor_child_spec">child_spec(Ref, NumAcceptors, Transport, TransOpts, Protocol, ProtoOpts) -> supervisor:child_spec()</h3>
<dl><dt>Ref = ref()</dt>
<dd><p>Listener name.</p>
</dd>
<dt>NumAcceptors = non_neg_integer()</dt>
<dd><p>Number of acceptor processes.</p>
</dd>
<dt>Transport = module()</dt>
<dd><p>Transport module.</p>
</dd>
<dt>TransOpts = any()</dt>
<dd><p>Transport options.</p>
</dd>
<dt>Protocol = module()</dt>
<dd><p>Protocol module.</p>
</dd>
<dt>ProtoOpts = any()</dt>
<dd><p>Protocol options.</p>
</dd>
</dl>
<p>Return child specifications for a new listener.</p>
<p>This function can be used to embed a listener directly in an application instead of letting Ranch handle it.</p>
<h3 id="_get_addr_ref______ip__port">get_addr(Ref) -> {IP, Port}</h3>
<dl><dt>Ref = ref()</dt>
<dd><p>Listener name.</p>
</dd>
<dt>IP = inet:ip_address()</dt>
<dd><p>IP of the interface used by this listener.</p>
</dd>
<dt>Port = inet:port_number()</dt>
<dd><p>Port number used by this listener.</p>
</dd>
</dl>
<p>Return the IP address and port for the given listener.</p>
<h3 id="_get_max_connections_ref_____maxconns">get_max_connections(Ref) -> MaxConns</h3>
<dl><dt>Ref = ref()</dt>
<dd><p>Listener name.</p>
</dd>
<dt>MaxConns = max_conns()</dt>
<dd><p>Current maximum number of connections.</p>
</dd>
</dl>
<p>Return the max number of connections allowed for the given listener.</p>
<h3 id="_get_port_ref_____port">get_port(Ref) -> Port</h3>
<dl><dt>Ref = ref()</dt>
<dd><p>Listener name.</p>
</dd>
<dt>Port = inet:port_number()</dt>
<dd><p>Port number used by this listener.</p>
</dd>
</dl>
<p>Return the port for the given listener.</p>
<h3 id="_get_protocol_options_ref_____protoopts">get_protocol_options(Ref) -> ProtoOpts</h3>
<dl><dt>Ref = ref()</dt>
<dd><p>Listener name.</p>
</dd>
<dt>ProtoOpts = any()</dt>
<dd><p>Current protocol options.</p>
</dd>
</dl>
<p>Return the protocol options set for the given listener.</p>
<h3 id="_info________ref____key__value">info() -> [{Ref, [{Key, Value}]}]</h3>
<dl><dt>Ref = ref()</dt>
<dd><p>Listener name.</p>
</dd>
<dt>Key = atom()</dt>
<dd><p>Information key.</p>
</dd>
<dt>Value = any()</dt>
<dd><p>Information value.</p>
</dd>
</dl>
<p>Return detailed information about all Ranch listeners.</p>
<p>The following keys are defined:</p>
<dl><dt>pid</dt>
<dd><p>Pid of the listener's top-level supervisor.</p>
</dd>
<dt>ip</dt>
<dd><p>Interface Ranch listens on.</p>
</dd>
<dt>port</dt>
<dd><p>Port number Ranch listens on.</p>
</dd>
<dt>num_acceptors</dt>
<dd><p>Number of acceptor processes.</p>
</dd>
<dt>max_connections</dt>
<dd><p>Maximum number of connections.</p>
</dd>
<dt>active_connections</dt>
<dd><p>Number of active connections.</p>
</dd>
<dt>all_connections</dt>
<dd><p>Number of connections, including those removed from the count.</p>
</dd>
<dt>transport</dt>
<dd><p>Transport module.</p>
</dd>
<dt>transport_options</dt>
<dd><p>Transport options.</p>
</dd>
<dt>protocol</dt>
<dd><p>Protocol module.</p>
</dd>
<dt>protocol_options</dt>
<dd><p>Protocol options.</p>
</dd>
</dl>
<h3 id="_procs_ref__acceptors___connections______pid">procs(Ref, acceptors | connections) -> [pid()]</h3>
<dl><dt>Ref = ref()</dt>
<dd><p>Listener name.</p>
</dd>
</dl>
<p>Return all acceptor or connection processes for one listener.</p>
<h3 id="_remove_connection_ref_____ok">remove_connection(Ref) -> ok</h3>
<dl><dt>Ref = ref()</dt>
<dd><p>Listener name.</p>
</dd>
</dl>
<p>Do not count this connection when limiting the number of connections.</p>
<p>You can use this function for long-running connection processes which spend most of their time idling rather than consuming resources. This allows Ranch to accept a lot more connections without sacrificing the latency of the system.</p>
<p>This function may only be called from a connection process.</p>
<h3 id="_set_max_connections_ref__maxconns_____ok">set_max_connections(Ref, MaxConns) -> ok</h3>
<dl><dt>Ref = ref()</dt>
<dd><p>Listener name.</p>
</dd>
<dt>MaxConns = max_conns()</dt>
<dd><p>New maximum number of connections.</p>
</dd>
</dl>
<p>Set the max number of connections for the given listener.</p>
<p>The change will be applied immediately. If the new value is smaller than the previous one, Ranch will not kill the extra connections, but will wait for them to terminate properly.</p>
<h3 id="_set_protocol_options_ref__protoopts_____ok">set_protocol_options(Ref, ProtoOpts) -> ok</h3>
<dl><dt>Ref = ref()</dt>
<dd><p>Listener name.</p>
</dd>
<dt>ProtoOpts = any()</dt>
<dd><p>New protocol options.</p>
</dd>
</dl>
<p>Set the protocol options for the given listener.</p>
<p>The change will be applied immediately for all new connections. Old connections will not receive the new options.</p>
<h3 id="_start_listener_ref__numacceptors__transport__transopts__protocol__protoopts______ok__pid_______error__badarg">start_listener(Ref, NumAcceptors, Transport, TransOpts, Protocol, ProtoOpts) -> {ok, pid()} | {error, badarg}</h3>
<dl><dt>Ref = ref()</dt>
<dd><p>Listener name.</p>
</dd>
<dt>NumAcceptors = non_neg_integer()</dt>
<dd><p>Number of acceptor processes.</p>
</dd>
<dt>Transport = module()</dt>
<dd><p>Transport module.</p>
</dd>
<dt>TransOpts = any()</dt>
<dd><p>Transport options.</p>
</dd>
<dt>Protocol = module()</dt>
<dd><p>Protocol module.</p>
</dd>
<dt>ProtoOpts = any()</dt>
<dd><p>Protocol options.</p>
</dd>
</dl>
<p>Start listening for connections using the given transport and protocol. Returns the pid for this listener's supervisor.</p>
<p>There are additional transport options that apply regardless of transport. They allow configuring how the connections are supervised, rate limited and more. Please consult the previous section for more details.</p>
<h3 id="_stop_listener_ref_____ok____error__not_found">stop_listener(Ref) -> ok | {error, not_found}</h3>
<dl><dt>Ref = ref()</dt>
<dd><p>Listener name.</p>
</dd>
</dl>
<p>Stop the given listener.</p>
<p>The listener is stopped gracefully, first by closing the listening port, then by stopping the connection processes. These processes are stopped according to the <code>shutdown</code> transport option, which may be set to brutally kill all connection processes or give them some time to stop properly.</p>
<p>This function does not return until the listener is completely stopped.</p>
</div>
<div class="span3 sidecol">
<h3>
Ranch
1.5
Function Reference
</h3>
<ul>
<li><a href="/docs/en/ranch/1.5/guide">User Guide</a></li>
<li><a href="/docs/en/ranch/1.5/manual">Function Reference</a></li>
</ul>
<h4 id="docs-nav">Navigation</h4>
<h4>Version select</h4>
<ul>
<li><a href="/docs/en/ranch/2.0/manual">2.0</a></li>
<li><a href="/docs/en/ranch/1.7/manual">1.7</a></li>
<li><a href="/docs/en/ranch/1.6/manual">1.6</a></li>
<li><a href="/docs/en/ranch/1.5/manual">1.5</a></li>
<li><a href="/docs/en/ranch/1.4/manual">1.4</a></li>
</ul>
<h3 id="_like_my_work__donate">Like my work? Donate!</h3>
<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p>
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline">
<input type="hidden" name="cmd" value="_donations">
<input type="hidden" name="business" value="[email protected]">
<input type="hidden" name="lc" value="FR">
<input type="hidden" name="item_name" value="Loic Hoguin">
<input type="hidden" name="item_number" value="99s">
<input type="hidden" name="currency_code" value="EUR">
<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted">
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1">
</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p>
</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-2018</p>
</div>
</div>
</div>
</footer>
<script src="/js/custom.js"></script>
</body>
</html>
|
