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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
= nng_tcp_dialer_getopt(3tcp)
//
// Copyright 2018 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_tcp_dialer_getopt - get option from TCP dialer
== SYNOPSIS
[source, c]
----
#include <nng/nng.h>
#include <nng/supplemental/tcp/tcp.h>
int nng_tcp_getopt(nng_tcp_dialer *d, const char *name, void *data, size_t *sizep);
----
== DESCRIPTION
The `nng_tcp_dialer_getopt()` is used to retrieve the value of the option _name_ for the <<nng_tcp_dialer.5#,TCP dialer>> _d_.
The size of the buffer located at _data_ to receive the copy is passed by the
caller at the location referenced by _sizep_.
If this size is sufficient to hold the entire object, the object is copied into
the buffer specified by _data_.
In either event, the size of the source object (the amount of data copied,
or that would have been copied if sufficient space were available) is stored
at the location of _sizep_.
=== Options
The options specifically suppported for retrieval from TCP dialers are:
* <<nng_options.5#NNG_OPT_LOCADDR,`NNG_OPT_LOCADDR`>>
* <<nng_options.5#NNG_OPT_TCP_KEEPALIVE,`NNG_OPT_TCP_KEEPALIVE`>>
* <<nng_options.5#NNG_OPT_TCP_NODELAY,`NNG_OPT_TCP_NODELAY`>>
== RETURN VALUES
This function returns 0 on success, and non-zero otherwise.
== ERRORS
[horizontal]
`NNG_ECLOSED`:: The dialer is closed.
`NNG_EINVAL`:: There was insufficient space to receive the object.
The amount of data actually needed is returned in _sizep_.
`NNG_ENOTSUP`:: The option _name_ is not supported.
`NNG_EWRITEONLY`:: The option _name_ may not read.
== SEE ALSO
[.text-left]
<<nng_tcp_dialer_setopt.3tcp#,nng_tcp_dialer_setopt(3tcp)>>,
<<nng_tcp_getopt.3tcp#,nng_tcp_getopt(3tcp)>>,
<<nng_options.5#,nng_options(5)>>,
<<nng_strerror.3#,nng_strerror(3)>>,
<<nng_tcp.5#,nng_tcp(5)>>,
<<nng_tcp_dialer.5#,nng_tcp_dialer(5)>>
|
