From 98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Thu, 15 Mar 2018 08:40:17 -0700
Subject: fixes #286 nng_pair0_open (and all others) need man page fixes #279
 consider restructuring man sections

This represents a rather significant rework, and major editing
effort, for the entire set of manual pages.

All of the pages now have a section number in their filename;
this assists in some other tooling, particularly ebook generation
as every link needs to be programmatically modified when combined
into an ebook.

Section 5 is introduced, and populated with pages for the main
types, and all options are now documented.

Numerous errors have been corrected, including rewriting certain
portions such as the header section of the surveyor protocol.

Much work has been done to facilitate index generation, although
certainly more work remains here.

Every internal link within these pages now resolves; there are no
more dead links.  (This is required to generate Kindle format books.)
---
 docs/man/nng_http_hijack.3http.adoc | 63 +++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 docs/man/nng_http_hijack.3http.adoc

(limited to 'docs/man/nng_http_hijack.3http.adoc')

diff --git a/docs/man/nng_http_hijack.3http.adoc b/docs/man/nng_http_hijack.3http.adoc
new file mode 100644
index 00000000..61f6d471
--- /dev/null
+++ b/docs/man/nng_http_hijack.3http.adoc
@@ -0,0 +1,63 @@
+= nng_http_hijack(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_hijack - hijack HTTP server connection
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+#include <nng/supplemental/http/http.h>
+
+void nng_http_hijack(nng_http_conn *conn);
+----
+
+== DESCRIPTION
+(((HTTP, hijack)))
+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_handler_alloc.3http#,`nng_http_handler_alloc()`>>.)
+
+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.3http#,`nng_http_conn_write_res()`>>.)
+
+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_strerror.3#,nng_strerror(3)>>,
+<<nng_http_conn_write_res.3http#,nng_http_conn_write_res(3http)>>,
+<<nng_http_handler_alloc.3http#,nng_http_handler_alloc(3http)>>,
+<<nng.7#,nng(7)>>
-- 
cgit v1.2.3-70-g09d2

