aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_http_conn_read.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_conn_read.3http.adoc
parenta381af4f5ca79576a4a9b461529a0f22fcf1e088 (diff)
downloadnng-http-client-trans.tar.gz
nng-http-client-trans.tar.bz2
nng-http-client-trans.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_conn_read.3http.adoc')
-rw-r--r--docs/man/nng_http_conn_read.3http.adoc77
1 files changed, 0 insertions, 77 deletions
diff --git a/docs/man/nng_http_conn_read.3http.adoc b/docs/man/nng_http_conn_read.3http.adoc
deleted file mode 100644
index dfb6e08c..00000000
--- a/docs/man/nng_http_conn_read.3http.adoc
+++ /dev/null
@@ -1,77 +0,0 @@
-= nng_http_conn_read(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_conn_read - read from HTTP connection
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-#include <nng/supplemental/http/http.h>
-
-void nng_http_conn_read(nng_http_conn *conn, nng_aio *aio);
-----
-
-== DESCRIPTION
-
-The `nng_http_conn_read()` function starts an asynchronous read from the
-HTTP connection _conn_, into the scatter/gather vector located in the
-asynchronous I/O structure _aio_.
-
-NOTE: The xref:nng_aio_set_iov.3.adoc[`nng_aio_set_iov()`] function must have been
-called first, to set the scatter/gather vector for _aio_.
-
-This function returns immediately, with no return value.
-Completion of the operation is signaled via the _aio_,
-and the final result may be obtained via
-xref:nng_aio_result.3.adoc[`nng_aio_result()`].
-That result will either be zero or an error code.
-
-The I/O operation completes as soon as at least one byte has been
-read, or an error has occurred.
-Therefore, the number of bytes read may be less than requested.
-The actual number of bytes read can be determined with
-xref:nng_aio_count.3.adoc[`nng_aio_count()`].
-
-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_ECANCELED`:: The operation was canceled.
-`NNG_ECLOSED`:: The connection was closed.
-`NNG_ECONNRESET`:: The peer closed the connection.
-`NNG_EINVAL`:: The _aio_ does not contain a valid scatter/gather vector.
-`NNG_ENOMEM`:: Insufficient free memory to perform the operation.
-`NNG_ENOTSUP`:: HTTP operations are not supported.
-`NNG_ETIMEDOUT`:: Timeout waiting for data from the connection.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)],
-xref:nng_aio_count.3.adoc[nng_aio_count(3)],
-xref:nng_aio_result.3.adoc[nng_aio_result(3)],
-xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov(3)],
-xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)],
-xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)],
-xref:nng_http_conn_read_all.3http.adoc[nng_http_conn_read_all(3http)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng.7.adoc[nng(7)]