aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_tcp_dialer.5.adoc
blob: 651afd02f0e11ce8ea5c00d6d9d780661c58165e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
= 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)>>