summaryrefslogtreecommitdiff
path: root/doc/xs_getsockopt.txt
diff options
context:
space:
mode:
authorMartin Sustrik <sustrik@250bpm.com>2012-04-20 08:46:17 +0200
committerMartin Sustrik <sustrik@250bpm.com>2012-04-21 07:24:04 +0200
commitf4149b0500b8011c58cd3f5acbb4225dd79e8b85 (patch)
tree218f8a2c7845e23b93553a2af1bb065827cb10cc /doc/xs_getsockopt.txt
parentcdf32999cfbe6fd76a7678c0a3d8d53bc3f3ca4f (diff)
Documentation for survey pattern added
Signed-off-by: Martin Sustrik <sustrik@250bpm.com>
Diffstat (limited to 'doc/xs_getsockopt.txt')
-rw-r--r--doc/xs_getsockopt.txt15
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