summaryrefslogtreecommitdiff
path: root/man/v1.5.2/nng_http_req_alloc.3http.html
blob: bd7ec0499541a985017b00d8708645e459a6d517 (plain)
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
---
version: v1.5.2
layout: manpage_v2
title: nng_http_req_alloc(3http)
---
<h1>nng_http_req_alloc(3http)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_http_req_alloc - allocate HTTP request structure</p>
</div>
</div>
</div>
<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 class="tok-cp">#include</span> <span class="tok-cpf">&lt;nng/nng.h&gt;</span>
<span class="tok-cp">#include</span> <span class="tok-cpf">&lt;nng/supplemental/http/http.h&gt;</span>

<span class="tok-kt">int</span> <span class="tok-nf">nng_http_req_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_http_req</span> <span class="tok-o">**</span><span class="tok-n">reqp</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-n">nng_url</span> <span class="tok-o">*</span><span class="tok-n">url</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_req_alloc()</code> function allocates a new HTTP request structure
and stores a pointer to it in <em>reqp</em>.
The request will be initialized
to perform an HTTP/1.1 <code>GET</code> operation using the URL specified in <em>url</em>.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
It is possible to specify <code>NULL</code> for the URL.
In this case the URI for the request must be specified by a subsequent call
to <a href="nng_http_req_set_uri.3http.html"><code>nng_http_req_set_uri()</code></a>.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This function returns 0 on success, and non-zero otherwise.</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_ENOMEM</code>
</td>
<td class="hdlist2">
<p>Insufficient free memory exists to allocate a message.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ENOTSUP</code>
</td>
<td class="hdlist2">
<p>HTTP support not configured.</p>
</td>
</tr>
</table>
</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_http_conn_read_req.3http.html">nng_http_conn_read_req(3http)</a>,
<a href="nng_http_conn_write_req.3http.html">nng_http_conn_write_req(3http)</a>,
<a href="nng_http_req_add_header.3http.html">nng_http_req_add_header(3http)</a>,
<a href="nng_http_req_copy_data.3http.html">nng_http_req_copy_data(3http)</a>,
<a href="nng_http_req_del_header.3http.html">nng_http_req_del_header(3http)</a>,
<a href="nng_http_req_free.3http.html">nng_http_req_free(3http)</a>,
<a href="nng_http_req_get_header.3http.html">nng_http_req_get_header(3http)</a>,
<a href="nng_http_req_get_method.3http.html">nng_http_req_get_method(3http)</a>,
<a href="nng_http_req_get_uri.3http.html">nng_http_req_get_uri(3http)</a>,
<a href="nng_http_req_get_version.3http.html">nng_http_req_get_version(3http)</a>,
<a href="nng_http_req_reset.3http.html">nng_http_req_reset(3http)</a>,
<a href="nng_http_req_set_data.3http.html">nng_http_req_set_data(3http)</a>,
<a href="nng_http_req_set_method.3http.html">nng_http_req_set_method(3http)</a>,
<a href="nng_http_req_set_uri.3http.html">nng_http_req_set_uri(3http)</a>,
<a href="nng_http_req_set_version.3http.html">nng_http_req_set_version(3http)</a>,
<a href="nng_http_res_alloc.3http.html">nng_http_res_alloc(3http)</a>,
<a href="nng_url_parse.3.html">nng_url_parse(3)</a>
<a href="nng_strerror.3.html">nng_strerror(3)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>