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
|
---
version: v1.2.2
layout: refman
---
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.10">
<title>nng_http_client_connect(3http)</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<link rel="stylesheet" href="./asciidoctor.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
</head>
<body class="manpage toc2 toc-left">
<div id="header">
<h1>nng_http_client_connect(3http) Manual Page</h1>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#_synopsis">SYNOPSIS</a></li>
<li><a href="#_description">DESCRIPTION</a></li>
<li><a href="#_return_values">RETURN VALUES</a></li>
<li><a href="#_errors">ERRORS</a></li>
<li><a href="#_example">EXAMPLE</a></li>
<li><a href="#_see_also">SEE ALSO</a></li>
</ul>
</div>
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<p>nng_http_client_connect - establish HTTP client connection</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="c"><span></span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span><span class="tok-cp"></span>
<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"></span>
<span class="tok-kt">void</span> <span class="tok-nf">nng_http_client_connect</span><span class="tok-p">(</span><span class="tok-n">nng_http_client</span> <span class="tok-o">*</span><span class="tok-n">client</span><span class="tok-p">,</span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>nng_http_client_connect()</code> starts the process of establishing an HTTP
connection from <em>client</em> to the server that was indicated in the URL that
<em>client</em> was configured with.</p>
</div>
<div class="paragraph">
<p>The result of the operation will be stored in the <em>aio</em> when the operation
is complete, and will be obtainable via
<a href="nng_aio_result.3.html"><code>nng_aio_result()</code></a>.</p>
</div>
<div class="paragraph">
<p>On success, a pointer to the underlying HTTP client (type <code>nng_http_conn *</code>)
will be stored in the first output result of the <em>aio</em>, and can be
obtained by
<a href="nng_aio_get_output.3.html"><code>nng_aio_get_output()</code></a> with an <em>index</em> of zero (0).</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>None.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_errors">ERRORS</h2>
<div class="sectionbody">
<div class="hdlist">
<table>
<tr>
<td class="hdlist1">
<code>NNG_EADDRINVAL</code>
</td>
<td class="hdlist2">
<p>The client is configured with an invalid address.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ECANCELED</code>
</td>
<td class="hdlist2">
<p>The operation was aborted.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ECONNREFUSED</code>
</td>
<td class="hdlist2">
<p>The TCP connection was refused by the server.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ECONNRESET</code>
</td>
<td class="hdlist2">
<p>The TCP connection was reset by the server.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ENOMEM</code>
</td>
<td class="hdlist2">
<p>Insufficient free memory exists.</p>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_example">EXAMPLE</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="c"><span></span> <span class="tok-n">nng_aio</span> <span class="tok-o">*</span><span class="tok-n">aio</span><span class="tok-p">;</span>
<span class="tok-n">nng_url</span> <span class="tok-o">*</span><span class="tok-n">url</span><span class="tok-p">;</span>
<span class="tok-n">nng_http_client</span> <span class="tok-o">*</span><span class="tok-n">client</span><span class="tok-p">;</span>
<span class="tok-n">nng_http_conn</span> <span class="tok-o">*</span><span class="tok-n">conn</span><span class="tok-p">;</span>
<span class="tok-kt">int</span> <span class="tok-n">rv</span><span class="tok-p">;</span>
<span class="tok-c1">// Error checks elided for clarity.</span>
<span class="tok-n">nng_url_parse</span><span class="tok-p">(</span><span class="tok-o">&</span><span class="tok-n">url</span><span class="tok-p">,</span> <span class="tok-s">"http://www.google.com"</span><span class="tok-p">);</span>
<span class="tok-n">nng_aio_alloc</span><span class="tok-p">(</span><span class="tok-o">&</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-nb">NULL</span><span class="tok-p">,</span> <span class="tok-nb">NULL</span><span class="tok-p">);</span>
<span class="tok-n">nng_http_client_alloc</span><span class="tok-p">(</span><span class="tok-o">&</span><span class="tok-n">client</span><span class="tok-p">,</span> <span class="tok-n">url</span><span class="tok-p">);</span>
<span class="tok-n">nng_http_client_connect</span><span class="tok-p">(</span><span class="tok-n">client</span><span class="tok-p">,</span> <span class="tok-n">aio</span><span class="tok-p">);</span>
<span class="tok-c1">// Wait for connection to establish (or attempt to fail).</span>
<span class="tok-n">nng_aio_wait</span><span class="tok-p">(</span><span class="tok-n">aio</span><span class="tok-p">);</span>
<span class="tok-k">if</span> <span class="tok-p">((</span><span class="tok-n">rv</span> <span class="tok-o">=</span> <span class="tok-n">nng_aio_result</span><span class="tok-p">(</span><span class="tok-n">aio</span><span class="tok-p">))</span> <span class="tok-o">!=</span> <span class="tok-mi">0</span><span class="tok-p">)</span> <span class="tok-p">{</span>
<span class="tok-n">printf</span><span class="tok-p">(</span><span class="tok-s">"Connection failed: %s</span><span class="tok-se">\n</span><span class="tok-s">"</span><span class="tok-p">,</span> <span class="tok-n">nng_strerror</span><span class="tok-p">(</span><span class="tok-n">rv</span><span class="tok-p">));</span>
<span class="tok-p">}</span> <span class="tok-k">else</span> <span class="tok-p">{</span>
<span class="tok-c1">// Connection established, get it.</span>
<span class="tok-n">conn</span> <span class="tok-o">=</span> <span class="tok-n">nng_aio_get_output</span><span class="tok-p">(</span><span class="tok-n">aio</span><span class="tok-p">,</span> <span class="tok-mi">0</span><span class="tok-p">);</span>
<span class="tok-c1">// ... do something with it here</span>
<span class="tok-c1">// Close the connection when done to avoid leaking it.</span>
<span class="tok-n">nng_http_conn_close</span><span class="tok-p">(</span><span class="tok-n">conn</span><span class="tok-p">);</span>
<span class="tok-p">}</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="paragraph text-left">
<p><a href="nng_aio_get_output.3.html">nng_aio_get_output(3)</a>,
<a href="nng_aio_result.3.html">nng_aio_result(3)</a>,
<a href="nng_aio_wait.3.html">nng_aio_wait(3)</a>,
<a href="nng_strerror.3.html">nng_strerror(3)</a>,
<a href="nng_http_client_alloc.3http.html">nng_http_client_alloc(3http)</a>,
<a href="nng_http_conn_close.3http.html">nng_http_conn_close(3http)</a>,
<a href="nng_http_conn_read.3http.html">nng_http_conn_read(3http)</a>,
<a href="nng_http_conn_write.3http.html">nng_http_conn_write(3http)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>
</div>
<link rel="stylesheet" href="./pygments-default.css">
</body>
</html>
|
