diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-28 15:04:08 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-28 15:04:08 -0700 |
| commit | caa0c875339badd5a0da38aee9605a40cb7e9d83 (patch) | |
| tree | 8a544d3c12fb6129603cfe9b8587190427d2750b /docs | |
| parent | 1401d2f622e52f0ca4e68fc932ded4f96801989f (diff) | |
| download | nng-caa0c875339badd5a0da38aee9605a40cb7e9d83.tar.gz nng-caa0c875339badd5a0da38aee9605a40cb7e9d83.tar.bz2 nng-caa0c875339badd5a0da38aee9605a40cb7e9d83.zip | |
streams: drop some stream set functions
We don't need nng_stream_set_addr nor nng_stream_set_ptr.
These methods are simply not useful for streams, which have
their properties established at creation time.
Arguably in fact, all of nng_stream_set_* could go away --
the only properties it is implemented for are TCP keepalive and
nodelay tuning, and those should be reasonably set by the
creator of the stream.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/nng_stream_set.3str.adoc | 25 |
1 files changed, 2 insertions, 23 deletions
diff --git a/docs/man/nng_stream_set.3str.adoc b/docs/man/nng_stream_set.3str.adoc index e4a82a1a..9386168e 100644 --- a/docs/man/nng_stream_set.3str.adoc +++ b/docs/man/nng_stream_set.3str.adoc @@ -1,6 +1,6 @@ = nng_stream_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> // @@ -28,16 +28,12 @@ int nng_stream_set_int(nng_stream *s, const char *opt, int val); int nng_stream_set_ms(nng_stream *s, const char *opt, nng_duration val); -int nng_stream_set_ptr(nng_stream *s, const char *opt, void *val); - int nng_stream_set_size(nng_stream *s, const char *opt, size_t val); int nng_stream_set_string(nng_stream *s, const char *opt, const char *val); int nng_stream_set_uint64(nng_stream *s, const char *opt, uint64_t val); -int nng_stream_set_addr(nng_stream *s, const char *opt, const nng_sockaddr *val); - ---- == DESCRIPTION @@ -76,17 +72,6 @@ the type xref:nng_duration.5.adoc[`nng_duration`]. The duration is an integer number of milliseconds. -`nng_stream_set_ptr()`:: -This function is used to pass a pointer to structured data. -The data referenced by 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. -Please see the documentation for the specific option for further details. - `nng_stream_set_size()`:: This function is used to configure a size, typically for buffer sizes, message maximum sizes, and similar options. @@ -103,12 +88,6 @@ This function is used to configure a 64-bit unsigned value/ This is typically used for identifiers, network numbers, and similar options. -`nng_stream_set_addr()`:: -This function is used to configure a -xref:nng_sockaddr.5.adoc[socket address]. -The value is copied, and thus the caller may discard the supplied -value immediately after this function returns. - == RETURN VALUES This function returns 0 on success, and non-zero otherwise. @@ -130,4 +109,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.5.adoc[nng_stream(5)]
\ No newline at end of file +xref:nng_stream.5.adoc[nng_stream(5)] |