aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_http_server_release.adoc
blob: 7e2939816599345418cac04d33c3440e40fc468f (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_release(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_server_release - release HTTP server instance

== SYNOPSIS

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

void nng_http_server_release(nng_http_server *server);
-----------


== DESCRIPTION

The `nng_http_server_release()` releases an instance of an HTTP _server_
that was previously held with
<<nng_http_server_hold#,nng_http_server_hold(3)>>.

This effectively drops the reference count on the server instance.  When
the reference count drops to zero, then the _server_ and all resources
associated with it (e.g. HTTP handlers, connections, etc.) are deallocated.
(If the server is "running" when this occurs, then the server is stopped.)

WARNING: It is an error to release an instance of a server that has
not previously been held, or to attempt to release an instance more
times than it has been held.

== RETURN VALUES

None.

== ERRORS

None.

== SEE ALSO

<<nng_http_server_hold#,nng_http_server_hold(3)>>,
<<nng_http_server_stop#,nng_http_server_stop(3)>>,
<<nng#,nng(7)>>

== COPYRIGHT

{copyright}