aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_setopt.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-09-07 14:56:23 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-06 14:16:06 -0700
commit0a8b26cd6955f28e405e007a8ff2f090426ded04 (patch)
tree649b0b1ef99f191a05e25d8f8b6542fc921bb40b /docs/man/nng_setopt.3.adoc
parente677cf5a779ab1698985cf926ba7112168bc5c97 (diff)
downloadnng-0a8b26cd6955f28e405e007a8ff2f090426ded04.tar.gz
nng-0a8b26cd6955f28e405e007a8ff2f090426ded04.tar.bz2
nng-0a8b26cd6955f28e405e007a8ff2f090426ded04.zip
Remove the last of the legacy option handling functions.
Diffstat (limited to 'docs/man/nng_setopt.3.adoc')
-rw-r--r--docs/man/nng_setopt.3.adoc125
1 files changed, 0 insertions, 125 deletions
diff --git a/docs/man/nng_setopt.3.adoc b/docs/man/nng_setopt.3.adoc
deleted file mode 100644
index aa65a638..00000000
--- a/docs/man/nng_setopt.3.adoc
+++ /dev/null
@@ -1,125 +0,0 @@
-= 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_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)]