summaryrefslogblamecommitdiffstats
path: root/docs/en/ranch/1.7/manual/ranch_proxy_header.header/index.html
blob: 99efaf3b5f11dc3c7d0b90b4796edd8018a655b7 (plain) (tree) 
4ddd4e85












d1e24ed5

4ddd4e85































































d3abb447

4ddd4e85












































d3abb447

4ddd4e85








































136d443b


4ddd4e85








4ddd4e85


f40886df
















4ddd4e85






























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












                                                                                                                      
                                                   






























































                                                                                                                                                                                                                                 
                                                                                                                 











































                                                                                                                                                                                                                       
                                                                                                                 







































                                                                                                                                         

                                                                    







                                                                    

     















                                                                                                                                                                                                                                     





























                                                                                                                                                                                                                           
<!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_proxy_header:header(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=5" 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_proxy_header:header(3)</span></h1>

<h2 id="_name">Name</h2>
<p>ranch_proxy_header:header - Build a PROXY protocol header</p>
<h2 id="_description">Description</h2>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#000000">header</font></b>(<font color="#009900">ProxyInfo</font>)            <font color="#990000">-&gt;</font> <b><font color="#000000">header</font></b>(<font color="#009900">ProxyInfo</font>, #{})
<b><font color="#000000">header</font></b>(<font color="#009900">ProxyInfo</font>, <font color="#009900">BuildOpts</font>) <font color="#990000">-&gt;</font> <b><font color="#000000">iodata</font></b>()

<font color="#009900">ProxyInfo</font> <font color="#990000">::</font> <b><font color="#000000">ranch_proxy_header:proxy_info</font></b>()
<font color="#009900">BuildOpts</font> <font color="#990000">::</font> #{
    <font color="#0000FF">checksum</font> <font color="#990000">=&gt;</font> <font color="#FF6600">crc32c</font>,
    <font color="#0000FF">padding</font>  <font color="#990000">=&gt;</font> <b><font color="#000000">pos_integer</font></b>() <i><font color="#9A1900">%% &gt;= 3</font></i>
}</tt></pre>
</div></div>
<p>Build a PROXY protocol header.</p>
<h2 id="_arguments">Arguments</h2>
<dl><dt>ProxyInfo</dt>
<dd><p>The proxy information to encode.</p>
</dd>
<dt>BuildOpts</dt>
<dd><p>Options to control whether to add a checksum or padding should be included in the encoded PROXY protocol header.</p>
</dd>
</dl>
<h2 id="_return_value">Return value</h2>
<p>The PROXY protocol header is returned.</p>
<h2 id="_changelog">Changelog</h2>
<ul><li><strong>1.7</strong>: Function introduced.
</li>
</ul>
<h2 id="_examples">Examples</h2>
<div class="listingblock"><div class="title">Build a PROXY protocol header</div>
<div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><font color="#009900">ProxyInfo</font> <font color="#990000">=</font> #{
    <font color="#0000FF">version</font> <font color="#990000">=&gt;</font> <font color="#993399">2</font>,
    <b><font color="#000080">command</font></b> <font color="#990000">=&gt;</font> <font color="#FF6600">proxy</font>,

    <font color="#0000FF">transport_family</font>   <font color="#990000">=&gt;</font> <font color="#FF6600">ipv4</font>,
    <font color="#0000FF">transport_protocol</font> <font color="#990000">=&gt;</font> <font color="#FF6600">stream</font>,

    <font color="#0000FF">src_address</font>  <font color="#990000">=&gt;</font> {<font color="#993399">192</font>, <font color="#993399">168</font>, <font color="#993399">1</font>, <font color="#993399">11</font>},
    <font color="#0000FF">src_port</font>     <font color="#990000">=&gt;</font> <font color="#993399">54321</font>,
    <font color="#0000FF">dest_address</font> <font color="#990000">=&gt;</font> {<font color="#993399">192</font>, <font color="#993399">168</font>, <font color="#993399">1</font>, <font color="#993399">42</font>},
    <font color="#0000FF">dest_port</font>    <font color="#990000">=&gt;</font> <font color="#993399">443</font>
},
<font color="#009900">Data</font> <font color="#990000">=</font> <b><font color="#000000">ranch_proxy_header:parse</font></b>(<font color="#009900">ProxyInfo</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<div class="listingblock"><div class="title">Build a PROXY protocol header with checksum and padding</div>
<div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><font color="#009900">Data</font> <font color="#990000">=</font> <b><font color="#000000">ranch_proxy_header:parse</font></b>(<font color="#009900">ProxyInfo</font>, #{
    <font color="#0000FF">checksum</font> <font color="#990000">=&gt;</font> <font color="#FF6600">crc32c</font>,
    <font color="#0000FF">padding</font>  <font color="#990000">=&gt;</font> <font color="#993399">7</font>
})<font color="#990000">.</font></tt></pre>
</div></div>
<h2 id="_see_also">See also</h2>
<p><a href="../ranch_proxy_header.header">ranch_proxy_header:header(3)</a>, <a href="../ranch_proxy_header">ranch_proxy_header(3)</a></p>






</div>

<div class="span3 sidecol">


<h3>
	Ranch
	1.7
	Function Reference
	
</h3>

<ul>
	
		<li><a href="/docs/en/ranch/1.7/guide">User Guide</a></li>
	
	
		<li><a href="/docs/en/ranch/1.7/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://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like 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 05:08:14 +0000