diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-03-30 23:07:20 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-03-30 23:07:20 -0700 |
| commit | f73cd76f54b8aead38689e0ea805d5d805dfbe96 (patch) | |
| tree | 0f6643e955770a9e96a8bbd900ca957a73fe1182 /docs/reference/src/old | |
| parent | 6f8944a96a5acd509014caae4e57dafbba51e126 (diff) | |
| download | nng-f73cd76f54b8aead38689e0ea805d5d805dfbe96.tar.gz nng-f73cd76f54b8aead38689e0ea805d5d805dfbe96.tar.bz2 nng-f73cd76f54b8aead38689e0ea805d5d805dfbe96.zip | |
Staging work. converted nng_ipc.
Diffstat (limited to 'docs/reference/src/old')
| -rw-r--r-- | docs/reference/src/old/nng_dialer_getopt.3.adoc | 149 | ||||
| -rw-r--r-- | docs/reference/src/old/nng_dialer_setopt.3.adoc | 134 | ||||
| -rw-r--r-- | docs/reference/src/old/nng_getopt.3.adoc | 145 | ||||
| -rw-r--r-- | docs/reference/src/old/nng_inproc_register.3.adoc | 47 | ||||
| -rw-r--r-- | docs/reference/src/old/nng_ipc_register.3.adoc | 47 | ||||
| -rw-r--r-- | docs/reference/src/old/nng_listener_getopt.3.adoc | 150 | ||||
| -rw-r--r-- | docs/reference/src/old/nng_listener_setopt.3.adoc | 136 | ||||
| -rw-r--r-- | docs/reference/src/old/nng_pipe_getopt.3.adoc | 155 | ||||
| -rw-r--r-- | docs/reference/src/old/nng_setopt.3.adoc | 127 | ||||
| -rw-r--r-- | docs/reference/src/old/nng_tcp_register.3.adoc | 47 | ||||
| -rw-r--r-- | docs/reference/src/old/nng_tls_register.3.adoc | 44 | ||||
| -rw-r--r-- | docs/reference/src/old/nng_ws_register.3.adoc | 47 | ||||
| -rw-r--r-- | docs/reference/src/old/nng_wss_register.3.adoc | 47 | ||||
| -rw-r--r-- | docs/reference/src/old/nng_zt_register.3.adoc | 47 |
14 files changed, 1322 insertions, 0 deletions
diff --git a/docs/reference/src/old/nng_dialer_getopt.3.adoc b/docs/reference/src/old/nng_dialer_getopt.3.adoc new file mode 100644 index 00000000..a4083819 --- /dev/null +++ b/docs/reference/src/old/nng_dialer_getopt.3.adoc @@ -0,0 +1,149 @@ += nng_dialer_getopt(3) +// +// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// 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 <nng/nng.h> + +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/reference/src/old/nng_dialer_setopt.3.adoc b/docs/reference/src/old/nng_dialer_setopt.3.adoc new file mode 100644 index 00000000..3aaff1eb --- /dev/null +++ b/docs/reference/src/old/nng_dialer_setopt.3.adoc @@ -0,0 +1,134 @@ += nng_dialer_setopt(3) +// +// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// 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 <nng/nng.h> + +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/reference/src/old/nng_getopt.3.adoc b/docs/reference/src/old/nng_getopt.3.adoc new file mode 100644 index 00000000..364d8f71 --- /dev/null +++ b/docs/reference/src/old/nng_getopt.3.adoc @@ -0,0 +1,145 @@ += nng_getopt(3) +// +// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// 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 <nng/nng.h> + +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/reference/src/old/nng_inproc_register.3.adoc b/docs/reference/src/old/nng_inproc_register.3.adoc new file mode 100644 index 00000000..8379a4e8 --- /dev/null +++ b/docs/reference/src/old/nng_inproc_register.3.adoc @@ -0,0 +1,47 @@ += nng_inproc_register(3) +// +// Copyright 2021 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// 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_inproc_register - register inproc transport + +== SYNOPSIS + +[source,c] +---- +#include <nng/transport/inproc/inproc.h> + +int nng_inproc_register(void); +---- + +== DESCRIPTION + +The `nng_inproc_register()` function registers the +((_inproc_ transport))(((transport, _inproc_))) for use. + +NOTE: This function is deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +[horizontal] +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_ENOTSUP`:: The transport is not supported. + +== SEE ALSO + +[.text-left] +xref:nng_inproc.7.adoc[nng_inproc(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/reference/src/old/nng_ipc_register.3.adoc b/docs/reference/src/old/nng_ipc_register.3.adoc new file mode 100644 index 00000000..64da4b00 --- /dev/null +++ b/docs/reference/src/old/nng_ipc_register.3.adoc @@ -0,0 +1,47 @@ += nng_ipc_register(3) +// +// Copyright 2021 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// 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_ipc_register - register ipc transport + +== SYNOPSIS + +[source,c] +---- +#include <nng/transport/ipc/ipc.h> + +int nng_ipc_register(void); +---- + +== DESCRIPTION + +The `nng_ipc_register()` function registers the +((_ipc_ transport))(((transport, _ipc_))) for use. + +NOTE: This function is deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +[horizontal] +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_ENOTSUP`:: The transport is not supported. + +== SEE ALSO + +[.text-left] +xref:nng_ipc.7.adoc[nng_ipc(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/reference/src/old/nng_listener_getopt.3.adoc b/docs/reference/src/old/nng_listener_getopt.3.adoc new file mode 100644 index 00000000..828f440d --- /dev/null +++ b/docs/reference/src/old/nng_listener_getopt.3.adoc @@ -0,0 +1,150 @@ += nng_listener_getopt(3) +// +// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// 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 <nng/nng.h> + +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/reference/src/old/nng_listener_setopt.3.adoc b/docs/reference/src/old/nng_listener_setopt.3.adoc new file mode 100644 index 00000000..25411adc --- /dev/null +++ b/docs/reference/src/old/nng_listener_setopt.3.adoc @@ -0,0 +1,136 @@ += nng_listener_setopt(3) +// +// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// 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 <nng/nng.h> + +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/reference/src/old/nng_pipe_getopt.3.adoc b/docs/reference/src/old/nng_pipe_getopt.3.adoc new file mode 100644 index 00000000..648abbcc --- /dev/null +++ b/docs/reference/src/old/nng_pipe_getopt.3.adoc @@ -0,0 +1,155 @@ += nng_pipe_getopt(3) +// +// Copyright 2019 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// 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 <nng/nng.h> + +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/reference/src/old/nng_setopt.3.adoc b/docs/reference/src/old/nng_setopt.3.adoc new file mode 100644 index 00000000..6c21cf95 --- /dev/null +++ b/docs/reference/src/old/nng_setopt.3.adoc @@ -0,0 +1,127 @@ += nng_setopt(3) + +// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// 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 <nng/nng.h> + +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/reference/src/old/nng_tcp_register.3.adoc b/docs/reference/src/old/nng_tcp_register.3.adoc new file mode 100644 index 00000000..3da671a9 --- /dev/null +++ b/docs/reference/src/old/nng_tcp_register.3.adoc @@ -0,0 +1,47 @@ += nng_tcp_register(3) +// +// Copyright 2021 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// 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_tcp_register - register tcp transport + +== SYNOPSIS + +[source,c] +---- +#include <nng/transport/tcp/tcp.h> + +int nng_tcp_register(void); +---- + +== DESCRIPTION + +The `nng_tcp_register()` function registers the +((_tcp_ transport))(((transport, _tcp_))) for use. + +NOTE: This function is deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +[horizontal] +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_ENOTSUP`:: The transport is not supported. + +== SEE ALSO + +[.text-left] +xref:nng_tcp.7.adoc[nng_tcp(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/reference/src/old/nng_tls_register.3.adoc b/docs/reference/src/old/nng_tls_register.3.adoc new file mode 100644 index 00000000..bfe27e05 --- /dev/null +++ b/docs/reference/src/old/nng_tls_register.3.adoc @@ -0,0 +1,44 @@ += nng_tls_register(3) +// +// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// 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_tls_register - register tls transport + +== SYNOPSIS + +[source,c] +---- +#include <nng/transport/tls/tls.h> + +int nng_tls_register(void); +---- + +== DESCRIPTION + +The `nng_tls_register()` function registers the +((_tls_ transport))(((transport, _tls_))) for use. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +[horizontal] +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_ENOTSUP`:: The transport is not supported. + +== SEE ALSO + +[.text-left] +xref:nng_tls.7.adoc[nng_tls(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/reference/src/old/nng_ws_register.3.adoc b/docs/reference/src/old/nng_ws_register.3.adoc new file mode 100644 index 00000000..7a9cc1f3 --- /dev/null +++ b/docs/reference/src/old/nng_ws_register.3.adoc @@ -0,0 +1,47 @@ += nng_ws_register(3) +// +// Copyright 2021 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// 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_ws_register - register WebSocket transport + +== SYNOPSIS + +[source,c] +---- +#include <nng/transport/websocket/ws.h> + +int nng_ws_register(void); +---- + +== DESCRIPTION + +The `nng_ws_register()` function registers the +((_ws_ transport))(((transport, _ws_))) for use. + +NOTE: This function is deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +[horizontal] +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_ENOTSUP`:: The transport is not supported. + +== SEE ALSO + +[.text-left] +xref:nng_ws.7.adoc[nng_ws(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/reference/src/old/nng_wss_register.3.adoc b/docs/reference/src/old/nng_wss_register.3.adoc new file mode 100644 index 00000000..856fe1c0 --- /dev/null +++ b/docs/reference/src/old/nng_wss_register.3.adoc @@ -0,0 +1,47 @@ += nng_wss_register(3) +// +// Copyright 2021 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// 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_wss_register - register WebSocket secure transport + +== SYNOPSIS + +[source,c] +---- +#include <nng/transport/websocket/ws.h> + +int nng_wss_register(void); +---- + +== DESCRIPTION + +The `nng_wss_register()` function registers the +((_wss_ transport))(((transport, _wss_))) for use. + +NOTE: This function is deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +[horizontal] +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_ENOTSUP`:: The transport is not supported. + +== SEE ALSO + +[.text-left] +xref:nng_ws.7.adoc[nng_ws(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/reference/src/old/nng_zt_register.3.adoc b/docs/reference/src/old/nng_zt_register.3.adoc new file mode 100644 index 00000000..9c4a4ac4 --- /dev/null +++ b/docs/reference/src/old/nng_zt_register.3.adoc @@ -0,0 +1,47 @@ += nng_zt_register(3) +// +// Copyright 2021 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// 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_zt_register - register ZeroTier transport + +== SYNOPSIS + +[source,c] +---- +#include <nng/transport/zerotier/zerotier.h> + +int nng_zt_register(void); +---- + +== DESCRIPTION + +The `nng_zt_register()` function registers the +((_zt_ transport))(((transport, _zt_))) for use. + +NOTE: This function is deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +[horizontal] +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_ENOTSUP`:: The transport is not supported. + +== SEE ALSO + +[.text-left] +xref:nng_zerotier.7.adoc[nng_zerotier(7)], +xref:nng.7.adoc[nng(7)] |
