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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
= nng_dialer_set(3)
//
// Copyright 2020 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_dialer_set - set dialer option
== SYNOPSIS
[source, c]
----
#include <nng/nng.h>
int nng_dialer_set_bool(nng_dialer d, const char *opt, bool bval);
int nng_dialer_set_int(nng_dialer d, const char *opt, int ival);
int nng_dialer_set_ms(nng_dialer d, const char *opt, nng_duration dur);
int nng_dialer_set_size(nng_dialer d, const char *opt, size_t z);
int nng_dialer_set_string(nng_dialer d, const char *opt, const char *str);
int nng_dialer_set_uint64(nng_dialer d, const char *opt, uint64_t u64);
----
== DESCRIPTION
(((options, dialer)))
The `nng_dialer_set` functions are used to configure options for
the xref:nng_dialer.5.adoc[dialer] _d_.
The actual options that may be configured in this way
vary, and many are documented in xref:nng_options.5.adoc[nng_options(5)].
Additionally some transport-specific options are documented with the transports themselves.
NOTE: Once a dialer has started, it is generally not possible to change
its configuration.
=== Forms
In all of these forms, the option _opt_ is configured on the dialer _d_.
The details of the type, size, and semantics of the option will depend
on the actual option, and will be documented with the option itself.
`nng_dialer_set_bool()`::
This function is for options which take a Boolean (`bool`).
The _bval_ is passed to the option.
`nng_dialer_set_int()`::
This function is for options which take an integer (`int`).
The _ival_ is passed to the option.
`nng_dialer_set_ms()`::
This function is used to configure time durations (such as timeouts) using
type xref:nng_duration.5.adoc[`nng_duration`].
The duration _dur_ is an integer number of milliseconds.
`nng_dialer_set_size()`::
This function is used to configure a size, _z_, typically for buffer sizes,
message maximum sizes, and similar options.
`nng_dialer_set_string()`::
This function is used to pass configure a string, _str_.
Strings passed this way must be legal UTF-8 or ASCII strings, terminated
with a `NUL` (`\0`) byte.
(Other constraints may apply as well, see the documentation for each option
for details.)
`nng_dialer_set_uint64()`::
This function is used to configure a 64-bit unsigned value, _u64_.
This is typically used for options related to identifiers, network numbers,
and such.
== RETURN VALUES
These functions return 0 on success, and non-zero otherwise.
== ERRORS
[horizontal]
`NNG_EBADTYPE`:: Incorrect type for option.
`NNG_ECLOSED`:: Parameter _d_ does not refer to an open dialer.
`NNG_EINVAL`:: The value being passed is invalid.
`NNG_ENOTSUP`:: The option _opt_ is not supported.
`NNG_EREADONLY`:: The option _opt_ is read-only.
`NNG_ESTATE`:: The dialer _d_ is already started.
== SEE ALSO
[.text-left]
xref:nng_dialer_create.3.adoc[nng_dialer_create(3)]
xref:nng_dialer_get.3.adoc[nng_dialer_get(3)]
xref:nng_strerror.3.adoc[nng_strerror(3)],
xref:nng_dialer.5.adoc[nng_dialer(5)],
xref:nng_duration.5.adoc[nng_duration(5)],
xref:nng_options.5.adoc[nng_options(5)],
xref:nng.7.adoc[nng(7)]
|
