summaryrefslogtreecommitdiff
path: root/docs/ref/proto/surveyor.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-04-07 23:40:27 -0700
committerGarrett D'Amore <garrett@damore.org>2024-04-07 23:40:27 -0700
commitb9e2720357dabdaa6853437bd83364211e1be599 (patch)
tree7fb42b5e059169d7cce5ba33d53f89e035de17ca /docs/ref/proto/surveyor.adoc
parentd06684afc1177cab655899609fcb03853f280bfc (diff)
downloadnng-b9e2720357dabdaa6853437bd83364211e1be599.tar.gz
nng-b9e2720357dabdaa6853437bd83364211e1be599.tar.bz2
nng-b9e2720357dabdaa6853437bd83364211e1be599.zip
fix title levels
Diffstat (limited to 'docs/ref/proto/surveyor.adoc')
-rw-r--r--docs/ref/proto/surveyor.adoc10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/ref/proto/surveyor.adoc b/docs/ref/proto/surveyor.adoc
index 8c2fa05b..cd0c8e02 100644
--- a/docs/ref/proto/surveyor.adoc
+++ b/docs/ref/proto/surveyor.adoc
@@ -9,7 +9,7 @@ This protocol is useful in solving voting problems, such as ((leader election)),
The _SURVEYOR_ protocol is the surveyor side, and the xref:respondent.adoc[_RESPONDENT_] protocol is the respondent side.
-#### Socket Operations
+### Socket Operations
The xref:nng_surveyor_open.adoc[`nng_surveyor_open`] functions create a _SURVEYOR_ socket.
This socket may be used to send messages (surveys), and then to receive replies.
@@ -24,7 +24,7 @@ Only one survey can be outstanding at a time; sending another survey will cancel
xref:../sock/raw.adoc[Raw mode] sockets ignore all these restrictions.
-#### Context Operations
+### Context Operations
This protocol supports the creation of xref:../ctx/index.adoc[contexts] for concurrent
use cases using xref:../ctx/nng_ctx_open.adoc[`nng_ctx_open`].
@@ -38,12 +38,12 @@ Additionally, sending a survey on a context will only cancel an outstanding surv
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
+### Protocol Versions
Only version 0 of this protocol is supported.footnote:[At the time of writing, no other versions of this protocol have been defined.
An earlier and incompatible version of the protocol was used in older pre-releases of http://nanomsg.org[nanomsg], but was not released in any production version.]
-#### Protocol Options
+### Protocol Options
The following protocol-specific options is available.
@@ -55,7 +55,7 @@ Any responses arriving this time will be discarded.
Attempts to receive after the timer expires with no other surveys started will result in `NNG_ESTATE`.
Attempts to receive when this timer expires will result in `NNG_ETIMEDOUT`.
-#### Protocol Headers
+### Protocol Headers
(((backtrace)))This form uses a stack of 32-bit big-endian identifiers.
There *must* be at least one identifier, the __survey ID__, which will be the last element in the array, and *must* have the most significant bit set.