summaryrefslogtreecommitdiff
path: root/docs/man/nng_http_server_add_handler.3http.adoc
blob: 489489b1f0836182baa69e234d4cc55d8d2cb45c (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
53
54
55
56
57
= nng_http_server_add_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_add_handler - add HTTP server handler

== SYNOPSIS

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

int nng_http_server_add_handler(nng_http_server *s, nng_http_handler *h);
----

== DESCRIPTION

The `nng_http_server_add_handler()` adds the handler _h_ to the server
instance _s_.

If another handler is already added to the server that would conflict
with handler _h_, then the operation will fail with `NNG_EADDRINUSE`.

If a handler is added to a server, and the server is subsequently
deallocated, the handler and any of its resources will also be deallocated.

Handlers that are added to a server may be subsequently removed using the
<<nng_http_server_del_handler.3http#,`nng_http_server_del_handler()`>> function.

== RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

== ERRORS

`NNG_EADDRINUSE`:: Handler conflicts with another handler.
`NNG_ENOMEM`:: Insufficient free memory exists.
`NNG_ENOTSUP`:: HTTP not supported.

== SEE ALSO


<<nng_http_handler_alloc.3http#,nng_http_handler_alloc(3http)>>,
<<nng_http_server_del_handler.3http#,nng_http_server_del_handler(3http)>>,
<<nng_http_server_hold.3http#,nng_http_server_hold(3http)>>,
<<nng_strerror.3#,nng_strerror(3)>>,
<<nng.7#,nng(7)>>