summaryrefslogblamecommitdiffstats
path: root/docs/en/gun/1.3/manual/gun.connect/index.html
blob: 6b5bff425548b889d463755230d1fda10b7b821c (plain) (tree) 
24b2e92a












53a79df4

24b2e92a






d73aae06

24b2e92a














































8459bebc

24b2e92a











































8459bebc

24b2e92a













8459bebc

24b2e92a















8459bebc

24b2e92a



















































5e05fe8e


e39252ae


24b2e92a










f40886df












519eb0a3

f40886df



24b2e92a






























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












                                                                                                                      
                                                   





                                                                                                      
               













































                                                                                                                                                                                   
                                                                                         










































                                                                                                                                                                                                                                           
                                                               












                                                                                                                                                                                                                                                                                                       
                                                               














                                                                                                                                                                                                                                                                                                       
                                                               


















































                                                                                                                                                                                                                                                                                                       

                                                                  

                                                                  









                                                                  











                                                                                                                                                                   
                                                                                                                                                                                                                                  


 





























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

<h2 id="_name">Name</h2>
<p>gun:connect - Establish a tunnel to the origin server</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">connect</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Destination</font>)
    <font color="#990000">-&gt;</font> <b><font color="#000000">connect</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Destination</font>, [], #{})<font color="#990000">.</font>

<b><font color="#000000">connect</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Destination</font>, <font color="#009900">Headers</font>)
    <font color="#990000">-&gt;</font> <b><font color="#000000">connect</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Destination</font>, <font color="#009900">Headers</font>, #{})<font color="#990000">.</font>

<b><font color="#000000">connect</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Destination</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>)
    <font color="#990000">-&gt;</font> <font color="#009900">StreamRef</font>

<font color="#009900">ConnPid</font>     <font color="#990000">::</font> <b><font color="#000080">pid</font></b>()
<font color="#009900">Destination</font> <font color="#990000">::</font> <b><font color="#000000">gun:connect_destination</font></b>()
<font color="#009900">Headers</font>     <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000000">iodata</font></b>()}]
<font color="#009900">ReqOpts</font>     <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>()
<font color="#009900">StreamRef</font>   <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre>
</div></div>
<p>Establish a tunnel to the origin server.</p>
<p>This feature is currently only available for HTTP/1.1 connections. Upon successful completion of the CONNECT request a tunnel is established and subsequent requests will go through the tunnel.</p>
<p>Gun will not automatically re-issue the CONNECT request upon reconnection to the proxy server. The <code>gun_up</code> message can be used to know when the tunnel needs to be established again.</p>
<h2 id="_arguments">Arguments</h2>
<dl><dt>ConnPid</dt>
<dd><p>The pid of the Gun connection process.</p>
</dd>
<dt>Destination</dt>
<dd><p>Destination of the CONNECT request.</p>
</dd>
<dt>Headers</dt>
<dd><p>Additional request headers.</p>
</dd>
<dt>ReqOpts</dt>
<dd><p>Request options.</p>
</dd>
</dl>
<h2 id="_return_value">Return value</h2>
<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p>
<h2 id="_changelog">Changelog</h2>
<ul><li><strong>1.2</strong>: Function introduced.
</li>
</ul>
<h2 id="_examples">Examples</h2>
<div class="listingblock"><div class="title">Establish a tunnel</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="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"proxy.example.org"</font>, <font color="#993399">1080</font>),
{<font color="#FF6600">ok</font>, <font color="#FF6600">http</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_up</font></b>(<font color="#009900">ConnPid</font>),
<font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:connect</font></b>(<font color="#009900">ConnPid</font>, #{
    <font color="#0000FF">host</font> <font color="#990000">=&gt;</font> <font color="#FF0000">"origin-server.example.org"</font>,
    <font color="#0000FF">port</font> <font color="#990000">=&gt;</font> <font color="#993399">80</font>
}),
{<font color="#FF6600">response</font>, <font color="#FF6600">fin</font>, <font color="#993399">200</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>),
<i><font color="#9A1900">%% Subsequent requests will be sent to origin-server.example.org.</font></i></tt></pre>
</div></div>
<div class="listingblock"><div class="title">Establish a tunnel for a secure HTTP/2 connection</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="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"proxy.example.org"</font>, <font color="#993399">1080</font>),
{<font color="#FF6600">ok</font>, <font color="#FF6600">http</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_up</font></b>(<font color="#009900">ConnPid</font>),
<font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:connect</font></b>(<font color="#009900">ConnPid</font>, #{
    <font color="#0000FF">host</font> <font color="#990000">=&gt;</font> <font color="#FF0000">"origin-server.example.org"</font>,
    <font color="#0000FF">port</font> <font color="#990000">=&gt;</font> <font color="#993399">443</font>,
    <font color="#0000FF">protocols</font> <font color="#990000">=&gt;</font> [<font color="#FF6600">http2</font>],
    <font color="#0000FF">transport</font> <font color="#990000">=&gt;</font> <font color="#FF6600">tls</font>
}),
{<font color="#FF6600">response</font>, <font color="#FF6600">fin</font>, <font color="#993399">200</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>),
<i><font color="#9A1900">%% Subsequent requests will be sent to origin-server.example.org.</font></i></tt></pre>
</div></div>
<div class="listingblock"><div class="title">Establish a tunnel using proxy authorization</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="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"proxy.example.org"</font>, <font color="#993399">1080</font>),
{<font color="#FF6600">ok</font>, <font color="#FF6600">http</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_up</font></b>(<font color="#009900">ConnPid</font>),
<font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:connect</font></b>(<font color="#009900">ConnPid</font>, #{
    <font color="#0000FF">host</font> <font color="#990000">=&gt;</font> <font color="#FF0000">"origin-server.example.org"</font>,
    <font color="#0000FF">port</font> <font color="#990000">=&gt;</font> <font color="#993399">80</font>,
    <font color="#0000FF">username</font> <font color="#990000">=&gt;</font> <font color="#FF0000">"essen"</font>,
    <font color="#0000FF">password</font> <font color="#990000">=&gt;</font> <font color="#FF0000">"myrealpasswordis"</font>
}),
{<font color="#FF6600">response</font>, <font color="#FF6600">fin</font>, <font color="#993399">200</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>),
<i><font color="#9A1900">%% Subsequent requests will be sent to origin-server.example.org.</font></i></tt></pre>
</div></div>
<h2 id="_see_also">See also</h2>
<p><a href="../gun">gun(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a>, <a href="../gun_up">gun_up(3)</a></p>






</div>

<div class="span3 sidecol">


<h3>
	Gun
	1.3
	Function Reference
	
</h3>

<ul>
	
		<li><a href="/docs/en/gun/1.3/guide">User Guide</a></li>
	
	
		<li><a href="/docs/en/gun/1.3/manual">Function Reference</a></li>
	
	
</ul>

<h4 id="docs-nav">Navigation</h4>

<h4>Version select</h4>
<ul>
	
	
	
		<li><a href="/docs/en/gun/2.1/manual">2.1</a></li>
	
		<li><a href="/docs/en/gun/2.0/manual">2.0</a></li>
	
		<li><a href="/docs/en/gun/1.3/manual">1.3</a></li>
	
		<li><a href="/docs/en/gun/1.2/manual">1.2</a></li>
	
		<li><a href="/docs/en/gun/1.1/manual">1.1</a></li>
	
		<li><a href="/docs/en/gun/1.0/manual">1.0</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-17 02:24:41 +0000