From 56619463ac26dc6c3e576d2fbf6b544eebeb5148 Mon Sep 17 00:00:00 2001 From: Martin Lucina Date: Sun, 20 May 2012 11:24:59 +0200 Subject: Imported Upstream version 2.2.0 --- doc/zmq.7 | 20 +-- doc/zmq.html | 197 ++++++++++++++++---------- doc/zmq.txt | 3 +- doc/zmq_bind.3 | 19 +-- doc/zmq_bind.html | 163 ++++++++++++--------- doc/zmq_bind.txt | 3 +- doc/zmq_close.3 | 19 +-- doc/zmq_close.html | 161 ++++++++++++--------- doc/zmq_close.txt | 3 +- doc/zmq_connect.3 | 19 +-- doc/zmq_connect.html | 163 ++++++++++++--------- doc/zmq_connect.txt | 3 +- doc/zmq_cpp.7 | 19 +-- doc/zmq_cpp.html | 275 +++++++++++++++++++++--------------- doc/zmq_cpp.txt | 3 +- doc/zmq_device.3 | 27 +--- doc/zmq_device.html | 175 +++++++++++++---------- doc/zmq_device.txt | 16 +-- doc/zmq_epgm.7 | 19 +-- doc/zmq_epgm.html | 171 +++++++++++++--------- doc/zmq_epgm.txt | 4 +- doc/zmq_errno.3 | 19 +-- doc/zmq_errno.html | 161 ++++++++++++--------- doc/zmq_errno.txt | 3 +- doc/zmq_getsockopt.3 | 97 +++++++++++-- doc/zmq_getsockopt.html | 343 ++++++++++++++++++++++++++++++++++----------- doc/zmq_getsockopt.txt | 35 ++++- doc/zmq_init.3 | 19 +-- doc/zmq_init.html | 161 ++++++++++++--------- doc/zmq_init.txt | 3 +- doc/zmq_inproc.7 | 19 +-- doc/zmq_inproc.html | 169 +++++++++++++--------- doc/zmq_inproc.txt | 3 +- doc/zmq_ipc.7 | 19 +-- doc/zmq_ipc.html | 169 +++++++++++++--------- doc/zmq_ipc.txt | 3 +- doc/zmq_msg_close.3 | 19 +-- doc/zmq_msg_close.html | 161 ++++++++++++--------- doc/zmq_msg_close.txt | 3 +- doc/zmq_msg_copy.3 | 19 +-- doc/zmq_msg_copy.html | 161 ++++++++++++--------- doc/zmq_msg_copy.txt | 3 +- doc/zmq_msg_data.3 | 19 +-- doc/zmq_msg_data.html | 161 ++++++++++++--------- doc/zmq_msg_data.txt | 3 +- doc/zmq_msg_init.3 | 19 +-- doc/zmq_msg_init.html | 163 ++++++++++++--------- doc/zmq_msg_init.txt | 3 +- doc/zmq_msg_init_data.3 | 19 +-- doc/zmq_msg_init_data.html | 163 ++++++++++++--------- doc/zmq_msg_init_data.txt | 3 +- doc/zmq_msg_init_size.3 | 19 +-- doc/zmq_msg_init_size.html | 161 ++++++++++++--------- doc/zmq_msg_init_size.txt | 3 +- doc/zmq_msg_move.3 | 19 +-- doc/zmq_msg_move.html | 161 ++++++++++++--------- doc/zmq_msg_move.txt | 3 +- doc/zmq_msg_size.3 | 19 +-- doc/zmq_msg_size.html | 161 ++++++++++++--------- doc/zmq_msg_size.txt | 3 +- doc/zmq_pgm.7 | 19 +-- doc/zmq_pgm.html | 171 +++++++++++++--------- doc/zmq_pgm.txt | 4 +- doc/zmq_poll.3 | 19 +-- doc/zmq_poll.html | 163 ++++++++++++--------- doc/zmq_poll.txt | 3 +- doc/zmq_recv.3 | 19 +-- doc/zmq_recv.html | 167 +++++++++++++--------- doc/zmq_recv.txt | 3 +- doc/zmq_send.3 | 19 +-- doc/zmq_send.html | 167 +++++++++++++--------- doc/zmq_send.txt | 3 +- doc/zmq_setsockopt.3 | 97 +++++++++++-- doc/zmq_setsockopt.html | 335 ++++++++++++++++++++++++++++++++----------- doc/zmq_setsockopt.txt | 35 ++++- doc/zmq_socket.3 | 19 +-- doc/zmq_socket.html | 7 +- doc/zmq_socket.txt | 3 +- doc/zmq_strerror.3 | 19 +-- doc/zmq_strerror.html | 163 ++++++++++++--------- doc/zmq_strerror.txt | 3 +- doc/zmq_tcp.7 | 19 +-- doc/zmq_tcp.html | 169 +++++++++++++--------- doc/zmq_tcp.txt | 3 +- doc/zmq_term.3 | 19 +-- doc/zmq_term.html | 161 ++++++++++++--------- doc/zmq_term.txt | 3 +- doc/zmq_version.3 | 19 +-- doc/zmq_version.html | 163 ++++++++++++--------- doc/zmq_version.txt | 4 +- 90 files changed, 3587 insertions(+), 2584 deletions(-) (limited to 'doc') diff --git a/doc/zmq.7 b/doc/zmq.7 index 7f60700..e87f35a 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ" "7" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ" "7" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -215,27 +215,17 @@ The 0MQ distribution includes a C++ language binding, which is documented separa Other language bindings (Python, Ruby, Java and more) are provided by members of the 0MQ community and pointers can be found on the 0MQ website\&. .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>\&. +This manual page was written by the 0MQ community\&. .SH "RESOURCES" .sp Main web site: \m[blue]\fBhttp://www\&.zeromq\&.org/\fR\m[] .sp -Report bugs to the 0MQ development mailing list: <\m[blue]\fBzeromq\-dev@lists\&.zeromq\&.org\fR\m[]\&\s-2\u[3]\d\s+2> +Report bugs to the 0MQ development mailing list: <\m[blue]\fBzeromq\-dev@lists\&.zeromq\&.org\fR\m[]\&\s-2\u[1]\d\s+2> .SH "COPYING" .sp Free use of this software is granted under the terms of the GNU Lesser General Public License (LGPL)\&. For details see the files COPYING and COPYING\&.LESSER included with the 0MQ distribution\&. .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 -.IP " 3." 4 zeromq-dev@lists.zeromq.org .RS 4 \%mailto:zeromq-dev@lists.zeromq.org diff --git a/doc/zmq.html b/doc/zmq.html index e44f8a1..2c3ceee 100644 --- a/doc/zmq.html +++ b/doc/zmq.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq(7) - +
+

SYNOPSIS

#include <zmq.h>

cc [flags] files -lzmq [libraries]

+
+

DESCRIPTION

The ØMQ lightweight messaging kernel is a library which extends the standard @@ -596,7 +615,8 @@ and more.

This documentation presents an overview of ØMQ concepts, describes how ØMQ abstracts standard sockets and provides a reference manual for the functions provided by the ØMQ library.

-

Context

+
+

Context

Before using any ØMQ library functions the caller must initialise a ØMQ context using zmq_init(). The following functions are provided to handle initialisation and termination of a context:

@@ -618,6 +638,7 @@ Terminate ØMQ context

+

Thread safety

A ØMQ context is thread safe and may be shared among as many application threads as necessary, without any additional locking required on the part of @@ -628,12 +649,17 @@ In practice this means applications can create a socket in one thread with zmq_socket() and then pass it to a newly created thread as part of thread initialization, for example via a structure passed as an argument to pthread_create().

+
+

Multiple contexts

Multiple contexts may coexist within a single application. Thus, an application can use ØMQ directly and at the same time make use of any number of additional libraries or components which themselves make use of ØMQ as long as the above guidelines regarding thread safety are adhered to.

-

Messages

+
+
+
+

Messages

A ØMQ message is a discrete unit of data passed between applications or components of the same application. ØMQ messages have no internal structure and from the point of view of ØMQ itself they are considered to be opaque binary @@ -677,7 +703,9 @@ Message manipulation

-

Sockets

+
+
+

Sockets

ØMQ sockets present an abstraction of a asynchronous message queue, with the exact queueing semantics depending on the socket type in use. See zmq_socket(3) for the socket types provided.

@@ -731,7 +759,9 @@ Sending and receiving messages a set containing both ØMQ sockets and standard sockets. This mechanism mirrors the standard poll() system call, and is described in detail in zmq_poll(3).

-

Transports

+
+
+

Transports

A ØMQ socket can use multiple different underlying transport mechanisms. Each transport mechanism is suited to a particular purpose and has its own advantages and drawbacks.

@@ -770,13 +800,18 @@ Local in-process (inter-thread) communication transport

-

Devices

+
+
+

Devices

ØMQ provides devices, which are building blocks that act as intermediate nodes in complex messaging topologies. Devices can act as brokers that other nodes connect to, proxies that connect through to other nodes, or any mix of these two models.

You can start a device in an application thread, see zmq_device(3).

+ + +

ERROR HANDLING

The ØMQ library functions handle errors using the standard conventions found on @@ -790,6 +825,8 @@ to assist in these cases; for details refer to zmq_errn

The zmq_strerror() function is provided to translate ØMQ-specific error codes into error message strings; for details refer to zmq_strerror(3).

+
+

MISCELLANEOUS

The following miscellaneous functions are provided:

@@ -804,6 +841,8 @@ Report ØMQ library version
+
+

LANGUAGE BINDINGS

The ØMQ library provides interfaces suitable for calling from programs in any @@ -811,23 +850,32 @@ language; this documentation documents those interfaces as they would be used by C programmers. The intent is that programmers using ØMQ from other languages shall refer to this documentation alongside any documentation provided by the vendor of their language binding.

-

C++ language binding

+
+

C++ language binding

The ØMQ distribution includes a C++ language binding, which is documented separately in zmq_cpp(7).

-

Other language bindings

+
+
+

Other language bindings

Other language bindings (Python, Ruby, Java and more) are provided by members of the ØMQ community and pointers can be found on the ØMQ website.

+
+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
+

RESOURCES

Main web site: http://www.zeromq.org/

Report bugs to the ØMQ development mailing list: <zeromq-dev@lists.zeromq.org>

+
+

COPYING

Free use of this software is granted under the terms of the GNU Lesser General @@ -835,11 +883,12 @@ Public License (LGPL). For details see the files COPYING and COPYIN included with the ØMQ distribution.

+
diff --git a/doc/zmq.txt b/doc/zmq.txt index 16a5d30..1a00c56 100644 --- a/doc/zmq.txt +++ b/doc/zmq.txt @@ -200,8 +200,7 @@ of the 0MQ community and pointers can be found on the 0MQ website. AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. RESOURCES diff --git a/doc/zmq_bind.3 b/doc/zmq_bind.3 index ace7588..8aa0ad0 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_BIND" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_BIND" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -157,15 +157,4 @@ assert (rc == 0); \fBzmq_connect\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\&. diff --git a/doc/zmq_bind.html b/doc/zmq_bind.html index e3b1da2..6cb5e28 100644 --- a/doc/zmq_bind.html +++ b/doc/zmq_bind.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_bind(3) - +
+

SYNOPSIS

int zmq_bind (void *socket, const char *endpoint);

+
+

DESCRIPTION

The zmq_bind() function shall create an endpoint for accepting connections @@ -633,11 +652,15 @@ incoming connections from multiple endpoints bound to the socket using zmq_bind(). Refer to zmq_socket(3) for a description of the exact semantics involved when connecting or binding a socket to multiple endpoints.

+
+

RETURN VALUE

The zmq_bind() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

@@ -715,6 +738,8 @@ No I/O thread is available to accomplish the task.
+
+

EXAMPLE

@@ -731,23 +756,27 @@ rc = zmq_bind (socket, "tcp://eth0:5555"); assert (rc == 0);
+
+

SEE ALSO

zmq_connect(3) zmq_socket(3) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_bind.txt b/doc/zmq_bind.txt index 1d7c2ff..078e619 100644 --- a/doc/zmq_bind.txt +++ b/doc/zmq_bind.txt @@ -89,5 +89,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_close.3 b/doc/zmq_close.3 index d47f494..03a8091 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_CLOSE" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_CLOSE" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -67,15 +67,4 @@ was invalid\&. \fBzmq_socket\fR(3) \fBzmq_term\fR(3) \fBzmq_setsockopt\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\&. diff --git a/doc/zmq_close.html b/doc/zmq_close.html index f30c3a3..bb7f925 100644 --- a/doc/zmq_close.html +++ b/doc/zmq_close.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_close(3) - +
+

SYNOPSIS

int zmq_close (void *socket);

+
+

DESCRIPTION

The zmq_close() function shall destroy the socket referenced by the socket @@ -603,11 +622,15 @@ For details refer to zmq_setsockopt(3) and

+
+

RETURN VALUE

The zmq_close() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

@@ -621,6 +644,8 @@ The provided socket was invalid.
+
+

SEE ALSO

zmq_socket(3) @@ -628,17 +653,19 @@ The provided socket was invalid. zmq_setsockopt(3) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_close.txt b/doc/zmq_close.txt index 47f9bb2..7d727da 100644 --- a/doc/zmq_close.txt +++ b/doc/zmq_close.txt @@ -48,5 +48,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_connect.3 b/doc/zmq_connect.3 index eb0eb03..641e488 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_CONNECT" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_CONNECT" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -152,15 +152,4 @@ assert (rc == 0); \fBzmq_bind\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\&. diff --git a/doc/zmq_connect.html b/doc/zmq_connect.html index b6353b6..5dc35f8 100644 --- a/doc/zmq_connect.html +++ b/doc/zmq_connect.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_connect(3) - +
+

SYNOPSIS

int zmq_connect (void *socket, const char *endpoint);

+
+

DESCRIPTION

The zmq_connect() function shall connect the socket referenced by the @@ -643,11 +662,15 @@ physical connection was or can actually be established.

+
+

RETURN VALUE

The zmq_connect() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

@@ -701,6 +724,8 @@ No I/O thread is available to accomplish the task.
+
+

EXAMPLE

@@ -717,23 +742,27 @@ rc = zmq_connect (socket, "tcp://server001:5555"); assert (rc == 0);
+
+

SEE ALSO

zmq_bind(3) zmq_socket(3) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_connect.txt b/doc/zmq_connect.txt index 6ec56b0..f260dd5 100644 --- a/doc/zmq_connect.txt +++ b/doc/zmq_connect.txt @@ -87,5 +87,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_cpp.7 b/doc/zmq_cpp.7 index 0008023..38bd1b4 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_CPP" "7" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_CPP" "7" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -396,15 +396,4 @@ s\&.send (msg); \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\&. diff --git a/doc/zmq_cpp.html b/doc/zmq_cpp.html index c59c01d..ff44f57 100644 --- a/doc/zmq_cpp.html +++ b/doc/zmq_cpp.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_cpp(7) - +
+

SYNOPSIS

#include <zmq.hpp>

c++ [flags] files -lzmq [libraries]

+
+

DESCRIPTION

This manual page describes how the ØMQ C++ language binding maps to the @@ -592,126 +611,151 @@ underlying ØMQ C library functions.

All ØMQ constants defined by zmq.h are also available to the C++ language binding.

The following classes are provided in the zmq namespace:

-

Context

+
+

Context

The context_t class encapsulates functionality dealing with the initialisation and termination of a ØMQ context.

+

Constructor

-
context_t::context_t(int io_threads)
-
+
context_t::context_t(int io_threads)
+

Maps to the zmq_init() function, as described in zmq_init(3).

+
+

Destructor

-
context_t::~context_t(void)
-
+
context_t::~context_t(void)
+

Maps to the zmq_term() function, as described in zmq_term(3).

+
+

Methods

None.

-

Socket

+
+
+
+

Socket

The socket_t class encapsulates a ØMQ socket.

+

Constructor

-
socket_t::socket_t(context_t &context, int type)
-
+
socket_t::socket_t(context_t &context, int type)
+

Maps to the zmq_socket() function, as described in zmq_socket(3).

+
+

Destructor

-
socket_t::~socket_t(void)
-
+
socket_t::~socket_t(void)
+

Calls the zmq_close() function, as described in zmq_close(3).

+
+

Methods

-
void socket_t::getsockopt(int option_name, void *option_value, size_t -*option_len)
-
+
void socket_t::getsockopt(int option_name, void *option_value, size_t
+*option_len)
+

Maps to the zmq_getsockopt() function, as described in zmq_getsockopt(3).

-
void socket_t::setsockopt(int option_name, const void *option_value, size_t -option_len)
-
+
void socket_t::setsockopt(int option_name, const void *option_value, size_t
+option_len)
+

Maps to the zmq_setsockopt() function, as described in zmq_setsockopt(3).

-
void socket_t::bind(const char *endpoint)
-
+
void socket_t::bind(const char *endpoint)
+

Maps to the zmq_bind() function, as described in zmq_bind(3).

-
void socket_t::connect(const char *endpoint)
-
+
void socket_t::connect(const char *endpoint)
+

Maps to the zmq_connect() function, as described in zmq_connect(3).

-
bool socket_t::send(message_t &msg, int flags = 0)
-
+
bool socket_t::send(message_t &msg, int flags = 0)
+

Maps to the zmq_send() function, as described in zmq_send(3). Returns true if message is successfully sent, false if it is not.

-
bool socket_t::recv(message_t *msg, int flags = 0)
-
+
bool socket_t::recv(message_t *msg, int flags = 0)
+

Maps to the zmq_recv() function, as described in zmq_recv(3). Returns true if message is successfully received, false if it is not.

-

Message

+
+
+
+

Message

The zmq::message_t class encapsulates the zmq_msg_t structure and functions to construct, destruct and manipulate ØMQ messages.

+

Constructor

-
message_t::message_t(void) +
message_t::message_t(void)
 message_t::message_t(size_t size)
-message_t::message_t(void *data, size_t size, free_fn *ffn)
-
+message_t::message_t(void *data, size_t size, free_fn *ffn) +

These map to the zmq_msg_init(), zmq_msg_init_size() and zmq_msg_init_data() functions, described in zmq_msg_init(3), zmq_msg_init_size(3) and zmq_msg_init_data(3) respectively.

+
+

Destructor

-
message_t::~message_t(void)
-
+
message_t::~message_t(void)
+

Calls the zmq_msg_close() function, as described in zmq_msg_close(3).

+
+

Methods

-
void *message_t::data (void)
-
+
void *message_t::data (void)
+

Maps to the zmq_msg_data() function, as described in zmq_msg_data(3).

-
size_t message_t::size (void)
-
+
size_t message_t::size (void)
+

Maps to the zmq_msg_size() function, as described in zmq_msg_size(3).

-
void message_t::copy (message_t *src)
-
+
void message_t::copy (message_t *src)
+

Maps to the zmq_msg_copy() function, as described in zmq_msg_copy(3).

-
void message_t::move (message_t *src)
-
+
void message_t::move (message_t *src)
+

Maps to the zmq_msg_move() function, as described in zmq_msg_move(3).

-
message_t::rebuild(void) +
message_t::rebuild(void)
 message_t::rebuild(size_t size)
-message_t::rebuild(void *data, size_t size, free_fn *ffn)
-
+message_t::rebuild(void *data, size_t size, free_fn *ffn) +

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

-

Input/output multiplexing

+
+
+
+

Input/output multiplexing

-
int poll (zmq_pollitem_t *items, int nitems, long timeout = -1)
-
+
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).

@@ -725,6 +769,9 @@ should cast an instance of the socket_t class to (void *).
+
+
+

ERROR HANDLING

All errors reported by the underlying ØMQ C library functions are automatically @@ -732,6 +779,8 @@ converted to exceptions by the C++ language binding. The zmq::error_t is derived from the std::exception class and uses the zmq_strerror() function to convert the error code to human-readable string.

+
+

EXAMPLE

@@ -744,21 +793,25 @@ memset (msg.data (), 0, 100); s.send (msg);
+
+

SEE ALSO

zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_cpp.txt b/doc/zmq_cpp.txt index cd5cdc9..b963afa 100644 --- a/doc/zmq_cpp.txt +++ b/doc/zmq_cpp.txt @@ -208,5 +208,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_device.3 b/doc/zmq_device.3 index 66ad2be..a8b8477 100644 --- a/doc/zmq_device.3 +++ b/doc/zmq_device.3 @@ -2,12 +2,12 @@ .\" Title: zmq_device .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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_DEVICE" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_DEVICE" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -118,23 +118,4 @@ zmq_device (ZMQ_QUEUE, frontend, backend); \fBzmq_bind\fR(3) \fBzmq_connect\fR(3) \fBzmq_socket\fR(3) \fBzmq\fR(7) .SH "AUTHORS" .sp -This 0MQ manual page was written by Pieter Hintjens <\m[blue]\fBph@imatix\&.com\fR\m[]\&\s-2\u[1]\d\s+2> -.SH "RESOURCES" -.sp -Main web site: \m[blue]\fBhttp://www\&.zeromq\&.org/\fR\m[] -.sp -Report bugs to the 0MQ development mailing list: <\m[blue]\fBzeromq\-dev@lists\&.zeromq\&.org\fR\m[]\&\s-2\u[2]\d\s+2> -.SH "COPYING" -.sp -Free use of this software is granted under the terms of the GNU Lesser General Public License (LGPL)\&. For details see the files COPYING and COPYING\&.LESSER included with the 0MQ distribution\&. -.SH "NOTES" -.IP " 1." 4 -ph@imatix.com -.RS 4 -\%mailto:ph@imatix.com -.RE -.IP " 2." 4 -zeromq-dev@lists.zeromq.org -.RS 4 -\%mailto:zeromq-dev@lists.zeromq.org -.RE +This manual page was written by the 0MQ community\&. diff --git a/doc/zmq_device.html b/doc/zmq_device.html index 06ce951..d460e1c 100644 --- a/doc/zmq_device.html +++ b/doc/zmq_device.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_device(3) - +
+

SYNOPSIS

int zmq_device (int device, const void *frontend, const void *backend);

+
+

DESCRIPTION

The zmq_device() function starts a built-in ØMQ device. The device argument @@ -646,6 +665,8 @@ bind both frontend and backend sockets. The two conventional device models are:<

zmq_device() runs in the current thread and returns only if/when the current context is closed.

+
+

QUEUE DEVICE

ZMQ_QUEUE creates a shared queue that collects requests from a set of clients, @@ -658,6 +679,8 @@ clients and the backend speaks to services. You should use ZMQ_QUEUE wi Other combinations are not documented.

Refer to zmq_socket(3) for a description of these socket types.

+
+

FORWARDER DEVICE

ZMQ_FORWARDER collects messages from a set of publishers and forwards these to @@ -669,6 +692,8 @@ publishers and the backend speaks to subscribers. You should use for the backend. Other combinations are not documented.

Refer to zmq_socket(3) for a description of these socket types.

+
+

STREAMER DEVICE

ZMQ_STREAMER collects tasks from a set of pushers and forwards these to a set @@ -680,11 +705,15 @@ and the backend speaks to pullers. You should use ZMQ_STREAMER with a Other combinations are not documented.

Refer to zmq_socket(3) for a description of these socket types.

+
+

RETURN VALUE

The zmq_device() function always returns -1 and errno set to ETERM (the ØMQ context associated with either of the specified sockets was terminated).

+
+

EXAMPLE

@@ -702,6 +731,8 @@ assert (zmq_bind (backend, "tcp://*:5556") == 0); zmq_device (ZMQ_QUEUE, frontend, backend);
+
+

SEE ALSO

zmq_bind(3) @@ -709,27 +740,19 @@ zmq_device (ZMQ_QUEUE, frontend, backend); zmq_socket(3) zmq(7)

-

AUTHORS

-
-

This ØMQ manual page was written by Pieter Hintjens <ph@imatix.com>

-

RESOURCES

+
+

AUTHORS

-

Main web site: http://www.zeromq.org/

-

Report bugs to the ØMQ development mailing list: <zeromq-dev@lists.zeromq.org>

+

This manual page was written by the ØMQ community.

-

COPYING

-
-

Free use of this software is granted under the terms of the GNU Lesser General -Public License (LGPL). For details see the files COPYING and COPYING.LESSER -included with the ØMQ distribution.

diff --git a/doc/zmq_device.txt b/doc/zmq_device.txt index 93e616d..216052c 100644 --- a/doc/zmq_device.txt +++ b/doc/zmq_device.txt @@ -121,18 +121,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Pieter Hintjens - - -RESOURCES ---------- -Main web site: - -Report bugs to the 0MQ development mailing list: - - -COPYING -------- -Free use of this software is granted under the terms of the GNU Lesser General -Public License (LGPL). For details see the files `COPYING` and `COPYING.LESSER` -included with the 0MQ distribution. +This manual page was written by the 0MQ community. diff --git a/doc/zmq_epgm.7 b/doc/zmq_epgm.7 index b83f9ae..0f4536d 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_PGM" "7" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_PGM" "7" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -195,15 +195,4 @@ assert (rc == 0); \fBzmq_connect\fR(3) \fBzmq_setsockopt\fR(3) \fBzmq_tcp\fR(7) \fBzmq_ipc\fR(7) \fBzmq_inproc\fR(7) \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\&. diff --git a/doc/zmq_epgm.html b/doc/zmq_epgm.html index 5dfc00d..53f80cc 100644 --- a/doc/zmq_epgm.html +++ b/doc/zmq_epgm.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_pgm(7) - +
+

SYNOPSIS

PGM (Pragmatic General Multicast) is a protocol for reliable multicast transport of data over IP networks.

+
+

DESCRIPTION

ØMQ implements two variants of PGM, the standard protocol where PGM datagrams @@ -610,6 +629,8 @@ not require any special privileges.

+
+

ADDRESSING

A ØMQ address string consists of two parts as follows: @@ -618,7 +639,8 @@ transport protocol to use. For the standard PGM protocol, transport sha set to pgm. For the "Encapsulated PGM" protocol transport shall be set to epgm. The meaning of the endpoint part for both the pgm and epgm transport is defined below.

-

Connecting a socket

+
+

Connecting a socket

When connecting a socket to a peer address using zmq_connect() with the pgm or epgm transport, the endpoint shall be interpreted as an interface followed by a semicolon, followed by a multicast address, followed by a colon @@ -651,6 +673,9 @@ names exist, thus only the primary IPv4 address may be used to specify an

A multicast address is specified by an IPv4 multicast address in its numeric representation.

+
+
+

WIRE FORMAT

Consecutive PGM datagrams are interpreted by ØMQ as a single continuous stream @@ -658,7 +683,8 @@ of data where ØMQ messages are not necessarily aligned with PGM datagram boundaries and a single ØMQ message may span several PGM datagrams. This stream of data consists of ØMQ messages encapsulated in frames as described in zmq_tcp(7).

-

PGM datagram payload

+
+

PGM datagram payload

The following ABNF grammar represents the payload of a single PGM datagram as used by ØMQ:

@@ -706,6 +732,9 @@ Third datagram payload +--------------+----------------------------+-------------+
+
+
+

EXAMPLE

@@ -723,6 +752,8 @@ rc = zmq_connect(socket, "pgm://192.168.1.1;239.192.1.1:5555"); assert (rc == 0);
+
+

SEE ALSO

zmq_connect(3) @@ -732,17 +763,19 @@ assert (rc == 0); zmq_inproc(7) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_epgm.txt b/doc/zmq_epgm.txt index 68ec504..9ce1452 100644 --- a/doc/zmq_epgm.txt +++ b/doc/zmq_epgm.txt @@ -156,7 +156,7 @@ linkzmq:zmq_ipc[7] linkzmq:zmq_inproc[7] linkzmq:zmq[7] + AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_errno.3 b/doc/zmq_errno.3 index b912203..aac70ed 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_ERRNO" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_ERRNO" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -64,15 +64,4 @@ No errors are defined\&. \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\&. diff --git a/doc/zmq_errno.html b/doc/zmq_errno.html index 0a98725..1097ede 100644 --- a/doc/zmq_errno.html +++ b/doc/zmq_errno.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_errno(3) - +
+

SYNOPSIS

int zmq_errno (void);

+
+

DESCRIPTION

The zmq_errno() function shall retrieve the value of the errno variable for @@ -604,30 +623,38 @@ variable directly.

+
+

RETURN VALUE

The zmq_errno() function shall return the value of the errno variable for the calling thread.

+
+

ERRORS

No errors are defined.

+
+

SEE ALSO

zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_errno.txt b/doc/zmq_errno.txt index f9cf6cb..a2d6334 100644 --- a/doc/zmq_errno.txt +++ b/doc/zmq_errno.txt @@ -46,5 +46,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. 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 -.\" 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\&. diff --git a/doc/zmq_getsockopt.html b/doc/zmq_getsockopt.html index 18c64b1..f726b0b 100644 --- a/doc/zmq_getsockopt.html +++ b/doc/zmq_getsockopt.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_getsockopt(3) - +
+

SYNOPSIS

int zmq_getsockopt (void *socket, int option_name, void *option_value, size_t *option_len);

+
+

DESCRIPTION

The zmq_getsockopt() function shall retrieve the value for the option @@ -594,7 +613,8 @@ to by option_value; upon successful completion zmq_getsockopt()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_TYPE: Retrieve socket type

+
+

ZMQ_TYPE: Retrieve socket type

The ZMQ_TYPE option shall retrieve the socket type for the specified socket. The socket type is specified at socket creation time and cannot be modified afterwards.

@@ -644,7 +664,9 @@ all
-

ZMQ_RCVMORE: More message parts to follow

+
+
+

ZMQ_RCVMORE: More message parts to follow

The ZMQ_RCVMORE option shall return a boolean value indicating if the multi-part message currently being read from the specified socket has more message parts to follow. If there are no message parts to follow or if the @@ -698,7 +720,9 @@ all

-

ZMQ_HWM: Retrieve high water mark

+
+
+

ZMQ_HWM: Retrieve high water mark

The ZMQ_HWM option shall retrieve the high water mark for the specified socket. The high water mark is a hard limit on the maximum number of outstanding messages ØMQ shall queue in memory for any single peer that the @@ -755,7 +779,117 @@ all

-

ZMQ_SWAP: Retrieve disk offload size

+
+
+

ZMQ_RCVTIMEO: Maximum time before a socket operation returns with EAGAIN

+

Retrieve the timeout for recv operation on the socket. If the value is 0, +zmq_recv(3) 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.

+
+ + + + + + + + + + + + + + + + +
+Option value type +
+		 +

+int +

+
+Option value unit +
+		 +

+milliseconds +

+
+Default value +
+		 +

+-1 (infinite) +

+
+Applicable socket types +
+		 +

+all +

+
+
+
+

ZMQ_SNDTIMEO: Maximum time before a socket operation returns with EAGAIN

+

Retrieve the timeout for send operation on the socket. If the value is 0, +zmq_send(3) 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.

+
+ + + + + + + + + + + + + + + + +
+Option value type +
+		 +

+int +

+
+Option value unit +
+		 +

+milliseconds +

+
+Default value +
+		 +

+-1 (infinite) +

+
+Applicable socket types +
+		 +

+all +

+
+
+
+

ZMQ_SWAP: Retrieve disk offload size

The ZMQ_SWAP option shall retrieve the disk offload (swap) size for the specified socket. A socket which has ZMQ_SWAP set to a non-zero value may exceed its high water mark; in this case outstanding messages shall be @@ -807,7 +941,9 @@ all

-

ZMQ_AFFINITY: Retrieve I/O thread affinity

+
+
+

ZMQ_AFFINITY: Retrieve I/O thread affinity

The ZMQ_AFFINITY option shall retrieve the I/O thread affinity for newly created connections on the specified socket.

Affinity determines which threads from the ØMQ I/O thread pool associated with @@ -865,7 +1001,9 @@ N/A

-

ZMQ_IDENTITY: Retrieve socket identity

+
+
+

ZMQ_IDENTITY: Retrieve socket identity

The ZMQ_IDENTITY option shall retrieve the identity of the specified socket. Socket identity determines if existing ØMQ infrastructure (message queues, forwarding devices) shall be identified with a specific application @@ -923,7 +1061,9 @@ all

-

ZMQ_RATE: Retrieve multicast data rate

+
+
+

ZMQ_RATE: Retrieve multicast data rate

The ZMQ_RATE option shall retrieve the maximum send or receive data rate for multicast transports using the specified socket.

@@ -972,7 +1112,9 @@ all, when using multicast transports
-

ZMQ_RECOVERY_IVL: Get multicast recovery interval

+
+
+

ZMQ_RECOVERY_IVL: Get multicast recovery interval

The ZMQ_RECOVERY_IVL option shall retrieve the recovery interval for multicast transports using the specified socket. The recovery interval determines the maximum time in seconds that a receiver can be absent from a @@ -1023,7 +1165,9 @@ all, when using multicast transports

-

ZMQ_RECOVERY_IVL_MSEC: Get multicast recovery interval in milliseconds

+
+
+

ZMQ_RECOVERY_IVL_MSEC: Get multicast recovery interval in milliseconds

The ZMQ_RECOVERY_IVL’_MSEC option shall retrieve the recovery interval, in milliseconds, for multicast transports using the specified 'socket. The recovery interval determines the maximum time in seconds that a receiver @@ -1079,7 +1223,9 @@ all, when using multicast transports

-

ZMQ_MCAST_LOOP: Control multicast loop-back

+
+
+

ZMQ_MCAST_LOOP: Control multicast loop-back

The ZMQ_MCAST_LOOP option controls whether data sent via multicast transports can also be received by the sending host via loop-back. A value of zero indicates that the loop-back functionality is disabled, while the default @@ -1133,7 +1279,9 @@ all, when using multicast transports

-

ZMQ_SNDBUF: Retrieve kernel transmit buffer size

+
+
+

ZMQ_SNDBUF: Retrieve kernel transmit buffer size

The ZMQ_SNDBUF option shall retrieve the underlying kernel transmit buffer size for the specified socket. A value of zero means that the OS default is in effect. For details refer to your operating system documentation for the @@ -1184,7 +1332,9 @@ all

-

ZMQ_RCVBUF: Retrieve kernel receive buffer size

+
+
+

ZMQ_RCVBUF: Retrieve kernel receive buffer size

The ZMQ_RCVBUF option shall retrieve the underlying kernel receive buffer size for the specified socket. A value of zero means that the OS default is in effect. For details refer to your operating system documentation for the @@ -1235,7 +1385,9 @@ all

-

ZMQ_LINGER: Retrieve linger period for socket shutdown

+
+
+

ZMQ_LINGER: Retrieve linger period for socket shutdown

The ZMQ_LINGER option shall retrieve the linger period for the specified socket. The linger period determines how long pending messages which have yet to be sent to a peer shall linger in memory after a socket is closed with @@ -1313,7 +1465,9 @@ all

-

ZMQ_RECONNECT_IVL: Retrieve reconnection interval

+
+
+

ZMQ_RECONNECT_IVL: Retrieve reconnection interval

The ZMQ_RECONNECT_IVL option shall retrieve the initial reconnection interval for the specified socket. The reconnection interval is the period ØMQ shall wait between attempts to reconnect disconnected peers when using @@ -1373,7 +1527,9 @@ all, only for connection-oriented transports

-

ZMQ_RECONNECT_IVL_MAX: Retrieve maximum reconnection interval

+
+
+

ZMQ_RECONNECT_IVL_MAX: Retrieve maximum reconnection interval

The ZMQ_RECONNECT_IVL_MAX option shall retrieve the maximum reconnection interval for the specified socket. This is the maximum period ØMQ shall wait between attempts to reconnect. On each reconnect attempt, the previous interval @@ -1434,7 +1590,9 @@ all, only for connection-oriented transport

-

ZMQ_BACKLOG: Retrieve maximum length of the queue of outstanding connections

+
+
+

ZMQ_BACKLOG: Retrieve maximum length of the queue of outstanding connections

The ZMQ_BACKLOG option shall retrieve the maximum length of the queue of outstanding peer connections for the specified socket; this only applies to connection-oriented transports. For details refer to your operating system @@ -1485,7 +1643,9 @@ all, only for connection-oriented transports

-

ZMQ_FD: Retrieve file descriptor associated with the socket

+
+
+

ZMQ_FD: Retrieve file descriptor associated with the socket

The ZMQ_FD option shall retrieve the file descriptor associated with the specified socket. The returned file descriptor can be used to integrate the socket into an existing event loop; the ØMQ library shall signal any pending @@ -1558,7 +1718,9 @@ all

-

ZMQ_EVENTS: Retrieve socket event state

+
+
+

ZMQ_EVENTS: Retrieve socket event state

The ZMQ_EVENTS option shall retrieve the event state for the specified socket. The returned value is a bit mask constructed by OR’ing a combination of the following event flags:

@@ -1633,11 +1795,16 @@ all
+
+
+

RETURN VALUE

The zmq_getsockopt() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

@@ -1678,6 +1845,8 @@ The operation was interrupted by delivery of a signal.
+
+

EXAMPLE

@@ -1690,23 +1859,27 @@ rc = zmq_getsockopt (socket, ZMQ_HWM, &hwm, &hwm_size); assert (rc == 0);
+
+

SEE ALSO

zmq_setsockopt(3) zmq_socket(3) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index 1e075d7..b39c784 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -79,6 +79,38 @@ Default value:: 0 Applicable socket types:: all +ZMQ_RCVTIMEO: Maximum time before a socket operation returns with EAGAIN +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Retrieve the timeout for recv operation on the socket. If the value is `0`, +_zmq_recv(3)_ 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. + +[horizontal] +Option value type:: int +Option value unit:: milliseconds +Default value:: -1 (infinite) +Applicable socket types:: all + + +ZMQ_SNDTIMEO: Maximum time before a socket operation returns with EAGAIN +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Retrieve the timeout for send operation on the socket. If the value is `0`, +_zmq_send(3)_ 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. + +[horizontal] +Option value type:: int +Option value unit:: milliseconds +Default value:: -1 (infinite) +Applicable socket types:: all + + ZMQ_SWAP: Retrieve disk offload size ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The 'ZMQ_SWAP' option shall retrieve the disk offload (swap) size for the @@ -403,5 +435,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_init.3 b/doc/zmq_init.3 index 052397d..d8aa63d 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_INIT" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_INIT" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -57,15 +57,4 @@ was requested\&. \fBzmq\fR(7) \fBzmq_term\fR(3) .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\&. diff --git a/doc/zmq_init.html b/doc/zmq_init.html index 1798d87..b427285 100644 --- a/doc/zmq_init.html +++ b/doc/zmq_init.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_init(3) - +
+

SYNOPSIS

void *zmq_init (int io_threads);

+
+

DESCRIPTION

The zmq_init() function initialises a ØMQ context.

@@ -594,12 +613,16 @@ messaging you may set this to zero, otherwise set it to at least one.

threads as necessary, without any additional locking required on the part of the caller.

+
+

RETURN VALUE

The zmq_init() function shall return an opaque handle to the initialised context if successful. Otherwise it shall return NULL and set errno to one of the values defined below.

+
+

ERRORS

@@ -613,22 +636,26 @@ An invalid number of io_threads was requested.
+
+

SEE ALSO

zmq(7) zmq_term(3)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_init.txt b/doc/zmq_init.txt index eadf65d..606b71d 100644 --- a/doc/zmq_init.txt +++ b/doc/zmq_init.txt @@ -47,5 +47,4 @@ linkzmq:zmq_term[3] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_inproc.7 b/doc/zmq_inproc.7 index 567813e..df4cb6c 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_INPROC" "7" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_INPROC" "7" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -101,15 +101,4 @@ assert (rc == 0); \fBzmq_bind\fR(3) \fBzmq_connect\fR(3) \fBzmq_ipc\fR(7) \fBzmq_tcp\fR(7) \fBzmq_pgm\fR(7) \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\&. diff --git a/doc/zmq_inproc.html b/doc/zmq_inproc.html index f3176f9..083be3a 100644 --- a/doc/zmq_inproc.html +++ b/doc/zmq_inproc.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_inproc(7) - +
+

SYNOPSIS

The in-process transport passes messages via memory directly between threads @@ -596,6 +613,8 @@ only you can initialise the context with zero I/O threads. See

+
+

ADDRESSING

A ØMQ address string consists of two parts as follows: @@ -603,23 +622,31 @@ only you can initialise the context with zero I/O threads. See transport protocol to use, and for the in-process transport shall be set to inproc. The meaning of the endpoint part for the in-process transport is defined below.

-

Assigning a local address to a socket

+
+

Assigning a local address to a socket

When assigning a local address to a socket using zmq_bind() with the inproc transport, the endpoint shall be interpreted as an arbitrary string identifying the name to create. The name must be unique within the ØMQ context associated with the socket and may be up to 256 characters in length. No other restrictions are placed on the format of the name.

-

Connecting a socket

+
+
+

Connecting a socket

When connecting a socket to a peer address using zmq_connect() with the inproc transport, the endpoint shall be interpreted as an arbitrary string identifying the name to connect to. The name must have been previously created by assigning it to at least one socket within the same ØMQ context as the socket being connected.

+
+
+

WIRE FORMAT

Not applicable.

+
+

EXAMPLES

@@ -643,6 +670,8 @@ rc = zmq_connect(socket, "inproc://my-endpoint"); assert (rc == 0);
+
+

SEE ALSO

zmq_bind(3) @@ -652,17 +681,19 @@ assert (rc == 0); zmq_pgm(7) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_inproc.txt b/doc/zmq_inproc.txt index e68e14b..128e9d5 100644 --- a/doc/zmq_inproc.txt +++ b/doc/zmq_inproc.txt @@ -85,5 +85,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_ipc.7 b/doc/zmq_ipc.7 index f9aafb6..a410925 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_IPC" "7" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_IPC" "7" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -95,15 +95,4 @@ assert (rc == 0); \fBzmq_bind\fR(3) \fBzmq_connect\fR(3) \fBzmq_inproc\fR(7) \fBzmq_tcp\fR(7) \fBzmq_pgm\fR(7) \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\&. diff --git a/doc/zmq_ipc.html b/doc/zmq_ipc.html index 8b0601d..dc010a8 100644 --- a/doc/zmq_ipc.html +++ b/doc/zmq_ipc.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_ipc(7) - +
+

SYNOPSIS

The inter-process transport passes messages between local processes using a @@ -594,6 +611,8 @@ systems that provide UNIX domain sockets.

+
+

ADDRESSING

A ØMQ address string consists of two parts as follows: @@ -601,24 +620,32 @@ systems that provide UNIX domain sockets. transport protocol to use, and for the inter-process transport shall be set to ipc. The meaning of the endpoint part for the inter-process transport is defined below.

-

Assigning a local address to a socket

+
+

Assigning a local address to a socket

When assigning a local address to a socket using zmq_bind() with the ipc transport, the endpoint shall be interpreted as an arbitrary string identifying the pathname to create. The pathname must be unique within the operating system namespace used by the ipc implementation, and must fulfill any restrictions placed by the operating system on the format and length of a pathname.

-

Connecting a socket

+
+
+

Connecting a socket

When connecting a socket to a peer address using zmq_connect() with the ipc transport, the endpoint shall be interpreted as an arbitrary string identifying the pathname to connect to. The pathname must have been previously created within the operating system namespace by assigning it to a socket with zmq_bind().

+
+
+

WIRE FORMAT

Not applicable.

+
+

EXAMPLES

@@ -636,6 +663,8 @@ rc = zmq_connect(socket, "ipc:///tmp/feeds/0"); assert (rc == 0);
+
+

SEE ALSO

zmq_bind(3) @@ -645,17 +674,19 @@ assert (rc == 0); zmq_pgm(7) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_ipc.txt b/doc/zmq_ipc.txt index 974ad24..1d4df2c 100644 --- a/doc/zmq_ipc.txt +++ b/doc/zmq_ipc.txt @@ -76,5 +76,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_msg_close.3 b/doc/zmq_msg_close.3 index 07892bc..e6afc8e 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_MSG_CLOSE" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_MSG_CLOSE" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -67,15 +67,4 @@ Invalid message\&. \fBzmq_msg_init\fR(3) \fBzmq_msg_init_size\fR(3) \fBzmq_msg_init_data\fR(3) \fBzmq_msg_data\fR(3) \fBzmq_msg_size\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\&. diff --git a/doc/zmq_msg_close.html b/doc/zmq_msg_close.html index 621d39c..fd02b53 100644 --- a/doc/zmq_msg_close.html +++ b/doc/zmq_msg_close.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_msg_close(3) - +
+

SYNOPSIS

int zmq_msg_close (zmq_msg_t *msg);

+
+

DESCRIPTION

The zmq_msg_close() function shall inform the ØMQ infrastructure that any @@ -603,11 +622,15 @@ no longer required, otherwise memory leaks may occur.

+
+

RETURN VALUE

The zmq_msg_close() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

@@ -621,6 +644,8 @@ Invalid message.
+
+

SEE ALSO

zmq_msg_init(3) @@ -630,17 +655,19 @@ Invalid message. zmq_msg_size(3) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_msg_close.txt b/doc/zmq_msg_close.txt index 025302b..1150e1c 100644 --- a/doc/zmq_msg_close.txt +++ b/doc/zmq_msg_close.txt @@ -51,5 +51,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_msg_copy.3 b/doc/zmq_msg_copy.3 index 01f58e6..e246337 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_MSG_COPY" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_MSG_COPY" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -81,15 +81,4 @@ Invalid message\&. \fBzmq_msg_move\fR(3) \fBzmq_msg_init\fR(3) \fBzmq_msg_init_size\fR(3) \fBzmq_msg_init_data\fR(3) \fBzmq_msg_close\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\&. diff --git a/doc/zmq_msg_copy.html b/doc/zmq_msg_copy.html index 0130499..41d4758 100644 --- a/doc/zmq_msg_copy.html +++ b/doc/zmq_msg_copy.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_msg_copy(3) - +
+

SYNOPSIS

int zmq_msg_copy (zmq_msg_t *dest, zmq_msg_t *src);

+
+

DESCRIPTION

The zmq_msg_copy() function shall copy the message object referenced by src @@ -612,11 +631,15 @@ copy the message content using memcpy().

+
+

RETURN VALUE

The zmq_msg_copy() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

@@ -630,6 +653,8 @@ Invalid message.
+
+

SEE ALSO

zmq_msg_move(3) @@ -639,17 +664,19 @@ Invalid message. zmq_msg_close(3) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_msg_copy.txt b/doc/zmq_msg_copy.txt index d6ce1b9..155a6f8 100644 --- a/doc/zmq_msg_copy.txt +++ b/doc/zmq_msg_copy.txt @@ -53,5 +53,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_msg_data.3 b/doc/zmq_msg_data.3 index 3b0a7db..7d4674e 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_MSG_DATA" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_MSG_DATA" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -62,15 +62,4 @@ No errors are defined\&. \fBzmq_msg_size\fR(3) \fBzmq_msg_init\fR(3) \fBzmq_msg_init_size\fR(3) \fBzmq_msg_init_data\fR(3) \fBzmq_msg_close\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\&. diff --git a/doc/zmq_msg_data.html b/doc/zmq_msg_data.html index 76d547a..3ac3fa6 100644 --- a/doc/zmq_msg_data.html +++ b/doc/zmq_msg_data.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_msg_data(3) - +
+

SYNOPSIS

void *zmq_msg_data (zmq_msg_t *msg);

+
+

DESCRIPTION

The zmq_msg_data() function shall return a pointer to the message content of @@ -598,15 +617,21 @@ the message object referenced by msg.

+
+

RETURN VALUE

Upon successful completion, zmq_msg_data() shall return a pointer to the message content.

+
+

ERRORS

No errors are defined.

+
+

SEE ALSO

zmq_msg_size(3) @@ -616,17 +641,19 @@ message content.

zmq_msg_close(3) zmq(7)

+ +

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_msg_data.txt b/doc/zmq_msg_data.txt index 36a3ce3..b82fbca 100644 --- a/doc/zmq_msg_data.txt +++ b/doc/zmq_msg_data.txt @@ -44,5 +44,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_msg_init.3 b/doc/zmq_msg_init.3 index ba4ba98..6865f86 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_MSG_INIT" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_MSG_INIT" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -96,15 +96,4 @@ assert (rc == 0); \fBzmq_msg_init_size\fR(3) \fBzmq_msg_init_data\fR(3) \fBzmq_msg_close\fR(3) \fBzmq_msg_data\fR(3) \fBzmq_msg_size\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\&. diff --git a/doc/zmq_msg_init.html b/doc/zmq_msg_init.html index 8d836ec..06ca9a5 100644 --- a/doc/zmq_msg_init.html +++ b/doc/zmq_msg_init.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_msg_init(3) - +
+

SYNOPSIS

int zmq_msg_init (zmq_msg_t *msg);

+
+

DESCRIPTION

The zmq_msg_init() function shall initialise the message object referenced by @@ -609,15 +628,21 @@ before receiving a message with zmq_recv().

+
+

RETURN VALUE

The zmq_msg_init() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

No errors are defined.

+
+

EXAMPLE

@@ -630,6 +655,8 @@ rc = zmq_recv (socket, &msg, 0); assert (rc == 0);
+ +

SEE ALSO

zmq_msg_init_size(3) @@ -639,17 +666,19 @@ assert (rc == 0); zmq_msg_size(3) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_msg_init.txt b/doc/zmq_msg_init.txt index 1c2577d..4bdfbe6 100644 --- a/doc/zmq_msg_init.txt +++ b/doc/zmq_msg_init.txt @@ -61,5 +61,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_msg_init_data.3 b/doc/zmq_msg_init_data.3 index 77b61b1..49469ad 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_MSG_INIT_DATA" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_MSG_INIT_DATA" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -124,15 +124,4 @@ assert (rc == 0); \fBzmq_msg_init_size\fR(3) \fBzmq_msg_init\fR(3) \fBzmq_msg_close\fR(3) \fBzmq_msg_data\fR(3) \fBzmq_msg_size\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\&. diff --git a/doc/zmq_msg_init_data.html b/doc/zmq_msg_init_data.html index 2ee1b7e..430582c 100644 --- a/doc/zmq_msg_init_data.html +++ b/doc/zmq_msg_init_data.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_msg_init_data(3) - +
+

SYNOPSIS

typedef void (zmq_free_fn) (void *data, void *hint);

int zmq_msg_init_data (zmq_msg_t *msg, void *data, size_t size, zmq_free_fn *ffn, void *hint);

+
+

DESCRIPTION

The zmq_msg_init_data() function shall initialise the message object @@ -623,15 +642,21 @@ will be called from an arbitrary thread.

+
+

RETURN VALUE

The zmq_msg_init_data() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

No errors are defined.

+
+

EXAMPLE

@@ -652,6 +677,8 @@ rc = zmq_msg_init_data (&msg, data, 6, my_free, NULL); assert (rc == 0);
+
+

SEE ALSO

zmq_msg_init_size(3) @@ -661,17 +688,19 @@ assert (rc == 0); zmq_msg_size(3) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_msg_init_data.txt b/doc/zmq_msg_init_data.txt index 2842c10..f8b4aeb 100644 --- a/doc/zmq_msg_init_data.txt +++ b/doc/zmq_msg_init_data.txt @@ -79,5 +79,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_msg_init_size.3 b/doc/zmq_msg_init_size.3 index 4195e9b..eb49823 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_MSG_INIT_SIZE" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_MSG_INIT_SIZE" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -83,15 +83,4 @@ Insufficient storage space is available\&. \fBzmq_msg_init_data\fR(3) \fBzmq_msg_init\fR(3) \fBzmq_msg_close\fR(3) \fBzmq_msg_data\fR(3) \fBzmq_msg_size\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\&. diff --git a/doc/zmq_msg_init_size.html b/doc/zmq_msg_init_size.html index 9d5218d..4222f25 100644 --- a/doc/zmq_msg_init_size.html +++ b/doc/zmq_msg_init_size.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_msg_init_size(3) - +
+

SYNOPSIS

int zmq_msg_init_size (zmq_msg_t *msg, size_t size);

+
+

DESCRIPTION

The zmq_msg_init_size() function shall allocate any resources required to @@ -612,11 +631,15 @@ by msg to represent the newly allocated message.

+
+

RETURN VALUE

The zmq_msg_init_size() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

@@ -630,6 +653,8 @@ Insufficient storage space is available.
+
+

SEE ALSO

zmq_msg_init_data(3) @@ -639,17 +664,19 @@ Insufficient storage space is available. zmq_msg_size(3) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_msg_init_size.txt b/doc/zmq_msg_init_size.txt index 9be6263..44ef495 100644 --- a/doc/zmq_msg_init_size.txt +++ b/doc/zmq_msg_init_size.txt @@ -54,5 +54,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_msg_move.3 b/doc/zmq_msg_move.3 index 259eec9..0c6f72c 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_MSG_MOVE" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_MSG_MOVE" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -65,15 +65,4 @@ Invalid message\&. \fBzmq_msg_copy\fR(3) \fBzmq_msg_init\fR(3) \fBzmq_msg_init_size\fR(3) \fBzmq_msg_init_data\fR(3) \fBzmq_msg_close\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\&. diff --git a/doc/zmq_msg_move.html b/doc/zmq_msg_move.html index cbf6c79..1d1eb87 100644 --- a/doc/zmq_msg_move.html +++ b/doc/zmq_msg_move.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_msg_move(3) - +
+

SYNOPSIS

int zmq_msg_move (zmq_msg_t *dest, zmq_msg_t *src);

+
+

DESCRIPTION

The zmq_msg_move() function shall move the content of the message object @@ -601,11 +620,15 @@ The original content of dest, if any, shall be released.

+
+

RETURN VALUE

The zmq_msg_move() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

@@ -619,6 +642,8 @@ Invalid message.
+
+

SEE ALSO

zmq_msg_copy(3) @@ -628,17 +653,19 @@ Invalid message. zmq_msg_close(3) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_msg_move.txt b/doc/zmq_msg_move.txt index 6ab6eab..c8b8b71 100644 --- a/doc/zmq_msg_move.txt +++ b/doc/zmq_msg_move.txt @@ -48,5 +48,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_msg_size.3 b/doc/zmq_msg_size.3 index 3b0c2ac..008f763 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_MSG_SIZE" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_MSG_SIZE" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -62,15 +62,4 @@ No errors are defined\&. \fBzmq_msg_data\fR(3) \fBzmq_msg_init\fR(3) \fBzmq_msg_init_size\fR(3) \fBzmq_msg_init_data\fR(3) \fBzmq_msg_close\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\&. diff --git a/doc/zmq_msg_size.html b/doc/zmq_msg_size.html index b59c528..5368a13 100644 --- a/doc/zmq_msg_size.html +++ b/doc/zmq_msg_size.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_msg_size(3) - +
+

SYNOPSIS

size_t zmq_msg_size (zmq_msg_t *msg);

+
+

DESCRIPTION

The zmq_msg_size() function shall return the size in bytes of the content of @@ -598,15 +617,21 @@ the message object referenced by msg.

+
+

RETURN VALUE

Upon successful completion, zmq_msg_size() shall return the size of the message content in bytes.

+
+

ERRORS

No errors are defined.

+
+

SEE ALSO

zmq_msg_data(3) @@ -616,17 +641,19 @@ message content in bytes.

zmq_msg_close(3) zmq(7)

+ +

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_msg_size.txt b/doc/zmq_msg_size.txt index 354ca28..26ec840 100644 --- a/doc/zmq_msg_size.txt +++ b/doc/zmq_msg_size.txt @@ -44,5 +44,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_pgm.7 b/doc/zmq_pgm.7 index b83f9ae..0f4536d 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_PGM" "7" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_PGM" "7" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -195,15 +195,4 @@ assert (rc == 0); \fBzmq_connect\fR(3) \fBzmq_setsockopt\fR(3) \fBzmq_tcp\fR(7) \fBzmq_ipc\fR(7) \fBzmq_inproc\fR(7) \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\&. diff --git a/doc/zmq_pgm.html b/doc/zmq_pgm.html index 5dfc00d..53f80cc 100644 --- a/doc/zmq_pgm.html +++ b/doc/zmq_pgm.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_pgm(7) - +
+

SYNOPSIS

PGM (Pragmatic General Multicast) is a protocol for reliable multicast transport of data over IP networks.

+
+

DESCRIPTION

ØMQ implements two variants of PGM, the standard protocol where PGM datagrams @@ -610,6 +629,8 @@ not require any special privileges.

+
+

ADDRESSING

A ØMQ address string consists of two parts as follows: @@ -618,7 +639,8 @@ transport protocol to use. For the standard PGM protocol, transport sha set to pgm. For the "Encapsulated PGM" protocol transport shall be set to epgm. The meaning of the endpoint part for both the pgm and epgm transport is defined below.

-

Connecting a socket

+
+

Connecting a socket

When connecting a socket to a peer address using zmq_connect() with the pgm or epgm transport, the endpoint shall be interpreted as an interface followed by a semicolon, followed by a multicast address, followed by a colon @@ -651,6 +673,9 @@ names exist, thus only the primary IPv4 address may be used to specify an

A multicast address is specified by an IPv4 multicast address in its numeric representation.

+
+
+

WIRE FORMAT

Consecutive PGM datagrams are interpreted by ØMQ as a single continuous stream @@ -658,7 +683,8 @@ of data where ØMQ messages are not necessarily aligned with PGM datagram boundaries and a single ØMQ message may span several PGM datagrams. This stream of data consists of ØMQ messages encapsulated in frames as described in zmq_tcp(7).

-

PGM datagram payload

+
+

PGM datagram payload

The following ABNF grammar represents the payload of a single PGM datagram as used by ØMQ:

@@ -706,6 +732,9 @@ Third datagram payload +--------------+----------------------------+-------------+
+
+
+

EXAMPLE

@@ -723,6 +752,8 @@ rc = zmq_connect(socket, "pgm://192.168.1.1;239.192.1.1:5555"); assert (rc == 0);
+
+

SEE ALSO

zmq_connect(3) @@ -732,17 +763,19 @@ assert (rc == 0); zmq_inproc(7) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_pgm.txt b/doc/zmq_pgm.txt index 68ec504..9ce1452 100644 --- a/doc/zmq_pgm.txt +++ b/doc/zmq_pgm.txt @@ -156,7 +156,7 @@ linkzmq:zmq_ipc[7] linkzmq:zmq_inproc[7] linkzmq:zmq[7] + AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_poll.3 b/doc/zmq_poll.3 index 186dbd0..f801b5a 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_POLL" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_POLL" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -190,15 +190,4 @@ assert (rc >= 0); Your operating system documentation for the \fIpoll()\fR system call\&. .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\&. diff --git a/doc/zmq_poll.html b/doc/zmq_poll.html index c2645dd..339f441 100644 --- a/doc/zmq_poll.html +++ b/doc/zmq_poll.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_poll(3) - +
+

SYNOPSIS

int zmq_poll (zmq_pollitem_t *items, int nitems, long timeout);

+
+

DESCRIPTION

The zmq_poll() function provides a mechanism for applications to multiplex @@ -673,6 +692,8 @@ of those interfaces in ways not defined in this documentation.

+
+

RETURN VALUE

Upon successful completion, the zmq_poll() function shall return the number @@ -680,6 +701,8 @@ of zmq_pollitem_t structures with events signaled in revent events have been signaled. Upon failure, zmq_poll() shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

@@ -711,6 +734,8 @@ available.
+
+

EXAMPLE

@@ -730,6 +755,8 @@ assert (rc >= 0); /* Returned events will be stored in items[].revents */
+
+

SEE ALSO

zmq_socket(3) @@ -738,17 +765,19 @@ assert (rc >= 0); zmq(7)

Your operating system documentation for the poll() system call.

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_poll.txt b/doc/zmq_poll.txt index ee7539b..9c0fc49 100644 --- a/doc/zmq_poll.txt +++ b/doc/zmq_poll.txt @@ -128,5 +128,4 @@ Your operating system documentation for the _poll()_ system call. AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_recv.3 b/doc/zmq_recv.3 index 095a0c5..2e1cbc8 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_RECV" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_RECV" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -158,15 +158,4 @@ do { \fBzmq_send\fR(3) \fBzmq_getsockopt\fR(3) \fBzmq_socket\fR(7) \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\&. diff --git a/doc/zmq_recv.html b/doc/zmq_recv.html index b27b619..49b635d 100644 --- a/doc/zmq_recv.html +++ b/doc/zmq_recv.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_recv(3) - +
+

SYNOPSIS

int zmq_recv (void *socket, zmq_msg_t *msg, int flags);

+
+

DESCRIPTION

The zmq_recv() function shall receive a message from the socket referenced by @@ -604,7 +623,8 @@ shall fail with errno set to EAGAIN.

-

Multi-part messages

+
+

Multi-part messages

A ØMQ message is composed of 1 or more message parts; each message part is an independent zmq_msg_t in its own right. ØMQ ensures atomic delivery of messages; peers shall receive either all message parts of a message or none @@ -617,11 +637,16 @@ follow, or if the message is not composed of multiple parts, ZMQ_RCVMOREZMQ_RCVMORE shall report a value of 1, indicating that more message parts are to follow.

+
+
+

RETURN VALUE

The zmq_recv() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

@@ -687,6 +712,8 @@ The message passed to the function was invalid.
+
+

EXAMPLE

@@ -722,6 +749,8 @@ do { } while (more);
+
+

SEE ALSO

zmq_send(3) @@ -729,17 +758,19 @@ do { zmq_socket(7) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_recv.txt b/doc/zmq_recv.txt index afbcb9c..a5ef24c 100644 --- a/doc/zmq_recv.txt +++ b/doc/zmq_recv.txt @@ -117,5 +117,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_send.3 b/doc/zmq_send.3 index 3c1896d..dc5b998 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_SEND" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_SEND" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -171,15 +171,4 @@ rc = zmq_send (socket, &part3, 0); \fBzmq_recv\fR(3) \fBzmq_socket\fR(7) \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\&. diff --git a/doc/zmq_send.html b/doc/zmq_send.html index 9ba1f96..f23e439 100644 --- a/doc/zmq_send.html +++ b/doc/zmq_send.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_send(3) - +
+

SYNOPSIS

int zmq_send (void *socket, zmq_msg_t *msg, int flags);

+
+

DESCRIPTION

The zmq_send() function shall queue the message referenced by the msg @@ -624,7 +643,8 @@ message has been transmitted to the network, only that it has been queued on the socket and ØMQ has assumed responsibility for the message.

-

Multi-part messages

+
+

Multi-part messages

A ØMQ message is composed of 1 or more message parts; each message part is an independent zmq_msg_t in its own right. ØMQ ensures atomic delivery of messages; peers shall receive either all message parts of a message or none @@ -637,11 +657,16 @@ are to follow. When the application wishes to send the final message part it does so by calling zmq_send() without the ZMQ_SNDMORE flag; this indicates that no more message parts are to follow.

+
+
+

RETURN VALUE

The zmq_send() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

@@ -707,6 +732,8 @@ Invalid message.
+
+

EXAMPLE

@@ -732,23 +759,27 @@ rc = zmq_send (socket, &part2, ZMQ_SNDMORE); rc = zmq_send (socket, &part3, 0);
+
+

SEE ALSO

zmq_recv(3) zmq_socket(7) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_send.txt b/doc/zmq_send.txt index c99c123..8bd725a 100644 --- a/doc/zmq_send.txt +++ b/doc/zmq_send.txt @@ -116,5 +116,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_setsockopt.3 b/doc/zmq_setsockopt.3 index 0978a8d..6990966 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_SETSOCKOPT" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_SETSOCKOPT" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -289,6 +289,84 @@ ZMQ_SUB T} .TE .sp 1 +.SS "ZMQ_RCVTIMEO: Maximum time before a recv operation returns with EAGAIN" +.sp +Sets the timeout for receive 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 send operation returns with EAGAIN" +.sp +Sets 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_RATE: Set multicast data rate" .sp The \fIZMQ_RATE\fR option shall set the maximum send or receive data rate for multicast transports such as \fBzmq_pgm\fR(7) using the specified \fIsocket\fR\&. @@ -864,15 +942,4 @@ assert (rc); \fBzmq_getsockopt\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\&. diff --git a/doc/zmq_setsockopt.html b/doc/zmq_setsockopt.html index d3b17ca..5467997 100644 --- a/doc/zmq_setsockopt.html +++ b/doc/zmq_setsockopt.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_setsockopt(3) - +
+

SYNOPSIS

int zmq_setsockopt (void *socket, int option_name, const void *option_value, size_t option_len);

Caution: All options, with the exception of ZMQ_SUBSCRIBE, ZMQ_UNSUBSCRIBE and ZMQ_LINGER, only take effect for subsequent socket bind/connects.

+
+

DESCRIPTION

The zmq_setsockopt() function shall set the option specified by the @@ -593,7 +612,8 @@ ZMQ_LINGER, only take effect for subsequent socket bind/connects.

for the ØMQ socket pointed to by the socket argument. The option_len argument is the size of the option value in bytes.

The following socket options can be set with the zmq_setsockopt() function:

-

ZMQ_HWM: Set high water mark

+
+

ZMQ_HWM: Set high water mark

The ZMQ_HWM option shall set the high water mark for the specified socket. The high water mark is a hard limit on the maximum number of outstanding messages ØMQ shall queue in memory for any single peer that the specified @@ -650,7 +670,9 @@ all

-

ZMQ_SWAP: Set disk offload size

+
+
+

ZMQ_SWAP: Set disk offload size

The ZMQ_SWAP option shall set the disk offload (swap) size for the specified socket. A socket which has ZMQ_SWAP set to a non-zero value may exceed its high water mark; in this case outstanding messages shall be offloaded to @@ -702,7 +724,9 @@ all

-

ZMQ_AFFINITY: Set I/O thread affinity

+
+
+

ZMQ_AFFINITY: Set I/O thread affinity

The ZMQ_AFFINITY option shall set the I/O thread affinity for newly created connections on the specified socket.

Affinity determines which threads from the ØMQ I/O thread pool associated with @@ -760,7 +784,9 @@ N/A

-

ZMQ_IDENTITY: Set socket identity

+
+
+

ZMQ_IDENTITY: Set socket identity

The ZMQ_IDENTITY option shall set the identity of the specified socket. Socket identity determines if existing ØMQ infrastructure (message queues, forwarding devices) shall be identified with a specific application and @@ -818,7 +844,9 @@ all

-

ZMQ_SUBSCRIBE: Establish message filter

+
+
+

ZMQ_SUBSCRIBE: Establish message filter

The ZMQ_SUBSCRIBE option shall establish a new message filter on a ZMQ_SUB socket. Newly created ZMQ_SUB sockets shall filter out all incoming messages, therefore you should call this option to establish an initial message filter.

@@ -873,7 +901,9 @@ ZMQ_SUB
-

ZMQ_UNSUBSCRIBE: Remove message filter

+
+
+

ZMQ_UNSUBSCRIBE: Remove message filter

The ZMQ_UNSUBSCRIBE option shall remove an existing message filter on a ZMQ_SUB socket. The filter specified must match an existing filter previously established with the ZMQ_SUBSCRIBE option. If the socket has several @@ -925,7 +955,117 @@ ZMQ_SUB

-

ZMQ_RATE: Set multicast data rate

+
+
+

ZMQ_RCVTIMEO: Maximum time before a recv operation returns with EAGAIN

+

Sets the timeout for receive operation on the socket. If the value is 0, +zmq_recv(3) 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.

+
+ + + + + + + + + + + + + + + + +
+Option value type +
+		 +

+int +

+
+Option value unit +
+		 +

+milliseconds +

+
+Default value +
+		 +

+-1 (infinite) +

+
+Applicable socket types +
+		 +

+all +

+
+
+
+

ZMQ_SNDTIMEO: Maximum time before a send operation returns with EAGAIN

+

Sets the timeout for send operation on the socket. If the value is 0, +zmq_send(3) 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.

+
+ + + + + + + + + + + + + + + + +
+Option value type +
+		 +

+int +

+
+Option value unit +
+		 +

+milliseconds +

+
+Default value +
+		 +

+-1 (infinite) +

+
+Applicable socket types +
+		 +

+all +

+
+
+
+

ZMQ_RATE: Set multicast data rate

The ZMQ_RATE option shall set the maximum send or receive data rate for multicast transports such as zmq_pgm(7) using the specified socket.

@@ -974,7 +1114,9 @@ all, when using multicast transports
-

ZMQ_RECOVERY_IVL: Set multicast recovery interval

+
+
+

ZMQ_RECOVERY_IVL: Set multicast recovery interval

The ZMQ_RECOVERY_IVL option shall set the recovery interval for multicast transports using the specified socket. The recovery interval determines the maximum time in seconds that a receiver can be absent from a multicast group @@ -1035,7 +1177,9 @@ all, when using multicast transports

-

ZMQ_RECOVERY_IVL_MSEC: Set multicast recovery interval in milliseconds

+
+
+

ZMQ_RECOVERY_IVL_MSEC: Set multicast recovery interval in milliseconds

The ZMQ_RECOVERY_IVL_MSEC option shall set the recovery interval, specified in milliseconds (ms) for multicast transports using the specified socket. The recovery interval determines the maximum time in milliseconds that a @@ -1101,7 +1245,9 @@ all, when using multicast transports

-

ZMQ_MCAST_LOOP: Control multicast loop-back

+
+
+

ZMQ_MCAST_LOOP: Control multicast loop-back

The ZMQ_MCAST_LOOP option shall control whether data sent via multicast transports using the specified socket can also be received by the sending host via loop-back. A value of zero disables the loop-back functionality, while @@ -1155,7 +1301,9 @@ all, when using multicast transports

-

ZMQ_SNDBUF: Set kernel transmit buffer size

+
+
+

ZMQ_SNDBUF: Set kernel transmit buffer size

The ZMQ_SNDBUF option shall set the underlying kernel transmit buffer size for the socket to the specified size in bytes. A value of zero means leave the OS default unchanged. For details please refer to your operating system @@ -1206,7 +1354,9 @@ all

-

ZMQ_RCVBUF: Set kernel receive buffer size

+
+
+

ZMQ_RCVBUF: Set kernel receive buffer size

The ZMQ_RCVBUF option shall set the underlying kernel receive buffer size for the socket to the specified size in bytes. A value of zero means leave the OS default unchanged. For details refer to your operating system documentation @@ -1257,7 +1407,9 @@ all

-

ZMQ_LINGER: Set linger period for socket shutdown

+
+
+

ZMQ_LINGER: Set linger period for socket shutdown

The ZMQ_LINGER option shall set the linger period for the specified socket. The linger period determines how long pending messages which have yet to be sent to a peer shall linger in memory after a socket is closed with @@ -1335,7 +1487,9 @@ all

-

ZMQ_RECONNECT_IVL: Set reconnection interval

+
+
+

ZMQ_RECONNECT_IVL: Set reconnection interval

The ZMQ_RECONNECT_IVL option shall set the initial reconnection interval for the specified socket. The reconnection interval is the period ØMQ shall wait between attempts to reconnect disconnected peers when using @@ -1395,7 +1549,9 @@ all, only for connection-oriented transports

-

ZMQ_RECONNECT_IVL_MAX: Set maximum reconnection interval

+
+
+

ZMQ_RECONNECT_IVL_MAX: Set maximum reconnection interval

The ZMQ_RECONNECT_IVL_MAX option shall set the maximum reconnection interval for the specified socket. This is the maximum period ØMQ shall wait between attempts to reconnect. On each reconnect attempt, the previous interval shall be @@ -1456,7 +1612,9 @@ all, only for connection-oriented transports

-

ZMQ_BACKLOG: Set maximum length of the queue of outstanding connections

+
+
+

ZMQ_BACKLOG: Set maximum length of the queue of outstanding connections

The ZMQ_BACKLOG option shall set the maximum length of the queue of outstanding peer connections for the specified socket; this only applies to connection-oriented transports. For details refer to your operating system @@ -1508,11 +1666,16 @@ all, only for connection-oriented transports.

+ + +

RETURN VALUE

The zmq_setsockopt() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

@@ -1551,6 +1714,8 @@ The operation was interrupted by delivery of a signal.
+
+

EXAMPLE

@@ -1580,23 +1745,27 @@ rc = zmq_bind (socket, "tcp://lo:5556"); assert (rc);
+ +

SEE ALSO

zmq_getsockopt(3) zmq_socket(3) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index 5911b7f..070c977 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -143,6 +143,38 @@ Default value:: N/A Applicable socket types:: ZMQ_SUB +ZMQ_RCVTIMEO: Maximum time before a recv operation returns with EAGAIN +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sets the timeout for receive operation on the socket. If the value is `0`, +_zmq_recv(3)_ 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. + +[horizontal] +Option value type:: int +Option value unit:: milliseconds +Default value:: -1 (infinite) +Applicable socket types:: all + + +ZMQ_SNDTIMEO: Maximum time before a send operation returns with EAGAIN +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sets the timeout for send operation on the socket. If the value is `0`, +_zmq_send(3)_ 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. + +[horizontal] +Option value type:: int +Option value unit:: milliseconds +Default value:: -1 (infinite) +Applicable socket types:: all + + ZMQ_RATE: Set multicast data rate ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The 'ZMQ_RATE' option shall set the maximum send or receive data rate for @@ -378,5 +410,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_socket.3 b/doc/zmq_socket.3 index 6b5e23b..91d8996 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.11 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_SOCKET" "3" "11/22/2011" "0MQ 2\&.1\&.11" "0MQ Manual" +.TH "ZMQ_SOCKET" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -765,15 +765,4 @@ The context specified was terminated\&. \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_inproc\fR(7) \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\&. diff --git a/doc/zmq_socket.html b/doc/zmq_socket.html index 05c5ab7..d8d44ec 100644 --- a/doc/zmq_socket.html +++ b/doc/zmq_socket.html @@ -1462,16 +1462,15 @@ The context specified was terminated.

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

diff --git a/doc/zmq_socket.txt b/doc/zmq_socket.txt index ebd2151..420fdad 100644 --- a/doc/zmq_socket.txt +++ b/doc/zmq_socket.txt @@ -338,5 +338,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_strerror.3 b/doc/zmq_strerror.3 index 2a5b33a..dcac43a 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_STRERROR" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_STRERROR" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -64,15 +64,4 @@ if (!ctx) { \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\&. diff --git a/doc/zmq_strerror.html b/doc/zmq_strerror.html index 7e01d4e..33377ed 100644 --- a/doc/zmq_strerror.html +++ b/doc/zmq_strerror.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_strerror(3) - +
+

SYNOPSIS

const char *zmq_strerror (int errnum);

+
+

DESCRIPTION

The zmq_strerror() function shall return a pointer to an error message string @@ -592,15 +611,21 @@ defines additional error numbers over and above those defined by the operating system, applications should use zmq_strerror() in preference to the standard strerror() function.

+
+

RETURN VALUE

The zmq_strerror() function shall return a pointer to an error message string.

+
+

ERRORS

No errors are defined.

+
+

EXAMPLE

@@ -613,21 +638,25 @@ if (!ctx) { }
+
+

SEE ALSO

zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_strerror.txt b/doc/zmq_strerror.txt index 2cd9829..95623a5 100644 --- a/doc/zmq_strerror.txt +++ b/doc/zmq_strerror.txt @@ -51,5 +51,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_tcp.7 b/doc/zmq_tcp.7 index b1f6ae7..aa1c931 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_TCP" "7" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_TCP" "7" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -230,15 +230,4 @@ assert (rc == 0); \fBzmq_bind\fR(3) \fBzmq_connect\fR(3) \fBzmq_pgm\fR(7) \fBzmq_ipc\fR(7) \fBzmq_inproc\fR(7) \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\&. diff --git a/doc/zmq_tcp.html b/doc/zmq_tcp.html index cf5b7ed..03680ae 100644 --- a/doc/zmq_tcp.html +++ b/doc/zmq_tcp.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_tcp(7) - +
+

SYNOPSIS

TCP is an ubiquitous, reliable, unicast transport. When connecting distributed applications over a network with ØMQ, using the TCP transport will likely be your first choice.

+
+

ADDRESSING

A ØMQ address string consists of two parts as follows: transport://endpoint. The transport part specifies the underlying transport protocol to use, and for the TCP transport shall be set to tcp. The meaning of the endpoint part for the TCP transport is defined below.

-

Assigning a local address to a socket

+
+

Assigning a local address to a socket

When assigning a local address to a socket using zmq_bind() with the tcp transport, the endpoint shall be interpreted as an interface followed by a colon and the TCP port number to use.

@@ -626,7 +646,9 @@ names exist, thus only the primary IPv4 address may be used to specify an interface.
-

Connecting a socket

+
+
+

Connecting a socket

When connecting a socket to a peer address using zmq_connect() with the tcp transport, the endpoint shall be interpreted as a peer address followed by a colon and the TCP port number to use.

@@ -644,6 +666,9 @@ The IPv4 address of the peer, in its numeric representation.
+
+ +

WIRE FORMAT

ØMQ messages are transmitted over TCP in frames consisting of an encoded @@ -703,6 +728,8 @@ exceeding 254 octets:

+-+-+-+-+-+-+-+ ...
+ +

EXAMPLES

@@ -729,6 +756,8 @@ rc = zmq_connect(socket, "tcp://server1:5555"); assert (rc == 0);
+ +

SEE ALSO

zmq_bind(3) @@ -738,17 +767,19 @@ assert (rc == 0); zmq_inproc(7) zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_tcp.txt b/doc/zmq_tcp.txt index 0117ccf..1d4a41e 100644 --- a/doc/zmq_tcp.txt +++ b/doc/zmq_tcp.txt @@ -158,5 +158,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_term.3 b/doc/zmq_term.3 index d68b100..6c5db93 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_TERM" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_TERM" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -121,15 +121,4 @@ Termination was interrupted by a signal\&. It can be restarted if needed\&. \fBzmq\fR(7) \fBzmq_init\fR(3) \fBzmq_close\fR(3) \fBzmq_setsockopt\fR(3) .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\&. diff --git a/doc/zmq_term.html b/doc/zmq_term.html index 6f6ecf1..6f50334 100644 --- a/doc/zmq_term.html +++ b/doc/zmq_term.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_term(3) - +
+

SYNOPSIS

int zmq_term (void *context);

+
+

DESCRIPTION

The zmq_term() function shall terminate the ØMQ context context.

@@ -622,11 +641,15 @@ For each socket within context, all messages sent by the application

For further details regarding socket linger behaviour refer to the ZMQ_LINGER option in zmq_setsockopt(3).

+
+

RETURN VALUE

The zmq_term() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

+
+

ERRORS

@@ -648,6 +671,8 @@ Termination was interrupted by a signal. It can be restarted if needed.
+
+

SEE ALSO

zmq(7) @@ -655,17 +680,19 @@ Termination was interrupted by a signal. It can be restarted if needed. zmq_close(3) zmq_setsockopt(3)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_term.txt b/doc/zmq_term.txt index 577de3d..09cb201 100644 --- a/doc/zmq_term.txt +++ b/doc/zmq_term.txt @@ -61,5 +61,4 @@ linkzmq:zmq_setsockopt[3] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_version.3 b/doc/zmq_version.3 index 3ac6390..bd0d0fc 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: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_VERSION" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_VERSION" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -64,15 +64,4 @@ printf ("Current 0MQ version is %d\&.%d\&.%d\en", major, minor, patch); \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\&. diff --git a/doc/zmq_version.html b/doc/zmq_version.html index a1c0047..65b94df 100644 --- a/doc/zmq_version.html +++ b/doc/zmq_version.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_version(3) - +
+

SYNOPSIS

void zmq_version (int *major, int *minor, int *patch);

+
+

DESCRIPTION

The zmq_version() function shall fill in the integer variables pointed to by @@ -593,14 +612,20 @@ components of the ØMQ library version.

dynamically linking to the ØMQ library that wish to determine the actual version of the ØMQ library they are using.

+
+

RETURN VALUE

There is no return value.

+
+

ERRORS

No errors are defined.

+
+

EXAMPLE

@@ -611,21 +636,25 @@ zmq_version (&major, &minor, &patch); printf ("Current 0MQ version is %d.%d.%d\n", major, minor, patch);
+ +

SEE ALSO

zmq(7)

+
+

AUTHORS

-

This ØMQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and -Martin Lucina <mato@kotelna.sk>.

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_version.txt b/doc/zmq_version.txt index eeb0b40..0a89c01 100644 --- a/doc/zmq_version.txt +++ b/doc/zmq_version.txt @@ -47,7 +47,7 @@ SEE ALSO -------- linkzmq:zmq[7] + AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. -- cgit v1.2.3