diff options
| author | Garrett D'Amore <garrett@damore.org> | 2019-01-21 22:40:10 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2019-02-16 19:22:27 -0800 |
| commit | 5cf750697624d4fd63cfe26921209d7c30e1a2d2 (patch) | |
| tree | bf11695e5f1ec5e400c87da0cc6ff23935a2eeff /docs/man/nng_tls_dialer_dial.3tls.adoc | |
| parent | ca655b9db689ee0e655248b1a9f166b8db6cc984 (diff) | |
| download | nng-5cf750697624d4fd63cfe26921209d7c30e1a2d2.tar.gz nng-5cf750697624d4fd63cfe26921209d7c30e1a2d2.tar.bz2 nng-5cf750697624d4fd63cfe26921209d7c30e1a2d2.zip | |
fixes #872 create unified nng_stream API
This is a major change, and includes changes to use a polymorphic
stream API for all transports. There have been related bugs fixed
along the way. Additionally the man pages have changed.
The old non-polymorphic APIs are removed now. This is a breaking
change, but the old APIs were never part of any released public API.
Diffstat (limited to 'docs/man/nng_tls_dialer_dial.3tls.adoc')
| -rw-r--r-- | docs/man/nng_tls_dialer_dial.3tls.adoc | 65 |
1 files changed, 0 insertions, 65 deletions
diff --git a/docs/man/nng_tls_dialer_dial.3tls.adoc b/docs/man/nng_tls_dialer_dial.3tls.adoc deleted file mode 100644 index 31d9036d..00000000 --- a/docs/man/nng_tls_dialer_dial.3tls.adoc +++ /dev/null @@ -1,65 +0,0 @@ -= nng_tls_dialer_dial(3tls) -// -// Copyright 2019 Staysail Systems, Inc. <info@staysail.tech> -// Copyright 2018 Capitar IT Group BV <info@capitar.com> -// Copyright 2019 Devolutions <info@devolutions.net> -// -// 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_tls_dialer_dial - initiate outgoing TLS connection - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> -#include <nng/supplemental/tls/tls.h> - -void nng_tls_dialer_dial(nng_tls_dialer *d, const nng_sockaddr *sa, nng_aio *aio); ----- - -== DESCRIPTION - -The `nng_tls_dialer_dial()` attempts to establish a TLS connection to the -remote peer identified by _sa_, using the dialer _d_. -The operation is completed asynchronously, using _aio_. - -The address _sa_ must be in the `NNG_AF_INET` or `NNG_AF_INET6` families, -and have a valid IPv4 or IPv6 address and TCP port number. - -If a connection is successfully established, the _aio_ will have the -resulting <<nng_tls.5#,`nng_tls`>> stored as its first output. -(See <<nng_aio_get_output.3#,`nng_aio_get_output()`>>.) - -== RETURN VALUES - -None. - -== ERRORS - -[horizontal] -`NNG_EADDRINVAL`:: The address specified is invalid. -`NNG_ECANCELED`:: The operation was aborted. -`NNG_ECLOSED`:: The dialer is closed. -`NNG_ECONNREFUSED`:: The connection was refused by the server. -`NNG_ECONNRESET`:: The connection was reset by the server. -`NNG_ECRYPTO`:: Cryptographic or certificate validation error. -`NNG_ENOMEM`:: Insufficient free memory exists. - -== SEE ALSO - -[.text-left] -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_tls_dialer_alloc.3tls#,nng_tls_dialer_alloc(3tls)>>, -<<nng_tls_dialer_close.3tls#,nng_tls_dialer_close(3tls)>>, -<<nng_tls_dialer_free.3tls#,nng_tls_dialer_free(3tls)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng_sockaddr.5#,nng_sockaddr(5)>>, -<<nng_tls.5#,nng_tls(5)>>, -<<nng_tls_dialer.5#,nng_tls_dialer(5)>> |