aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_dialer_set.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-11-03 09:15:48 -0800
committerGarrett D'Amore <garrett@damore.org>2024-11-03 09:17:08 -0800
commitc77e32bc6da45a2c20b70451a6fb9d0caf636c75 (patch)
treee4adca494a120f37460c1f79c5f122c6ee65ffae /docs/man/nng_dialer_set.3.adoc
parentfb7f83b4c6f371372f742ff45f5efb8e83374f8c (diff)
downloadnng-c77e32bc6da45a2c20b70451a6fb9d0caf636c75.tar.gz
nng-c77e32bc6da45a2c20b70451a6fb9d0caf636c75.tar.bz2
nng-c77e32bc6da45a2c20b70451a6fb9d0caf636c75.zip
Remove untyped nng_dialer_get/set and nng_listener_get/set.
Diffstat (limited to 'docs/man/nng_dialer_set.3.adoc')
-rw-r--r--docs/man/nng_dialer_set.3.adoc13
1 files changed, 1 insertions, 12 deletions
diff --git a/docs/man/nng_dialer_set.3.adoc b/docs/man/nng_dialer_set.3.adoc
index 3363eae9..82673959 100644
--- a/docs/man/nng_dialer_set.3.adoc
+++ b/docs/man/nng_dialer_set.3.adoc
@@ -19,9 +19,6 @@ nng_dialer_set - set dialer option
----
#include <nng/nng.h>
-int nng_dialer_set(nng_dialer d, const char *opt, const void *val,
- size_t valsz);
-
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);
@@ -35,13 +32,12 @@ 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 `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)].
@@ -58,13 +54,6 @@ 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()`::
-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_.
-
-TIP: It may be easier to use one of the typed forms of this function.
-
`nng_dialer_set_bool()`::
This function is for options which take a Boolean (`bool`).
The _bval_ is passed to the option.