aboutsummaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-12-22 11:40:36 -0800
committerGarrett D'Amore <garrett@damore.org>2024-12-22 11:40:36 -0800
commit8d1b52931b1d7ad8fabffe0098b9bc31c0b61a9b (patch)
treeb6bf2966a0fa4dbabcd06bdaf0135776f11f6563 /docs/man
parent6800bdd8b9e3fd4488bab56cd9fb12206d0631f6 (diff)
downloadnng-8d1b52931b1d7ad8fabffe0098b9bc31c0b61a9b.tar.gz
nng-8d1b52931b1d7ad8fabffe0098b9bc31c0b61a9b.tar.bz2
nng-8d1b52931b1d7ad8fabffe0098b9bc31c0b61a9b.zip
http: method on request structure is now static
This saves yet another allocation. It also no longer returns a value making this a breaking change.
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/nng_http_req_set_method.3http.adoc15
1 files changed, 4 insertions, 11 deletions
diff --git a/docs/man/nng_http_req_set_method.3http.adoc b/docs/man/nng_http_req_set_method.3http.adoc
index bc80b832..9cd4f638 100644
--- a/docs/man/nng_http_req_set_method.3http.adoc
+++ b/docs/man/nng_http_req_set_method.3http.adoc
@@ -20,7 +20,7 @@ nng_http_req_set_method - set HTTP request method
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>
-int nng_http_req_set_method(nng_http_req *req, const char *method);
+void nng_http_req_set_method(nng_http_req *req, const char *method);
----
== DESCRIPTION
@@ -32,17 +32,10 @@ be upper case.
The default value method for newly allocated requests is "GET".
-A local copy of the _method_ is made in the request _req_.
-
-== RETURN VALUES
-
-This function returns 0 on success, and non-zero otherwise.
+If the method is longer than 32 bytes, it may be silently truncated.
+(There are no methods defined that are this long.)
-== ERRORS
-
-[horizontal]
-`NNG_ENOMEM`:: Insufficient memory to perform the operation.
-`NNG_ENOTSUP`:: No support for HTTP in the library.
+A local copy of the _method_ is made in the request _req_.
== SEE ALSO