aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_http_handler_set_method.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-06 16:07:10 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-06 16:07:10 -0800
commit51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9 (patch)
treef320ab2eec336cb781aa3774260e99a35d97e991 /docs/nng_http_handler_set_method.adoc
parent3b33f6878ee628da22fd4451f248c036aae231ed (diff)
downloadnng-51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9.tar.gz
nng-51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9.tar.bz2
nng-51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9.zip
Document HTTP server API completely.
Diffstat (limited to 'docs/nng_http_handler_set_method.adoc')
-rw-r--r--docs/nng_http_handler_set_method.adoc61
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/nng_http_handler_set_method.adoc b/docs/nng_http_handler_set_method.adoc
new file mode 100644
index 00000000..a993868e
--- /dev/null
+++ b/docs/nng_http_handler_set_method.adoc
@@ -0,0 +1,61 @@
+= nng_http_handler_set_method(3)
+:doctype: manpage
+:manmanual: nng
+:mansource: nng
+:manvolnum: 3
+:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \
+ Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \
+ {blank} + \
+ This document is supplied under the terms of the \
+ https://opensource.org/licenses/MIT[MIT License].
+
+== NAME
+
+nng_http_handler_set_method - set HTTP handler method
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+int nng_http_handler_set_method(nng_http_handler *handler, const char *method);
+-----------
+
+== DESCRIPTION
+
+The `nng_http_handler_set_method()` function sets the _method_ that the
+_handler_ will be called for, such as "GET" or "POST". (By default the
+"GET" method is handled.) If _method_ is `NULL`, then the request method
+is not examined, and the handler will be executed regardless of the
+method.
+
+NOTE: The server will automatically call "GET" handlers if the client
+sends a "HEAD" request, and will suppress HTTP body data in the responses
+sent for such requests.
+
+NOTE: No validation of the _method_ is performed, but HTTP specifications
+insist that the actual method sent over the wire be capitalized.
+
+The handler may always examine the actual method used using the
+<<nng_http_req_get_method#,nng_http_req_get_method(3)>> function.
+
+== RETURN VALUES
+
+This function returns 0 on success, and non-zero otherwise.
+
+== ERRORS
+
+`NNG_ENOMEM`:: Insufficient free memory exists.
+`NNG_ENOTSUP`:: No support for HTTP in the library.
+
+== SEE ALSO
+
+<<nng_http_handler_alloc#,nng_http_handler_alloc(3)>>,
+<<nng_http_server_add_handler#,nng_http_server_add_handler(3)>>,
+<<nng_http_req_get_method#,nng_http_req_get_method(3)>>,
+<<nng#,nng(7)>>
+
+== COPYRIGHT
+
+{copyright}