aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-09-07 14:43:23 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-06 14:14:56 -0700
commite677cf5a779ab1698985cf926ba7112168bc5c97 (patch)
tree81e66d44929f9114a909a3a091e54b8264b69a3f /docs
parent313cbe0abffd02b33b379ba1057b4735d3573ad3 (diff)
downloadnng-e677cf5a779ab1698985cf926ba7112168bc5c97.tar.gz
nng-e677cf5a779ab1698985cf926ba7112168bc5c97.tar.bz2
nng-e677cf5a779ab1698985cf926ba7112168bc5c97.zip
Remove deprecated context option functions.
Diffstat (limited to 'docs')
-rw-r--r--docs/man/CMakeLists.txt2
-rw-r--r--docs/man/libnng.3.adoc2
-rw-r--r--docs/man/nng_ctx_getopt.3.adoc134
-rw-r--r--docs/man/nng_ctx_open.3.adoc4
-rw-r--r--docs/man/nng_ctx_setopt.3.adoc114
5 files changed, 2 insertions, 254 deletions
diff --git a/docs/man/CMakeLists.txt b/docs/man/CMakeLists.txt
index 4d788843..bdb16b27 100644
--- a/docs/man/CMakeLists.txt
+++ b/docs/man/CMakeLists.txt
@@ -85,13 +85,11 @@ if (NNG_ENABLE_DOC)
nng_close
nng_ctx_close
nng_ctx_get
- nng_ctx_getopt
nng_ctx_id
nng_ctx_open
nng_ctx_recv
nng_ctx_send
nng_ctx_set
- nng_ctx_setopt
nng_device
nng_dial
nng_dialer_close
diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc
index 1125dd50..cc86cde6 100644
--- a/docs/man/libnng.3.adoc
+++ b/docs/man/libnng.3.adoc
@@ -209,7 +209,6 @@ concurrent applications.
|===
|xref:nng_ctx_close.3.adoc[nng_ctx_close()]|close context
|xref:nng_ctx_get.3.adoc[nng_ctx_get()]|get context option
-|xref:nng_ctx_getopt.3.adoc[nng_ctx_getopt()]|get context option
|xref:nng_ctx_id.3.adoc[nng_ctx_id()]|get numeric context identifier
|xref:nng_ctx_open.3.adoc[nng_ctx_open()]|create context
|xref:nng_ctx_recv.3.adoc[nng_ctx_recv()]|receive message using context asynchronously
@@ -217,7 +216,6 @@ concurrent applications.
|xref:nng_ctx_send.3.adoc[nng_ctx_send()]|send message using context asynchronously
|xref:nng_ctx_sendmsg.3.adoc[nng_ctx_sendmsg()]|send a message using context
|xref:nng_ctx_set.3.adoc[nng_ctx_set()]|set context option
-|xref:nng_ctx_setopt.3.adoc[nng_ctx_setopt()]|set context option
|===
=== Devices, Relays
diff --git a/docs/man/nng_ctx_getopt.3.adoc b/docs/man/nng_ctx_getopt.3.adoc
deleted file mode 100644
index 2214a3eb..00000000
--- a/docs/man/nng_ctx_getopt.3.adoc
+++ /dev/null
@@ -1,134 +0,0 @@
-= nng_ctx_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_ctx_getopt - get context option
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-int nng_ctx_getopt(nng_ctx ctx, const char *opt, void *val, size_t *valszp);
-
-int nng_ctx_getopt_bool(nng_ctx ctx, const char *opt, bool *bvalp);
-
-int nng_ctx_getopt_int(nng_ctx ctx, const char *opt, int *ivalp);
-
-int nng_ctx_getopt_ms(nng_ctx ctx, const char *opt, nng_duration *durp);
-
-int nng_ctx_getopt_size(nng_ctx ctx, const char *opt, size_t *zp);
-
-int nng_ctx_getopt_string(nng_ctx ctx, const char *opt, char **strp);
-
-int nng_ctx_getopt_uint64(nng_ctx ctx, const char *opt, uint64_t *u64p);
-
-----
-
-== DESCRIPTION
-
-IMPORTANT: These functions are deprecated. Please see xref:nng_ctx_get.3.adoc[nng_ctx_get].
-They may not be present if the library was built with `NNG_ELIDE_DEPRECATED`.
-
-(((options, context)))
-The `nng_ctx_getopt()` functions are used to retrieve option values for
-the xref:nng_ctx.5.adoc[context] _ctx_.
-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)].
-
-NOTE: Context options are protocol specific.
-The details will be documented with the protocol.
-
-=== Forms
-
-In all of these forms, the option _opt_ is retrieved from the context _ctx_.
-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_ctx_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_ctx_getopt_bool()`::
-This function is for options which take a Boolean (`bool`).
-The value will be stored at _ivalp_.
-
-`nng_ctx_getopt_int()`::
-This function is for options which take an integer (`int`).
-The value will be stored at _ivalp_.
-
-`nng_ctx_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_ctx_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_ctx_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_ctx_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_ctx_setopt.3.adoc[nng_ctx_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_ctx.5.adoc[nng_ctx(5)],
-xref:nng_options.5.adoc[nng_options(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_ctx_open.3.adoc b/docs/man/nng_ctx_open.3.adoc
index 76842b7e..8157c6ee 100644
--- a/docs/man/nng_ctx_open.3.adoc
+++ b/docs/man/nng_ctx_open.3.adoc
@@ -59,10 +59,10 @@ This function returns 0 on success, and non-zero otherwise.
[.text-left]
xref:nng_ctx_close.3.adoc[nng_ctx_close(3)],
-xref:nng_ctx_getopt.3.adoc[nng_ctx_getopt(3)],
+xref:nng_ctx_get.3.adoc[nng_ctx_get(3)],
xref:nng_ctx_recv.3.adoc[nng_ctx_recv(3)],
xref:nng_ctx_send.3.adoc[nng_ctx_send(3)],
-xref:nng_ctx_setopt.3.adoc[nng_ctx_setopt(3)],
+xref:nng_ctx_set.3.adoc[nng_ctx_set(3)],
xref:nng_strerror.3.adoc[nng_strerror(3)],
xref:nng_ctx.5.adoc[nng_ctx(5)],
xref:nng_socket.5.adoc[nng_socket(5)],
diff --git a/docs/man/nng_ctx_setopt.3.adoc b/docs/man/nng_ctx_setopt.3.adoc
deleted file mode 100644
index f6f7f9ef..00000000
--- a/docs/man/nng_ctx_setopt.3.adoc
+++ /dev/null
@@ -1,114 +0,0 @@
-= nng_ctx_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_ctx_setopt - set context option
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-int nng_ctx_setopt(nng_ctx ctx, const char *opt, const void *val, size_t valsz);
-
-int nng_ctx_setopt_bool(nng_ctx ctx, const char *opt, int bval);
-
-int nng_ctx_setopt_int(nng_ctx ctx, const char *opt, int ival);
-
-int nng_ctx_setopt_ms(nng_ctx ctx, const char *opt, nng_duration dur);
-
-int nng_ctx_setopt_size(nng_ctx ctx, const char *opt, size_t z);
-
-int nng_ctx_setopt_string(nng_ctx ctx, const char *opt, const char *str);
-
-int nng_ctx_setopt_uint64(nng_ctx ctx, const char *opt, uint64_t u64);
-----
-
-== DESCRIPTION
-
-IMPORTANT: These functions are deprecated. Please see xref:nng_ctx_set.3.adoc[nng_ctx_set].
-They may not be present if the library was built with `NNG_ELIDE_DEPRECATED`.
-
-(((options, context)))
-The `nng_ctx_setopt()` functions are used to configure options for
-the context _ctx_.
-The actual options that may be configured in this way vary, and are
-specified by _opt_.
-
-NOTE: Context options are protocol specific.
-The details will be documented with the protocol.
-
-=== 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_ctx_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_ctx_setopt_bool()`::
-This function is for options which take a Boolean (`bool`).
-The _bval_ is passed to the option.
-
-`nng_ctx_setopt_int()`::
-This function is for options which take an integer (`int`).
-The _ival_ is passed to the option.
-
-`nng_ctx_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_ctx_setopt_size()`::
-This function is used to configure a size, _z_, typically for buffer sizes,
-message maximum sizes, and similar options.
-
-`nng_ctx_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_ctx_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_ctx_getopt.3.adoc[nng_ctx_getopt(3)],
-xref:nng_setopt.3.adoc[nng_setopt(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_ctx.5.adoc[nng_ctx(5)],
-xref:nng_options.5.adoc[nng_options(5)],
-xref:nng_socket.5.adoc[nng_socket(5)],
-xref:nng.7.adoc[nng(7)]