From 51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Tue, 6 Feb 2018 16:07:10 -0800
Subject: Document HTTP server API completely.

---
 docs/nng_http_handler_set_method.adoc | 61 +++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 docs/nng_http_handler_set_method.adoc

(limited to 'docs/nng_http_handler_set_method.adoc')

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}
-- 
cgit v1.2.3-70-g09d2