diff options
Diffstat (limited to 'docs/nng_http_client_get_tls.adoc')
| -rw-r--r-- | docs/nng_http_client_get_tls.adoc | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/nng_http_client_get_tls.adoc b/docs/nng_http_client_get_tls.adoc new file mode 100644 index 00000000..ecf7f5fd --- /dev/null +++ b/docs/nng_http_client_get_tls.adoc @@ -0,0 +1,54 @@ += nng_http_client_get_tls(3) +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + +nng_http_client_get_tls - get HTTP client TLS configuration + +== SYNOPSIS + +[source, c] +----------- +#include <nng/nng.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 configuration will be `NULL` if the HTTP client instance is not enabled +to use HTTPS. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +`NNG_ENOMEM`:: Insufficient free memory exists. +`NNG_ENOTSUP`:: Either HTTP or TLS not supported. + +== SEE ALSO + +<<nng_http_client_alloc#,nng_http_client_alloc(3)>>, +<<nng_http_client_connect#,nng_http_client_connect(3)>>, +<<nng_http_client_set_tls#,nng_http_client_set_tls(3)>>, +<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, +<<nng_strerror#,nng_strerror(3)>>, +<<nng#,nng(7)>> + +== COPYRIGHT + +{copyright} |
