aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_http_server_del_handler.3http.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/nng_http_server_del_handler.3http.adoc')
-rw-r--r--docs/man/nng_http_server_del_handler.3http.adoc48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/man/nng_http_server_del_handler.3http.adoc b/docs/man/nng_http_server_del_handler.3http.adoc
new file mode 100644
index 00000000..868ff73e
--- /dev/null
+++ b/docs/man/nng_http_server_del_handler.3http.adoc
@@ -0,0 +1,48 @@
+= nng_http_server_del_handler(3http)
+//
+// Copyright 2018 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_server_del_handler - delete HTTP server handler
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+#include <nng/supplemental/http/http.h>
+
+int nng_http_server_del_handler(nng_http_server *s, nng_http_handler *h);
+----
+
+== DESCRIPTION
+
+The `nng_http_server_del_handler()` removes the handler _h_ from the server
+instance _s_.
+
+Once a handler has been deleted from a server, it is the responsibility
+of the caller to dispose of the handler, or add it to another server instance.
+
+== RETURN VALUES
+
+This function returns 0 on success, and non-zero otherwise.
+
+== ERRORS
+
+`NNG_ENOENT`:: Handler is not registered with server.
+`NNG_ENOTSUP`:: HTTP not supported.
+
+== SEE ALSO
+
+<<nng_http_handler_free.3http#,nng_http_handler_free(3http)>>,
+<<nng_http_server_add_handler.3http#,nng_http_server_add_handler(3http)>>,
+<<nng_strerror.3#,nng_strerror(3)>>,
+<<nng.7#,nng(7)>>