diff options
Diffstat (limited to 'docs/man')
| -rw-r--r-- | docs/man/nng_stream_dialer_get.3str.adoc | 24 | ||||
| -rw-r--r-- | docs/man/nng_stream_dialer_set.3str.adoc | 15 | ||||
| -rw-r--r-- | docs/man/nng_stream_get.3str.adoc | 27 | ||||
| -rw-r--r-- | docs/man/nng_stream_listener_get.3str.adoc | 28 | ||||
| -rw-r--r-- | docs/man/nng_stream_listener_set.3str.adoc | 15 |
5 files changed, 12 insertions, 97 deletions
diff --git a/docs/man/nng_stream_dialer_get.3str.adoc b/docs/man/nng_stream_dialer_get.3str.adoc index 4023e56f..13813c1f 100644 --- a/docs/man/nng_stream_dialer_get.3str.adoc +++ b/docs/man/nng_stream_dialer_get.3str.adoc @@ -20,8 +20,6 @@ nng_stream_dialer_get - get option from byte stream dialer ---- #include <nng/nng.h> -int nng_stream_dialer_get(nng_stream_dialer *d, const char *opt, void *val, size_t *sizep); - int nng_stream_dialer_get_bool(nng_stream_dialer *d, const char *opt, bool *valp); int nng_stream_dialer_get_int(nng_stream_dialer *d, const char *opt, int *valp); @@ -42,7 +40,7 @@ int nng_stream_dialer_get_uint64(nng_stream_dialer *d, const char *opt, uint64_t == DESCRIPTION -The `nng_stream_dialer_get()` functions are used to retrieve option values for the +The `nng_stream_dialer_get()` functions are used to retrieve option values for the xref:nng_stream_dialer.5.adoc[byte stream dialer] _d_. The actual options that may be retrieved in this way vary. @@ -58,26 +56,6 @@ The forms vary based on the type of the option they take. 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_get()`:: -This function is untyped and can be used to retrieve the value of any option. -The caller must store a pointer to a buffer to receive the value in _val_, -and the size of the buffer shall be stored at the location referenced by -_sizep_. -+ -When the function returns, the actual size of the data copied (or that -would have been copied if sufficient space were present) is stored at -the location referenced by _sizep_. -If the caller's buffer is not large enough to hold the entire object, -then the copy is truncated. -Therefore the caller should check for truncation by verifying that the -returned size in _sizep_ does not exceed the original buffer size. -+ -It is acceptable to pass `NULL` for _val_ if the value in _sizep_ is zero. -This can be used to determine the size of the buffer needed to receive -the object. -+ -TIP: It may be easier to use one of the typed forms of this function. - `nng_stream_dialer_get_bool()`:: This function is for options which take a Boolean (`bool`). 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)] diff --git a/docs/man/nng_stream_get.3str.adoc b/docs/man/nng_stream_get.3str.adoc index 64ff626f..b0f8ee19 100644 --- a/docs/man/nng_stream_get.3str.adoc +++ b/docs/man/nng_stream_get.3str.adoc @@ -1,6 +1,6 @@ = nng_stream_get(3str) // -// Copyright 2019 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_get - get option from byte stream ---- #include <nng/nng.h> -int nng_stream_get(nng_stream *s, const char *opt, void *val, size_t *sizep); - int nng_stream_get_bool(nng_stream *s, const char *opt, bool *valp); int nng_stream_get_int(nng_stream *s, const char *opt, int *valp); @@ -37,12 +35,11 @@ int nng_stream_get_addr(nng_stream *s, const char *opt, nng_sockaddr *valp); int nng_stream_get_string(nng_stream *s, const char *opt, char **valp); int nng_stream_get_uint64(nng_stream *s, const char *opt, uint64_t *valp); - ---- == DESCRIPTION -The `nng_stream_get()` functions are used to retrieve option values for the +The `nng_stream_get` functions are used to retrieve option values for the xref:nng_stream.5.adoc[byte stream] _conn_. The actual options that may be retrieved in this way vary. @@ -58,26 +55,6 @@ The forms vary based on the type of the option they take. 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_get()`:: -This function is untyped and can be used to retrieve the value of any option. -The caller must store a pointer to a buffer to receive the value in _val_, -and the size of the buffer shall be stored at the location referenced by -_sizep_. -+ -When the function returns, the actual size of the data copied (or that -would have been copied if sufficient space were present) is stored at -the location referenced by _sizep_. -If the caller's buffer is not large enough to hold the entire object, -then the copy is truncated. -Therefore the caller should check for truncation by verifying that the -returned size in _sizep_ does not exceed the original buffer size. -+ -It is acceptable to pass `NULL` for _val_ if the value in _sizep_ is zero. -This can be used to determine the size of the buffer needed to receive -the object. -+ -TIP: It may be easier to use one of the typed forms of this function. - `nng_stream_get_bool()`:: This function is for options which take a Boolean (`bool`). diff --git a/docs/man/nng_stream_listener_get.3str.adoc b/docs/man/nng_stream_listener_get.3str.adoc index 927e36a8..77c8e4b1 100644 --- a/docs/man/nng_stream_listener_get.3str.adoc +++ b/docs/man/nng_stream_listener_get.3str.adoc @@ -1,6 +1,6 @@ = nng_stream_listener_get(3str) // -// Copyright 2019 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_listener_get - get option from byte stream listener ---- #include <nng/nng.h> -int nng_stream_listener_get(nng_stream_listener *l, const char *opt, void *val, size_t *sizep); - int nng_stream_listener_get_bool(nng_stream_listener *l, const char *opt, bool *valp); int nng_stream_listener_get_int(nng_stream_listener *l, const char *opt, int *valp); @@ -42,8 +40,8 @@ int nng_stream_listener_get_uint64(nng_stream_listener *l, const char *opt, uint == DESCRIPTION -The `nng_stream_listener_get()` functions are used to retrieve option values -for the +The `nng_stream_listener_get` functions are used to retrieve option values +for the xref:nng_stream_listener.5.adoc[byte stream listener] _l_. The actual options that may be retrieved in this way vary. @@ -59,26 +57,6 @@ The forms vary based on the type of the option they take. 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_listener_get()`:: -This function is untyped and can be used to retrieve the value of any option. -The caller must store a pointer to a buffer to receive the value in _val_, -and the size of the buffer shall be stored at the location referenced by -_sizep_. -+ -When the function returns, the actual size of the data copied (or that -would have been copied if sufficient space were present) is stored at -the location referenced by _sizep_. -If the caller's buffer is not large enough to hold the entire object, -then the copy is truncated. -Therefore the caller should check for truncation by verifying that the -returned size in _sizep_ does not exceed the original buffer size. -+ -It is acceptable to pass `NULL` for _val_ if the value in _sizep_ is zero. -This can be used to determine the size of the buffer needed to receive -the object. -+ -TIP: It may be easier to use one of the typed forms of this function. - `nng_stream_listener_get_bool()`:: This function is for options which take a Boolean (`bool`). diff --git a/docs/man/nng_stream_listener_set.3str.adoc b/docs/man/nng_stream_listener_set.3str.adoc index ccabe5ca..08a852bf 100644 --- a/docs/man/nng_stream_listener_set.3str.adoc +++ b/docs/man/nng_stream_listener_set.3str.adoc @@ -1,6 +1,6 @@ = nng_stream_listener_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_listener_set - set option on byte stream listener ---- #include <nng/nng.h> -int nng_stream_listener_set(nng_stream_listener *l, const char *name, const void *data, size_t size); - int nng_stream_listener_set_bool(nng_stream_listener *l, const char *opt, bool val); int nng_stream_listener_set_int(nng_stream_listener *l, const char *opt, int val); @@ -42,7 +40,7 @@ int nng_stream_listener_set_addr(nng_stream_listener *l, const char *opt, const == DESCRIPTION -The `nng_stream_listener_set()` functions are used to configure options for the +The `nng_stream_listener_set` functions are used to configure options for the xref:nng_stream.5.adoc[byte stream listener] _l_. 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_listener_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_listener_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_listener.5.adoc[nng_stream_listener(5)]
\ No newline at end of file +xref:nng_stream_listener.5.adoc[nng_stream_listener(5)] |