From c4ca4834e39e48676ea50df1fc6239c7dc2a56ff Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Wed, 15 Jan 2025 08:14:00 -0800 Subject: http docs: documentation conversion for http handlers This is not yet fully complete, but it's most of the content. --- docs/man/nng_http_handler_set_tree.3http.adoc | 45 --------------------------- 1 file changed, 45 deletions(-) delete mode 100644 docs/man/nng_http_handler_set_tree.3http.adoc (limited to 'docs/man/nng_http_handler_set_tree.3http.adoc') diff --git a/docs/man/nng_http_handler_set_tree.3http.adoc b/docs/man/nng_http_handler_set_tree.3http.adoc deleted file mode 100644 index 77b1cc59..00000000 --- a/docs/man/nng_http_handler_set_tree.3http.adoc +++ /dev/null @@ -1,45 +0,0 @@ -= nng_http_handler_set_tree(3http) - -// Copyright 2025 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// Copyright 2020 Dirac Research -// -// 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_handler_set_tree - set HTTP handler to match trees - -== SYNOPSIS - -[source,c] ----- -#include -#include - -void nng_http_handler_set_tree(nng_http_handler *handler); ----- - -== DESCRIPTION - -The `nng_http_handler_set_tree()` function causes the _handler_ to be matched if the request URI sent -by the client is a logical child of the path for _handler_, and no more specific -_handler_ has been registered. - -This is useful in cases when the handler would like to examine the entire path -and possibly behave differently; for example a REST API that uses the rest of -the path to pass additional parameters. - -TIP: This function is useful when constructing API handlers where a single -service address (path) supports dynamically generated children. -It can also provide a logical fallback instead of relying on a 404 error code. - -== SEE ALSO - -[.text-left] -xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)], -xref:nng_http_server_add_handler.3http.adoc[nng_http_server_add_handler(3http)], -xref:nng_http_get_method.3http.adoc[nng_http_get_method(3http)] -- cgit v1.2.3-70-g09d2