diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-11-03 08:57:35 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-11-03 08:57:56 -0800 |
| commit | fb7f83b4c6f371372f742ff45f5efb8e83374f8c (patch) | |
| tree | 1dd5d7be8fdb4c47881051f3511f0932160c9619 /docs/man/nng_ctx_set.3.adoc | |
| parent | 4367013d8b56105edd0d27d0b9b6da2becab9717 (diff) | |
| download | nng-fb7f83b4c6f371372f742ff45f5efb8e83374f8c.tar.gz nng-fb7f83b4c6f371372f742ff45f5efb8e83374f8c.tar.bz2 nng-fb7f83b4c6f371372f742ff45f5efb8e83374f8c.zip | |
Remove nng_ctx untyped option functions
Diffstat (limited to 'docs/man/nng_ctx_set.3.adoc')
| -rw-r--r-- | docs/man/nng_ctx_set.3.adoc | 15 |
1 files changed, 2 insertions, 13 deletions
diff --git a/docs/man/nng_ctx_set.3.adoc b/docs/man/nng_ctx_set.3.adoc index 9bfeb43f..1a7f7033 100644 --- a/docs/man/nng_ctx_set.3.adoc +++ b/docs/man/nng_ctx_set.3.adoc @@ -1,6 +1,6 @@ = nng_ctx_set(3) // -// Copyright 2019 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_ctx_set - set context option ---- #include <nng/nng.h> -int nng_ctx_set(nng_ctx ctx, const char *opt, const void *val, size_t valsz); - int nng_ctx_set_bool(nng_ctx ctx, const char *opt, int bval); int nng_ctx_set_int(nng_ctx ctx, const char *opt, int ival); @@ -36,10 +34,8 @@ int nng_ctx_set_uint64(nng_ctx ctx, const char *opt, uint64_t u64); == DESCRIPTION -NOTE: These functions are deprecated. Please see xref:nng_ctx_set.3.adoc[nng_ctx_set]. - (((options, context))) -The `nng_ctx_set()` functions are used to configure options for +The `nng_ctx_set` 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_. @@ -52,13 +48,6 @@ The details will be documented with the protocol. 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_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_ctx_set_bool()`:: This function is for options which take a Boolean (`bool`). The _bval_ is passed to the option. |