aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_tcp_dialer.5.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2019-01-21 22:40:10 -0800
committerGarrett D'Amore <garrett@damore.org>2019-02-16 19:22:27 -0800
commit5cf750697624d4fd63cfe26921209d7c30e1a2d2 (patch)
treebf11695e5f1ec5e400c87da0cc6ff23935a2eeff /docs/man/nng_tcp_dialer.5.adoc
parentca655b9db689ee0e655248b1a9f166b8db6cc984 (diff)
downloadnng-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_tcp_dialer.5.adoc')
-rw-r--r--docs/man/nng_tcp_dialer.5.adoc49
1 files changed, 0 insertions, 49 deletions
diff --git a/docs/man/nng_tcp_dialer.5.adoc b/docs/man/nng_tcp_dialer.5.adoc
deleted file mode 100644
index 651afd02..00000000
--- a/docs/man/nng_tcp_dialer.5.adoc
+++ /dev/null
@@ -1,49 +0,0 @@
-= nng_tcp_dialer(5)
-//
-// Copyright 2019 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_tcp_dialer - TCP dialer
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-typedef struct nng_tcp_dialer_s nng_tcp_dialer;
-----
-
-== DESCRIPTION
-
-(((TCP, dialer)))
-An `nng_tcp_dialer` is a handle to a TCP "`dialer`", which is responsible for
-creating connections (<<nng_tcp.5#,`nng_tcp`>> objects) by connecting to
-remote systems.
-
-NOTE: The `nng_tcp_dialer` object is used for raw TCP connections, and
-should not be confused with a dialer object created using the
-<<nng_tcp.7#,nng_tcp(7)>> transport.
-
-TIP: Most NNG applications should not use this, but instead use the
-<<nng_tcp.7#,`nng_tcp`>> transport instead.
-
-== SEE ALSO
-
-[.text-left]
-<<nng_tcp_dialer_alloc.3tcp#,nng_tcp_dialer_alloc(3tcp)>>,
-<<nng_tcp_dialer_close.3tcp#,nng_tcp_dialer_close(3tcp)>>,
-<<nng_tcp_dialer_dial.3tcp#,nng_tcp_dialer_dial(3tcp)>>,
-<<nng_tcp_dialer_free.3tcp#,nng_tcp_dialer_free(3tcp)>>,
-<<nng_tcp.5#,nng_tcp(5)>>,
-<<nng_tcp_listener.5#,nng_tcp_listener(5)>>,
-<<nng_tcp.7#,nng_tcp(7)>>