aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_http_hijack.3http.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-01-06 15:20:09 -0800
committerGarrett D'Amore <garrett@damore.org>2025-01-09 23:22:56 -0800
commit73f50e2679525e7df8734c875a3c12732565f953 (patch)
tree23bd167dfcd95305b58a29c142b51879011f63b2 /docs/man/nng_http_hijack.3http.adoc
parenta381af4f5ca79576a4a9b461529a0f22fcf1e088 (diff)
downloadnng-73f50e2679525e7df8734c875a3c12732565f953.tar.gz
nng-73f50e2679525e7df8734c875a3c12732565f953.tar.bz2
nng-73f50e2679525e7df8734c875a3c12732565f953.zip
http: The big HTTP API refactoring of January 2025.v2.0.0-alpha.3http-client-trans
This represents a major change in the HTTP code base, consisting of a complete revamp of the HTTP API. The changes here are too numerous to mention, but the end result should be a vastly simpler API for both server and client applications. Many needless allocations were removed by providing fixed buffers for various parameters and headers when possible. A few bugs were fixed. Most especially we have fixed some bugs around very large URIs and headers, and we have also addressed conformance bugs to more closely conform to RFCs 9110 and 9112. As part of this work, the APIs for WebSockets changed slightly as well. In particular the properties available for accessing headers have changed. There is still documentation conversion work to do, and additional functionality (such as proper support for chunked transfers), but this is a big step in the right direction.
Diffstat (limited to 'docs/man/nng_http_hijack.3http.adoc')
-rw-r--r--docs/man/nng_http_hijack.3http.adoc65
1 files changed, 0 insertions, 65 deletions
diff --git a/docs/man/nng_http_hijack.3http.adoc b/docs/man/nng_http_hijack.3http.adoc
deleted file mode 100644
index 51231425..00000000
--- a/docs/man/nng_http_hijack.3http.adoc
+++ /dev/null
@@ -1,65 +0,0 @@
-= 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 xref:nng_http_handler_alloc.3http.adoc[`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 xref:nng_http_conn_write_res.3http.adoc[`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
-
-[horizontal]
-`NNG_ECLOSED`:: The connection was closed.
-`NNG_ENOMEM`:: Insufficient free memory exists.
-`NNG_ENOTSUP`:: HTTP not supported.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_http_conn_write_res.3http.adoc[nng_http_conn_write_res(3http)],
-xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)],
-xref:nng.7.adoc[nng(7)]