diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-11-03 08:38:22 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-11-03 08:49:33 -0800 |
| commit | 4367013d8b56105edd0d27d0b9b6da2becab9717 (patch) | |
| tree | 1bc6abaaff5b010adc415b3ab25698b59e73f353 /docs/man/nng_stream_dialer_set.3str.adoc | |
| parent | 8249242a9325a27e57107d78bfa168e918cc4f7a (diff) | |
| download | nng-4367013d8b56105edd0d27d0b9b6da2becab9717.tar.gz nng-4367013d8b56105edd0d27d0b9b6da2becab9717.tar.bz2 nng-4367013d8b56105edd0d27d0b9b6da2becab9717.zip | |
Remove untyped stream option functions.
The underlying stream APIs have no need for untyped accessors.
Another step on the road to removal of NNI_TYPE_OPAQUE.
Diffstat (limited to 'docs/man/nng_stream_dialer_set.3str.adoc')
| -rw-r--r-- | docs/man/nng_stream_dialer_set.3str.adoc | 15 |
1 files changed, 3 insertions, 12 deletions
diff --git a/docs/man/nng_stream_dialer_set.3str.adoc b/docs/man/nng_stream_dialer_set.3str.adoc index bd4ac478..6a610500 100644 --- a/docs/man/nng_stream_dialer_set.3str.adoc +++ b/docs/man/nng_stream_dialer_set.3str.adoc @@ -1,6 +1,6 @@ = nng_stream_dialer_set(3str) // -// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2024 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> // Copyright 2019 Devolutions <info@devolutions.net> // @@ -20,8 +20,6 @@ nng_stream_dialer_set - set option on byte stream dialer ---- #include <nng/nng.h> -int nng_stream_dialer_set(nng_stream_dialer *d, const char *name, const void *data, size_t size); - int nng_stream_dialer_set_bool(nng_stream_dialer *d, const char *opt, bool val); int nng_stream_dialer_set_int(nng_stream_dialer *d, const char *opt, int val); @@ -42,7 +40,7 @@ int nng_stream_dialer_set_addr(nng_stream_dialer *d, const char *opt, const nng_ == DESCRIPTION -The `nng_stream_dialer_set()` functions are used to configure options for the +The `nng_stream_dialer_set` functions are used to configure options for the xref:nng_stream.5.adoc[byte stream dialer] _d_. The actual options that may be configured in this way vary, and are specified by _opt_. @@ -57,13 +55,6 @@ documented with the transports and protocols themselves. 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_stream_dialer_set()`:: -This function is untyped, and can be used to configure any arbitrary data. -The _val_ pointer addresses the data to copy, and _size_ 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_stream_dialer_set_bool()`:: This function is for options which take a Boolean (`bool`). @@ -130,4 +121,4 @@ xref:nng_options.5.adoc[nng_options(5)], xref:nng_ipc_options.5.adoc[nng_ipc_options(5)], xref:nng_tcp_options.5.adoc[nng_tcp_options(5)], xref:nng_tls_options.5.adoc[nng_tls_options(5)], -xref:nng_stream_dialer.5.adoc[nng_stream_dialer(5)]
\ No newline at end of file +xref:nng_stream_dialer.5.adoc[nng_stream_dialer(5)] |