aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_http_handler_set_tree.adoc
blob: 45b998bc5fc3664715ac33c5acd7178c798ab590 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
= nng_http_handler_set_tree(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_tree - set HTTP handler to match trees

== SYNOPSIS

[source, c]
-----------
#include <nng/nng.h>

int 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_.

TIP: This method is useful when constructing API handlers where a single
service address (path) supports dynamically generated children.

== 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}