diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-11-03 09:46:54 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-11-03 10:14:11 -0800 |
| commit | 11485d2723f22dc60e4cefea3ffb3fd8a378d931 (patch) | |
| tree | daef10d4d8ed13e983a2b50db80a00254f474ee0 /docs/man/nng_socket_set.3.adoc | |
| parent | c77e32bc6da45a2c20b70451a6fb9d0caf636c75 (diff) | |
| download | nng-11485d2723f22dc60e4cefea3ffb3fd8a378d931.tar.gz nng-11485d2723f22dc60e4cefea3ffb3fd8a378d931.tar.bz2 nng-11485d2723f22dc60e4cefea3ffb3fd8a378d931.zip | |
Remove untyped nng_socket_get and nng_socket_set.
Diffstat (limited to 'docs/man/nng_socket_set.3.adoc')
| -rw-r--r-- | docs/man/nng_socket_set.3.adoc | 14 |
1 files changed, 2 insertions, 12 deletions
diff --git a/docs/man/nng_socket_set.3.adoc b/docs/man/nng_socket_set.3.adoc index aa5784f3..bd3f7f47 100644 --- a/docs/man/nng_socket_set.3.adoc +++ b/docs/man/nng_socket_set.3.adoc @@ -1,6 +1,6 @@ = nng_socket_set(3) // -// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2024 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 @@ -19,8 +19,6 @@ nng_socket_set - set socket option ---- #include <nng/nng.h> -int nng_socket_set(nng_socket s, const char *opt, const void *val, size_t valsz); - int nng_socket_set_bool(nng_socket s, const char *opt, bool bval); int nng_socket_set_int(nng_socket s, const char *opt, int ival); @@ -34,12 +32,11 @@ int nng_socket_set_size(nng_socket s, const char *opt, size_t z); int nng_socket_set_string(nng_socket s, const char *opt, const char *str); int nng_socket_set_uint64(nng_socket s, const char *opt, uint64_t u64); - ---- == DESCRIPTION (((options, socket))) -The `nng_socket_set()` functions are used to configure options for +The `nng_socket_set` 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_. @@ -57,13 +54,6 @@ xref:nng_listener_set.3.adoc[nng_listener_get] for specific dialers or listeners The details of the type, size, and semantics of the option will depend on the actual option, and is documented with the option itself. -`nng_socket_set()`:: -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_socket_set_bool()`:: This function is for options which take a Boolean (`bool`). The _bval_ is passed to the option. |