summaryrefslogtreecommitdiff
path: root/doc/zmq_getsockopt.3
diff options
context:
space:
mode:
authorMartin Lucina <mato@kotelna.sk>2010-09-08 15:25:45 +0200
committerMartin Lucina <martin@lucina.net>2012-01-23 08:53:27 +0100
commit90d73cba9cd1d1724f38ed82fc0eefb1781c9c20 (patch)
tree1760872164a93384d1adb90db9c8d41777dbb2a7 /doc/zmq_getsockopt.3
parentcf026feae205bfeb7e007f6afd0e8d7b283865c8 (diff)
parent5ba1cb20fe6f6699cef1cc726718e760cd4c9af1 (diff)
Imported Debian patch 2.0.9.dfsg-1debian/2.0.9.dfsg-1
Diffstat (limited to 'doc/zmq_getsockopt.3')
-rw-r--r--doc/zmq_getsockopt.328
1 files changed, 18 insertions, 10 deletions
diff --git a/doc/zmq_getsockopt.3 b/doc/zmq_getsockopt.3
index 90edfd4..9efb5a0 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: 06/04/2010
+.\" Date: 09/06/2010
.\" Manual: 0MQ Manual
-.\" Source: 0MQ 2.0.7
+.\" Source: 0MQ 2.0.9
.\" Language: English
.\"
-.TH "ZMQ_GETSOCKOPT" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual"
+.TH "ZMQ_GETSOCKOPT" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -34,7 +34,7 @@ zmq_getsockopt \- get 0MQ socket options
\fBint zmq_getsockopt (void \fR\fB\fI*socket\fR\fR\fB, int \fR\fB\fIoption_name\fR\fR\fB, void \fR\fB\fI*option_value\fR\fR\fB, size_t \fR\fB\fI*option_len\fR\fR\fB);\fR
.SH "DESCRIPTION"
.sp
-The \fIzmq_getsockopt()\fR function shall retrieve the value for the option specified by the \fIoption_name\fR argument for the 0MQ socket pointed to by the \fIsocket\fR argument, and store it in the buffer pointed to by the \fIoption_value\fR argument\&. The \fIoption_len\fR argument is the size in bytes of the buffer pointed to by \fIoption_value\fR; upon successful completion \fIzmq_getsockopt()\fR shall modify the \fIoption_value\fR argument to indicate the actual size of the option value stored in the buffer\&.
+The \fIzmq_getsockopt()\fR function shall retrieve the value for the option specified by the \fIoption_name\fR argument for the 0MQ socket pointed to by the \fIsocket\fR argument, and store it in the buffer pointed to by the \fIoption_value\fR argument\&. The \fIoption_len\fR argument is the size in bytes of the buffer pointed to by \fIoption_value\fR; upon successful completion \fIzmq_getsockopt()\fR shall modify the \fIoption_len\fR argument to indicate the actual size of the option value stored in the buffer\&.
.sp
The following options can be retrieved with the \fIzmq_getsockopt()\fR function:
.SS "ZMQ_RCVMORE: More message parts to follow"
@@ -96,7 +96,7 @@ T{
Option value type
T}:T{
.sp
-int64_t
+uint64_t
T}
T{
.sp
@@ -180,7 +180,7 @@ T{
Option value type
T}:T{
.sp
-int64_t
+uint64_t
T}
T{
.sp
@@ -262,7 +262,7 @@ T{
Option value type
T}:T{
.sp
-uint64_t
+int64_t
T}
T{
.sp
@@ -301,7 +301,7 @@ T{
Option value type
T}:T{
.sp
-uint64_t
+int64_t
T}
T{
.sp
@@ -340,7 +340,7 @@ T{
Option value type
T}:T{
.sp
-uint64_t
+int64_t
T}
T{
.sp
@@ -469,6 +469,13 @@ associated with the specified
\fIsocket\fR
was terminated\&.
.RE
+.PP
+\fBEFAULT\fR
+.RS 4
+The provided
+\fIsocket\fR
+was not valid (NULL)\&.
+.RE
.SH "EXAMPLE"
.PP
\fBRetrieving the high water mark\fR.
@@ -479,7 +486,8 @@ was terminated\&.
.nf
/* Retrieve high water mark into hwm */
int64_t hwm;
-rc = zmq_getsockopt (socket, ZMQ_HWM, &hwm, sizeof hwm);
+size_t hwm_size = sizeof (hwm);
+rc = zmq_getsockopt (socket, ZMQ_HWM, &hwm, &hwm_size);
assert (rc == 0);
.fi
.if n \{\