aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_http_req_alloc.adoc
blob: 32e756be187e8a252bee13d1c1ae6441ea60af07 (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
= nng_http_req_alloc(3)
:doctype: manpage
:manmanual: nng
:mansource: nng
:manvolnum: 3
:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \
            Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \
            {blank} + \
            This document is supplied under the terms of the \
            https://opensource.org/licenses/MIT[MIT License].

== NAME

nng_http_req_alloc - allocate HTTP request structure

== SYNOPSIS

[source, c]
-----------
#include <nng/nng.h>

int nng_http_req_alloc(nng_http_req **reqp, const nng_url *url);
-----------


== DESCRIPTION

The `nng_http_req_alloc()` function allocates a new HTTP request structure
and stores a pointer to it in __reqp__.  The request will be initialized
to perform an HTTP/1.1 `GET` operation using the URL specified in __url__.

== RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

== ERRORS

`NNG_ENOMEM`:: Insufficient free memory exists to allocate a message.
`NNG_ENOTSUP`:: HTTP support not configured.

== SEE ALSO

<<nng_http_conn_read_req#,nng_http_conn_read_req(3)>>,
<<nng_http_conn_write_req#,nng_http_conn_write_req(3)>>,
<<nng_http_req_add_header#,nng_http_req_add_header(3)>>,
<<nng_http_req_copy_data#,nng_http_req_copy_data(3)>>,
<<nng_http_req_del_header#,nng_http_req_del_header(3)>>,
<<nng_http_req_free#,nng_http_req_free(3)>>,
<<nng_http_req_get_header#,nng_http_req_get_header(3)>>,
<<nng_http_req_get_method#,nng_http_req_get_method(3)>>,
<<nng_http_req_get_uri#,nng_http_req_get_uri(3)>>,
<<nng_http_req_get_version#,nng_http_req_get_version(3)>>,
<<nng_http_req_set_data#,nng_http_req_set_data(3)>>,
<<nng_http_req_set_method#,nng_http_req_set_method(3)>>,
<<nng_http_req_set_uri#,nng_http_req_set_uri(3)>>,
<<nng_http_req_set_version#,nng_http_req_set_version(3)>>,
<<nng_http_res_alloc#,nng_http_res_alloc(3)>>,
<<nng_url_parse#,nng_url_parse(3)>>
<<nng_strerror#,nng_strerror(3)>>,
<<nng#,nng(7)>>

== COPYRIGHT

{copyright}