From 5ba1cb20fe6f6699cef1cc726718e760cd4c9af1 Mon Sep 17 00:00:00 2001 From: Martin Lucina Date: Mon, 23 Jan 2012 08:53:25 +0100 Subject: Imported Upstream version 2.0.9.dfsg --- doc/Makefile.am | 2 +- doc/Makefile.in | 6 +- doc/asciidoc.conf | 56 ++++++++++++ doc/zmq.7 | 8 +- doc/zmq.html | 6 +- doc/zmq.txt | 3 +- doc/zmq_bind.3 | 13 ++- doc/zmq_bind.html | 11 ++- doc/zmq_bind.txt | 2 + doc/zmq_close.3 | 15 ++-- doc/zmq_close.html | 14 ++- doc/zmq_close.txt | 3 +- doc/zmq_connect.3 | 13 ++- doc/zmq_connect.html | 11 ++- doc/zmq_connect.txt | 2 + doc/zmq_cpp.7 | 16 +++- doc/zmq_cpp.html | 7 +- doc/zmq_cpp.txt | 4 + doc/zmq_epgm.7 | 6 +- doc/zmq_epgm.html | 3 +- doc/zmq_errno.3 | 6 +- doc/zmq_errno.html | 3 +- doc/zmq_forwarder.1 | 6 +- doc/zmq_forwarder.html | 3 +- doc/zmq_getsockopt.3 | 28 +++--- doc/zmq_getsockopt.html | 26 ++++-- doc/zmq_getsockopt.txt | 17 ++-- doc/zmq_init.3 | 6 +- doc/zmq_init.html | 3 +- doc/zmq_inproc.7 | 6 +- doc/zmq_inproc.html | 3 +- doc/zmq_ipc.7 | 6 +- doc/zmq_ipc.html | 3 +- doc/zmq_msg_close.3 | 6 +- doc/zmq_msg_close.html | 3 +- doc/zmq_msg_copy.3 | 6 +- doc/zmq_msg_copy.html | 3 +- doc/zmq_msg_data.3 | 6 +- doc/zmq_msg_data.html | 3 +- doc/zmq_msg_init.3 | 6 +- doc/zmq_msg_init.html | 3 +- doc/zmq_msg_init_data.3 | 6 +- doc/zmq_msg_init_data.html | 3 +- doc/zmq_msg_init_size.3 | 6 +- doc/zmq_msg_init_size.html | 3 +- doc/zmq_msg_move.3 | 6 +- doc/zmq_msg_move.html | 3 +- doc/zmq_msg_size.3 | 6 +- doc/zmq_msg_size.html | 3 +- doc/zmq_pgm.7 | 6 +- doc/zmq_pgm.html | 3 +- doc/zmq_poll.3 | 13 ++- doc/zmq_poll.html | 11 ++- doc/zmq_poll.txt | 2 + doc/zmq_queue.1 | 6 +- doc/zmq_queue.html | 3 +- doc/zmq_recv.3 | 18 +++- doc/zmq_recv.html | 18 +++- doc/zmq_recv.txt | 7 +- doc/zmq_send.3 | 13 ++- doc/zmq_send.html | 11 ++- doc/zmq_send.txt | 2 + doc/zmq_setsockopt.3 | 23 +++-- doc/zmq_setsockopt.html | 21 +++-- doc/zmq_setsockopt.txt | 12 +-- doc/zmq_socket.3 | 187 +++++++++++++++++++++++++++++++++++---- doc/zmq_socket.html | 212 +++++++++++++++++++++++++++++++++++++++++---- doc/zmq_socket.txt | 102 ++++++++++++++++++---- doc/zmq_streamer.1 | 6 +- doc/zmq_streamer.html | 3 +- doc/zmq_strerror.3 | 6 +- doc/zmq_strerror.html | 3 +- doc/zmq_tcp.7 | 20 ++--- doc/zmq_tcp.html | 18 ++-- doc/zmq_tcp.txt | 11 +-- doc/zmq_term.3 | 15 ++-- doc/zmq_term.html | 14 ++- doc/zmq_term.txt | 3 +- doc/zmq_version.3 | 6 +- doc/zmq_version.html | 3 +- 80 files changed, 916 insertions(+), 251 deletions(-) create mode 100644 doc/asciidoc.conf (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index 3c7b20b..ba2b64a 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -17,7 +17,7 @@ if INSTALL_MAN dist_man_MANS = $(MAN_DOC) endif -EXTRA_DIST = $(MAN_TXT) +EXTRA_DIST = asciidoc.conf $(MAN_TXT) if BUILD_DOC EXTRA_DIST += $(MAN_HTML) endif diff --git a/doc/Makefile.in b/doc/Makefile.in index c75a926..8948f1c 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -201,7 +201,7 @@ MAN_DOC = $(MAN1) $(MAN3) $(MAN7) MAN_TXT = $(MAN1:%.1=%.txt) $(MAN3:%.3=%.txt) $(MAN7:%.7=%.txt) MAN_HTML = $(MAN_TXT:%.txt=%.html) @INSTALL_MAN_TRUE@dist_man_MANS = $(MAN_DOC) -EXTRA_DIST = $(MAN_TXT) $(am__append_1) +EXTRA_DIST = asciidoc.conf $(MAN_TXT) $(am__append_1) MAINTAINERCLEANFILES = $(MAN_DOC) $(MAN_HTML) @BUILD_DOC_TRUE@SUFFIXES = .html .txt .xml .1 .3 .7 all: all-am @@ -217,9 +217,9 @@ $(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps) exit 1;; \ esac; \ done; \ - echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/Makefile'; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign doc/Makefile'; \ cd $(top_srcdir) && \ - $(AUTOMAKE) --gnu doc/Makefile + $(AUTOMAKE) --foreign doc/Makefile .PRECIOUS: Makefile Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status @case '$?' in \ diff --git a/doc/asciidoc.conf b/doc/asciidoc.conf new file mode 100644 index 0000000..d73d711 --- /dev/null +++ b/doc/asciidoc.conf @@ -0,0 +1,56 @@ +[paradef-default] +literal-style=template="literalparagraph" + +[macros] +(?su)[\\]?(?Plinkzmq):(?P\S*?)\[(?P.*?)\]= + +ifdef::backend-docbook[] +[linkzmq-inlinemacro] +{0%{target}} +{0#} +{0#{target}{0}} +{0#} +endif::backend-docbook[] + +ifdef::backend-xhtml11[] +[linkzmq-inlinemacro] +{target}{0?({0})} +endif::backend-xhtml11[] + +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[header] +template::[header-declarations] + + +{mantitle} +{manvolnum} +0MQ +{zmq_version} +0MQ Manual + + + {manname} + {manpurpose} + +endif::backend-docbook[] +endif::doctype-manpage[] + +ifdef::backend-xhtml11[] +[footer] + +{disable-javascript%
} + + + +endif::backend-xhtml11[] + +[replacements] +ifdef::backend-xhtml11[] +0MQ=ØMQ +endif::backend-xhtml11[] diff --git a/doc/zmq.7 b/doc/zmq.7 index 56cfe1f..d17390a 100644 --- a/doc/zmq.7 +++ b/doc/zmq.7 @@ -2,12 +2,12 @@ .\" Title: zmq .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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" "7" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ" "7" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -63,7 +63,7 @@ Terminate 0MQ context \fBThread safety\fR .RS 4 .sp -A 0MQ \fIcontext\fR is thread safe and may be shared among as many application threads as the application has requested using the \fIapp_threads\fR parameter to \fIzmq_init()\fR, without any additional locking required on the part of the caller\&. Each 0MQ socket belonging to a particular \fIcontext\fR may only be used by \fBthe thread that created it\fR using \fIzmq_socket()\fR\&. +A 0MQ \fIcontext\fR is thread safe and may be shared among as many application threads as necessary, without any additional locking required on the part of the caller\&. Each 0MQ socket belonging to a particular \fIcontext\fR may only be used by \fBthe thread that created it\fR using \fIzmq_socket()\fR\&. .RE .sp .it 1 an-trap diff --git a/doc/zmq.html b/doc/zmq.html index 934381a..c73f990 100644 --- a/doc/zmq.html +++ b/doc/zmq.html @@ -620,8 +620,7 @@ Terminate ØMQ context

Thread safety

A ØMQ context is thread safe and may be shared among as many application -threads as the application has requested using the app_threads parameter to -zmq_init(), without any additional locking required on the part of the +threads as necessary, without any additional locking required on the part of the caller. Each ØMQ socket belonging to a particular context may only be used by the thread that created it using zmq_socket().

Multiple contexts

@@ -859,7 +858,8 @@ included with the ØMQ distribution.

diff --git a/doc/zmq.txt b/doc/zmq.txt index d13f572..06658c9 100644 --- a/doc/zmq.txt +++ b/doc/zmq.txt @@ -44,8 +44,7 @@ Terminate 0MQ context:: Thread safety ^^^^^^^^^^^^^ A 0MQ 'context' is thread safe and may be shared among as many application -threads as the application has requested using the _app_threads_ parameter to -_zmq_init()_, without any additional locking required on the part of the +threads as necessary, without any additional locking required on the part of the caller. Each 0MQ socket belonging to a particular 'context' may only be used by *the thread that created it* using _zmq_socket()_. diff --git a/doc/zmq_bind.3 b/doc/zmq_bind.3 index 164989e..3d37d82 100644 --- a/doc/zmq_bind.3 +++ b/doc/zmq_bind.3 @@ -2,12 +2,12 @@ .\" Title: zmq_bind .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_BIND" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_BIND" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -113,6 +113,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 \fBBinding a publisher socket to an in-process and a TCP transport\fR. diff --git a/doc/zmq_bind.html b/doc/zmq_bind.html index 5035f0c..cd759ea 100644 --- a/doc/zmq_bind.html +++ b/doc/zmq_bind.html @@ -689,6 +689,14 @@ The requested address specifies a nonexistent interface. The ØMQ context associated with the specified socket was terminated.

+
+EFAULT +
+
+

+The provided socket was not valid (NULL). +

+

EXAMPLE

@@ -722,7 +730,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_bind.txt b/doc/zmq_bind.txt index a74e81d..7aa5a0b 100644 --- a/doc/zmq_bind.txt +++ b/doc/zmq_bind.txt @@ -56,6 +56,8 @@ The requested 'address' was not local. The requested 'address' specifies a nonexistent interface. *ETERM*:: The 0MQ 'context' associated with the specified 'socket' was terminated. +*EFAULT*:: +The provided 'socket' was not valid (NULL). EXAMPLE diff --git a/doc/zmq_close.3 b/doc/zmq_close.3 index 7ea5e3f..d8f2d0e 100644 --- a/doc/zmq_close.3 +++ b/doc/zmq_close.3 @@ -2,12 +2,12 @@ .\" Title: zmq_close .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_CLOSE" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_CLOSE" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -39,8 +39,13 @@ The \fIzmq_close()\fR function shall destroy the socket referenced by the \fIsoc .sp The \fIzmq_close()\fR function shall return zero if successful\&. Otherwise it shall return \-1 and set \fIerrno\fR to one of the values defined below\&. .SH "ERRORS" -.sp -No errors are defined\&. +.PP +\fBEFAULT\fR +.RS 4 +The provided +\fIsocket\fR +was not valid (NULL)\&. +.RE .SH "SEE ALSO" .sp \fBzmq_socket\fR(3) \fBzmq_term\fR(3) \fBzmq\fR(7) diff --git a/doc/zmq_close.html b/doc/zmq_close.html index ebdfa9f..e8ab194 100644 --- a/doc/zmq_close.html +++ b/doc/zmq_close.html @@ -601,7 +601,16 @@ return -1 and set errno to one of the values defined below.

ERRORS

-

No errors are defined.

+
+
+EFAULT +
+
+

+The provided socket was not valid (NULL). +

+
+

SEE ALSO

@@ -618,7 +627,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_close.txt b/doc/zmq_close.txt index f944bda..e903437 100644 --- a/doc/zmq_close.txt +++ b/doc/zmq_close.txt @@ -31,7 +31,8 @@ return `-1` and set 'errno' to one of the values defined below. ERRORS ------ -No errors are defined. +*EFAULT*:: +The provided 'socket' was not valid (NULL). SEE ALSO diff --git a/doc/zmq_connect.3 b/doc/zmq_connect.3 index 69e67c4..695daa0 100644 --- a/doc/zmq_connect.3 +++ b/doc/zmq_connect.3 @@ -2,12 +2,12 @@ .\" Title: zmq_connect .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_CONNECT" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_CONNECT" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -108,6 +108,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 \fBConnecting a subscriber socket to an in-process and a TCP transport\fR. diff --git a/doc/zmq_connect.html b/doc/zmq_connect.html index 9b7c4e9..4e33d65 100644 --- a/doc/zmq_connect.html +++ b/doc/zmq_connect.html @@ -675,6 +675,14 @@ The requested transport protocol is not compatible with the socket type The ØMQ context associated with the specified socket was terminated.

+
+EFAULT +
+
+

+The provided socket was not valid (NULL). +

+

EXAMPLE

@@ -708,7 +716,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_connect.txt b/doc/zmq_connect.txt index 0061c37..ffcf3b4 100644 --- a/doc/zmq_connect.txt +++ b/doc/zmq_connect.txt @@ -54,6 +54,8 @@ The requested 'transport' protocol is not supported. The requested 'transport' protocol is not compatible with the socket type. *ETERM*:: The 0MQ 'context' associated with the specified 'socket' was terminated. +*EFAULT*:: +The provided 'socket' was not valid (NULL). EXAMPLE diff --git a/doc/zmq_cpp.7 b/doc/zmq_cpp.7 index 612ecec..0203dfc 100644 --- a/doc/zmq_cpp.7 +++ b/doc/zmq_cpp.7 @@ -2,12 +2,12 @@ .\" Title: zmq_cpp .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_CPP" "7" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_CPP" "7" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -345,6 +345,16 @@ Equivalent to calling the \fIzmq_msg_close()\fR function followed by the corresp .RE .SS "Input/output multiplexing" .sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint poll (zmq_pollitem_t *items, int nitems, long timeout = \-1)\fR +.fi +.if n \{\ +.RE +.\} +.sp The \fIpoll()\fR function is a namespaced equivalent of the \fIzmq_poll()\fR function, as described in \fBzmq_poll\fR(3)\&. .if n \{\ .sp diff --git a/doc/zmq_cpp.html b/doc/zmq_cpp.html index c373f8e..13a8761 100644 --- a/doc/zmq_cpp.html +++ b/doc/zmq_cpp.html @@ -707,6 +707,10 @@ functions to construct, destruct and manipulate ØMQ messages.

Equivalent to calling the zmq_msg_close() function followed by the corresponding zmq_msg_init() function.

Input/output multiplexing

+
+
int poll (zmq_pollitem_t *items, int nitems, long timeout = -1)
+
+

The poll() function is a namespaced equivalent of the zmq_poll() function, as described in zmq_poll(3).

@@ -751,7 +755,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_cpp.txt b/doc/zmq_cpp.txt index b7a5a42..d43ff62 100644 --- a/doc/zmq_cpp.txt +++ b/doc/zmq_cpp.txt @@ -168,6 +168,10 @@ corresponding _zmq_msg_init()_ function. Input/output multiplexing ~~~~~~~~~~~~~~~~~~~~~~~~~ + +[verse] +*int poll (zmq_pollitem_t *items, int nitems, long timeout = -1)* + The _poll()_ function is a namespaced equivalent of the _zmq_poll()_ function, as described in linkzmq:zmq_poll[3]. diff --git a/doc/zmq_epgm.7 b/doc/zmq_epgm.7 index 98318ad..34a37be 100644 --- a/doc/zmq_epgm.7 +++ b/doc/zmq_epgm.7 @@ -2,12 +2,12 @@ .\" Title: zmq_pgm .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_PGM" "7" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_PGM" "7" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_epgm.html b/doc/zmq_epgm.html index 456fcdf..637cb7b 100644 --- a/doc/zmq_epgm.html +++ b/doc/zmq_epgm.html @@ -737,7 +737,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_errno.3 b/doc/zmq_errno.3 index 071cbc8..09e38d8 100644 --- a/doc/zmq_errno.3 +++ b/doc/zmq_errno.3 @@ -2,12 +2,12 @@ .\" Title: zmq_errno .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_ERRNO" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_ERRNO" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_errno.html b/doc/zmq_errno.html index 56a470e..fe10d59 100644 --- a/doc/zmq_errno.html +++ b/doc/zmq_errno.html @@ -626,7 +626,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_forwarder.1 b/doc/zmq_forwarder.1 index 3b22d3e..df3d28b 100644 --- a/doc/zmq_forwarder.1 +++ b/doc/zmq_forwarder.1 @@ -2,12 +2,12 @@ .\" Title: zmq_forwarder .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_FORWARDER" "1" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_FORWARDER" "1" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_forwarder.html b/doc/zmq_forwarder.html index c123dd8..ed63630 100644 --- a/doc/zmq_forwarder.html +++ b/doc/zmq_forwarder.html @@ -605,7 +605,8 @@ Martin Lucina <mato@kotelna.sk>.

<
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 -.\" 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 \{\ diff --git a/doc/zmq_getsockopt.html b/doc/zmq_getsockopt.html index 1c4dda1..9b45f1c 100644 --- a/doc/zmq_getsockopt.html +++ b/doc/zmq_getsockopt.html @@ -591,7 +591,7 @@ specified by the option_name argument for the ØMQ socket pointed to by socket argument, and store it in the buffer pointed to by the option_value argument. The option_len argument is the size in bytes of the buffer pointed to by option_value; upon successful completion zmq_getsockopt() shall -modify the option_value argument to indicate the actual size of the option +modify the option_len argument to indicate the actual size of the option value stored in the buffer.

The following options can be retrieved with the zmq_getsockopt() function:

ZMQ_RCVMORE: More message parts to follow

@@ -667,7 +667,7 @@ Option value type

-int64_t +uint64_t

@@ -777,7 +777,7 @@ Option value type

-int64_t +uint64_t

@@ -884,7 +884,7 @@ Option value type

-uint64_t +int64_t

@@ -935,7 +935,7 @@ Option value type

-uint64_t +int64_t

@@ -989,7 +989,7 @@ Option value type

-uint64_t +int64_t

@@ -1157,6 +1157,14 @@ option value. The ØMQ context associated with the specified socket was terminated.

+
+EFAULT +
+
+

+The provided socket was not valid (NULL). +

+

EXAMPLE

@@ -1166,7 +1174,8 @@ The ØMQ context associated with the specified socket was term 
/* 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);
@@ -1185,7 +1194,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index 7886eaf..1e36a2a 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -20,7 +20,7 @@ specified by the 'option_name' argument for the 0MQ socket pointed to by the 'socket' argument, and store it in the buffer pointed to by the 'option_value' argument. The 'option_len' argument is the size in bytes of the buffer pointed to by 'option_value'; upon successful completion _zmq_getsockopt()_ shall -modify the 'option_value' argument to indicate the actual size of the option +modify the 'option_len' argument to indicate the actual size of the option value stored in the buffer. The following options can be retrieved with the _zmq_getsockopt()_ function: @@ -60,7 +60,7 @@ type. The default 'ZMQ_HWM' value of zero means "no limit". [horizontal] -Option value type:: int64_t +Option value type:: uint64_t Option value unit:: messages Default value:: 0 Applicable socket types:: all @@ -99,7 +99,7 @@ See also linkzmq:zmq_init[3] for details on allocating the number of I/O threads for a specific _context_. [horizontal] -Option value type:: int64_t +Option value type:: uint64_t Option value unit:: N/A (bitmap) Default value:: 0 Applicable socket types:: N/A @@ -134,7 +134,7 @@ The 'ZMQ_RATE' option shall retrieve the maximum send or receive data rate for multicast transports using the specified 'socket'. [horizontal] -Option value type:: uint64_t +Option value type:: int64_t Option value unit:: kilobits per second Default value:: 100 Applicable socket types:: all, when using multicast transports @@ -148,7 +148,7 @@ determines the maximum time in seconds that a receiver can be absent from a multicast group before unrecoverable data loss will occur. [horizontal] -Option value type:: uint64_t +Option value type:: int64_t Option value unit:: seconds Default value:: 10 Applicable socket types:: all, when using multicast transports @@ -165,7 +165,7 @@ on performance. Where possible, disable 'ZMQ_MCAST_LOOP' in production environments. [horizontal] -Option value type:: uint64_t +Option value type:: int64_t Option value unit:: boolean Default value:: 1 Applicable socket types:: all, when using multicast transports @@ -214,6 +214,8 @@ _option_value_, as specified by _option_len_, is insufficient for storing the option value. *ETERM*:: The 0MQ 'context' associated with the specified 'socket' was terminated. +*EFAULT*:: +The provided 'socket' was not valid (NULL). EXAMPLE @@ -222,7 +224,8 @@ EXAMPLE ---- /* 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); ---- diff --git a/doc/zmq_init.3 b/doc/zmq_init.3 index 9e0be97..a06e885 100644 --- a/doc/zmq_init.3 +++ b/doc/zmq_init.3 @@ -2,12 +2,12 @@ .\" Title: zmq_init .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_INIT" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_INIT" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_init.html b/doc/zmq_init.html index a9f2986..aea120d 100644 --- a/doc/zmq_init.html +++ b/doc/zmq_init.html @@ -624,7 +624,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_inproc.7 b/doc/zmq_inproc.7 index c5d9307..ec67911 100644 --- a/doc/zmq_inproc.7 +++ b/doc/zmq_inproc.7 @@ -2,12 +2,12 @@ .\" Title: zmq_inproc .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_INPROC" "7" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_INPROC" "7" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_inproc.html b/doc/zmq_inproc.html index 468a196..015e18e 100644 --- a/doc/zmq_inproc.html +++ b/doc/zmq_inproc.html @@ -661,7 +661,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_ipc.7 b/doc/zmq_ipc.7 index 619b352..ba6fb3c 100644 --- a/doc/zmq_ipc.7 +++ b/doc/zmq_ipc.7 @@ -2,12 +2,12 @@ .\" Title: zmq_ipc .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_IPC" "7" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_IPC" "7" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_ipc.html b/doc/zmq_ipc.html index ec5ac70..27e5a69 100644 --- a/doc/zmq_ipc.html +++ b/doc/zmq_ipc.html @@ -654,7 +654,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_msg_close.3 b/doc/zmq_msg_close.3 index 0a4ebdf..8912b41 100644 --- a/doc/zmq_msg_close.3 +++ b/doc/zmq_msg_close.3 @@ -2,12 +2,12 @@ .\" Title: zmq_msg_close .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_MSG_CLOSE" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_MSG_CLOSE" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_msg_close.html b/doc/zmq_msg_close.html index 23b7a1c..1cb720c 100644 --- a/doc/zmq_msg_close.html +++ b/doc/zmq_msg_close.html @@ -630,7 +630,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_msg_copy.3 b/doc/zmq_msg_copy.3 index 259ebd4..c91938f 100644 --- a/doc/zmq_msg_copy.3 +++ b/doc/zmq_msg_copy.3 @@ -2,12 +2,12 @@ .\" Title: zmq_msg_copy .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_MSG_COPY" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_MSG_COPY" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_msg_copy.html b/doc/zmq_msg_copy.html index dbc2c57..671e643 100644 --- a/doc/zmq_msg_copy.html +++ b/doc/zmq_msg_copy.html @@ -639,7 +639,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_msg_data.3 b/doc/zmq_msg_data.3 index 0dec4d2..09bb2e7 100644 --- a/doc/zmq_msg_data.3 +++ b/doc/zmq_msg_data.3 @@ -2,12 +2,12 @@ .\" Title: zmq_msg_data .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_MSG_DATA" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_MSG_DATA" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_msg_data.html b/doc/zmq_msg_data.html index 78df0fc..29e345e 100644 --- a/doc/zmq_msg_data.html +++ b/doc/zmq_msg_data.html @@ -625,7 +625,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_msg_init.3 b/doc/zmq_msg_init.3 index 823118f..054fba8 100644 --- a/doc/zmq_msg_init.3 +++ b/doc/zmq_msg_init.3 @@ -2,12 +2,12 @@ .\" Title: zmq_msg_init .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_MSG_INIT" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_MSG_INIT" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_msg_init.html b/doc/zmq_msg_init.html index 83e2234..a20b52f 100644 --- a/doc/zmq_msg_init.html +++ b/doc/zmq_msg_init.html @@ -648,7 +648,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_msg_init_data.3 b/doc/zmq_msg_init_data.3 index 6893236..458482b 100644 --- a/doc/zmq_msg_init_data.3 +++ b/doc/zmq_msg_init_data.3 @@ -2,12 +2,12 @@ .\" Title: zmq_msg_init_data .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_MSG_INIT_DATA" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_MSG_INIT_DATA" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_msg_init_data.html b/doc/zmq_msg_init_data.html index 11f8014..65ec587 100644 --- a/doc/zmq_msg_init_data.html +++ b/doc/zmq_msg_init_data.html @@ -661,7 +661,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_msg_init_size.3 b/doc/zmq_msg_init_size.3 index 6934ffd..390a74f 100644 --- a/doc/zmq_msg_init_size.3 +++ b/doc/zmq_msg_init_size.3 @@ -2,12 +2,12 @@ .\" Title: zmq_msg_init_size .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_MSG_INIT_SIZE" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_MSG_INIT_SIZE" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_msg_init_size.html b/doc/zmq_msg_init_size.html index 87812ce..30d0cc3 100644 --- a/doc/zmq_msg_init_size.html +++ b/doc/zmq_msg_init_size.html @@ -648,7 +648,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_msg_move.3 b/doc/zmq_msg_move.3 index 24815cc..ed960e5 100644 --- a/doc/zmq_msg_move.3 +++ b/doc/zmq_msg_move.3 @@ -2,12 +2,12 @@ .\" Title: zmq_msg_move .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_MSG_MOVE" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_MSG_MOVE" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_msg_move.html b/doc/zmq_msg_move.html index 46e2fd1..859e24c 100644 --- a/doc/zmq_msg_move.html +++ b/doc/zmq_msg_move.html @@ -628,7 +628,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_msg_size.3 b/doc/zmq_msg_size.3 index 71337e3..7b60376 100644 --- a/doc/zmq_msg_size.3 +++ b/doc/zmq_msg_size.3 @@ -2,12 +2,12 @@ .\" Title: zmq_msg_size .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_MSG_SIZE" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_MSG_SIZE" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_msg_size.html b/doc/zmq_msg_size.html index 6e3e9ac..f4de3ac 100644 --- a/doc/zmq_msg_size.html +++ b/doc/zmq_msg_size.html @@ -625,7 +625,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_pgm.7 b/doc/zmq_pgm.7 index 98318ad..34a37be 100644 --- a/doc/zmq_pgm.7 +++ b/doc/zmq_pgm.7 @@ -2,12 +2,12 @@ .\" Title: zmq_pgm .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_PGM" "7" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_PGM" "7" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_pgm.html b/doc/zmq_pgm.html index 456fcdf..637cb7b 100644 --- a/doc/zmq_pgm.html +++ b/doc/zmq_pgm.html @@ -737,7 +737,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_poll.3 b/doc/zmq_poll.3 index 96408c6..f19ba45 100644 --- a/doc/zmq_poll.3 +++ b/doc/zmq_poll.3 @@ -2,12 +2,12 @@ .\" Title: zmq_poll .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_POLL" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_POLL" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -171,6 +171,13 @@ whose associated 0MQ \fIcontext\fR was terminated\&. .RE +.PP +\fBEFAULT\fR +.RS 4 +The provided +\fIitems\fR +was not valid (NULL)\&. +.RE .SH "EXAMPLE" .PP \fBPolling indefinitely for input events on both a 0MQ socket and a standard socket.\fR. diff --git a/doc/zmq_poll.html b/doc/zmq_poll.html index fe38ead..722bc05 100644 --- a/doc/zmq_poll.html +++ b/doc/zmq_poll.html @@ -710,6 +710,14 @@ At least one of the members of the items array refers to a socketcontext was terminated.

+
+EFAULT +
+
+

+The provided items was not valid (NULL). +

+

EXAMPLE

@@ -748,7 +756,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_poll.txt b/doc/zmq_poll.txt index d96af3e..fe2a209 100644 --- a/doc/zmq_poll.txt +++ b/doc/zmq_poll.txt @@ -96,6 +96,8 @@ to a different application thread. *ETERM*:: At least one of the members of the 'items' array refers to a 'socket' whose associated 0MQ 'context' was terminated. +*EFAULT*:: +The provided 'items' was not valid (NULL). EXAMPLE diff --git a/doc/zmq_queue.1 b/doc/zmq_queue.1 index bd085ee..154b2c1 100644 --- a/doc/zmq_queue.1 +++ b/doc/zmq_queue.1 @@ -2,12 +2,12 @@ .\" Title: zmq_queue .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_QUEUE" "1" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_QUEUE" "1" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_queue.html b/doc/zmq_queue.html index 074b90a..b87eb5a 100644 --- a/doc/zmq_queue.html +++ b/doc/zmq_queue.html @@ -605,7 +605,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_recv.3 b/doc/zmq_recv.3 index 8e9720e..1c65e4d 100644 --- a/doc/zmq_recv.3 +++ b/doc/zmq_recv.3 @@ -2,12 +2,12 @@ .\" Title: zmq_recv .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_RECV" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_RECV" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -88,6 +88,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 \fBReceiving a message from a socket\fR. @@ -103,6 +110,8 @@ assert (rc == 0); /* Block until a message is available to be received from socket */ rc = zmq_recv (socket, &msg, 0); assert (rc == 0); +/* Release message */ +zmq_msg_close (&msg); .fi .if n \{\ .RE @@ -115,7 +124,7 @@ assert (rc == 0); .\} .nf int64_t more; -int64_t more_size = sizeof more; +size_t more_size = sizeof more; do { /* Create an empty 0MQ message to hold the message part */ zmq_msg_t part; @@ -127,6 +136,7 @@ do { /* Determine if more message parts are to follow */ rc = zmq_getsockopt (socket, ZMQ_RCVMORE, &more, &more_size); assert (rc == 0); + zmq_msg_close (&part); } while (more); .fi .if n \{\ diff --git a/doc/zmq_recv.html b/doc/zmq_recv.html index 218892d..50aaa56 100644 --- a/doc/zmq_recv.html +++ b/doc/zmq_recv.html @@ -660,6 +660,14 @@ socket types that switch between several states, such as ZMQ_REP. See the The ØMQ context associated with the specified socket was terminated.

+
+EFAULT +
+
+

+The provided socket was not valid (NULL). +

+

EXAMPLE

@@ -673,13 +681,15 @@ int rc = zmq_msg_init (&msg); assert (rc == 0); /* Block until a message is available to be received from socket */ rc = zmq_recv (socket, &msg, 0); -assert (rc == 0); +assert (rc == 0); +/* Release message */ +zmq_msg_close (&msg);
Receiving a multi-part message
int64_t more;
-int64_t more_size = sizeof more;
+size_t more_size = sizeof more;
 do {
     /* Create an empty 0MQ message to hold the message part */
     zmq_msg_t part;
@@ -691,6 +701,7 @@ do {
     /* Determine if more message parts are to follow */
     rc = zmq_getsockopt (socket, ZMQ_RCVMORE, &more, &more_size);
     assert (rc == 0);
+    zmq_msg_close (&part);
 } while (more);
@@ -710,7 +721,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_recv.txt b/doc/zmq_recv.txt index 79d3dc1..dc60af6 100644 --- a/doc/zmq_recv.txt +++ b/doc/zmq_recv.txt @@ -63,6 +63,8 @@ socket types that switch between several states, such as ZMQ_REP. See the _messaging patterns_ section of linkzmq:zmq_socket[3] for more information. *ETERM*:: The 0MQ 'context' associated with the specified 'socket' was terminated. +*EFAULT*:: +The provided 'socket' was not valid (NULL). EXAMPLE @@ -76,12 +78,14 @@ assert (rc == 0); /* Block until a message is available to be received from socket */ rc = zmq_recv (socket, &msg, 0); assert (rc == 0); +/* Release message */ +zmq_msg_close (&msg); ---- .Receiving a multi-part message ---- int64_t more; -int64_t more_size = sizeof more; +size_t more_size = sizeof more; do { /* Create an empty 0MQ message to hold the message part */ zmq_msg_t part; @@ -93,6 +97,7 @@ do { /* Determine if more message parts are to follow */ rc = zmq_getsockopt (socket, ZMQ_RCVMORE, &more, &more_size); assert (rc == 0); + zmq_msg_close (&part); } while (more); ---- diff --git a/doc/zmq_send.3 b/doc/zmq_send.3 index 5161d4e..0bc094f 100644 --- a/doc/zmq_send.3 +++ b/doc/zmq_send.3 @@ -2,12 +2,12 @@ .\" Title: zmq_send .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_SEND" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_SEND" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -109,6 +109,13 @@ associated with the specified \fIsocket\fR was terminated\&. .RE +.PP +\fBEFAULT\fR +.RS 4 +The provided +\fIcontext\fR +was not valid (NULL)\&. +.RE .SH "EXAMPLE" .PP \fBFilling in a message and sending it to a socket\fR. diff --git a/doc/zmq_send.html b/doc/zmq_send.html index 22bd55a..eb7c8b0 100644 --- a/doc/zmq_send.html +++ b/doc/zmq_send.html @@ -677,6 +677,14 @@ socket types that switch between several states, such as ZMQ_REP. See the The ØMQ context associated with the specified socket was terminated.

+
+EFAULT +
+
+

+The provided context was not valid (NULL). +

+

EXAMPLE

@@ -719,7 +727,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_send.txt b/doc/zmq_send.txt index 419e386..793d1a8 100644 --- a/doc/zmq_send.txt +++ b/doc/zmq_send.txt @@ -69,6 +69,8 @@ socket types that switch between several states, such as ZMQ_REP. See the _messaging patterns_ section of linkzmq:zmq_socket[3] for more information. *ETERM*:: The 0MQ 'context' associated with the specified 'socket' was terminated. +*EFAULT*:: +The provided 'context' was not valid (NULL). EXAMPLE diff --git a/doc/zmq_setsockopt.3 b/doc/zmq_setsockopt.3 index 8ed1e59..f51a613 100644 --- a/doc/zmq_setsockopt.3 +++ b/doc/zmq_setsockopt.3 @@ -2,12 +2,12 @@ .\" Title: zmq_setsockopt .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_SETSOCKOPT" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_SETSOCKOPT" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -55,7 +55,7 @@ T{ Option value type T}:T{ .sp -int64_t +uint64_t T} T{ .sp @@ -139,7 +139,7 @@ T{ Option value type T}:T{ .sp -int64_t +uint64_t T} T{ .sp @@ -301,7 +301,7 @@ T{ Option value type T}:T{ .sp -uint64_t +int64_t T} T{ .sp @@ -356,7 +356,7 @@ T{ Option value type T}:T{ .sp -uint64_t +int64_t T} T{ .sp @@ -395,7 +395,7 @@ T{ Option value type T}:T{ .sp -uint64_t +int64_t T} T{ .sp @@ -522,6 +522,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 \fBSubscribing to messages on a ZMQ_SUB socket\fR. diff --git a/doc/zmq_setsockopt.html b/doc/zmq_setsockopt.html index 2bccca9..62617a2 100644 --- a/doc/zmq_setsockopt.html +++ b/doc/zmq_setsockopt.html @@ -610,7 +610,7 @@ Option value type

-int64_t +uint64_t

@@ -720,7 +720,7 @@ Option value type

-int64_t +uint64_t

@@ -934,7 +934,7 @@ Option value type

-uint64_t +int64_t

@@ -995,7 +995,7 @@ Option value type

-uint64_t +int64_t

@@ -1049,7 +1049,7 @@ Option value type

-uint64_t +int64_t

@@ -1215,6 +1215,14 @@ The requested option option_name is unknown, or the requested optio The ØMQ context associated with the specified socket was terminated.

+
+EFAULT +
+
+

+The provided socket was not valid (NULL). +

+

EXAMPLE

@@ -1261,7 +1269,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index a5a2601..1b551c6 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -39,7 +39,7 @@ type. The default 'ZMQ_HWM' value of zero means "no limit". [horizontal] -Option value type:: int64_t +Option value type:: uint64_t Option value unit:: messages Default value:: 0 Applicable socket types:: all @@ -78,7 +78,7 @@ See also linkzmq:zmq_init[3] for details on allocating the number of I/O threads for a specific _context_. [horizontal] -Option value type:: int64_t +Option value type:: uint64_t Option value unit:: N/A (bitmap) Default value:: 0 Applicable socket types:: N/A @@ -147,7 +147,7 @@ The 'ZMQ_RATE' option shall set the maximum send or receive data rate for multicast transports such as linkzmq:zmq_pgm[7] using the specified 'socket'. [horizontal] -Option value type:: uint64_t +Option value type:: int64_t Option value unit:: kilobits per second Default value:: 100 Applicable socket types:: all, when using multicast transports @@ -165,7 +165,7 @@ needed for recovery will be held in memory. For example, a 1 minute recovery interval at a data rate of 1Gbps requires a 7GB in-memory buffer. [horizontal] -Option value type:: uint64_t +Option value type:: int64_t Option value unit:: seconds Default value:: 10 Applicable socket types:: all, when using multicast transports @@ -182,7 +182,7 @@ performance. Where possible, disable 'ZMQ_MCAST_LOOP' in production environments. [horizontal] -Option value type:: uint64_t +Option value type:: int64_t Option value unit:: boolean Default value:: 1 Applicable socket types:: all, when using multicast transports @@ -229,6 +229,8 @@ The requested option _option_name_ is unknown, or the requested _option_len_ or _option_value_ is invalid. *ETERM*:: The 0MQ 'context' associated with the specified 'socket' was terminated. +*EFAULT*:: +The provided 'socket' was not valid (NULL). EXAMPLE diff --git a/doc/zmq_socket.3 b/doc/zmq_socket.3 index 3e4ebd1..aa70f1a 100644 --- a/doc/zmq_socket.3 +++ b/doc/zmq_socket.3 @@ -2,12 +2,12 @@ .\" Title: zmq_socket .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_SOCKET" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_SOCKET" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -196,6 +196,152 @@ T} .TE .sp 1 .RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBZMQ_XREQ\fR +.RS 4 +.sp +A socket of type \fIZMQ_XREQ\fR is an advanced pattern used for extending request/reply sockets\&. Each message sent is load\-balanced among all connected peers, and each message received is fair\-queued from all connected peers\&. +.sp +When a \fIZMQ_XREQ\fR socket enters an exceptional state due to having reached the high water mark for all peers, or if there are no peers at all, then any \fBzmq_send\fR(3) operations on the socket shall block until the exceptional state ends or at least one peer becomes available for sending; messages are not discarded\&. +.sp +When a \fIZMQ_XREQ\fR socket is connected to a \fIZMQ_REP\fR socket each message sent must consist of an empty message part, the \fIdelimiter\fR, followed by one or more \fIbody parts\fR\&. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&3.\ \&Summary of ZMQ_XREQ characteristics +.TS +tab(:); +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt. +T{ +.sp +Compatible peer sockets +T}:T{ +.sp +\fIZMQ_XREP\fR, \fIZMQ_REP\fR +T} +T{ +.sp +Direction +T}:T{ +.sp +Bidirectional +T} +T{ +.sp +Send/receive pattern +T}:T{ +.sp +Unrestricted +T} +T{ +.sp +Outgoing routing strategy +T}:T{ +.sp +Load\-balanced +T} +T{ +.sp +Incoming routing strategy +T}:T{ +.sp +Fair\-queued +T} +T{ +.sp +ZMQ_HWM option action +T}:T{ +.sp +Block +T} +.TE +.sp 1 +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBZMQ_XREP\fR +.RS 4 +.sp +A socket of type \fIZMQ_XREP\fR is an advanced pattern used for extending request/reply sockets\&. When receiving messages a \fIZMQ_XREP\fR socket shall prepend a message part containing the \fIidentity\fR of the originating peer to the message before passing it to the application\&. Messages received are fair\-queued from among all connected peers\&. When sending messages a \fIZMQ_XREP\fR socket shall remove the first part of the message and use it to determine the \fIidentity\fR of the peer the message shall be routed to\&. +.sp +When a \fIZMQ_XREP\fR socket enters an exceptional state due to having reached the high water mark for all peers, or if there are no peers at all, then any messages sent to the socket shall be dropped until the exceptional state ends\&. Likewise, any messages routed to a non\-existent peer or a peer for which the individual high water mark has been reached shall also be dropped\&. +.sp +When a \fIZMQ_REQ\fR socket is connected to a \fIZMQ_XREP\fR socket, in addition to the \fIidentity\fR of the originating peer each message received shall contain an empty \fIdelimiter\fR message part\&. Hence, the entire structure of each received message as seen by the application becomes: one or more \fIidentity\fR parts, \fIdelimiter\fR part, one or more \fIbody parts\fR\&. When sending replies to a \fIZMQ_REQ\fR socket the application must include the \fIdelimiter\fR part\&. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&4.\ \&Summary of ZMQ_XREP characteristics +.TS +tab(:); +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt. +T{ +.sp +Compatible peer sockets +T}:T{ +.sp +\fIZMQ_XREQ\fR, \fIZMQ_REQ\fR +T} +T{ +.sp +Direction +T}:T{ +.sp +Bidirectional +T} +T{ +.sp +Send/receive pattern +T}:T{ +.sp +Unrestricted +T} +T{ +.sp +Outgoing routing strategy +T}:T{ +.sp +See text +T} +T{ +.sp +Incoming routing strategy +T}:T{ +.sp +Fair\-queued +T} +T{ +.sp +ZMQ_HWM option action +T}:T{ +.sp +Drop +T} +.TE +.sp 1 +.RE .SS "Publish\-subscribe pattern" .sp The publish\-subscribe pattern is used for one\-to\-many distribution of data from a single \fIpublisher\fR to multiple \fIsubscribers\fR in a fanout fashion\&. @@ -216,7 +362,7 @@ When a \fIZMQ_PUB\fR socket enters an exceptional state due to having reached th .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&3.\ \&Summary of ZMQ_PUB characteristics +.B Table\ \&5.\ \&Summary of ZMQ_PUB characteristics .TS tab(:); lt lt @@ -285,7 +431,7 @@ A socket of type \fIZMQ_SUB\fR is used by a \fIsubscriber\fR to subscribe to dat .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&4.\ \&Summary of ZMQ_SUB characteristics +.B Table\ \&6.\ \&Summary of ZMQ_SUB characteristics .TS tab(:); lt lt @@ -348,18 +494,20 @@ The pipeline pattern is used for distributing data to \fInodes\fR arranged in a .nr an-break-flag 1 .br .ps +1 -\fBZMQ_DOWNSTREAM\fR +\fBZMQ_PUSH\fR .RS 4 .sp -A socket of type \fIZMQ_DOWNSTREAM\fR is used by a pipeline \fInode\fR to send messages to downstream pipeline \fInodes\fR\&. Messages are load\-balanced to all connected downstream \fInodes\fR\&. The \fIzmq_recv()\fR function is not implemented for this socket type\&. +A socket of type \fIZMQ_PUSH\fR is used by a pipeline \fInode\fR to send messages to downstream pipeline \fInodes\fR\&. Messages are load\-balanced to all connected downstream \fInodes\fR\&. The \fIzmq_recv()\fR function is not implemented for this socket type\&. .sp -When a \fIZMQ_DOWNSTREAM\fR socket enters an exceptional state due to having reached the high water mark for all downstream \fInodes\fR, or if there are no downstream \fInodes\fR at all, then any \fBzmq_send\fR(3) operations on the socket shall block until the exceptional state ends or at least one downstream \fInode\fR becomes available for sending; messages are not discarded\&. +When a \fIZMQ_PUSH\fR socket enters an exceptional state due to having reached the high water mark for all downstream \fInodes\fR, or if there are no downstream \fInodes\fR at all, then any \fBzmq_send\fR(3) operations on the socket shall block until the exceptional state ends or at least one downstream \fInode\fR becomes available for sending; messages are not discarded\&. +.sp +Deprecated alias: \fIZMQ_DOWNSTREAM\fR\&. .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&5.\ \&Summary of ZMQ_DOWNSTREAM characteristics +.B Table\ \&7.\ \&Summary of ZMQ_PUSH characteristics .TS tab(:); lt lt @@ -373,7 +521,7 @@ T{ Compatible peer sockets T}:T{ .sp -\fIZMQ_UPSTREAM\fR +\fIZMQ_PULL\fR T} T{ .sp @@ -419,16 +567,18 @@ T} .nr an-break-flag 1 .br .ps +1 -\fBZMQ_UPSTREAM\fR +\fBZMQ_PULL\fR .RS 4 .sp -A socket of type \fIZMQ_UPSTREAM\fR is used by a pipeline \fInode\fR to receive messages from upstream pipeline \fInodes\fR\&. Messages are fair\-queued from among all connected upstream \fInodes\fR\&. The \fIzmq_send()\fR function is not implemented for this socket type\&. +A socket of type \fIZMQ_PULL\fR is used by a pipeline \fInode\fR to receive messages from upstream pipeline \fInodes\fR\&. Messages are fair\-queued from among all connected upstream \fInodes\fR\&. The \fIzmq_send()\fR function is not implemented for this socket type\&. +.sp +Deprecated alias: \fIZMQ_UPSTREAM\fR\&. .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&6.\ \&Summary of ZMQ_UPSTREAM characteristics +.B Table\ \&8.\ \&Summary of ZMQ_PULL characteristics .TS tab(:); lt lt @@ -442,7 +592,7 @@ T{ Compatible peer sockets T}:T{ .sp -\fIZMQ_DOWNSTREAM\fR +\fIZMQ_PUSH\fR T} T{ .sp @@ -518,7 +668,7 @@ When a \fIZMQ_PAIR\fR socket enters an exceptional state due to having reached t .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&7.\ \&Summary of ZMQ_PAIR characteristics +.B Table\ \&9.\ \&Summary of ZMQ_PAIR characteristics .TS tab(:); lt lt @@ -590,6 +740,13 @@ The maximum number of sockets within this \fIcontext\fR has been exceeded\&. .RE +.PP +\fBEFAULT\fR +.RS 4 +The provided +\fIcontext\fR +was not valid (NULL)\&. +.RE .SH "SEE ALSO" .sp \fBzmq_init\fR(3) \fBzmq_setsockopt\fR(3) \fBzmq_bind\fR(3) \fBzmq_connect\fR(3) \fBzmq_send\fR(3) \fBzmq_recv\fR(3) \fBzmq\fR(7) diff --git a/doc/zmq_socket.html b/doc/zmq_socket.html index ddab7e1..4546e37 100644 --- a/doc/zmq_socket.html +++ b/doc/zmq_socket.html @@ -774,6 +774,173 @@ Drop +

ZMQ_XREQ

+

A socket of type ZMQ_XREQ is an advanced pattern used for extending +request/reply sockets. Each message sent is load-balanced among all connected +peers, and each message received is fair-queued from all connected peers.

+

When a ZMQ_XREQ socket enters an exceptional state due to having reached the +high water mark for all peers, or if there are no peers at all, then any +zmq_send(3) operations on the socket shall block until the exceptional +state ends or at least one peer becomes available for sending; messages are not +discarded.

+

When a ZMQ_XREQ socket is connected to a ZMQ_REP socket each message sent +must consist of an empty message part, the delimiter, followed by one or more +body parts.

+
Summary of ZMQ_XREQ characteristics
+ + + + + + + + + + + + + + + + + + + + + + + + +
+Compatible peer sockets +
+		 +

+ZMQ_XREP, ZMQ_REP +

+
+Direction +
+		 +

+Bidirectional +

+
+Send/receive pattern +
+		 +

+Unrestricted +

+
+Outgoing routing strategy +
+		 +

+Load-balanced +

+
+Incoming routing strategy +
+		 +

+Fair-queued +

+
+ZMQ_HWM option action +
+		 +

+Block +

+
+

ZMQ_XREP

+

A socket of type ZMQ_XREP is an advanced pattern used for extending +request/reply sockets. When receiving messages a ZMQ_XREP socket shall +prepend a message part containing the identity of the originating peer to the +message before passing it to the application. Messages received are fair-queued +from among all connected peers. When sending messages a ZMQ_XREP socket shall +remove the first part of the message and use it to determine the identity of +the peer the message shall be routed to.

+

When a ZMQ_XREP socket enters an exceptional state due to having reached the +high water mark for all peers, or if there are no peers at all, then any +messages sent to the socket shall be dropped until the exceptional state ends. +Likewise, any messages routed to a non-existent peer or a peer for which the +individual high water mark has been reached shall also be dropped.

+

When a ZMQ_REQ socket is connected to a ZMQ_XREP socket, in addition to the +identity of the originating peer each message received shall contain an empty +delimiter message part. Hence, the entire structure of each received message +as seen by the application becomes: one or more identity parts, delimiter +part, one or more body parts. When sending replies to a ZMQ_REQ socket the +application must include the delimiter part.

+
Summary of ZMQ_XREP characteristics
+ + + + + + + + + + + + + + + + + + + + + + + + +
+Compatible peer sockets +
+		 +

+ZMQ_XREQ, ZMQ_REQ +

+
+Direction +
+		 +

+Bidirectional +

+
+Send/receive pattern +
+		 +

+Unrestricted +

+
+Outgoing routing strategy +
+		 +

+See text +

+
+Incoming routing strategy +
+		 +

+Fair-queued +

+
+ZMQ_HWM option action +
+		 +

+Drop +

+

Publish-subscribe pattern

The publish-subscribe pattern is used for one-to-many distribution of data from a single publisher to multiple subscribers in a fanout fashion.

@@ -932,17 +1099,18 @@ N/A a pipeline. Data always flows down the pipeline, and each stage of the pipeline is connected to at least one node. When a pipeline stage is connected to multiple nodes data is load-balanced among all connected nodes.

-

ZMQ_DOWNSTREAM

-

A socket of type ZMQ_DOWNSTREAM is used by a pipeline node to send messages +

ZMQ_PUSH

+

A socket of type ZMQ_PUSH is used by a pipeline node to send messages to downstream pipeline nodes. Messages are load-balanced to all connected downstream nodes. The zmq_recv() function is not implemented for this socket type.

-

When a ZMQ_DOWNSTREAM socket enters an exceptional state due to having -reached the high water mark for all downstream nodes, or if there are no -downstream nodes at all, then any zmq_send(3) operations on the -socket shall block until the exceptional state ends or at least one downstream -node becomes available for sending; messages are not discarded.

-
Summary of ZMQ_DOWNSTREAM characteristics
+

When a ZMQ_PUSH socket enters an exceptional state due to having reached the +high water mark for all downstream nodes, or if there are no downstream +nodes at all, then any zmq_send(3) operations on the socket shall +block until the exceptional state ends or at least one downstream node +becomes available for sending; messages are not discarded.

+

Deprecated alias: ZMQ_DOWNSTREAM.

+
Summary of ZMQ_PUSH characteristics
@@ -1010,12 +1178,13 @@ Block
Compatible peer sockets @@ -950,7 +1118,7 @@ Compatible peer sockets

-ZMQ_UPSTREAM +ZMQ_PULL

-

ZMQ_UPSTREAM

-

A socket of type ZMQ_UPSTREAM is used by a pipeline node to receive -messages from upstream pipeline nodes. Messages are fair-queued from among -all connected upstream nodes. The zmq_send() function is not implemented -for this socket type.

-
Summary of ZMQ_UPSTREAM characteristics
+

ZMQ_PULL

+

A socket of type ZMQ_PULL is used by a pipeline node to receive messages +from upstream pipeline nodes. Messages are fair-queued from among all +connected upstream nodes. The zmq_send() function is not implemented for +this socket type.

+

Deprecated alias: ZMQ_UPSTREAM.

+
Summary of ZMQ_PULL characteristics
@@ -1197,6 +1366,14 @@ The requested socket type is invalid. The maximum number of sockets within this context has been exceeded.

+
+EFAULT +
+
+

+The provided context was not valid (NULL). +

+

SEE ALSO

@@ -1218,7 +1395,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_socket.txt b/doc/zmq_socket.txt index 23cc317..2156af2 100644 --- a/doc/zmq_socket.txt +++ b/doc/zmq_socket.txt @@ -104,6 +104,65 @@ Outgoing routing stratagy:: Last peer ZMQ_HWM option action:: Drop +ZMQ_XREQ +^^^^^^^^ +A socket of type 'ZMQ_XREQ' is an advanced pattern used for extending +request/reply sockets. Each message sent is load-balanced among all connected +peers, and each message received is fair-queued from all connected peers. + +When a 'ZMQ_XREQ' socket enters an exceptional state due to having reached the +high water mark for all peers, or if there are no peers at all, then any +linkzmq:zmq_send[3] operations on the socket shall block until the exceptional +state ends or at least one peer becomes available for sending; messages are not +discarded. + +When a 'ZMQ_XREQ' socket is connected to a 'ZMQ_REP' socket each message sent +must consist of an empty message part, the _delimiter_, followed by one or more +_body parts_. + +[horizontal] +.Summary of ZMQ_XREQ characteristics +Compatible peer sockets:: 'ZMQ_XREP', 'ZMQ_REP' +Direction:: Bidirectional +Send/receive pattern:: Unrestricted +Outgoing routing strategy:: Load-balanced +Incoming routing strategy:: Fair-queued +ZMQ_HWM option action:: Block + + +ZMQ_XREP +^^^^^^^^ +A socket of type 'ZMQ_XREP' is an advanced pattern used for extending +request/reply sockets. When receiving messages a 'ZMQ_XREP' socket shall +prepend a message part containing the _identity_ of the originating peer to the +message before passing it to the application. Messages received are fair-queued +from among all connected peers. When sending messages a 'ZMQ_XREP' socket shall +remove the first part of the message and use it to determine the _identity_ of +the peer the message shall be routed to. + +When a 'ZMQ_XREP' socket enters an exceptional state due to having reached the +high water mark for all peers, or if there are no peers at all, then any +messages sent to the socket shall be dropped until the exceptional state ends. +Likewise, any messages routed to a non-existent peer or a peer for which the +individual high water mark has been reached shall also be dropped. + +When a 'ZMQ_REQ' socket is connected to a 'ZMQ_XREP' socket, in addition to the +_identity_ of the originating peer each message received shall contain an empty +_delimiter_ message part. Hence, the entire structure of each received message +as seen by the application becomes: one or more _identity_ parts, _delimiter_ +part, one or more _body parts_. When sending replies to a 'ZMQ_REQ' socket the +application must include the _delimiter_ part. + +[horizontal] +.Summary of ZMQ_XREP characteristics +Compatible peer sockets:: 'ZMQ_XREQ', 'ZMQ_REQ' +Direction:: Bidirectional +Send/receive pattern:: Unrestricted +Outgoing routing strategy:: See text +Incoming routing strategy:: Fair-queued +ZMQ_HWM option action:: Drop + + Publish-subscribe pattern ~~~~~~~~~~~~~~~~~~~~~~~~~ The publish-subscribe pattern is used for one-to-many distribution of data from @@ -157,22 +216,24 @@ is connected to at least one _node_. When a pipeline stage is connected to multiple _nodes_ data is load-balanced among all connected _nodes_. -ZMQ_DOWNSTREAM -^^^^^^^^^^^^^^ -A socket of type 'ZMQ_DOWNSTREAM' is used by a pipeline _node_ to send messages +ZMQ_PUSH +^^^^^^^^ +A socket of type 'ZMQ_PUSH' is used by a pipeline _node_ to send messages to downstream pipeline _nodes_. Messages are load-balanced to all connected downstream _nodes_. The _zmq_recv()_ function is not implemented for this socket type. -When a 'ZMQ_DOWNSTREAM' socket enters an exceptional state due to having -reached the high water mark for all downstream _nodes_, or if there are no -downstream _nodes_ at all, then any linkzmq:zmq_send[3] operations on the -socket shall block until the exceptional state ends or at least one downstream -_node_ becomes available for sending; messages are not discarded. +When a 'ZMQ_PUSH' socket enters an exceptional state due to having reached the +high water mark for all downstream _nodes_, or if there are no downstream +_nodes_ at all, then any linkzmq:zmq_send[3] operations on the socket shall +block until the exceptional state ends or at least one downstream _node_ +becomes available for sending; messages are not discarded. + +Deprecated alias: 'ZMQ_DOWNSTREAM'. [horizontal] -.Summary of ZMQ_DOWNSTREAM characteristics -Compatible peer sockets:: 'ZMQ_UPSTREAM' +.Summary of ZMQ_PUSH characteristics +Compatible peer sockets:: 'ZMQ_PULL' Direction:: Unidirectional Send/receive pattern:: Send only Incoming routing strategy:: N/A @@ -180,16 +241,18 @@ Outgoing routing strategy:: Load-balanced ZMQ_HWM option action:: Block -ZMQ_UPSTREAM -^^^^^^^^^^^^ -A socket of type 'ZMQ_UPSTREAM' is used by a pipeline _node_ to receive -messages from upstream pipeline _nodes_. Messages are fair-queued from among -all connected upstream _nodes_. The _zmq_send()_ function is not implemented -for this socket type. +ZMQ_PULL +^^^^^^^^ +A socket of type 'ZMQ_PULL' is used by a pipeline _node_ to receive messages +from upstream pipeline _nodes_. Messages are fair-queued from among all +connected upstream _nodes_. The _zmq_send()_ function is not implemented for +this socket type. + +Deprecated alias: 'ZMQ_UPSTREAM'. [horizontal] -.Summary of ZMQ_UPSTREAM characteristics -Compatible peer sockets:: 'ZMQ_DOWNSTREAM' +.Summary of ZMQ_PULL characteristics +Compatible peer sockets:: 'ZMQ_PUSH' Direction:: Unidirectional Send/receive pattern:: Receive only Incoming routing strategy:: Fair-queued @@ -238,9 +301,10 @@ ERRORS ------ *EINVAL*:: The requested socket 'type' is invalid. - *EMTHREAD*:: The maximum number of sockets within this 'context' has been exceeded. +*EFAULT*:: +The provided 'context' was not valid (NULL). SEE ALSO diff --git a/doc/zmq_streamer.1 b/doc/zmq_streamer.1 index d8af2e5..8a5c212 100644 --- a/doc/zmq_streamer.1 +++ b/doc/zmq_streamer.1 @@ -2,12 +2,12 @@ .\" Title: zmq_streamer .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_STREAMER" "1" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_STREAMER" "1" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_streamer.html b/doc/zmq_streamer.html index 389c146..ea39ef9 100644 --- a/doc/zmq_streamer.html +++ b/doc/zmq_streamer.html @@ -605,7 +605,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_strerror.3 b/doc/zmq_strerror.3 index 3045e41..a32b650 100644 --- a/doc/zmq_strerror.3 +++ b/doc/zmq_strerror.3 @@ -2,12 +2,12 @@ .\" Title: zmq_strerror .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_STRERROR" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_STRERROR" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_strerror.html b/doc/zmq_strerror.html index a57b380..2f60b25 100644 --- a/doc/zmq_strerror.html +++ b/doc/zmq_strerror.html @@ -626,7 +626,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_tcp.7 b/doc/zmq_tcp.7 index 3d4129b..31430a0 100644 --- a/doc/zmq_tcp.7 +++ b/doc/zmq_tcp.7 @@ -2,12 +2,12 @@ .\" Title: zmq_tcp .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_TCP" "7" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_TCP" "7" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -49,7 +49,8 @@ An \fIinterface\fR may be specified by either of the following: .sp -1 .IP \(bu 2.3 .\} -The interface name as defined by the operating system\&. +The wildcard +*, meaning all available interfaces\&. .RE .sp .RS 4 @@ -60,7 +61,7 @@ The interface name as defined by the operating system\&. .sp -1 .IP \(bu 2.3 .\} -The primary IPv4 address assigned to the interface, in it\(cqs numeric representation\&. +The primary IPv4 address assigned to the interface, in its numeric representation\&. .RE .sp .RS 4 @@ -71,8 +72,7 @@ The primary IPv4 address assigned to the interface, in it\(cqs numeric represent .sp -1 .IP \(bu 2.3 .\} -The wildcard -*, meaning that the interface address is unspecified\&. +The interface name as defined by the operating system\&. .RE .if n \{\ .sp @@ -194,15 +194,15 @@ The following diagram illustrates the layout of a frame with a \fIpayload length .RS 4 .\} .nf +/* TCP port 5555 on all available interfaces */ +rc = zmq_bind(socket, "tcp://*:5555"); +assert (rc == 0); /* TCP port 5555 on the local loopback interface on all platforms */ rc = zmq_bind(socket, "tcp://127\&.0\&.0\&.1:5555"); assert (rc == 0); /* TCP port 5555 on the first ethernet network interface on Linux */ rc = zmq_bind(socket, "tcp://eth0:5555"); assert (rc == 0); -/* TCP port 5555 with an unspecified interface */ -rc = zmq_bind(socket, "tcp://*:5555"); -assert (rc == 0); .fi .if n \{\ .RE diff --git a/doc/zmq_tcp.html b/doc/zmq_tcp.html index 6a7ca72..38c2db7 100644 --- a/doc/zmq_tcp.html +++ b/doc/zmq_tcp.html @@ -600,17 +600,18 @@ colon and the TCP port number to use.

  • -The interface name as defined by the operating system. +The wildcard *, meaning all available interfaces.

  • -The primary IPv4 address assigned to the interface, in it’s numeric representation. +The primary IPv4 address assigned to the interface, in its numeric + representation.

  • -The wildcard *, meaning that the interface address is unspecified. +The interface name as defined by the operating system.

@@ -707,14 +708,14 @@ exceeding 254 octets:

Assigning a local address to a socket
-
/* TCP port 5555 on the local loopback interface on all platforms */
+
/* TCP port 5555 on all available interfaces */
+rc = zmq_bind(socket, "tcp://*:5555");
+assert (rc == 0);
+/* TCP port 5555 on the local loopback interface on all platforms */
 rc = zmq_bind(socket, "tcp://127.0.0.1:5555");
 assert (rc == 0);
 /* TCP port 5555 on the first ethernet network interface on Linux */
 rc = zmq_bind(socket, "tcp://eth0:5555");
-assert (rc == 0);
-/* TCP port 5555 with an unspecified interface */
-rc = zmq_bind(socket, "tcp://*:5555");
 assert (rc == 0);
@@ -746,7 +747,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_tcp.txt b/doc/zmq_tcp.txt index a845f62..29fa181 100644 --- a/doc/zmq_tcp.txt +++ b/doc/zmq_tcp.txt @@ -30,9 +30,10 @@ colon and the TCP port number to use. An 'interface' may be specified by either of the following: +* The wildcard `*`, meaning all available interfaces. +* The primary IPv4 address assigned to the interface, in its numeric + representation. * The interface name as defined by the operating system. -* The primary IPv4 address assigned to the interface, in it's numeric representation. -* The wildcard `*`, meaning that the interface address is unspecified. NOTE: Interface names are not standardised in any way and should be assumed to be arbitrary and platform dependent. On Win32 platforms no short interface @@ -123,15 +124,15 @@ EXAMPLES -------- .Assigning a local address to a socket ---- +/* TCP port 5555 on all available interfaces */ +rc = zmq_bind(socket, "tcp://*:5555"); +assert (rc == 0); /* TCP port 5555 on the local loopback interface on all platforms */ rc = zmq_bind(socket, "tcp://127.0.0.1:5555"); assert (rc == 0); /* TCP port 5555 on the first ethernet network interface on Linux */ rc = zmq_bind(socket, "tcp://eth0:5555"); assert (rc == 0); -/* TCP port 5555 with an unspecified interface */ -rc = zmq_bind(socket, "tcp://*:5555"); -assert (rc == 0); ---- .Connecting a socket diff --git a/doc/zmq_term.3 b/doc/zmq_term.3 index bfb533d..e1bb69d 100644 --- a/doc/zmq_term.3 +++ b/doc/zmq_term.3 @@ -2,12 +2,12 @@ .\" Title: zmq_term .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_TERM" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_TERM" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -98,8 +98,13 @@ until the last socket within it is closed with .sp The \fIzmq_term()\fR function shall return zero if successful\&. Otherwise it shall return \-1 and set \fIerrno\fR to one of the values defined below\&. .SH "ERRORS" -.sp -No errors are defined\&. +.PP +\fBEFAULT\fR +.RS 4 +The provided +\fIcontext\fR +was not valid (NULL)\&. +.RE .SH "SEE ALSO" .sp \fBzmq\fR(7) \fBzmq_init\fR(3) diff --git a/doc/zmq_term.html b/doc/zmq_term.html index 847abf5..d44d336 100644 --- a/doc/zmq_term.html +++ b/doc/zmq_term.html @@ -625,7 +625,16 @@ return -1 and set errno to one of the values defined below.

ERRORS

-

No errors are defined.

+
+
+EFAULT +
+
+

+The provided context was not valid (NULL). +

+
+

SEE ALSO

@@ -641,7 +650,8 @@ Martin Lucina <mato@kotelna.sk>.

<
diff --git a/doc/zmq_term.txt b/doc/zmq_term.txt index 820fa30..f3ffa01 100644 --- a/doc/zmq_term.txt +++ b/doc/zmq_term.txt @@ -43,7 +43,8 @@ return `-1` and set 'errno' to one of the values defined below. ERRORS ------ -No errors are defined. +*EFAULT*:: +The provided 'context' was not valid (NULL). SEE ALSO diff --git a/doc/zmq_version.3 b/doc/zmq_version.3 index 37d2aaa..c87eede 100644 --- a/doc/zmq_version.3 +++ b/doc/zmq_version.3 @@ -2,12 +2,12 @@ .\" Title: zmq_version .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_VERSION" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_VERSION" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_version.html b/doc/zmq_version.html index 7be9aa2..130daf1 100644 --- a/doc/zmq_version.html +++ b/doc/zmq_version.html @@ -624,7 +624,8 @@ Martin Lucina <mato@kotelna.sk>.

<
-- cgit v1.2.3
Compatible peer sockets @@ -1023,7 +1192,7 @@ Compatible peer sockets

-ZMQ_DOWNSTREAM +ZMQ_PUSH