diff options
| author | Garrett D'Amore <garrett@damore.org> | 2025-01-06 15:20:09 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2025-01-09 23:22:56 -0800 |
| commit | 73f50e2679525e7df8734c875a3c12732565f953 (patch) | |
| tree | 23bd167dfcd95305b58a29c142b51879011f63b2 /docs/man/nng_http_set_reason.3http.adoc | |
| parent | a381af4f5ca79576a4a9b461529a0f22fcf1e088 (diff) | |
| download | nng-2.0.0-alpha.3.tar.gz nng-2.0.0-alpha.3.tar.bz2 nng-2.0.0-alpha.3.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_set_reason.3http.adoc')
| -rw-r--r-- | docs/man/nng_http_set_reason.3http.adoc | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/man/nng_http_set_reason.3http.adoc b/docs/man/nng_http_set_reason.3http.adoc new file mode 100644 index 00000000..62fb4561 --- /dev/null +++ b/docs/man/nng_http_set_reason.3http.adoc @@ -0,0 +1,54 @@ += nng_http_set_reason(3http) +// +// Copyright 2025 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_set_reason - set HTTP response reason + +== SYNOPSIS + +[source, c] +---- +#include <nng/nng.h> +#include <nng/http.h> + +int nng_http_set_reason(nng_http *conn, const char *reason); +---- + +== DESCRIPTION + +The `nng_http_set_reason()` sets the human readable reason +associated with the response for _conn_ to _reason_. + +If the value of _reason_ is `NULL` (the default), then a default reason +phrase is supplied based upon the value of the status code (see +xref:nng_http_set_status.3http.adoc[`nng_http_set_status()`]). + +TIP: The _reason_ is never parsed automatically, but it can be a hint for humans + to help them understand the nature of any erroneous result. + +A local copy of the _reason_ is made in the response _res_. + +== 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_get_reason.3http.adoc[nng_http_get_reason(3http)], +xref:nng_http_set_status.3http.adoc[nng_http_set_status(3http)] |
