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
|
= nng_http_req_alloc(3http)
//
// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
// Copyright 2018 Capitar IT Group BV <info@capitar.com>
//
// This document is supplied under the terms of the MIT License, a
// copy of which should be located in the distribution where this
// file was obtained (LICENSE.txt). A copy of the license may also be
// found online at https://opensource.org/licenses/MIT.
//
== NAME
nng_http_req_alloc - allocate HTTP request structure
== SYNOPSIS
[source, c]
----
#include <nng/nng.h>
#include <nng/supplemental/http/http.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__.
TIP: It is possible to specify `NULL` for the URL.
In this case the URI for the request must be specified by a subsequent call
to `<<nng_http_req_set_uri.3http#,nng_http_req_set_uri()>>`.
== RETURN VALUES
This function returns 0 on success, and non-zero otherwise.
== ERRORS
[horizontal]
`NNG_ENOMEM`:: Insufficient free memory exists to allocate a message.
`NNG_ENOTSUP`:: HTTP support not configured.
== SEE ALSO
[.text-left]
<<nng_http_conn_read_req.3http#,nng_http_conn_read_req(3http)>>,
<<nng_http_conn_write_req.3http#,nng_http_conn_write_req(3http)>>,
<<nng_http_req_add_header.3http#,nng_http_req_add_header(3http)>>,
<<nng_http_req_copy_data.3http#,nng_http_req_copy_data(3http)>>,
<<nng_http_req_del_header.3http#,nng_http_req_del_header(3http)>>,
<<nng_http_req_free.3http#,nng_http_req_free(3http)>>,
<<nng_http_req_get_header.3http#,nng_http_req_get_header(3http)>>,
<<nng_http_req_get_method.3http#,nng_http_req_get_method(3http)>>,
<<nng_http_req_get_uri.3http#,nng_http_req_get_uri(3http)>>,
<<nng_http_req_get_version.3http#,nng_http_req_get_version(3http)>>,
<<nng_http_req_reset.3http#,nng_http_req_reset(3http)>>,
<<nng_http_req_set_data.3http#,nng_http_req_set_data(3http)>>,
<<nng_http_req_set_method.3http#,nng_http_req_set_method(3http)>>,
<<nng_http_req_set_uri.3http#,nng_http_req_set_uri(3http)>>,
<<nng_http_req_set_version.3http#,nng_http_req_set_version(3http)>>,
<<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>,
<<nng_url_parse.3#,nng_url_parse(3)>>
<<nng_strerror.3#,nng_strerror(3)>>,
<<nng.7#,nng(7)>>
|
