diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
| commit | 87795b46f2bc732bd11067805709161bdc00d6b6 (patch) | |
| tree | 892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/nng_http_req_set_uri.adoc | |
| parent | 545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff) | |
| download | nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.gz nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.bz2 nng-87795b46f2bc732bd11067805709161bdc00d6b6.zip | |
More man page reorganization.
Man pages need special handling, and we can have other kinds of documentation
like initial starting guides, etc., which would have different processing
applied. So lets move them off into their own directory.
Diffstat (limited to 'docs/nng_http_req_set_uri.adoc')
| -rw-r--r-- | docs/nng_http_req_set_uri.adoc | 55 |
1 files changed, 0 insertions, 55 deletions
diff --git a/docs/nng_http_req_set_uri.adoc b/docs/nng_http_req_set_uri.adoc deleted file mode 100644 index 9431b1da..00000000 --- a/docs/nng_http_req_set_uri.adoc +++ /dev/null @@ -1,55 +0,0 @@ -= nng_http_req_set_uri(3) -// -// 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_set_uri - set HTTP request URI - -== SYNOPSIS - -[source, c] ------------ -#include <nng/nng.h> -#include <nng/supplemental/http/http.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)>> |