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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
= nng_dialer_setopt(3)
//
// 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_dialer_setopt - set dialer option
== SYNOPSIS
[source, c]
----
#include <nng/nng.h>
int nng_dialer_setopt(nng_dialer d, const char *opt, const void *val,
size_t valsz);
int nng_dialer_setopt_bool(nng_dialer d, const char *opt, bool bval);
int nng_dialer_setopt_int(nng_dialer d, const char *opt, int ival);
int nng_dialer_setopt_ms(nng_dialer d, const char *opt, nng_duration dur);
int nng_dialer_setopt_ptr(nng_dialer d, const char *opt, void *ptr);
int nng_dialer_setopt_size(nng_dialer d, const char *opt, size_t z);
int nng_dialer_setopt_string(nng_dialer d, const char *opt, const char *str);
int nng_dialer_setopt_uint64(nng_dialer d, const char *opt, uint64_t u64);
----
== DESCRIPTION
(((options, dialer)))
The `nng_dialer_setopt()` functions are used to configure options for
the <<nng_dialer.5#,dialer>> _d_.
The actual options that may be configured in this way
vary, and many are documented in <<nng_options.5#,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
it's 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.
TIP: Generally, it will be easier to use one of the typed forms instead.
NOTE: No validation that the option is actually of the associated
type is performed, so the caller must take care to use the *correct* typed form.
==== `nng_dialer_setopt()`
This function is untyped, and can be used to configure any arbitrary data.
The _val_ pointer addresses the data to copy, and _valsz_ is the
size of the objected located at _val_.
==== `nng_dialer_setopt_bool()`
This function is for options which take a boolean (`bool`).
The _bval_ is passed to the option.
==== `nng_dialer_setopt_int()`
This function is for options which take an integer (`int`).
The _ival_ is passed to the option.
==== `nng_dialer_setopt_ms()`
This function is used to configure time durations (such as timeouts) using
type <<nng_duration.5#,`nng_duration`>>.
The duration _dur_ is an integer number of milliseconds.
==== `nng_dialer_setopt_ptr()`
This function is used to pass a pointer, _ptr_, to structured data.
The data referenced by _ptr_ is generally managed by other functions.
For example, TLS configuration objects created with
(<<nng_tls_config_alloc.3tls#,`nng_tls_config_alloc()`>>)
can be passed this way.
Note that this form is somewhat special in that the object is generally
not copied, but instead the *pointer* to the object is copied.
==== `nng_dialer_setopt_size()`
This function is used to configure a size, _z_, typically for buffer sizes,
message maximum sizes, and similar options.
==== `nng_dialer_setopt_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_setopt_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 similar.
== RETURN VALUES
These functions return 0 on success, and non-zero otherwise.
== ERRORS
`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
<<nng_dialer_create.3#,nng_dialer_create(3)>>
<<nng_dialer_getopt.3#,nng_dialer_getopt(3)>>
<<nng_strerror.3#,nng_strerror(3)>>,
<<nng_dialer.5#,nng_dialer(5)>>,
<<nng_duration.5#,nng_duration(5)>>,
<<nng_options.5#,nng_options(5)>>,
<<nng.7#,nng(7)>>
|
