aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_http_req_add_header.3http.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-01-06 15:20:09 -0800
committerGarrett D'Amore <garrett@damore.org>2025-01-09 23:22:56 -0800
commit73f50e2679525e7df8734c875a3c12732565f953 (patch)
tree23bd167dfcd95305b58a29c142b51879011f63b2 /docs/man/nng_http_req_add_header.3http.adoc
parenta381af4f5ca79576a4a9b461529a0f22fcf1e088 (diff)
downloadnng-73f50e2679525e7df8734c875a3c12732565f953.tar.gz
nng-73f50e2679525e7df8734c875a3c12732565f953.tar.bz2
nng-73f50e2679525e7df8734c875a3c12732565f953.zip
http: The big HTTP API refactoring of January 2025.v2.0.0-alpha.3http-client-trans
This represents a major change in the HTTP code base, consisting of a complete revamp of the HTTP API. The changes here are too numerous to mention, but the end result should be a vastly simpler API for both server and client applications. Many needless allocations were removed by providing fixed buffers for various parameters and headers when possible. A few bugs were fixed. Most especially we have fixed some bugs around very large URIs and headers, and we have also addressed conformance bugs to more closely conform to RFCs 9110 and 9112. As part of this work, the APIs for WebSockets changed slightly as well. In particular the properties available for accessing headers have changed. There is still documentation conversion work to do, and additional functionality (such as proper support for chunked transfers), but this is a big step in the right direction.
Diffstat (limited to 'docs/man/nng_http_req_add_header.3http.adoc')
-rw-r--r--docs/man/nng_http_req_add_header.3http.adoc65
1 files changed, 0 insertions, 65 deletions
diff --git a/docs/man/nng_http_req_add_header.3http.adoc b/docs/man/nng_http_req_add_header.3http.adoc
deleted file mode 100644
index bf95254a..00000000
--- a/docs/man/nng_http_req_add_header.3http.adoc
+++ /dev/null
@@ -1,65 +0,0 @@
-= nng_http_req_add_header(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_add_header - add HTTP request header
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-#include <nng/supplemental/http/http.h>
-
-int nng_http_req_add_header(nng_http_req *req, const char *key,
- const char *val);
-----
-
-== DESCRIPTION
-
-The `nng_http_req_add_header()` adds an HTTP header for the request
-_req_ and the _key_ to the _val_. The _key_ and _val_ are copied.
-
-If a header with the value of _key_ already exists, then a comma
-and whitespace separate are appended to it, followed by _val_.
-
-If no such header already exists, then one is created with the value _val_.
-
-TIP: The HTTP specification requires that duplicate headers be treated
-identically to a single header with multiple comma-delimited values.
-
-TIP: See xref:nng_http_req_set_header.3http.adoc[`nng_http_req_set_header()`] if
-replacement of an existing header rather than appending to it is desired.
-
-The value of _key_ is case insensitive, and should not include the final
-colon in an HTTP header.
-For example, specifying `Host` or `hOSt` are
-equivalent, whereas the value `Host:` is not a legal header key.
-
-== RETURN VALUES
-
-This function returns 0 on success, and non-zero otherwise.
-
-== ERRORS
-
-[horizontal]
-`NNG_ENOMEM`:: Insufficient memory to perform the operation.
-`NNG_ENOTSUP`:: No support for HTTP in the library.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)],
-xref:nng_http_req_del_header.3http.adoc[nng_http_req_del_header(3http)],
-xref:nng_http_req_get_header.3http.adoc[nng_http_req_get_header(3http)],
-xref:nng_http_req_set_header.3http.adoc[nng_http_req_set_header(3http)],
-xref:nng.7.adoc[nng(7)]