aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_http_conn_close.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-02 16:59:26 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-02 17:02:44 -0800
commitb893f8ff1f96dde567fa6a75f4b15bf69e53d6f5 (patch)
tree3a813aaccb9be661be3c6e9ecd7a80b5c7d81ecd /docs/nng_http_conn_close.adoc
parentc2deb4a479be750b054372e83154f4b3b051c95a (diff)
downloadnng-b893f8ff1f96dde567fa6a75f4b15bf69e53d6f5.tar.gz
nng-b893f8ff1f96dde567fa6a75f4b15bf69e53d6f5.tar.bz2
nng-b893f8ff1f96dde567fa6a75f4b15bf69e53d6f5.zip
Document the HTTP connection handling API.
Diffstat (limited to 'docs/nng_http_conn_close.adoc')
-rw-r--r--docs/nng_http_conn_close.adoc49
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/nng_http_conn_close.adoc b/docs/nng_http_conn_close.adoc
new file mode 100644
index 00000000..885015a6
--- /dev/null
+++ b/docs/nng_http_conn_close.adoc
@@ -0,0 +1,49 @@
+= nng_http_conn_close(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_conn_close - close HTTP connection
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+void nng_http_conn_close(nng_http_conn *conn);
+-----------
+
+== DESCRIPTION
+
+The `nng_http_conn_close()` function closes the supplied HTTP connection _conn_,
+including any disposing of any underlying file descriptors or related resources.
+
+Once this function, no further access to the _conn_ structure may be made.
+
+== RETURN VALUES
+
+None.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+<<nng_http_client_connect#,nng_http_client_connect(3)>>,
+<<nng_http_alloc_handler#,nng_http_alloc_handler(3)>>,
+<<nng_strerror#,nng_strerror(3)>>,
+<<nng#,nng(7)>>
+
+== COPYRIGHT
+
+{copyright}