diff options
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)] |