aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_http_client_transact.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_client_transact.3http.adoc
parenta381af4f5ca79576a4a9b461529a0f22fcf1e088 (diff)
downloadnng-2.0.0-alpha.3.tar.gz
nng-2.0.0-alpha.3.tar.bz2
nng-2.0.0-alpha.3.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_client_transact.3http.adoc')
-rw-r--r--docs/man/nng_http_client_transact.3http.adoc84
1 files changed, 0 insertions, 84 deletions
diff --git a/docs/man/nng_http_client_transact.3http.adoc b/docs/man/nng_http_client_transact.3http.adoc
deleted file mode 100644
index 0585fa7e..00000000
--- a/docs/man/nng_http_client_transact.3http.adoc
+++ /dev/null
@@ -1,84 +0,0 @@
-= nng_http_client_transact(3http)
-//
-// Copyright 2020 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_client_transact - perform one HTTP transaction
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-#include <nng/supplemental/http/http.h>
-
-void nng_http_client_transact(nng_http_client *client, nng_http_req *req,
- nng_http_res *res, nng_aio *aio);
-----
-
-== DESCRIPTION
-
-The `nng_http_client_transact()` function is used to perform a complete
-HTTP exchange.
-It creates a new connection using _client_, performs the transaction by
-sending the request _req_
-(and attached body data) to the remote server, then reading the response
-_res_, and finally closes the connection that it created.
-The entire response is read, including any associated body, which can
-subsequently be obtained using
-xref:nng_http_res_get_data.3http.adoc[`nng_http_res_get_data()`].
-
-This function is intended to make creation of client applications easier,
-by performing multiple asynchronous operations required to complete an
-entire HTTP transaction.
-
-A similar function,
-xref:nng_http_conn_transact.3http.adoc[`nng_http_conn_transact()`],
-exists.
-That function behaves similarily, but uses an existing connection, which
-can be reused.
-
-WARNING: If the remote server tries to send an extremely large buffer,
-then a corresponding allocation will be made, which can lead to denial
-of service attacks.
-Client applications should take care to use this only with reasonably
-trust-worthy servers.
-
-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.
-
-== 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_ENOMEM`:: Insufficient free memory to perform the operation.
-`NNG_ENOTSUP`:: HTTP operations are not supported, or peer sent chunked encoding.
-`NNG_EPROTO`:: An HTTP protocol error occurred.
-`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_result.3.adoc[nng_aio_result(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)],
-xref:nng_http_conn_transact.3http.adoc[nng_http_conn_transact(3http)],
-xref:nng_http_res_get_data.3http.adoc[nng_http_res_get_data(3http)],
-xref:nng.7.adoc[nng(7)]