From 2806ad76d9c5673b9305cfab00e738941fb7938c Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 7 Apr 2024 23:45:12 -0700 Subject: Legacy option pages --- docs/man/nng_dialer_getopt.3.adoc | 149 -------------------------------- docs/man/nng_dialer_setopt.3.adoc | 134 ----------------------------- docs/man/nng_getopt.3.adoc | 145 ------------------------------- docs/man/nng_listener_getopt.3.adoc | 150 -------------------------------- docs/man/nng_listener_setopt.3.adoc | 136 ----------------------------- docs/man/nng_pipe_getopt.3.adoc | 155 ---------------------------------- docs/man/nng_setopt.3.adoc | 127 ---------------------------- docs/ref/old/nng_ctx_getopt.adoc | 2 +- docs/ref/old/nng_dialer_getopt.adoc | 47 +++++++++++ docs/ref/old/nng_dialer_setopt.adoc | 45 ++++++++++ docs/ref/old/nng_getopt.adoc | 45 ++++++++++ docs/ref/old/nng_listener_getopt.adoc | 47 +++++++++++ docs/ref/old/nng_listener_setopt.adoc | 46 ++++++++++ docs/ref/old/nng_pipe_getopt.adoc | 47 +++++++++++ docs/ref/old/nng_setopt.adoc | 45 ++++++++++ 15 files changed, 323 insertions(+), 997 deletions(-) delete mode 100644 docs/man/nng_dialer_getopt.3.adoc delete mode 100644 docs/man/nng_dialer_setopt.3.adoc delete mode 100644 docs/man/nng_getopt.3.adoc delete mode 100644 docs/man/nng_listener_getopt.3.adoc delete mode 100644 docs/man/nng_listener_setopt.3.adoc delete mode 100644 docs/man/nng_pipe_getopt.3.adoc delete mode 100644 docs/man/nng_setopt.3.adoc create mode 100644 docs/ref/old/nng_dialer_getopt.adoc create mode 100644 docs/ref/old/nng_dialer_setopt.adoc create mode 100644 docs/ref/old/nng_getopt.adoc create mode 100644 docs/ref/old/nng_listener_getopt.adoc create mode 100644 docs/ref/old/nng_listener_setopt.adoc create mode 100644 docs/ref/old/nng_pipe_getopt.adoc create mode 100644 docs/ref/old/nng_setopt.adoc (limited to 'docs') diff --git a/docs/man/nng_dialer_getopt.3.adoc b/docs/man/nng_dialer_getopt.3.adoc deleted file mode 100644 index a4083819..00000000 --- a/docs/man/nng_dialer_getopt.3.adoc +++ /dev/null @@ -1,149 +0,0 @@ -= nng_dialer_getopt(3) -// -// Copyright 2020 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_dialer_getopt - get dialer option - -== SYNOPSIS - -[source, c] ----- -#include - -int nng_dialer_getopt(nng_dialer d, const char *opt, void *val, size_t *valszp); - -int nng_dialer_getopt_bool(nng_dialer d, const char *opt, bool *bvalp); - -int nng_dialer_getopt_int(nng_dialer d, const char *opt, int *ivalp); - -int nng_dialer_getopt_ms(nng_dialer d, const char *opt, nng_duration *durp); - -int nng_dialer_getopt_ptr(nng_dialer d, const char *opt, void **ptr); - -int nng_dialer_getopt_size(nng_dialer d, const char *opt, size_t *zp); - -int nng_dialer_getopt_sockaddr(nng_dialer d, const char *opt, nng_sockaddr *sap); - -int nng_dialer_getopt_string(nng_dialer d, const char *opt, char **strp); - -int nng_dialer_getopt_uint64(nng_dialer d, const char *opt, uint64_t *u64p); - ----- - -== DESCRIPTION - -IMPORTANT: These functions are deprecated. Please see xref:nng_dialer_get.3.adoc[nng_dialer_get]. -They may not be present if the library was built with `NNG_ELIDE_DEPRECATED`. - -(((options, dialer))) -The `nng_dialer_getopt()` functions are used to retrieve option values for -the xref:nng_dialer.5.adoc[dialer] _d_. -The actual options that may be retrieved in this way -vary, and many are documented in xref:nng_options.5.adoc[nng_options(5)]. - -Additionally some transport-specific options are documented with the transports themselves. - -=== Forms - -In all of these forms, the option _opt_ is retrieved from the dialer _d_. -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_dialer_getopt()`:: -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 _valszp_. + - + -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 _valszp_. -If the caller's buffer is not large -enough to hold the entire object, then the copy is truncated. -Therefore the caller should validate that the returned size in _valszp_ does not -exceed the original buffer size to check for truncation. + - + -It is acceptable to pass `NULL` for _val_ if the value in _valszp_ 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_dialer_getopt_bool()`:: -This function is for options which take a Boolean (`bool`). -The value will be stored at _bvalp_. - -`nng_dialer_getopt_int()`:: -This function is for options which take an integer (`int`). -The value will be stored at _ivalp_. - -`nng_dialer_getopt_ms()`:: -This function is used to retrieve time xref:nng_duration.5.adoc[durations] -(such as timeouts), stored in _durp_ as a number of milliseconds. -(The special value ((`NNG_DURATION_INFINITE`)) means an infinite amount of time, and -the special value ((`NNG_DURATION_DEFAULT`)) means a context-specific default.) - -`nng_dialer_getopt_ptr()`:: -This function is used to retrieve a pointer, _ptr_, to structured data. -The data referenced by _ptr_ is generally managed using other functions. -Note that this form is somewhat special in that the object is generally -not copied, but instead the *pointer* to the object is copied. - -`nng_dialer_getopt_size()`:: -This function is used to retrieve a size into the pointer _zp_, -typically for buffer sizes, message maximum sizes, and similar options. - -`nng_dialer_getopt_sockaddr()`:: -This function is used to retrieve an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] -into the value referenced by _sap_. - -`nng_dialer_getopt_string()`:: -This function is used to retrieve a string into _strp_. -This string is created from the source using xref:nng_strdup.3.adoc[`nng_strdup()`] -and consequently must be freed by the caller using -xref:nng_strfree.3.adoc[`nng_strfree()`] when it is no longer needed. - -`nng_dialer_getopt_uint64()`:: -This function is used to retrieve a 64-bit unsigned value into the value -referenced by _u64p_. -This is typically used for options related to identifiers, network -numbers, and similar. - -== RETURN VALUES - -These functions returns 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_EBADTYPE`:: Incorrect type for option. -`NNG_ECLOSED`:: Parameter _d_ does not refer to an open dialer. -`NNG_EINVAL`:: Size of destination _val_ too small for object. -`NNG_ENOMEM`:: Insufficient memory exists. -`NNG_ENOTSUP`:: The option _opt_ is not supported. -`NNG_EWRITEONLY`:: The option _opt_ is write-only. - -== SEE ALSO - -[.text-left] -xref:nng_dialer_create.3.adoc[nng_dialer_create(3)] -xref:nng_dialer_setopt.3.adoc[nng_dialer_setopt(3)] -xref:nng_strdup.3.adoc[nng_strdup(3)], -xref:nng_strerror.3.adoc[nng_strerror(3)], -xref:nng_strfree.3.adoc[nng_strfree(3)], -xref:nng_dialer.5.adoc[nng_dialer(5)], -xref:nng_duration.5.adoc[nng_duration(5)], -xref:nng_options.5.adoc[nng_options(5)], -xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_dialer_setopt.3.adoc b/docs/man/nng_dialer_setopt.3.adoc deleted file mode 100644 index 3aaff1eb..00000000 --- a/docs/man/nng_dialer_setopt.3.adoc +++ /dev/null @@ -1,134 +0,0 @@ -= nng_dialer_setopt(3) -// -// Copyright 2020 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_dialer_setopt - set dialer option - -== SYNOPSIS - -[source, c] ----- -#include - -int nng_dialer_setopt(nng_dialer d, const char *opt, const void *val, - size_t valsz); - -int nng_dialer_setopt_bool(nng_dialer d, const char *opt, bool bval); - -int nng_dialer_setopt_int(nng_dialer d, const char *opt, int ival); - -int nng_dialer_setopt_ms(nng_dialer d, const char *opt, nng_duration dur); - -int nng_dialer_setopt_ptr(nng_dialer d, const char *opt, void *ptr); - -int nng_dialer_setopt_size(nng_dialer d, const char *opt, size_t z); - -int nng_dialer_setopt_string(nng_dialer d, const char *opt, const char *str); - -int nng_dialer_setopt_uint64(nng_dialer d, const char *opt, uint64_t u64); - ----- - -== DESCRIPTION - -IMPORTANT: These functions are deprecated. Please see xref:nng_dialer_set.3.adoc[nng_dialer_set]. -They may not be present if the library was built with `NNG_ELIDE_DEPRECATED`. - -(((options, dialer))) -The `nng_dialer_setopt()` 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)]. - -Additionally some transport-specific options are documented with the -transports themselves. - -NOTE: Once a dialer has started, it is generally not possible to change -its configuration. - -=== Forms - -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_setopt()`:: -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_setopt_bool()`:: -This function is for options which take a Boolean (`bool`). -The _bval_ is passed to the option. - -`nng_dialer_setopt_int()`:: -This function is for options which take an integer (`int`). -The _ival_ is passed to the option. - -`nng_dialer_setopt_ms()`:: -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_setopt_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_setopt_size()`:: -This function is used to configure a size, _z_, typically for buffer sizes, -message maximum sizes, and similar options. - -`nng_dialer_setopt_string()`:: -This function is used to pass configure a string, _str_. -Strings passed this way must be legal UTF-8 or ASCII strings, terminated -with a `NUL` (`\0`) byte. -(Other constraints may apply as well, see the documentation for each option -for details.) - -`nng_dialer_setopt_uint64()`:: -This function is used to configure a 64-bit unsigned value, _u64_. -This is typically used for options related to identifiers, network numbers, -and such. - -== RETURN VALUES - -These functions return 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_EBADTYPE`:: Incorrect type for option. -`NNG_ECLOSED`:: Parameter _d_ does not refer to an open dialer. -`NNG_EINVAL`:: The value being passed is invalid. -`NNG_ENOTSUP`:: The option _opt_ is not supported. -`NNG_EREADONLY`:: The option _opt_ is read-only. -`NNG_ESTATE`:: The dialer _d_ is already started. - -== SEE ALSO - -[.text-left] -xref:nng_dialer_create.3.adoc[nng_dialer_create(3)] -xref:nng_dialer_getopt.3.adoc[nng_dialer_getopt(3)] -xref:nng_strerror.3.adoc[nng_strerror(3)], -xref:nng_dialer.5.adoc[nng_dialer(5)], -xref:nng_duration.5.adoc[nng_duration(5)], -xref:nng_options.5.adoc[nng_options(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_getopt.3.adoc b/docs/man/nng_getopt.3.adoc deleted file mode 100644 index 364d8f71..00000000 --- a/docs/man/nng_getopt.3.adoc +++ /dev/null @@ -1,145 +0,0 @@ -= nng_getopt(3) -// -// Copyright 2020 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_getopt - get socket option - -== SYNOPSIS - -[source, c] ----- -#include - -int nng_getopt(nng_socket s, const char *opt, void *val, size_t *valszp); - -int nng_getopt_bool(nng_socket s, const char *opt, bool *bvalp); - -int nng_getopt_int(nng_socket s, const char *opt, int *ivalp); - -int nng_getopt_ms(nng_socket s, const char *opt, nng_duration *durp); - -int nng_getopt_ptr(nng_socket s, const char *opt, void **ptr); - -int nng_getopt_size(nng_socket s, const char *opt, size_t *zp); - -int nng_getopt_string(nng_socket s, const char *opt, char **strp); - -int nng_getopt_uint64(nng_socket s, const char *opt, uint64_t *u64p); - ----- - -== DESCRIPTION - -IMPORTANT: These functions are deprecated. Please see xref:nng_socket_get.3.adoc[nng_socket_get]. -They may not be present if the library was built with `NNG_ELIDE_DEPRECATED`. - -(((options, socket))) -The `nng_getopt()` functions are used to retrieve option values for -the xref:nng_socket.5.adoc[socket] _s_. -The actual options that may be retrieved in this way vary. -A number of them are documented in xref:nng_options.5.adoc[nng_options(5)]. - -Additionally transport-specific options and protocol-specific options are -documented with the transports and protocols themselves. - -=== Forms - -In all of these forms, the option _opt_ is retrieved from the socket _s_. -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_getopt()`:: -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 -_valszp_. -+ -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 _valszp_. -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 _valszp_ does not exceed the original buffer size. -+ -It is acceptable to pass `NULL` for _val_ if the value in _valszp_ 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_getopt_bool()`:: -This function is for options which take a Boolean (`bool`). -The value will be stored at _bvalp_. - -`nng_getopt_int()`:: -This function is for options which take an integer (`int`). -The value will be stored at _ivalp_. - -`nng_getopt_ms()`:: -This function is used to retrieve time xref:nng_duration.5.adoc[durations] -(such as timeouts), stored in _durp_ as a number of milliseconds. -(The special value ((`NNG_DURATION_INFINITE`)) means an infinite amount of time, and -the special value ((`NNG_DURATION_DEFAULT`)) means a context-specific default.) - -`nng_getopt_ptr()`:: -This function is used to retrieve a pointer, _ptr_, to structured data. -The data referenced by _ptr_ is generally managed using other functions. -Note that this form is somewhat special in that the object is generally -not copied, but instead the *pointer* to the object is copied. - -`nng_getopt_size()`:: -This function is used to retrieve a size into the pointer _zp_, -typically for buffer sizes, message maximum sizes, and similar options. - -`nng_getopt_string()`:: -This function is used to retrieve a string into _strp_. -This string is created from the source using xref:nng_strdup.3.adoc[`nng_strdup()`] -and consequently must be freed by the caller using -xref:nng_strfree.3.adoc[`nng_strfree()`] when it is no longer needed. - -`nng_getopt_uint64()`:: -This function is used to retrieve a 64-bit unsigned value into the value -referenced by _u64p_. -This is typically used for options related to identifiers, network -numbers, and similar. - -== RETURN VALUES - -These functions return 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_EBADTYPE`:: Incorrect type for option. -`NNG_ECLOSED`:: Parameter _s_ does not refer to an open socket. -`NNG_EINVAL`:: Size of destination _val_ too small for object. -`NNG_ENOMEM`:: Insufficient memory exists. -`NNG_ENOTSUP`:: The option _opt_ is not supported. -`NNG_EWRITEONLY`:: The option _opt_ is write-only. - -== SEE ALSO - -[.text-left] -xref:nng_dialer_getopt.3.adoc[nng_dialer_getopt(3)], -xref:nng_listener_getopt.3.adoc[nng_listener_getopt(3)], -xref:nng_pipe_getopt.3.adoc[nng_pipe_getopt(3)], -xref:nng_setopt.3.adoc[nng_setopt(3)], -xref:nng_strdup.3.adoc[nng_strdup(3)], -xref:nng_strerror.3.adoc[nng_strerror(3)], -xref:nng_strfree.3.adoc[nng_strfree(3)], -xref:nng_duration.5.adoc[nng_duration(5)], -xref:nng_options.5.adoc[nng_options(5)], -xref:nng_socket.5.adoc[nng_socket(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_listener_getopt.3.adoc b/docs/man/nng_listener_getopt.3.adoc deleted file mode 100644 index 828f440d..00000000 --- a/docs/man/nng_listener_getopt.3.adoc +++ /dev/null @@ -1,150 +0,0 @@ -= nng_listener_getopt(3) -// -// Copyright 2020 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_listener_getopt - get listener option - -== SYNOPSIS - -[source, c] ----- -#include - -int nng_listener_getopt(nng_listener l, const char *opt, void *val, size_t *valszp); - -int nng_listener_getopt_bool(nng_listener l, const char *opt, bool *bvalp); - -int nng_listener_getopt_int(nng_listener l, const char *opt, int *ivalp); - -int nng_listener_getopt_ms(nng_listener l, const char *opt, nng_duration *durp); - -int nng_listener_getopt_ptr(nng_listener l, const char *opt, void **ptr); - -int nng_listener_getopt_size(nng_listener l, const char *opt, size_t *zp); - -int nng_listener_getopt_sockaddr(nng_listener l, const char *opt, nng_sockaddr *sap); - -int nng_listener_getopt_string(nng_listener l, const char *opt, char **strp); - -int nng_listener_getopt_uint64(nng_listener l, const char *opt, uint64_t *u64p); - ----- - -== DESCRIPTION - -IMPORTANT: These functions are deprecated. Please see xref:nng_listener_get.3.adoc[nng_listener_get]. -They may not be present if the library was built with `NNG_ELIDE_DEPRECATED`. - -(((options, listener))) -The `nng_listener_getopt()` functions are used to retrieve option values for -the xref:nng_listener.5.adoc[listener] _l_. -The actual options that may be retrieved in this way -vary, and many are documented in xref:nng_options.5.adoc[nng_options(5)]. - -Additionally some transport-specific options -are documented with the transports themselves. - -=== Forms - -In all of these forms, the option _opt_ is retrieved from the listener _l_. -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_listener_getopt()`:: -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 _valszp_. + - + -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 _valszp_. -If the caller's buffer is not large -enough to hold the entire object, then the copy is truncated. Therefore -the caller should validate that the returned size in _valszp_ does not -exceed the original buffer size to check for truncation. + - + -It is acceptable to pass `NULL` for _val_ if the value in _valszp_ 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_listener_getopt_bool()`:: -This function is for options which take a Boolean (`bool`). -The value will be stored at _bvalp_. - -`nng_listener_getopt_int()`:: -This function is for options which take an integer (`int`). -The value will be stored at _ivalp_. - -`nng_listener_getopt_ms()`:: -This function is used to retrieve time xref:nng_duration.5.adoc[durations] -(such as timeouts), stored in _durp_ as a number of milliseconds. - -`nng_listener_getopt_ptr()`:: -This function is used to retrieve a pointer, _ptr_, to structured data. -The data referenced by _ptr_ is generally managed using other functions. -Note that this form is somewhat special in that the object is generally -not copied, but instead the *pointer* to the object is copied. - -`nng_listener_getopt_size()`:: -This function is used to retrieve a size into the pointer _zp_, -typically for buffer sizes, message maximum sizes, and similar options. - -`nng_listener_getopt_sockaddr()`:: -This function is used to retrieve an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] -into the value referenced by _sap_. - -`nng_listener_getopt_string()`:: -This function is used to retrieve a string into _strp_. -This string is created from the source using xref:nng_strdup.3.adoc[`nng_strdup()`] -and consequently must be freed by the caller using -xref:nng_strfree.3.adoc[`nng_strfree()`] when it is no longer needed. - -`nng_listener_getopt_uint64()`:: -This function is used to retrieve a 64-bit unsigned value into the value -referenced by _u64p_. -This is typically used for options related to identifiers, network -numbers, and similar. - -== RETURN VALUES - -These functions return 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_EBADTYPE`:: Incorrect type for option. -`NNG_ECLOSED`:: Parameter _l_ does not refer to an open listener. -`NNG_EINVAL`:: Size of destination _val_ too small for object. -`NNG_ENOMEM`:: Insufficient memory exists. -`NNG_ENOTSUP`:: The option _opt_ is not supported. -`NNG_EWRITEONLY`:: The option _opt_ is write-only. - -== SEE ALSO - -[.text-left] -xref:nng_listen.3.adoc[nng_listen(3)], -xref:nng_listener_create.3.adoc[nng_listener_create(3)] -xref:nng_listener_setopt.3.adoc[nng_listener_setopt(3)] -xref:nng_getopt.3.adoc[nng_getopt(3)], -xref:nng_strdup.3.adoc[nng_strdup(3)], -xref:nng_strerror.3.adoc[nng_strerror(3)], -xref:nng_strfree.3.adoc[nng_strfree(3)], -xref:nng_duration.5.adoc[nng_duration(5)], -xref:nng_listener.5.adoc[nng_listener(5)], -xref:nng_options.5.adoc[nng_options(5)], -xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_listener_setopt.3.adoc b/docs/man/nng_listener_setopt.3.adoc deleted file mode 100644 index 25411adc..00000000 --- a/docs/man/nng_listener_setopt.3.adoc +++ /dev/null @@ -1,136 +0,0 @@ -= nng_listener_setopt(3) -// -// Copyright 2020 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_listener_setopt - set listener option - -== SYNOPSIS - -[source, c] ----- -#include - -int nng_listener_setopt(nng_listener l, const char *opt, const void *val, - size_t valsz); - -int nng_listener_setopt_bool(nng_listener l, const char *opt, bool bval); - -int nng_listener_setopt_int(nng_listener l, const char *opt, int ival); - -int nng_listener_setopt_ms(nng_listener l, const char *opt, nng_duration dur); - -int nng_listener_setopt_ptr(nng_listener l, const char *opt, void *ptr); - -int nng_listener_setopt_size(nng_listener l, const char *opt, size_t z); - -int nng_listener_setopt_string(nng_listener l, const char *opt, const char *str); - -int nng_listener_setopt_uint64(nng_listener l, const char *opt, uint64_t u64); - ----- - -== DESCRIPTION - -IMPORTANT: These functions are deprecated. Please see xref:nng_listener_set.3.adoc[nng_listener_set]. -They may not be present if the library was built with `NNG_ELIDE_DEPRECATED`. - -(((options, listener))) -The `nng_listener_setopt()` functions are used to configure options for -the xref:nng_listener.5.adoc[listener] _l_. -The actual options that may be configured in this way -vary, and many are documented in xref:nng_options.5.adoc[nng_options(5)]. - -Additionally some transport-specific options -are documented with the transports themselves. - -NOTE: Once a listener has started, it is generally not possible to change -its configuration. - -=== Forms - -In all of these forms, the option _opt_ is configured on the listener _l_. - -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. - -TIP: It may be easier to use one of the typed forms of this function. - -`nng_listener_setopt()`:: -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_. - -`nng_listener_setopt_bool()`:: -This function is for options which take a Boolean (`bool`). -The _bval_ is passed to the option. - -`nng_listener_setopt_int()`:: -This function is for options which take an integer (`int`). -The _ival_ is passed to the option. - -`nng_listener_setopt_ms()`:: -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_listener_setopt_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_listener_setopt_size()`:: -This function is used to configure a size, _z_, typically for buffer sizes, -message maximum sizes, and similar options. - -`nng_listener_setopt_string()`:: -This function is used to pass configure a string, _str_. -Strings passed this way must be legal UTF-8 or ASCII strings, terminated -with a `NUL` (`\0`) byte. -(Other constraints may apply as well, see the documentation for each option -for details.) - -`nng_listener_setopt_uint64()`:: -This function is used to configure a 64-bit unsigned value, _u64_. -This is typically used for options related to identifiers, network numbers, -and similar. - -== RETURN VALUES - -These functions return 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_EBADTYPE`:: Incorrect type for option. -`NNG_ECLOSED`:: Parameter _l_ does not refer to an open listener. -`NNG_EINVAL`:: The value being passed is invalid. -`NNG_ENOTSUP`:: The option _opt_ is not supported. -`NNG_EREADONLY`:: The option _opt_ is read-only. -`NNG_ESTATE`:: The listener _l_ is already started. - -== SEE ALSO - -[.text-left] -xref:nng_listen.3.adoc[nng_listen(3)], -xref:nng_listener_create.3.adoc[nng_listener_create(3)] -xref:nng_listener_getopt.3.adoc[nng_listener_getopt(3)] -xref:nng_setopt.3.adoc[nng_setopt(3)], -xref:nng_strerror.3.adoc[nng_strerror(3)], -xref:nng_duration.5.adoc[nng_duration(5)], -xref:nng_listener.5.adoc[nng_listener(5)], -xref:nng_options.5.adoc[nng_options(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pipe_getopt.3.adoc b/docs/man/nng_pipe_getopt.3.adoc deleted file mode 100644 index 648abbcc..00000000 --- a/docs/man/nng_pipe_getopt.3.adoc +++ /dev/null @@ -1,155 +0,0 @@ -= nng_pipe_getopt(3) -// -// Copyright 2019 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_pipe_getopt - get pipe option - -== SYNOPSIS - -[source, c] ----- -#include - -int nng_pipe_getopt(nng_pipe p, const char *opt, void *val, size_t *valszp); - -int nng_pipe_getopt_bool(nng_pipe p, const char *opt, bool *bvalp); - -int nng_pipe_getopt_int(nng_pipe p, const char *opt, int *ivalp); - -int nng_pipe_getopt_ms(nng_pipe p, const char *opt, nng_duration *durp); - -int nng_pipe_getopt_ptr(nng_pipe p, const char *opt, void **ptr); - -int nng_pipe_getopt_sockaddr(nng_pipe p, const char *opt, nng_sockaddr *sap); - -int nng_pipe_getopt_string(nng_pipe p, const char *opt, char **strp); - -int nng_pipe_getopt_size(nng_pipe p, const char *opt, size_t *zp); - -int nng_pipe_getopt_uint64(nng_pipe p, const char *opt, uint64_t *u64p); - ----- - -== DESCRIPTION - -NOTE: These functions are deprecated. Please see xref:nng_pipe_get.3.adoc[nng_pipe_get]. - -(((options, pipe))) -The `nng_pipe_getopt()` functions are used to retrieve option values for -the xref:nng_pipe.5.adoc[pipe] _p_. -The actual options that may be retrieved in this way -vary, and many are documented in xref:nng_options.5.adoc[nng_options(5)]. -Additionally some transport-specific options and protocol-specific options are -documented with the transports and protocols themselves. - -NOTE: All options on a pipe are read-only values. -Modification of options may be done before the pipe is created using -xref:nng_listener_setopt.3.adoc[`nng_listener_setopt()`] or -xref:nng_dialer_getopt.3.adoc[`nng_dialer_setopt()`]. - -Any option that is set on a dialer or listener will normally be retrievable -from pipes created by that dialer or listener. - -=== Forms - -In all of these forms, the option _opt_ is retrieved from the pipe _p_. - -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_pipe_getopt()`:: -This is untyped, and can be used to retrieve the value of any option. -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 _valszp_. + - + -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 _valszp_. -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 -size returned in _valszp_ does not exceed the original buffer size. + - + -It is acceptable to pass `NULL` for _val_ if the value in _valszp_ 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_pipe_getopt_bool()`:: -This function is for options which take a Boolean (`bool`). -The value will be stored at _bvalp_. - -`nng_pipe_getopt_int()`:: -This function is for options which take an integer (`int`). -The value will be stored at _ivalp_. - -`nng_pipe_getopt_ms()`:: -This function is used to retrieve time durations -(xref:nng_duration.5.adoc[`nng_duration`]) in milliseconds, which are stored in -_durp_. - -`nng_pipe_getopt_ptr()`:: -This function is used to retrieve a pointer, _ptr_, to structured data. -The data referenced by _ptr_ is generally managed using other functions. -Note that this form is somewhat special in that the object is generally -not copied, but instead the *pointer* to the object is copied. - -`nng_pipe_getopt_size()`:: -This function is used to retrieve a size into the pointer _zp_, -typically for buffer sizes, message maximum sizes, and similar options. - -`nng_pipe_getopt_sockaddr()`:: -This function is used to retrieve an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] -into _sap_. - -`nng_pipe_getopt_string()`:: -This function is used to retrieve a string into _strp_. -This string is created from the source using xref:nng_strdup.3.adoc[`nng_strdup()`] -and consequently must be freed by the caller using -xref:nng_strfree.3.adoc[`nng_strfree()`] when it is no longer needed. - -`nng_pipe_getopt_uint64()`:: -This function is used to retrieve a 64-bit unsigned value into the value -referenced by _u64p_. -This is typically used for options -related to identifiers, network numbers, and similar. - -== RETURN VALUES - -These functions return 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_EBADTYPE`:: Incorrect type for option. -`NNG_ECLOSED`:: Parameter _p_ does not refer to an open pipe. -`NNG_ENOTSUP`:: The option _opt_ is not supported. -`NNG_ENOMEM`:: Insufficient memory exists. -`NNG_EINVAL`:: Size of destination _val_ too small for object. -`NNG_EWRITEONLY`:: The option _opt_ is write-only. - -== SEE ALSO - -[.text-left] -xref:nng_dialer_setopt.3.adoc[nng_dialer_setopt(3)] -xref:nng_getopt.3.adoc[nng_getopt(3)], -xref:nng_listener_setopt.3.adoc[nng_listener_setopt(3)] -xref:nng_msg_get_pipe.3.adoc[nng_msg_get_pipe(3)] -xref:nng_strdup.3.adoc[nng_strdup(3)], -xref:nng_strerror.3.adoc[nng_strerror(3)], -xref:nng_strfree.3.adoc[nng_strfree(3)], -xref:nng_duration.5.adoc[nng_duration(5)], -xref:nng_options.5.adoc[nng_options(5)], -xref:nng_pipe.5.adoc[nng_pipe(5)], -xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_setopt.3.adoc b/docs/man/nng_setopt.3.adoc deleted file mode 100644 index 6c21cf95..00000000 --- a/docs/man/nng_setopt.3.adoc +++ /dev/null @@ -1,127 +0,0 @@ -= nng_setopt(3) - -// Copyright 2020 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. - -== NAME - -nng_setopt - set socket option - -== SYNOPSIS - -[source, c] ----- -#include - -int nng_setopt(nng_socket s, const char *opt, const void *val, size_t valsz); - -int nng_setopt_bool(nng_socket s, const char *opt, bool bval); - -int nng_setopt_int(nng_socket s, const char *opt, int ival); - -int nng_setopt_ms(nng_socket s, const char *opt, nng_duration dur); - -int nng_setopt_ptr(nng_socket s, const char *opt, void *ptr); - -int nng_setopt_size(nng_socket s, const char *opt, size_t z); - -int nng_setopt_string(nng_socket s, const char *opt, const char *str); - -int nng_setopt_uint64(nng_socket s, const char *opt, uint64_t u64); - ----- - -== DESCRIPTION - -IMPORTANT: These functions are deprecated. Please see xref:nng_socket_set.3.adoc[nng_socket_set]. -They may not be present if the library was built with `NNG_ELIDE_DEPRECATED`. - -(((options, socket))) -The `nng_setopt()` functions are used to configure options for -the socket _s_. -The actual options that may be configured in this way vary, and are -specified by _opt_. -A number of them are documented in xref:nng_options.5.adoc[nng_options(5)]. - -Additionally some transport-specific and protocol-specific options are -documented with the transports and protocols themselves. - -=== Forms - -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_setopt()`:: -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_setopt_bool()`:: -This function is for options which take a Boolean (`bool`). -The _bval_ is passed to the option. - -`nng_setopt_int()`:: -This function is for options which take an integer (`int`). -The _ival_ is passed to the option. - -`nng_setopt_ms()`:: -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_setopt_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_setopt_size()`:: -This function is used to configure a size, _z_, typically for buffer sizes, -message maximum sizes, and similar options. - -`nng_setopt_string()`:: -This function is used to pass configure a string, _str_. -Strings passed this way must be legal UTF-8 or ASCII strings, terminated -with a `NUL` (`\0`) byte. -(Other constraints may apply as well, see the documentation for each option -for details.) - -`nng_setopt_uint64()`:: -This function is used to configure a 64-bit unsigned value, _u64_. -This is typically used for options related to identifiers, network numbers, -and similar. - -== RETURN VALUES - -These functions return 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_ECLOSED`:: Parameter _s_ does not refer to an open socket. -`NNG_EINVAL`:: The value being passed is invalid. -`NNG_ENOTSUP`:: The option _opt_ is not supported. -`NNG_EREADONLY`:: The option _opt_ is read-only. -`NNG_ESTATE`:: The socket is in an inappropriate state for setting this option. - -== SEE ALSO - -[.text-left] -xref:nng_getopt.3.adoc[nng_getopt(3)], -xref:nng_dialer_setopt.3.adoc[nng_dialer_setopt(3)], -xref:nng_listener_setopt.3.adoc[nng_listener_setopt(3)], -xref:nng_strerror.3.adoc[nng_strerror(3)], -xref:nng_options.5.adoc[nng_options(5)], -xref:nng_socket.5.adoc[nng_socket(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/ref/old/nng_ctx_getopt.adoc b/docs/ref/old/nng_ctx_getopt.adoc index cd9dfd53..556818c8 100644 --- a/docs/ref/old/nng_ctx_getopt.adoc +++ b/docs/ref/old/nng_ctx_getopt.adoc @@ -27,7 +27,7 @@ These deprecated functions have one-to-one modern equivalents with the same argu |=== | Legacy Function | Modern Equivalent -| `nng_ctx_getopt` | `nng_ctx_set` +| `nng_ctx_getopt` | `nng_ctx_get` | `nng_ctx_getopt_bool`| `nng_ctx_get_bool` | `nng_ctx_getopt_int`| `nng_ctx_get_int` | `nng_ctx_getopt_ms`| `nng_ctx_get_ms` diff --git a/docs/ref/old/nng_dialer_getopt.adoc b/docs/ref/old/nng_dialer_getopt.adoc new file mode 100644 index 00000000..35fea278 --- /dev/null +++ b/docs/ref/old/nng_dialer_getopt.adoc @@ -0,0 +1,47 @@ +## nng_dialer_getopt + +Get dialer option (deprecated). + +### Synopsis + +```c +#include + +int nng_dialer_getopt(nng_dialer d, const char *opt, void *val, size_t *valszp); +int nng_dialer_getopt_bool(nng_dialer d, const char *opt, bool *bvalp); +int nng_dialer_getopt_int(nng_dialer d, const char *opt, int *ivalp); +int nng_dialer_getopt_ms(nng_dialer d, const char *opt, nng_duration *durp); +int nng_dialer_getopt_ptr(nng_dialer d, const char *opt, void **ptr); +int nng_dialer_getopt_size(nng_dialer d, const char *opt, size_t *zp); +int nng_dialer_getopt_sockaddr(nng_dialer d, const char *opt, nng_sockaddr *sap); +int nng_dialer_getopt_string(nng_dialer d, const char *opt, char **strp); +int nng_dialer_getopt_uint64(nng_dialer d, const char *opt, uint64_t *u64p); +``` + +### Description + +NOTE: These functions are deprecated. +They may not be present if the library was built with ((`NNG_ELIDE_DEPRECATED`)). + +These deprecated functions have one-to-one modern equivalents with the same arguments and semantics, as follows: + +[width=50%,] +|=== +| Legacy Function | Modern Equivalent + +| `nng_dialer_getopt` | `nng_dialer_get` +| `nng_dialer_getopt_bool`| `nng_dialer_get_bool` +| `nng_dialer_getopt_int`| `nng_dialer_get_int` +| `nng_dialer_getopt_ms`| `nng_dialer_get_ms` +| `nng_dialer_getopt_ptr`| `nng_dialer_get_ptr` +| `nng_dialer_getopt_size`| `nng_dialer_get_size` +| `nng_dialer_getopt_sockaddr`| `nng_dialer_get_addr` +| `nng_dialer_getopt_string`| `nng_dialer_get_string` +| `nng_dialer_getopt_uint64`| `nng_dialer_get_uint64` +|=== + +Please see the documentation for the modern equivalents for more detail. + +### See Also + +xref:../dialer/nng_dialer_get.adoc[nng_dialer_get] diff --git a/docs/ref/old/nng_dialer_setopt.adoc b/docs/ref/old/nng_dialer_setopt.adoc new file mode 100644 index 00000000..d64a78a8 --- /dev/null +++ b/docs/ref/old/nng_dialer_setopt.adoc @@ -0,0 +1,45 @@ +## nng_dialer_setopt + +Set dialer option (deprecated). + +### Synopsis + +```c +#include + +int nng_dialer_setopt(nng_dialer d, const char *opt, const void *val, size_t valsz); +int nng_dialer_setopt_bool(nng_dialer d, const char *opt, bool bval); +int nng_dialer_setopt_int(nng_dialer d, const char *opt, int ival); +int nng_dialer_setopt_ms(nng_dialer d, const char *opt, nng_duration dur); +int nng_dialer_setopt_ptr(nng_dialer d, const char *opt, void *ptr); +int nng_dialer_setopt_size(nng_dialer d, const char *opt, size_t z); +int nng_dialer_setopt_string(nng_dialer d, const char *opt, const char *str); +int nng_dialer_setopt_uint64(nng_dialer d, const char *opt, uint64_t u64); +``` + +### Description + +NOTE: These functions are deprecated. +They may not be present if the library was built with ((`NNG_ELIDE_DEPRECATED`)). + +These deprecated functions have one-to-one modern equivalents with the same arguments and semantics, as follows: + +[width=50%,] +|=== +| Legacy Function | Modern Equivalent + +| `nng_dialer_setopt` | `nng_dialer_set` +| `nng_dialer_setopt_bool`| `nng_dialer_set_bool` +| `nng_dialer_setopt_int`| `nng_dialer_set_int` +| `nng_dialer_setopt_ms`| `nng_dialer_set_ms` +| `nng_dialer_setopt_ptr`| `nng_dialer_set_ptr` +| `nng_dialer_setopt_size`| `nng_dailer_set_size` +| `nng_dialer_setopt_string`| `nng_dialer_set_string` +| `nng_dialer_setopt_uint64`| `nng_dialer_set_uint64` +|=== + +Please see the documentation for the modern equivalents for more detail. + +### See Also + +xref:../dialer/nng_dialer_set.adoc[nng_dialer_set] diff --git a/docs/ref/old/nng_getopt.adoc b/docs/ref/old/nng_getopt.adoc new file mode 100644 index 00000000..4f34b9fd --- /dev/null +++ b/docs/ref/old/nng_getopt.adoc @@ -0,0 +1,45 @@ +## nng_getopt + +Get socket option (deprecated). + +### Synopsis + +```c +#include + +int nng_getopt(nng_socket s, const char *opt, void *val, size_t *valszp); +int nng_getopt_bool(nng_socket s, const char *opt, bool *bvalp); +int nng_getopt_int(nng_socket s, const char *opt, int *ivalp); +int nng_getopt_ms(nng_socket s, const char *opt, nng_duration *durp); +int nng_getopt_ptr(nng_socket s, const char *opt, void **ptr); +int nng_getopt_size(nng_socket s, const char *opt, size_t *zp); +int nng_getopt_string(nng_socket s, const char *opt, char **strp); +int nng_getopt_uint64(nng_socket s, const char *opt, uint64_t *u64p); +``` + +### Description + +NOTE: These functions are deprecated. +They may not be present if the library was built with ((`NNG_ELIDE_DEPRECATED`)). + +These deprecated functions have one-to-one modern equivalents with the same arguments and semantics, as follows: + +[width=50%,] +|=== +| Legacy Function | Modern Equivalent + +| `nng_getopt` | `nng_socket_get` +| `nng_getopt_bool`| `nng_socket_get_bool` +| `nng_getopt_int`| `nng_socket_get_int` +| `nng_getopt_ms`| `nng_socket_get_ms` +| `nng_getopt_ptr`| `nng_socket_get_ptr` +| `nng_getopt_size`| `nng_socket_get_size` +| `nng_getopt_string`| `nng_socket_get_string` +| `nng_getopt_uint64`| `nng_socket_get_uint64` +|=== + +Please see the documentation for the modern equivalents for more detail. + +### See Also + +xref:../sock/nng_socket_get.adoc[nng_socket_get] diff --git a/docs/ref/old/nng_listener_getopt.adoc b/docs/ref/old/nng_listener_getopt.adoc new file mode 100644 index 00000000..dcbc6e2c --- /dev/null +++ b/docs/ref/old/nng_listener_getopt.adoc @@ -0,0 +1,47 @@ +## nng_listener_getopt + +Get listener option (deprecated). + +### Synopsis + +```c +#include + +int nng_listener_getopt(nng_listener l, const char *opt, void *val, size_t *valszp); +int nng_listener_getopt_bool(nng_listener l, const char *opt, bool *bvalp); +int nng_listener_getopt_int(nng_listener l, const char *opt, int *ivalp); +int nng_listener_getopt_ms(nng_listener l, const char *opt, nng_duration *durp); +int nng_listener_getopt_ptr(nng_listener l, const char *opt, void **ptr); +int nng_listener_getopt_size(nng_listener l, const char *opt, size_t *zp); +int nng_listener_getopt_sockaddr(nng_listener l, const char *opt, nng_sockaddr *sap); +int nng_listener_getopt_string(nng_listener l, const char *opt, char **strp); +int nng_listener_getopt_uint64(nng_listener l, const char *opt, uint64_t *u64p); +``` + +### Description + +NOTE: These functions are deprecated. +They may not be present if the library was built with ((`NNG_ELIDE_DEPRECATED`)). + +These deprecated functions have one-to-one modern equivalents with the same arguments and semantics, as follows: + +[width=50%,] +|=== +| Legacy Function | Modern Equivalent + +| `nng_listener_getopt` | `nng_listener_get` +| `nng_listener_getopt_bool`| `nng_listener_get_bool` +| `nng_listener_getopt_int`| `nng_listener_get_int` +| `nng_listener_getopt_ms`| `nng_listener_get_ms` +| `nng_listener_getopt_ptr`| `nng_listener_get_ptr` +| `nng_listener_getopt_size`| `nng_listener_get_size` +| `nng_listener_getopt_sockaddr`| `nng_listener_get_addr` +| `nng_listener_getopt_string`| `nng_listener_get_string` +| `nng_listener_getopt_uint64`| `nng_listener_get_uint64` +|=== + +Please see the documentation for the modern equivalents for more detail. + +### See Also + +xref:../listener/nng_listener_get.adoc[nng_listener_get] diff --git a/docs/ref/old/nng_listener_setopt.adoc b/docs/ref/old/nng_listener_setopt.adoc new file mode 100644 index 00000000..581ed6b2 --- /dev/null +++ b/docs/ref/old/nng_listener_setopt.adoc @@ -0,0 +1,46 @@ +## nng_listener_setopt + +Set listener option (deprecated). + +### Synopsis + +```c +#include + +int nng_listener_setopt(nng_listener l, const char *opt, const void *val, size_t valsz); + +int nng_listener_setopt_bool(nng_listener l, const char *opt, bool bval); +int nng_listener_setopt_int(nng_listener l, const char *opt, int ival); +int nng_listener_setopt_ms(nng_listener l, const char *opt, nng_duration dur); +int nng_listener_setopt_ptr(nng_listener l, const char *opt, void *ptr); +int nng_listener_setopt_size(nng_listener l, const char *opt, size_t z); +int nng_listener_setopt_string(nng_listener l, const char *opt, const char *str); +int nng_listener_setopt_uint64(nng_listener l, const char *opt, uint64_t u64); +``` + +### Description + +NOTE: These functions are deprecated. +They may not be present if the library was built with ((`NNG_ELIDE_DEPRECATED`)). + +These deprecated functions have one-to-one modern equivalents with the same arguments and semantics, as follows: + +[width=50%,] +|=== +| Legacy Function | Modern Equivalent + +| `nng_listener_setopt` | `nng_listener_set` +| `nng_listener_setopt_bool`| `nng_listener_set_bool` +| `nng_listener_setopt_int`| `nng_listener_set_int` +| `nng_listener_setopt_ms`| `nng_listener_set_ms` +| `nng_listener_setopt_ptr`| `nng_listener_set_ptr` +| `nng_listener_setopt_size`| `nng_dailer_set_size` +| `nng_listener_setopt_string`| `nng_listener_set_string` +| `nng_listener_setopt_uint64`| `nng_listener_set_uint64` +|=== + +Please see the documentation for the modern equivalents for more detail. + +### See Also + +xref:../listener/nng_listener_set.adoc[nng_listener_set] diff --git a/docs/ref/old/nng_pipe_getopt.adoc b/docs/ref/old/nng_pipe_getopt.adoc new file mode 100644 index 00000000..b413da24 --- /dev/null +++ b/docs/ref/old/nng_pipe_getopt.adoc @@ -0,0 +1,47 @@ +## nng_pipe_getopt + +Get pipe option (deprecated). + +### Synopsis + +```c +#include + +int nng_pipe_getopt(nng_pipe p, const char *opt, void *val, size_t *valszp); +int nng_pipe_getopt_bool(nng_pipe p, const char *opt, bool *bvalp); +int nng_pipe_getopt_int(nng_pipe p, const char *opt, int *ivalp); +int nng_pipe_getopt_ms(nng_pipe p, const char *opt, nng_duration *durp); +int nng_pipe_getopt_ptr(nng_pipe p, const char *opt, void **ptr); +int nng_pipe_getopt_sockaddr(nng_pipe p, const char *opt, nng_sockaddr *sap); +int nng_pipe_getopt_string(nng_pipe p, const char *opt, char **strp); +int nng_pipe_getopt_size(nng_pipe p, const char *opt, size_t *zp); +int nng_pipe_getopt_uint64(nng_pipe p, const char *opt, uint64_t *u64p); +``` + +### Description + +NOTE: These functions are deprecated. +They may not be present if the library was built with ((`NNG_ELIDE_DEPRECATED`)). + +These deprecated functions have one-to-one modern equivalents with the same arguments and semantics, as follows: + +[width=50%,] +|=== +| Legacy Function | Modern Equivalent + +| `nng_pipe_getopt` | `nng_pipe_get` +| `nng_pipe_getopt_bool`| `nng_pipe_get_bool` +| `nng_pipe_getopt_int`| `nng_pipe_get_int` +| `nng_pipe_getopt_ms`| `nng_pipe_get_ms` +| `nng_pipe_getopt_ptr` | `nng_pipe_get_ptr` +| `nng_pipe_getopt_size`| `nng_pipe_get_size` +| `nng_pipe_getopt_sockaddr` | `nng_pipe_get_addr` +| `nng_pipe_getopt_string`| `nng_pipe_get_string` +| `nng_pipe_getopt_uint64`| `nng_pipe_get_uint64` +|=== + +Please see the documentation for the modern equivalents for more detail. + +### See Also + +xref:../pipe/nng_pipe_get.adoc[nng_ctx_get] diff --git a/docs/ref/old/nng_setopt.adoc b/docs/ref/old/nng_setopt.adoc new file mode 100644 index 00000000..59a64f76 --- /dev/null +++ b/docs/ref/old/nng_setopt.adoc @@ -0,0 +1,45 @@ +## nng_setopt + +Set socket option (deprecated). + +### Synopsis + +```c +#include + +int nng_setopt(nng_socket s, const char *opt, const void *val, size_t valsz); +int nng_setopt_bool(nng_socket s, const char *opt, bool bval); +int nng_setopt_int(nng_socket s, const char *opt, int ival); +int nng_setopt_ms(nng_socket s, const char *opt, nng_duration dur); +int nng_setopt_ptr(nng_socket s, const char *opt, void *ptr); +int nng_setopt_size(nng_socket s, const char *opt, size_t z); +int nng_setopt_string(nng_socket s, const char *opt, const char *str); +int nng_setopt_uint64(nng_socket s, const char *opt, uint64_t u64); +``` + +### Description + +NOTE: These functions are deprecated. +They may not be present if the library was built with ((`NNG_ELIDE_DEPRECATED`)). + +These deprecated functions have one-to-one modern equivalents with the same arguments and semantics, as follows: + +[width=50%,] +|=== +| Legacy Function | Modern Equivalent + +| `nng_setopt` | `nng_socket_set` +| `nng_setopt_bool`| `nng_socket_set_bool` +| `nng_setopt_int`| `nng_socket_set_int` +| `nng_setopt_ms`| `nng_socket_set_ms` +| `nng_setopt_ptr`| `nng_socket_set_ptr` +| `nng_setopt_size`| `nng_socket_set_size` +| `nng_setopt_string`| `nng_socket_set_string` +| `nng_setopt_uint64`| `nng_socket_set_uint64` +|=== + +Please see the documentation for the modern equivalents for more detail. + +### See Also + +xref:../sock/nng_socket_set.adoc[nng_socket_set] -- cgit v1.2.3-70-g09d2