diff options
| author | Garrett D'Amore <garrett@damore.org> | 2025-01-06 15:20:09 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2025-01-09 23:22:56 -0800 |
| commit | 73f50e2679525e7df8734c875a3c12732565f953 (patch) | |
| tree | 23bd167dfcd95305b58a29c142b51879011f63b2 /docs/man/nng_http_client_get_tls.3http.adoc | |
| parent | a381af4f5ca79576a4a9b461529a0f22fcf1e088 (diff) | |
| download | nng-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_get_tls.3http.adoc')
| -rw-r--r-- | docs/man/nng_http_client_get_tls.3http.adoc | 59 |
1 files changed, 0 insertions, 59 deletions
diff --git a/docs/man/nng_http_client_get_tls.3http.adoc b/docs/man/nng_http_client_get_tls.3http.adoc deleted file mode 100644 index 89f03029..00000000 --- a/docs/man/nng_http_client_get_tls.3http.adoc +++ /dev/null @@ -1,59 +0,0 @@ -= nng_http_client_get_tls(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_client_get_tls - get HTTP client TLS configuration - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> -#include <nng/supplemental/http/http.h> - -int nng_http_client_get_tls(nng_http_client *client, nng_tls_config **cfgp); ----- - -== DESCRIPTION - -The `nng_http_client_get_tls()` obtains the TLS configuration of _client_ and -saves a pointer to it in the address referenced by _cfgp_. - -The object will be returned with an extra hold (see -xref:nng_tls_config_hold.3tls.adoc[`nng_tls_config_hold()`]) -placed on it on behalf of the caller. -The caller should free this hold by calling -xref:nng_tls_config_free.3tls.adoc[`nng_tls_config_free()`] with it is done -with the TLS configuration. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_EINVAL`:: TLS not configured on client. -`NNG_ENOMEM`:: Insufficient free memory exists. -`NNG_ENOTSUP`:: Either HTTP or TLS not supported. - -== SEE ALSO - -[.text-left] -xref:nng_http_client_alloc.3http.adoc[nng_http_client_alloc(3http)], -xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)], -xref:nng_http_client_set_tls.3http.adoc[nng_http_client_set_tls(3http)], -xref:nng_tls_config_alloc.3tls.adoc[nng_tls_config_alloc(3tls)], -xref:nng_tls_config_free.3tls.adoc[nng_tls_config_free(3tls)], -xref:nng_tls_config_hold.3tls.adoc[nng_tls_config_hold(3tls)], -xref:nng_strerror.3.adoc[nng_strerror(3)], -xref:nng.7.adoc[nng(7)] |
