diff options
| author | Garrett D'Amore <garrett@damore.org> | 2020-01-28 09:49:38 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2020-01-28 09:49:38 -0800 |
| commit | bd13268f356f83d541c4bce09eae02287d4ddbd9 (patch) | |
| tree | 1103b63eb4775442f18d8fe6b89d208f00f48cd2 /docs/man | |
| parent | 1dd217df4fd8e65709aca7352a2b0f8bc325c885 (diff) | |
| download | nng-bd13268f356f83d541c4bce09eae02287d4ddbd9.tar.gz nng-bd13268f356f83d541c4bce09eae02287d4ddbd9.tar.bz2 nng-bd13268f356f83d541c4bce09eae02287d4ddbd9.zip | |
Wordsmithing and markup changes for nng_http_handler_set_tree.
Diffstat (limited to 'docs/man')
| -rw-r--r-- | docs/man/nng_http_handler_set_tree.3http.adoc | 28 |
1 files changed, 18 insertions, 10 deletions
diff --git a/docs/man/nng_http_handler_set_tree.3http.adoc b/docs/man/nng_http_handler_set_tree.3http.adoc index dd2731f8..f0ecc4c9 100644 --- a/docs/man/nng_http_handler_set_tree.3http.adoc +++ b/docs/man/nng_http_handler_set_tree.3http.adoc @@ -1,6 +1,6 @@ = nng_http_handler_set_tree(3http) -// -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> + +// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> // Copyright 2020 Dirac Research <robert.bielik@dirac.com> // @@ -8,7 +8,6 @@ // 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 @@ -16,7 +15,7 @@ nng_http_handler_set_tree - set HTTP handler to match trees == SYNOPSIS -[source, c] +[source,c] ---- #include <nng/nng.h> #include <nng/supplemental/http/http.h> @@ -28,18 +27,27 @@ int nng_http_handler_set_tree_exclusive(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_. +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. The `nng_http_handler_set_tree_exclusive()` function is similar to `nng_http_server_set_tree()` -with the distinction that the _handler_ will be considered to *exclusively* handling its -Request URI. Other handlers will be tested against _handler_ when being added to a server, -possibly resulting in a URI conflict error. +with the distinction that the _handler_ will be considered to *exclusively* handle its request URI. +Unlike `nng_http_server_set_tree()`, it will not be possible to register additional +handlers in logical subdirectories of _handler_. + +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: These methods are useful when constructing API handlers where a single service address (path) supports dynamically generated children. +TIP: The non-exclusive form is also useful for providing a default handler to be +generated when a more specific child does not exist. +This can provide a better experience for users than the standard 404 error +handling. + == RETURN VALUES This function returns 0 on success, and non-zero otherwise. |
