Document HTTP server API completely.

1 files changed, 66 insertions, 0 deletions

diff --git a/docs/nng_http_hijack.adoc b/docs/nng_http_hijack.adoc
new file mode 100644
index 00000000..39105c1d
--- /dev/null
+++ b/docs/nng_http_hijack.adoc
@@ -0,0 +1,66 @@
+= nng_http_hijack(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_hijack - hijack HTTP server connection
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+void nng_http_hijack(nng_http_conn *conn);
+-----------
+
+== DESCRIPTION
+
+The `nng_http_hijack()` function hijacks the connection _conn_, causing it
+to be disassociated from the HTTP server where it was created.
+
+The purpose of this function is the creation of HTTP upgraders (such as
+WebSocket), where the underlying HTTP connection will be taken over for
+some other purpose, and should not be used any further by the server.
+
+This function is most useful when called from a handler function.
+(See <<nng_http_alloc_handler#,nng_http_alloc_handler(3).)
+
+NOTE: It is the responsibility of the caller to dispose of the underlying
+connection when it is no longer needed.  Furthermore, the HTTP server will
+no longer send any responses to the hijacked connection, so the caller should
+do that as well if appropriate.  (See
+<<nng_http_conn_write_res#,nng_http_conn_write_res(3)>>.)
+
+TIP: This function is intended to facilitate uses cases that involve changing
+the protocol from HTTP -- such as WebSocket.  Most applications will never need
+to use this function.
+
+== RETURN VALUES
+
+None.
+
+== ERRORS
+
+`NNG_ECLOSED`:: The connection was closed.
+`NNG_ENOMEM`:: Insufficient free memory exists.
+`NNG_ENOTSUP`:: HTTP not supported.
+
+== SEE ALSO
+
+<<nng_http_alloc_handler#,nng_http_alloc_handler(3)>>,
+<<nng_http_conn_write_res#,nng_http_conn_write_res(3)>>,
+<<nng_strerror#,nng_strerror(3)>>,
+<<nng#,nng(7)>>
+
+== COPYRIGHT
+
+{copyright}