aboutsummaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-09-07 14:34:55 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-06 14:14:28 -0700
commit313cbe0abffd02b33b379ba1057b4735d3573ad3 (patch)
tree582b3d220d3631e782a9aa39252f768227779fe3 /docs/man
parent5981b6eb6cf2177e704e21ff4dfc6e3e398405f8 (diff)
downloadnng-313cbe0abffd02b33b379ba1057b4735d3573ad3.tar.gz
nng-313cbe0abffd02b33b379ba1057b4735d3573ad3.tar.bz2
nng-313cbe0abffd02b33b379ba1057b4735d3573ad3.zip
Drop the legacy listener option functions
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/CMakeLists.txt2
-rw-r--r--docs/man/libnng.3.adoc2
-rw-r--r--docs/man/nng_getopt.3.adoc1
-rw-r--r--docs/man/nng_listener.5.adoc4
-rw-r--r--docs/man/nng_listener_create.3.adoc6
-rw-r--r--docs/man/nng_listener_getopt.3.adoc150
-rw-r--r--docs/man/nng_listener_setopt.3.adoc136
-rw-r--r--docs/man/nng_setopt.3.adoc1
-rw-r--r--docs/man/nng_zerotier.7.adoc2
9 files changed, 6 insertions, 298 deletions
diff --git a/docs/man/CMakeLists.txt b/docs/man/CMakeLists.txt
index 75189a42..4d788843 100644
--- a/docs/man/CMakeLists.txt
+++ b/docs/man/CMakeLists.txt
@@ -106,10 +106,8 @@ if (NNG_ENABLE_DOC)
nng_listener_close
nng_listener_create
nng_listener_get
- nng_listener_getopt
nng_listener_id
nng_listener_set
- nng_listener_setopt
nng_listener_start
nng_log
nng_log_get_level
diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc
index 8b81e8f7..1125dd50 100644
--- a/docs/man/libnng.3.adoc
+++ b/docs/man/libnng.3.adoc
@@ -73,10 +73,8 @@ Listeners accept incoming connection requests, and dialers make them.
|xref:nng_listener_close.3.adoc[nng_listener_close()]|close listener
|xref:nng_listener_create.3.adoc[nng_listener_create()]|create listener
|xref:nng_listener_get.3.adoc[nng_listener_get()]|get listener option
-|xref:nng_listener_getopt.3.adoc[nng_listener_getopt()]|get listener option
|xref:nng_listener_id.3.adoc[nng_listener_id()]|get numeric listener identifier
|xref:nng_listener_set.3.adoc[nng_listener_set()]|set listener option
-|xref:nng_listener_setopt.3.adoc[nng_listener_setopt()]|set listener option
|xref:nng_listener_start.3.adoc[nng_listener_start()]|start listener
|xref:nng_pipe_close.3.adoc[nng_pipe_close()]|close pipe
|xref:nng_pipe_dialer.3.adoc[nng_pipe_dialer()]|return dialer that created pipe
diff --git a/docs/man/nng_getopt.3.adoc b/docs/man/nng_getopt.3.adoc
index 4a648ae2..9b61fc5f 100644
--- a/docs/man/nng_getopt.3.adoc
+++ b/docs/man/nng_getopt.3.adoc
@@ -132,7 +132,6 @@ These functions return 0 on success, and non-zero otherwise.
== SEE ALSO
[.text-left]
-xref:nng_listener_getopt.3.adoc[nng_listener_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)],
diff --git a/docs/man/nng_listener.5.adoc b/docs/man/nng_listener.5.adoc
index 66eb736d..1af9c0ad 100644
--- a/docs/man/nng_listener.5.adoc
+++ b/docs/man/nng_listener.5.adoc
@@ -67,9 +67,9 @@ before it is opened, to prevent confusion with valid open listener.
xref:nng_listen.3.adoc[nng_listen(3)],
xref:nng_listener_close.3.adoc[nng_listener_close(3)],
xref:nng_listener_create.3.adoc[nng_listener_create(3)],
-xref:nng_listener_getopt.3.adoc[nng_listener_getopt(3)],
+xref:nng_listener_get.3.adoc[nng_listener_get(3)],
xref:nng_listener_id.3.adoc[nng_listener_id(3)],
-xref:nng_listener_setopt.3.adoc[nng_listener_setopt(3)],
+xref:nng_listener_set.3.adoc[nng_listener_set(3)],
xref:nng_listener_start.3.adoc[nng_listener_start(3)],
xref:nng_dialer.5.adoc[nng_dialer(5)],
xref:nng_pipe.5.adoc[nng_pipe(5)],
diff --git a/docs/man/nng_listener_create.3.adoc b/docs/man/nng_listener_create.3.adoc
index edf19af7..2e97e1c1 100644
--- a/docs/man/nng_listener_create.3.adoc
+++ b/docs/man/nng_listener_create.3.adoc
@@ -43,7 +43,7 @@ but might also have associated listeners.
It may even have some of each at the same time!
The listener is not started, but may be further configured with
-the xref:nng_listener_setopt.3.adoc[`nng_listener_setopt()`] family of
+the xref:nng_listener_set.3.adoc[`nng_listener_set()`] family of
functions.
Once it is fully configured, the listener may be started using the
@@ -69,8 +69,8 @@ This function returns 0 on success, and non-zero otherwise.
xref:nng_dialer_create.3.adoc[nng_dialer_create(3)]
xref:nng_listen.3.adoc[nng_listen(3)],
xref:nng_listener_close.3.adoc[nng_listener_close(3)],
-xref:nng_listener_getopt.3.adoc[nng_listener_getopt(3)],
-xref:nng_listener_setopt.3.adoc[nng_listener_setopt(3)],
+xref:nng_listener_get.3.adoc[nng_listener_get(3)],
+xref:nng_listener_set.3.adoc[nng_listener_set(3)],
xref:nng_listener_start.3.adoc[nng_listener_start(3)],
xref:nng_strerror.3.adoc[nng_strerror(3)],
xref:nng_listener.5.adoc[nng_listener(5)],
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. <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/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. <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/man/nng_setopt.3.adoc b/docs/man/nng_setopt.3.adoc
index 61926d69..aa65a638 100644
--- a/docs/man/nng_setopt.3.adoc
+++ b/docs/man/nng_setopt.3.adoc
@@ -119,7 +119,6 @@ These functions return 0 on success, and non-zero otherwise.
[.text-left]
xref:nng_getopt.3.adoc[nng_getopt(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)],
diff --git a/docs/man/nng_zerotier.7.adoc b/docs/man/nng_zerotier.7.adoc
index 36cf7f0e..40c048d6 100644
--- a/docs/man/nng_zerotier.7.adoc
+++ b/docs/man/nng_zerotier.7.adoc
@@ -64,7 +64,7 @@ the node's own node number.
Listeners may use port 0 to indicate that a suitable port
number be selected automatically.
Applications using this must determine the selected port number using the
-xref:nng_listener_getopt.3.adoc[`nng_listener_getopt()`] function.
+xref:nng_listener_get.3.adoc[`nng_listener_get()`] function.
=== Socket Address