aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_http_req_set_uri.adoc
blob: 3208958ad70cec261ca873c82e2d9b065be647f1 (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_set_uri(3)
:doctype: manpage
:manmanual: nng
:mansource: nng
:manvolnum: 3
:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \
            Copyright 2018 Capitar IT Group BV <info@capitar.com> \
            This software 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_set_uri - set HTTP request URI

== SYNOPSIS

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

int nng_http_req_set_uri(nng_http_req *req, const char *uri);
-----------

== DESCRIPTION

The `nng_http_req_set_uri()` sets the Request-URI associated with
the request _req_ to _uri_.  The _uri_ should contain precisely the
string that will be sent to the HTTP server in the request, including
any query information or fragment.

A local copy of the _uri_ is made in the request _req_.

NOTE: No validation or canonicalization of the _uri_ is performed.

TIP: The <<nng_url_parse#,nng_url_parse(3)>> function can be used to
perform validation and canonicalization.  The `u_requri` member will
contain a suitable value that can be used with this function.

== RETURN VALUES

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

== ERRORS

`NNG_ENOMEM`:: Insufficient memory to perform the operation.
`NNG_ENOTSUP`:: No support for HTTP in the library.

== SEE ALSO

<<nng_http_req_alloc#,nng_http_req_alloc(3)>>,
<<nng_http_req_get_uri#,nng_http_req_get_uri(3)>>,
<<nng_url_parse#,nng_url_parse(3)>>,
<<nng#,nng(7)>>


== COPYRIGHT

Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] +
Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV]

This document is supplied under the terms of the
https://opensource.org/licenses/MIT[MIT License].