aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_dialer_set.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-11-24 13:12:56 -0800
committerGarrett D'Amore <garrett@damore.org>2024-11-24 13:12:56 -0800
commit2afc725ff5a41fbc7445f3681e83cf579f13b578 (patch)
treeaafc445c2857c83edaae6378094ec5f217a9cbad /docs/man/nng_dialer_set.3.adoc
parent5ab47e210de76d29cffbc9ea47800775a3627210 (diff)
downloadnng-2afc725ff5a41fbc7445f3681e83cf579f13b578.tar.gz
nng-2afc725ff5a41fbc7445f3681e83cf579f13b578.tar.bz2
nng-2afc725ff5a41fbc7445f3681e83cf579f13b578.zip
Remove all the set_ptr option functions.
This hopefully ensures that we have good typed functions instead of just passing around pointers blithely.
Diffstat (limited to 'docs/man/nng_dialer_set.3.adoc')
-rw-r--r--docs/man/nng_dialer_set.3.adoc12
1 files changed, 0 insertions, 12 deletions
diff --git a/docs/man/nng_dialer_set.3.adoc b/docs/man/nng_dialer_set.3.adoc
index 82673959..efad700c 100644
--- a/docs/man/nng_dialer_set.3.adoc
+++ b/docs/man/nng_dialer_set.3.adoc
@@ -25,8 +25,6 @@ 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_ptr(nng_dialer d, const char *opt, void *ptr);
-
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);
@@ -67,16 +65,6 @@ 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_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
-(xref:nng_tls_config_alloc.3tls.adoc[`nng_tls_config_alloc()`])
-can be passed this way.
-
-NOTE: This form is somewhat special in that the object is generally
-not copied, but instead the *pointer* to the object is copied.
-
`nng_dialer_set_size()`::
This function is used to configure a size, _z_, typically for buffer sizes,
message maximum sizes, and similar options.