diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-12-22 11:52:04 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-12-22 11:52:04 -0800 |
| commit | 497b8e22047fb0efa3397289d23656d6483fdd6d (patch) | |
| tree | 8f2caf7dddc49e144b7e715ed64999792e796f66 /docs | |
| parent | 8d1b52931b1d7ad8fabffe0098b9bc31c0b61a9b (diff) | |
| download | nng-497b8e22047fb0efa3397289d23656d6483fdd6d.tar.gz nng-497b8e22047fb0efa3397289d23656d6483fdd6d.tar.bz2 nng-497b8e22047fb0efa3397289d23656d6483fdd6d.zip | |
http: setting response status never fails (breaking API change)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/nng_http_res_set_status.3http.adoc | 11 | ||||
| -rw-r--r-- | docs/ref/migrate/nng1.md | 3 |
2 files changed, 3 insertions, 11 deletions
diff --git a/docs/man/nng_http_res_set_status.3http.adoc b/docs/man/nng_http_res_set_status.3http.adoc index e57764d4..a1374941 100644 --- a/docs/man/nng_http_res_set_status.3http.adoc +++ b/docs/man/nng_http_res_set_status.3http.adoc @@ -20,7 +20,7 @@ nng_http_res_set_status - set HTTP response status #include <nng/nng.h> #include <nng/supplemental/http/http.h> -int nng_http_res_set_status(nng_http_res *res, uint16_t status); +void nng_http_res_set_status(nng_http_res *res, uint16_t status); ---- == DESCRIPTION @@ -106,15 +106,6 @@ TIP: It is a good idea to also set the reason message with xref:nng_http_res_set_reason.3http.adoc[`nng_http_set_reason()`]. This will help any humans who may have to diagnose a failure. -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_ENOTSUP`:: No support for HTTP in the library. - == SEE ALSO [.text-left] diff --git a/docs/ref/migrate/nng1.md b/docs/ref/migrate/nng1.md index bca68e38..8a1af631 100644 --- a/docs/ref/migrate/nng1.md +++ b/docs/ref/migrate/nng1.md @@ -221,7 +221,8 @@ accessors functions are provided: ## HTTP API -The [`nng_http_req_set_method`] no longer returns a value. It never fails, but it may truncate an unreasonably long value. +- [`nng_http_req_set_method`] no longer returns a value. It never fails, but it may truncate an unreasonably long value. +- [`nng_http_res_set_status`] no longer returns a value, and cannot fail. ## Security Descriptors (Windows Only) |