summaryrefslogtreecommitdiff
path: root/docs/man/nng_setopt.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-03-18 12:46:31 -0700
committerGarrett D'Amore <garrett@damore.org>2018-03-18 12:46:31 -0700
commit8b979454d891b84da727a329906c4293fadc5f3c (patch)
treecb491c476080de11c7fc5b5868579f4ef86f4df4 /docs/man/nng_setopt.3.adoc
parent3a2af394a7d94ac5f924aaea6cbad825a9b05d75 (diff)
downloadnng-8b979454d891b84da727a329906c4293fadc5f3c.tar.gz
nng-8b979454d891b84da727a329906c4293fadc5f3c.tar.bz2
nng-8b979454d891b84da727a329906c4293fadc5f3c.zip
fixes #295 boolean options should use C99 bool type
fixes #275 nng_pipe_getopt_ptr() missing? fixes #285 nng_setopt_ptr MIS fixes #297 nng_listener/dialer_close does not validate mode This change adds some missing APIs, and changes others. In particular, certain options are now of type bool, with size of just one. This is a *breaking* change for code that uses those options -- NNG_OPT_RAW, NNG_OPT_PAIR1_POLY, NNG_OPT_TLS_VERIFIED.
Diffstat (limited to 'docs/man/nng_setopt.3.adoc')
-rw-r--r--docs/man/nng_setopt.3.adoc9
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/man/nng_setopt.3.adoc b/docs/man/nng_setopt.3.adoc
index 95284852..201181cc 100644
--- a/docs/man/nng_setopt.3.adoc
+++ b/docs/man/nng_setopt.3.adoc
@@ -21,6 +21,8 @@ nng_setopt - set socket option
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, int 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);
@@ -59,10 +61,13 @@ 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_.
+`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`) or boolean (`bool`).
+This function is for options which take an integer (`int`).
The _ival_ is passed to the option.
-For booleans pass either 0 (`false`) or 1 (`true`).
`nng_setopt_ms()`::
This function is used to configure time durations (such as timeouts) using