aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_dialer_set.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_dialer_set.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_dialer_set.3.adoc')
-rw-r--r--docs/man/nng_dialer_set.3.adoc131
1 files changed, 131 insertions, 0 deletions
diff --git a/docs/man/nng_dialer_set.3.adoc b/docs/man/nng_dialer_set.3.adoc
new file mode 100644
index 00000000..5f81e9a0
--- /dev/null
+++ b/docs/man/nng_dialer_set.3.adoc
@@ -0,0 +1,131 @@
+= nng_dialer_set(3)
+//
+// 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
+// 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_dialer_set - set dialer option
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+
+int nng_dialer_set(nng_dialer d, const char *opt, const void *val,
+ size_t valsz);
+
+int nng_dialer_set_bool(nng_dialer d, const char *opt, bool bval);
+
+int nng_dialer_set_int(nng_dialer d, const char *opt, int ival);
+
+int nng_dialer_set_ms(nng_dialer d, const char *opt, nng_duration dur);
+
+int nng_dialer_set_ptr(nng_dialer d, const char *opt, void *ptr);
+
+int nng_dialer_set_size(nng_dialer d, const char *opt, size_t z);
+
+int nng_dialer_set_string(nng_dialer d, const char *opt, const char *str);
+
+int nng_dialer_set_uint64(nng_dialer d, const char *opt, uint64_t u64);
+
+----
+
+== DESCRIPTION
+
+(((options, dialer)))
+The `nng_dialer_set()` functions are used to configure options for
+the <<nng_dialer.5#,dialer>> _d_.
+The actual options that may be configured in this way
+vary, and many are documented in <<nng_options.5#,nng_options(5)>>.
+
+Additionally some transport-specific options are documented with the
+transports themselves.
+
+NOTE: Once a dialer has started, it is generally not possible to change
+its configuration.
+
+=== Forms
+
+In all of these forms, the option _opt_ is configured on the dialer _d_.
+
+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_dialer_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_dialer_set_bool()`::
+This function is for options which take a Boolean (`bool`).
+The _bval_ is passed to the option.
+
+`nng_dialer_set_int()`::
+This function is for options which take an integer (`int`).
+The _ival_ is passed to the option.
+
+`nng_dialer_set_ms()`::
+This function is used to configure time durations (such as timeouts) using
+type `<<nng_duration.5#,nng_duration>>`.
+The duration _dur_ is an integer number of milliseconds.
+
+`nng_dialer_set_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
+(`<<nng_tls_config_alloc.3tls#,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_dialer_set_size()`::
+This function is used to configure a size, _z_, typically for buffer sizes,
+message maximum sizes, and similar options.
+
+`nng_dialer_set_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_dialer_set_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 such.
+
+== RETURN VALUES
+
+These functions return 0 on success, and non-zero otherwise.
+
+== ERRORS
+
+[horizontal]
+`NNG_EBADTYPE`:: Incorrect type for option.
+`NNG_ECLOSED`:: Parameter _d_ does not refer to an open dialer.
+`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 dialer _d_ is already started.
+
+== SEE ALSO
+
+[.text-left]
+<<nng_dialer_create.3#,nng_dialer_create(3)>>
+<<nng_dialer_get.3#,nng_dialer_get(3)>>
+<<nng_strerror.3#,nng_strerror(3)>>,
+<<nng_dialer.5#,nng_dialer(5)>>,
+<<nng_duration.5#,nng_duration(5)>>,
+<<nng_options.5#,nng_options(5)>>,
+<<nng.7#,nng(7)>>