summaryrefslogtreecommitdiff
path: root/doc/zmq_getsockopt.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/zmq_getsockopt.3')
-rw-r--r--doc/zmq_getsockopt.397
1 files changed, 82 insertions, 15 deletions
diff --git a/doc/zmq_getsockopt.3 b/doc/zmq_getsockopt.3
index b2a0bfc..ac9bd83 100644
--- a/doc/zmq_getsockopt.3
+++ b/doc/zmq_getsockopt.3
@@ -2,12 +2,12 @@
.\" Title: zmq_getsockopt
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\" Date: 11/22/2011
+.\" Date: 04/04/2012
.\" Manual: 0MQ Manual
-.\" Source: 0MQ 2.1.10
+.\" Source: 0MQ 2.2.0
.\" Language: English
.\"
-.TH "ZMQ_GETSOCKOPT" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual"
+.TH "ZMQ_GETSOCKOPT" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -160,6 +160,84 @@ all
T}
.TE
.sp 1
+.SS "ZMQ_RCVTIMEO: Maximum time before a socket operation returns with EAGAIN"
+.sp
+Retrieve the timeout for recv operation on the socket\&. If the value is 0, \fIzmq_recv(3)\fR will return immediately, with a EAGAIN error if there is no message to receive\&. If the value is \-1, it will block until a message is available\&. For all other values, it will wait for a message for that amount of time before returning with an EAGAIN error\&.
+.TS
+tab(:);
+lt lt
+lt lt
+lt lt
+lt lt.
+T{
+.sp
+Option value type
+T}:T{
+.sp
+int
+T}
+T{
+.sp
+Option value unit
+T}:T{
+.sp
+milliseconds
+T}
+T{
+.sp
+Default value
+T}:T{
+.sp
+\-1 (infinite)
+T}
+T{
+.sp
+Applicable socket types
+T}:T{
+.sp
+all
+T}
+.TE
+.sp 1
+.SS "ZMQ_SNDTIMEO: Maximum time before a socket operation returns with EAGAIN"
+.sp
+Retrieve the timeout for send operation on the socket\&. If the value is 0, \fIzmq_send(3)\fR will return immediately, with a EAGAIN error if the message cannot be sent\&. If the value is \-1, it will block until the message is sent\&. For all other values, it will try to send the message for that amount of time before returning with an EAGAIN error\&.
+.TS
+tab(:);
+lt lt
+lt lt
+lt lt
+lt lt.
+T{
+.sp
+Option value type
+T}:T{
+.sp
+int
+T}
+T{
+.sp
+Option value unit
+T}:T{
+.sp
+milliseconds
+T}
+T{
+.sp
+Default value
+T}:T{
+.sp
+\-1 (infinite)
+T}
+T{
+.sp
+Applicable socket types
+T}:T{
+.sp
+all
+T}
+.TE
+.sp 1
.SS "ZMQ_SWAP: Retrieve disk offload size"
.sp
The \fIZMQ_SWAP\fR option shall retrieve the disk offload (swap) size for the specified \fIsocket\fR\&. A socket which has \fIZMQ_SWAP\fR set to a non\-zero value may exceed its high water mark; in this case outstanding messages shall be offloaded to storage on disk rather than held in memory\&.
@@ -930,15 +1008,4 @@ assert (rc == 0);
\fBzmq_setsockopt\fR(3) \fBzmq_socket\fR(3) \fBzmq\fR(7)
.SH "AUTHORS"
.sp
-This 0MQ manual page was written by Martin Sustrik <\m[blue]\fBsustrik@250bpm\&.com\fR\m[]\&\s-2\u[1]\d\s+2> and Martin Lucina <\m[blue]\fBmato@kotelna\&.sk\fR\m[]\&\s-2\u[2]\d\s+2>\&.
-.SH "NOTES"
-.IP " 1." 4
-sustrik@250bpm.com
-.RS 4
-\%mailto:sustrik@250bpm.com
-.RE
-.IP " 2." 4
-mato@kotelna.sk
-.RS 4
-\%mailto:mato@kotelna.sk
-.RE
+This manual page was written by the 0MQ community\&.