man/v1.7.2/nng_http_handler_set_tree.3http.html


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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

---
version: v1.7.2
layout: manpage_v2
title: nng_http_handler_set_tree(3http)
---
<h1>nng_http_handler_set_tree(3http)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_http_handler_set_tree - set HTTP handler to match trees</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="c"><span></span><span class="tok-cp">#include</span><span class="tok-w"> </span><span class="tok-cpf">&lt;nng/nng.h&gt;</span>
<span class="tok-cp">#include</span><span class="tok-w"> </span><span class="tok-cpf">&lt;nng/supplemental/http/http.h&gt;</span>

<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nng_http_handler_set_tree</span><span class="tok-p">(</span><span class="tok-n">nng_http_handler</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">handler</span><span class="tok-p">);</span>

<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nng_http_handler_set_tree_exclusive</span><span class="tok-p">(</span><span class="tok-n">nng_http_handler</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">handler</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>nng_http_handler_set_tree()</code> function causes the <em>handler</em> to be matched if the request URI sent
by the client is a logical child of the path for <em>handler</em>, and no more specific
<em>handler</em> has been registered.</p>
</div>
<div class="paragraph">
<p>The <code>nng_http_handler_set_tree_exclusive()</code> function is similar to <code>nng_http_server_set_tree()</code>
with the distinction that the <em>handler</em> will be considered to <strong>exclusively</strong> handle its request URI.
Unlike <code>nng_http_server_set_tree()</code>, it will not be possible to register additional
handlers in logical subdirectories of <em>handler</em>.</p>
</div>
<div class="paragraph">
<p>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.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
These methods are useful when constructing API handlers where a single
service address (path) supports dynamically generated children.
</td>
</tr>
</table>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
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.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This function returns 0 on success, and non-zero otherwise.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_errors">ERRORS</h2>
<div class="sectionbody">
<div class="hdlist">
<table>
<tr>
<td class="hdlist1">
<code>NNG_ENOMEM</code>
</td>
<td class="hdlist2">
<p>Insufficient free memory exists.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ENOTSUP</code>
</td>
<td class="hdlist2">
<p>No support for HTTP in the library.</p>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="paragraph text-left">
<p><a href="nng_http_handler_alloc.3http.html">nng_http_handler_alloc(3http)</a>,
<a href="nng_http_server_add_handler.3http.html">nng_http_server_add_handler(3http)</a>,
<a href="nng_http_req_get_method.3http.html">nng_http_req_get_method(3http)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>