diff options
Diffstat (limited to 'docs/nng_http_req_set_version.adoc')
| -rw-r--r-- | docs/nng_http_req_set_version.adoc | 55 |
1 files changed, 0 insertions, 55 deletions
diff --git a/docs/nng_http_req_set_version.adoc b/docs/nng_http_req_set_version.adoc deleted file mode 100644 index 969e8afa..00000000 --- a/docs/nng_http_req_set_version.adoc +++ /dev/null @@ -1,55 +0,0 @@ -= nng_http_req_set_version(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_version - set HTTP request protocol version - -== SYNOPSIS - -[source, c] ------------ -#include <nng/nng.h> -#include <nng/supplemental/http/http.h> - -int nng_http_req_set_version(nng_http_req *req, const char *version); ------------ - -== DESCRIPTION - -The `nng_http_req_set_version()` sets the HTTP protocol version associated with -the request _req_ to _version_. The _version_ must be a string containing -a valid HTTP protocol version, such as "HTTP/1.0". The default value is -"HTTP/1.1". - -A local copy of the _version_ is made in the request _req_. - -NOTE: No validation of the version supplied is performed. - -NOTE: The library does not contain support for versions of HTTP other than -"HTTP/1.0" and "HTTP/1.1". Specifying any other version may result in -unspecified behavior. - - -== 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_version#,nng_http_req_get_version(3)>>, -<<nng#,nng(7)>> |
