summaryrefslogtreecommitdiff
path: root/docs/man/nng_ctx_setopt.3.adoc
diff options
context:
space:
mode:
authorJake Woltersdorf <jake@playruyi.com>2019-03-04 12:35:19 +0800
committerGarrett D'Amore <garrett@damore.org>2019-04-07 19:13:44 -0700
commitc3e062661388f70386d6766e3ce648030af340ee (patch)
treea6d247bd24a17e3201a75b1a164e75d16e37196c /docs/man/nng_ctx_setopt.3.adoc
parent989c5e90d48066b12ad44ed903cfc163d8e89b29 (diff)
downloadnng-c3e062661388f70386d6766e3ce648030af340ee.tar.gz
nng-c3e062661388f70386d6766e3ce648030af340ee.tar.bz2
nng-c3e062661388f70386d6766e3ce648030af340ee.zip
fixes #901 shorter option get/set functions for all types
- Renamed internal nng_*_getx/setx methods with "nni" prefix - Moved stream get/set option definition macros to options.h and added "NNI_" prefix - "_PTR" variant of get/set option definition macros is for when first arg is passed as pointer (`nng_stream *s` vs `nng_pipe s`) - New get/set option functions for `nng_socket` are `nng_socket_get_X` eschewing the previous `nng_getopt` pattern - Macro-fy legacy getopt/setopt and implement in terms of "new" API - nng_setopt* use "new" shorter API. Add missing uint64 set functions. - Shorter get/set option functions get own man page and old getopt/setopt link to them - Built with -DNNG_ENABLE_DOC=ON and part of central libnng index - Update copyright
Diffstat (limited to 'docs/man/nng_ctx_setopt.3.adoc')
-rw-r--r--docs/man/nng_ctx_setopt.3.adoc5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/man/nng_ctx_setopt.3.adoc b/docs/man/nng_ctx_setopt.3.adoc
index 45f178f8..478410b5 100644
--- a/docs/man/nng_ctx_setopt.3.adoc
+++ b/docs/man/nng_ctx_setopt.3.adoc
@@ -1,6 +1,6 @@
= nng_ctx_setopt(3)
//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
+// Copyright 2019 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
@@ -35,6 +35,9 @@ int nng_ctx_setopt_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_setopt()` functions are used to configure options for
the context _ctx_.