From d04b0cfcb5a37f5b6b6ba0fbd031bdbad94399b1 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Tue, 27 Nov 2018 16:27:20 -0800
Subject: fixes #680 Public TCP API

---
 docs/man/nng_tcp_dialer.5.adoc | 49 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 docs/man/nng_tcp_dialer.5.adoc

(limited to 'docs/man/nng_tcp_dialer.5.adoc')

diff --git a/docs/man/nng_tcp_dialer.5.adoc b/docs/man/nng_tcp_dialer.5.adoc
new file mode 100644
index 00000000..99df685d
--- /dev/null
+++ b/docs/man/nng_tcp_dialer.5.adoc
@@ -0,0 +1,49 @@
+= nng_tcp_dialer(5)
+//
+// 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_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 a 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)>>
-- 
cgit v1.2.3-70-g09d2

