Documentation for survey pattern added

Signed-off-by: Martin Sustrik <sustrik@250bpm.com>

1 files changed, 15 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