summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-05-21 15:51:08 -0700
committerGarrett D'Amore <garrett@damore.org>2018-05-21 21:27:16 -0700
commitd0cf8ce6f43daf6882037dbdcdaa7f2169dd1e6a (patch)
treeb6201f5f27c556b0a8102669605220fffccd4528 /docs
parent45692d50c33f1fbc45554a5b82281046c4b3621a (diff)
downloadnng-d0cf8ce6f43daf6882037dbdcdaa7f2169dd1e6a.tar.gz
nng-d0cf8ce6f43daf6882037dbdcdaa7f2169dd1e6a.tar.bz2
nng-d0cf8ce6f43daf6882037dbdcdaa7f2169dd1e6a.zip
fixes #469 SO_REUSEADDR should be enabled
fixes #468 TCP nodelay and keepalive should start usable fixes #467 NN_RCVMAXSZ option does not work (compat) fixes #465 Support NN_OPT_TCPNODELAY (compat) This is a rather larger change set than I'd like, but when adding support for legacy TCP keepalive, I found a number if issues using the legacy TCP test (which we are introducing with this commit.) This fixes the concerns that are relevant and addressible. We have elected not to try to support to local address binding at this time, and the IPv6 test case in the old code was wrong, so changes relevant to that are commented out. I've also updated the nng_compat manual page to reflect additional caveats that folks should be aware of, including the previously undocumented caveat around the NN_SNDBUF and NN_RCVBUF options.
Diffstat (limited to 'docs')
-rw-r--r--docs/man/nng_compat.3compat.adoc17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/man/nng_compat.3compat.adoc b/docs/man/nng_compat.3compat.adoc
index f8472c3c..148f09d1 100644
--- a/docs/man/nng_compat.3compat.adoc
+++ b/docs/man/nng_compat.3compat.adoc
@@ -190,6 +190,23 @@ The following caveats apply when using the legacy API with _nng_.
Specifically, there is no `nn_symbol()` function yet.
(This may be addressed later if there is a need.)
+* The TCP transport (`tcp://` URLs) does not support specifying the local
+ address or interface when binding. (This could be fixed in the future,
+ but most likely this will be available only using the new API.)
+
+* The values of `NN_RCVMAXSIZE` are constrained.
+ Specifically, values set larger than 2GB using the new API will be reported
+ as unlimited (`-1`) in the new API, and the value `0` will disable any
+ enforcement, just like `-1`.
+ (There is no practical reason to ever want to limit the receive size to
+ zero.)
+
+* This implementation counts buffers in terms of messages rather than bytes.
+ As a result, the buffer sizes accessed with `NN_SNDBUF` and `NN_RCVBUF` are
+ rounded up to a whole number of kilobytes, then divided by 1024, in order
+ to approximate buffering assuming 1 KB messages.
+ Few applications should need to adjust the default values.
+
== SEE ALSO
<<libnng.3#,libnng(3)>>,