summaryrefslogblamecommitdiffstats
path: root/docs/en/ranch/1.6/manual/ranch.info/index.html
blob: 9363446d17890cd08dc1ed6080bcc76ec59e79b0 (plain) (tree) 
a63ee9b3












53a79df4

a63ee9b3






















































8459bebc

a63ee9b3

























































8459bebc

a63ee9b3






8459bebc

a63ee9b3










































136d443b


48f39402


4ddd4e85


a63ee9b3




a63ee9b3


f40886df












519eb0a3

f40886df



a63ee9b3






























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












                                                                                                                      
                                                   





















































                                                                                                                                                                                   
                                                                                         
























































                                                                                                                                                                                                                                                                                                          
                                                               





                                                                                                                                                                      
                                                               









































                                                                                                                                                                                                       

                                                                    

                                                                    

                                                                    



                                                                    

     











                                                                                                                                                                   
                                                                                                                                                                                                                                  


 





























                                                                                                                                                                                                                           
<!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:info(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:info(3)</span></h1>

<h2 id="_name">Name</h2>
<p>ranch:info - Overview of Ranch listeners</p>
<h2 id="_description">Description</h2>
<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">info</font></b>() <font color="#990000">-&gt;</font> [{<font color="#009900">Ref</font>, <font color="#009900">Info</font>}]
<b><font color="#000000">info</font></b>(<font color="#009900">Ref</font>) <font color="#990000">-&gt;</font> <font color="#009900">Info</font>

<font color="#009900">Info</font> <font color="#990000">::</font> [{<font color="#009900">Key</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>(), <font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()}]</tt></pre>
</div></div>
<p>Overview of Ranch listeners.</p>
<h2 id="_arguments">Arguments</h2>
<dl><dt>Ref</dt>
<dd><p>The listener name.</p>
</dd>
</dl>
<h2 id="_return_value">Return value</h2>
<p>Returns detailed information about one or all Ranch listeners. The following keys are returned:</p>
<dl><dt>pid</dt>
<dd><p>Pid of the listener&apos;s top-level supervisor.</p>
</dd>
<dt>status</dt>
<dd><p>Listener status, either running or suspended.</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>
<!-- @todo I mistakenly removed the num_acceptors key,-->
<!-- it should be added back.-->
<h2 id="_examples">Examples</h2>
<div class="listingblock"><div class="title">Get information about all listeners</div>
<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><font color="#009900">AllInfo</font> <font color="#990000">=</font> <b><font color="#000000">ranch:info</font></b>()<font color="#990000">.</font></tt></pre>
</div></div>
<div class="listingblock"><div class="title">Get information about a specific listener</div>
<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><font color="#009900">Info</font> <font color="#990000">=</font> <b><font color="#000000">ranch:info</font></b>(<font color="#FF6600">example</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<h2 id="_see_also">See also</h2>
<p><a href="../ranch.get_addr">ranch:get_addr(3)</a>, <a href="../ranch.get_port">ranch:get_port(3)</a>, <a href="../ranch.procs">ranch:procs(3)</a>, <a href="../ranch">ranch(3)</a></p>






</div>

<div class="span3 sidecol">


<h3>
	Ranch
	1.6
	Function Reference
	
</h3>

<ul>
	
		<li><a href="/docs/en/ranch/1.6/guide">User Guide</a></li>
	
	
		<li><a href="/docs/en/ranch/1.6/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.8/manual">1.8</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>
	
</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 &copy; Loïc Hoguin 2012-2018</p>
            </div>
          </div>
        </div>
      </footer>

    
    <script src="/js/custom.js"></script>
  </body>
</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-16 15:03:00 +0000