diff options
| -rw-r--r-- | doc/xs_getsockopt.txt | 15 | ||||
| -rw-r--r-- | doc/xs_setsockopt.txt | 14 | ||||
| -rw-r--r-- | doc/xs_socket.txt | 77 |
3 files changed, 106 insertions, 0 deletions
diff --git a/doc/xs_getsockopt.txt b/doc/xs_getsockopt.txt index 99d9376..fe40662 100644 --- a/doc/xs_getsockopt.txt +++ b/doc/xs_getsockopt.txt @@ -404,6 +404,21 @@ Default value:: 0 (false) Applicable socket types:: all, when using TCP transport. +XS_SURVEY_TIMEOUT: Retrieve deadline for the survey +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Specifies how long to wait for responses to the survey. After the interval +expires, any firther calls to xs_recv() will return EAGAIN error. All the +responses received later on will be silently discarded. Value of -1 means +infinite. + +[horizontal] +Option value type:: int +Option value unit:: milliseconds +Default value:: -1 (infinite) +Applicable socket types:: XS_SURVEYOR + + RETURN VALUE ------------ The _xs_getsockopt()_ function shall return zero if successful. Otherwise it diff --git a/doc/xs_setsockopt.txt b/doc/xs_setsockopt.txt index d636c83..4ac59a9 100644 --- a/doc/xs_setsockopt.txt +++ b/doc/xs_setsockopt.txt @@ -361,6 +361,20 @@ Default value:: 0 (false) Applicable socket types:: all, when using TCP transport. +XS_SURVEY_TIMEOUT: Sets the deadline for the survey +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Specifies how long to wait for responses to the survey. After the interval +expires, any firther calls to xs_recv() will return EAGAIN error. All the +responses received later on will be silently discarded. Value of -1 means +infinite. + +[horizontal] +Option value type:: int +Option value unit:: milliseconds +Default value:: -1 (infinite) +Applicable socket types:: XS_SURVEYOR + RETURN VALUE ------------ The _xs_setsockopt()_ function shall return zero if successful. Otherwise it diff --git a/doc/xs_socket.txt b/doc/xs_socket.txt index 7c37fc0..20e9505 100644 --- a/doc/xs_socket.txt +++ b/doc/xs_socket.txt @@ -282,6 +282,83 @@ Outgoing routing strategy:: N/A XS_HWM option action:: N/A +Survey pattern +~~~~~~~~~~~~~~ +Survey pattern can be used to post a survey to a set of notes and collect +responses from them. The survey is distributed from surveyor to all connected +respondents. Responses are routed back to the original surveyor. + +XS_SURVEYOR +^^^^^^^^^^^ + +XS_SURVEYOR socket type can be used to send surveys to all respondents in the +topology and receive the replies from all of them. Each survey sent is +distributed to all connected peers, and incoming replies are fair-queue. As you +don't know the number of respondents in the topology you don't know the number +of responses you are going to get, therefore you should use XS_SURVEY_TIMEOUT +socket option to set the deadline for the survey. + +[horizontal] +.Summary of XS_SURVEYOR characteristics +Compatible peer sockets:: 'XS_RESPONDENT', 'XS_XRESPONDENT' +Direction:: Bidirectional +Send/receive pattern:: Send one message, receive many messages. +Incoming routing strategy:: Fair-queued +Outgoing routing strategy:: Fan out +XS_HWM option action:: Drop + +XS_RESPONDENT +^^^^^^^^^^^^^ + +This socket type receives surveys from surveyors and sends responses. Incoming +surveys are fair-queued. Outgoing responses are routed back to the original +surveyor. + +[horizontal] +.Summary of XS_RESPONDENT characteristics +Compatible peer sockets:: 'XS_SURVEYOR', 'XS_XSURVEYOR' +Direction:: Bidirectional +Send/receive pattern:: Receive a survey, send one response. +Incoming routing strategy:: Fair-queued +Outgoing routing strategy:: Last peer +XS_HWM option action:: Drop + +XS_XSURVEYOR +^^^^^^^^^^^^ + +A socket of type 'XS_XSURVEYOR' is a socket type underlying 'XS_SURVEYOR'. +It doesn't impose the strict order of sends and recvs as 'XS_SURVEYOR' does and +it is intended for use in intermediate devices in survey topologies. + +[horizontal] +.Summary of XS_XSURVEYOR characteristics +Compatible peer sockets:: 'XS_RESPONDENT', 'XS_XRESPONDENT' +Direction:: Bidirectional +Send/receive pattern:: Send surveys, receive responses. +Incoming routing strategy:: Fair-queued +Outgoing routing strategy:: Fan out +XS_HWM option action:: Drop + +XS_XRESPONDENT +^^^^^^^^^^^^^^ + +A socket of type 'XS_XRESPONDENT' is a socket type underlying 'XS_RESPONDENT'. +It doesn't impose the strict order of sends and recvs as 'XS_RESPONDENT' does +and it is intended for use in intermediate devices in survey topologies. + +Incoming surveys are fair-queued. Each survey is prefixed by a message part +identifying the surveyor it was received from. Outgoing responses are routed +to the original surveyor based on the first message part. + +[horizontal] +.Summary of XS_XRESPONDENT characteristics +Compatible peer sockets:: 'XS_SURVEYOR', 'XS_XSURVEYOR' +Direction:: Bidirectional +Send/receive pattern:: Receive surveys, send responses. +Incoming routing strategy:: Fair-queued +Outgoing routing strategy:: See text +XS_HWM option action:: Drop + Exclusive pair pattern ~~~~~~~~~~~~~~~~~~~~~~ The exclusive pair is an advanced pattern used for communicating exclusively |