aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_http_server_release.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-06 16:07:10 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-06 16:07:10 -0800
commit51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9 (patch)
treef320ab2eec336cb781aa3774260e99a35d97e991 /docs/nng_http_server_release.adoc
parent3b33f6878ee628da22fd4451f248c036aae231ed (diff)
downloadnng-51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9.tar.gz
nng-51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9.tar.bz2
nng-51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9.zip
Document HTTP server API completely.
Diffstat (limited to 'docs/nng_http_server_release.adoc')
-rw-r--r--docs/nng_http_server_release.adoc57
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/nng_http_server_release.adoc b/docs/nng_http_server_release.adoc
new file mode 100644
index 00000000..7e293981
--- /dev/null
+++ b/docs/nng_http_server_release.adoc
@@ -0,0 +1,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}