summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-04-24 20:02:10 -0700
committerGarrett D'Amore <garrett@damore.org>2018-04-24 20:02:10 -0700
commit1dc4ca934ffcfdc1c9ba559f010fddfbf0f12fdb (patch)
treedcdd2958319520e1906cb248726dbd5367bf0b20
parentd35973833e6bf05fec29100a4d5e66bb07b06659 (diff)
downloadnng-1dc4ca934ffcfdc1c9ba559f010fddfbf0f12fdb.tar.gz
nng-1dc4ca934ffcfdc1c9ba559f010fddfbf0f12fdb.tar.bz2
nng-1dc4ca934ffcfdc1c9ba559f010fddfbf0f12fdb.zip
Document context support for surveyor.
-rw-r--r--docs/man/nng_surveyor.7.adoc18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/man/nng_surveyor.7.adoc b/docs/man/nng_surveyor.7.adoc
index 97578b33..7a8d2073 100644
--- a/docs/man/nng_surveyor.7.adoc
+++ b/docs/man/nng_surveyor.7.adoc
@@ -59,6 +59,24 @@ survey that arrive after this will be discarded.
<<nng.7#raw_mode,Raw>> mode sockets ignore all these restrictions.
+=== Context Operations
+
+This protocol supports the creation of <<nng_ctx.5#,contexts>> for concurrent
+use cases using <<nng_ctx_open.3#,`nng_ctx_open()`>>.
+
+Each context can initiate its own surveys, and it will receive only
+responses to its own outstanding surveys.
+Other contexts on the same socket may have overlapping surveys
+operating at the same time.
+Each of these may have their own timeouts established with
+`NNG_OPT_SURVEYOR_SURVEYTIME`.
+Additionally, sending a survey on a context will only cancel an outstanding
+survey on the same context.
+
+NOTE: Due to the best-effort nature of this protocol, if too may contexts
+are attempting to perform surveys simultaneously, it is possible for either
+individual outgoing surveys or incoming responses to be lost.
+
=== Protocol Versions
Only version 0 of this protocol is supported.