From 5cf750697624d4fd63cfe26921209d7c30e1a2d2 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Mon, 21 Jan 2019 22:40:10 -0800 Subject: 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. --- docs/man/nng_tls_dialer_dial.3tls.adoc | 65 ---------------------------------- 1 file changed, 65 deletions(-) delete mode 100644 docs/man/nng_tls_dialer_dial.3tls.adoc (limited to 'docs/man/nng_tls_dialer_dial.3tls.adoc') 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. -// Copyright 2018 Capitar IT Group BV -// Copyright 2019 Devolutions -// -// 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 -#include - -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 <> stored as its first output. -(See <>.) - -== 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] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> -- cgit v1.2.3-70-g09d2