From 75af6aed482ab16997c1388fe801f74d11ec12a4 Mon Sep 17 00:00:00 2001 From: Martin Lucina Date: Mon, 23 Jan 2012 08:54:14 +0100 Subject: Imported Upstream version 2.1.9 --- doc/zmq.7 | 6 +- doc/zmq.html | 158 ++++++++++++++++-------------- doc/zmq_bind.3 | 11 ++- doc/zmq_bind.html | 132 ++++++++++++------------- doc/zmq_bind.txt | 2 + doc/zmq_close.3 | 6 +- doc/zmq_close.html | 122 +++++++++++------------ doc/zmq_connect.3 | 11 ++- doc/zmq_connect.html | 132 ++++++++++++------------- doc/zmq_connect.txt | 2 + doc/zmq_cpp.7 | 6 +- doc/zmq_cpp.html | 236 ++++++++++++++++++++++++--------------------- doc/zmq_device.3 | 6 +- doc/zmq_device.html | 132 ++++++++++++------------- doc/zmq_epgm.7 | 10 +- doc/zmq_epgm.html | 136 +++++++++++++------------- doc/zmq_epgm.txt | 4 +- doc/zmq_errno.3 | 6 +- doc/zmq_errno.html | 122 +++++++++++------------ doc/zmq_getsockopt.3 | 8 +- doc/zmq_getsockopt.html | 198 +++++++++++++++++++++---------------- doc/zmq_getsockopt.txt | 2 +- doc/zmq_init.3 | 6 +- doc/zmq_init.html | 122 +++++++++++------------ doc/zmq_inproc.7 | 6 +- doc/zmq_inproc.html | 130 ++++++++++++------------- doc/zmq_ipc.7 | 6 +- doc/zmq_ipc.html | 130 ++++++++++++------------- doc/zmq_msg_close.3 | 6 +- doc/zmq_msg_close.html | 120 +++++++++++------------ doc/zmq_msg_copy.3 | 6 +- doc/zmq_msg_copy.html | 120 +++++++++++------------ doc/zmq_msg_data.3 | 6 +- doc/zmq_msg_data.html | 122 +++++++++++------------ doc/zmq_msg_init.3 | 6 +- doc/zmq_msg_init.html | 124 ++++++++++++------------ doc/zmq_msg_init_data.3 | 6 +- doc/zmq_msg_init_data.html | 124 ++++++++++++------------ doc/zmq_msg_init_size.3 | 6 +- doc/zmq_msg_init_size.html | 122 +++++++++++------------ doc/zmq_msg_move.3 | 6 +- doc/zmq_msg_move.html | 120 +++++++++++------------ doc/zmq_msg_size.3 | 8 +- doc/zmq_msg_size.html | 124 +++++++++++------------- doc/zmq_msg_size.txt | 2 +- doc/zmq_pgm.7 | 10 +- doc/zmq_pgm.html | 136 +++++++++++++------------- doc/zmq_pgm.txt | 4 +- doc/zmq_poll.3 | 6 +- doc/zmq_poll.html | 124 ++++++++++++------------ doc/zmq_recv.3 | 6 +- doc/zmq_recv.html | 128 ++++++++++++------------ doc/zmq_send.3 | 6 +- doc/zmq_send.html | 128 ++++++++++++------------ doc/zmq_setsockopt.3 | 8 +- doc/zmq_setsockopt.html | 190 ++++++++++++++++++++---------------- doc/zmq_setsockopt.txt | 2 +- doc/zmq_socket.3 | 10 +- doc/zmq_socket.html | 160 ++++++++++++++++-------------- doc/zmq_socket.txt | 4 +- doc/zmq_strerror.3 | 6 +- doc/zmq_strerror.html | 124 ++++++++++++------------ doc/zmq_tcp.7 | 8 +- doc/zmq_tcp.html | 132 ++++++++++++------------- doc/zmq_tcp.txt | 2 +- doc/zmq_term.3 | 6 +- doc/zmq_term.html | 122 +++++++++++------------ doc/zmq_version.3 | 6 +- doc/zmq_version.html | 124 ++++++++++++------------ 69 files changed, 2160 insertions(+), 2168 deletions(-) (limited to 'doc') diff --git a/doc/zmq.7 b/doc/zmq.7 index 60394d0..07ec236 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ" "7" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ" "7" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq.html b/doc/zmq.html index b35c57e..bce168f 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 +579,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 +602,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 +613,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 +667,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 +723,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 +764,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 +789,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 +805,8 @@ Report ØMQ library version
+
+

LANGUAGE BINDINGS

The ØMQ library provides interfaces suitable for calling from programs in any @@ -811,23 +814,33 @@ 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>.

+
+

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 +848,12 @@ Public License (LGPL). For details see the files COPYING and COPYIN included with the ØMQ distribution.

+
diff --git a/doc/zmq_bind.3 b/doc/zmq_bind.3 index ce589e9..997f7a0 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: 05/07/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_BIND" "3" "05/07/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_BIND" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -70,6 +70,11 @@ With the exception of \fIZMQ_PAIR\fR sockets, a single socket may be connected t The \fIzmq_bind()\fR function shall return zero if successful\&. Otherwise it shall return \-1 and set \fIerrno\fR to one of the values defined below\&. .SH "ERRORS" .PP +\fBEINVAL\fR +.RS 4 +The endpoint supplied is invalid\&. +.RE +.PP \fBEPROTONOSUPPORT\fR .RS 4 The requested diff --git a/doc/zmq_bind.html b/doc/zmq_bind.html index 034113d..ef04708 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,15 +616,27 @@ 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

+EINVAL +
+
+

+The endpoint supplied is invalid. +

+
+
EPROTONOSUPPORT
@@ -707,6 +702,8 @@ No I/O thread is available to accomplish the task.
+
+

EXAMPLE

@@ -723,23 +720,28 @@ 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>.

+
diff --git a/doc/zmq_bind.txt b/doc/zmq_bind.txt index 06fd79c..1d7c2ff 100644 --- a/doc/zmq_bind.txt +++ b/doc/zmq_bind.txt @@ -44,6 +44,8 @@ return `-1` and set 'errno' to one of the values defined below. ERRORS ------ +*EINVAL*:: +The endpoint supplied is invalid. *EPROTONOSUPPORT*:: The requested 'transport' protocol is not supported. *ENOCOMPATPROTO*:: diff --git a/doc/zmq_close.3 b/doc/zmq_close.3 index 86e5666..82a3cc8 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: 05/07/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_CLOSE" "3" "05/07/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_CLOSE" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_close.html b/doc/zmq_close.html index 015030a..bca12dc 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 +586,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 +608,8 @@ The provided socket was invalid.
+
+

SEE ALSO

zmq_socket(3) @@ -628,17 +617,20 @@ 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>.

+
diff --git a/doc/zmq_connect.3 b/doc/zmq_connect.3 index 1adc6af..4f50086 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: 05/07/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_CONNECT" "3" "05/07/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_CONNECT" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -86,6 +86,11 @@ The connection will not be performed immediately but as needed by 0MQ\&. Thus a The \fIzmq_connect()\fR function shall return zero if successful\&. Otherwise it shall return \-1 and set \fIerrno\fR to one of the values defined below\&. .SH "ERRORS" .PP +\fBEINVAL\fR +.RS 4 +The endpoint supplied is invalid\&. +.RE +.PP \fBEPROTONOSUPPORT\fR .RS 4 The requested diff --git a/doc/zmq_connect.html b/doc/zmq_connect.html index b67ced9..52c0ad3 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,15 +626,27 @@ 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

+EINVAL +
+
+

+The endpoint supplied is invalid. +

+
+
EPROTONOSUPPORT
@@ -693,6 +688,8 @@ No I/O thread is available to accomplish the task.
+
+

EXAMPLE

@@ -709,23 +706,28 @@ 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>.

+
diff --git a/doc/zmq_connect.txt b/doc/zmq_connect.txt index 1c69631..6ec56b0 100644 --- a/doc/zmq_connect.txt +++ b/doc/zmq_connect.txt @@ -48,6 +48,8 @@ shall return `-1` and set 'errno' to one of the values defined below. ERRORS ------ +*EINVAL*:: +The endpoint supplied is invalid. *EPROTONOSUPPORT*:: The requested 'transport' protocol is not supported. *ENOCOMPATPROTO*:: diff --git a/doc/zmq_cpp.7 b/doc/zmq_cpp.7 index 835da89..72c2f97 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_CPP" "7" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_CPP" "7" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_cpp.html b/doc/zmq_cpp.html index 31aea45..6b31c9f 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 +575,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 +733,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 +743,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 +757,26 @@ 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>.

+
diff --git a/doc/zmq_device.3 b/doc/zmq_device.3 index eb6d4c4..7888546 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_DEVICE" "3" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_DEVICE" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_device.html b/doc/zmq_device.html index 21a2fbc..f5ea972 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 +629,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 +643,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 +656,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 +669,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 +695,8 @@ assert (zmq_bind (backend, "tcp://*:5556") == 0); zmq_device (ZMQ_QUEUE, frontend, backend);
+
+

SEE ALSO

zmq_bind(3) @@ -709,15 +704,21 @@ 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

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 @@ -725,11 +726,12 @@ Public License (LGPL). For details see the files COPYING and COPYIN included with the ØMQ distribution.

+
diff --git a/doc/zmq_epgm.7 b/doc/zmq_epgm.7 index 8ee8ef3..66250f5 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_PGM" "7" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_PGM" "7" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -83,7 +83,7 @@ The interface name as defined by the operating system\&. .sp -1 .IP \(bu 2.3 .\} -The primary IPv4 address assigned to the interface, in it\(cqs numeric representation\&. +The primary IPv4 address assigned to the interface, in its numeric representation\&. .RE .if n \{\ .sp @@ -102,7 +102,7 @@ Interface names are not standardised in any way and should be assumed to be arbi .sp .5v .RE .sp -A \fImulticast address\fR is specified by an IPv4 multicast address in it\(cqs numeric representation\&. +A \fImulticast address\fR is specified by an IPv4 multicast address in its numeric representation\&. .SH "WIRE FORMAT" .sp Consecutive PGM datagrams are interpreted by 0MQ as a single continuous stream of data where 0MQ messages are not necessarily aligned with PGM datagram boundaries and a single 0MQ message may span several PGM datagrams\&. This stream of data consists of 0MQ messages encapsulated in \fIframes\fR as described in \fBzmq_tcp\fR(7)\&. diff --git a/doc/zmq_epgm.html b/doc/zmq_epgm.html index 9383d71..64e3e75 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 +593,8 @@ not require any special privileges.

+
+

ADDRESSING

A ØMQ address string consists of two parts as follows: @@ -618,7 +603,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 @@ -632,7 +618,7 @@ The interface name as defined by the operating system.

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

    • @@ -648,9 +634,12 @@ names exist, thus only the primary IPv4 address may be used to specify an interface.
    -

    A multicast address is specified by an IPv4 multicast address in it’s numeric +

    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 +647,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 +696,9 @@ Third datagram payload +--------------+----------------------------+-------------+
    +
    +
    +

    EXAMPLE

    @@ -723,6 +716,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 +727,20 @@ 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>.

    +
    diff --git a/doc/zmq_epgm.txt b/doc/zmq_epgm.txt index 9a48afd..68ec504 100644 --- a/doc/zmq_epgm.txt +++ b/doc/zmq_epgm.txt @@ -55,7 +55,7 @@ and a port number. An 'interface' may be specified by either of the following: * The interface name as defined by the operating system. -* The primary IPv4 address assigned to the interface, in it's numeric +* The primary IPv4 address assigned to the interface, in its numeric representation. NOTE: Interface names are not standardised in any way and should be assumed to @@ -63,7 +63,7 @@ be arbitrary and platform dependent. On Win32 platforms no short interface names exist, thus only the primary IPv4 address may be used to specify an 'interface'. -A 'multicast address' is specified by an IPv4 multicast address in it's numeric +A 'multicast address' is specified by an IPv4 multicast address in its numeric representation. diff --git a/doc/zmq_errno.3 b/doc/zmq_errno.3 index 3eeeab8..fd3694c 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_ERRNO" "3" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_ERRNO" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_errno.html b/doc/zmq_errno.html index b84c35b..ee4d04b 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 +587,39 @@ 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>.

    +
    diff --git a/doc/zmq_getsockopt.3 b/doc/zmq_getsockopt.3 index c744803..c11b5f0 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: 05/07/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_GETSOCKOPT" "3" "05/07/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_GETSOCKOPT" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -162,7 +162,7 @@ T} .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 it\(cqs high water mark; in this case outstanding messages shall be offloaded to storage on disk rather than held in memory\&. +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\&. .sp The value of \fIZMQ_SWAP\fR defines the maximum size of the swap space in bytes\&. .TS diff --git a/doc/zmq_getsockopt.html b/doc/zmq_getsockopt.html index 3c0b0e4..e77e2e1 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 +577,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 +628,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 +684,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,10 +743,12 @@ all

    -

    ZMQ_SWAP: Retrieve disk offload size

    +
    +
    +

    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 it’s high water mark; in this case outstanding messages shall be +exceed its high water mark; in this case outstanding messages shall be offloaded to storage on disk rather than held in memory.

    The value of ZMQ_SWAP defines the maximum size of the swap space in bytes.

    @@ -807,7 +797,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 +857,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 +917,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 +968,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 +1021,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 +1079,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 +1135,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 +1188,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 +1241,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 +1321,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 +1383,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 +1446,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 +1499,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 +1574,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 +1651,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 +1701,8 @@ The operation was interrupted by delivery of a signal.
    +
    +

    EXAMPLE

    @@ -1690,23 +1715,28 @@ 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>.

    +
    diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index e211d83..1e075d7 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -83,7 +83,7 @@ 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 it's high water mark; in this case outstanding messages shall be +exceed its high water mark; in this case outstanding messages shall be offloaded to storage on disk rather than held in memory. The value of 'ZMQ_SWAP' defines the maximum size of the swap space in bytes. diff --git a/doc/zmq_init.3 b/doc/zmq_init.3 index ea2d43f..13a1686 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_INIT" "3" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_INIT" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_init.html b/doc/zmq_init.html index 17f2614..7629e0a 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 +577,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 +600,27 @@ 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>.

    +
    diff --git a/doc/zmq_inproc.7 b/doc/zmq_inproc.7 index aedbed4..a0d6a5d 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_INPROC" "7" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_INPROC" "7" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_inproc.html b/doc/zmq_inproc.html index 6bc6959..a46d127 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 +577,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 +586,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 +634,8 @@ rc = zmq_connect(socket, "inproc://my-endpoint"); assert (rc == 0);
    +
    +

    SEE ALSO

    zmq_bind(3) @@ -652,17 +645,20 @@ 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>.

    +
    diff --git a/doc/zmq_ipc.7 b/doc/zmq_ipc.7 index 4aaeffa..0e19c95 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_IPC" "7" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_IPC" "7" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_ipc.html b/doc/zmq_ipc.html index f07b58a..3a4a88c 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 +575,8 @@ systems that provide UNIX domain sockets.

    +
    +

    ADDRESSING

    A ØMQ address string consists of two parts as follows: @@ -601,24 +584,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 +627,8 @@ rc = zmq_connect(socket, "ipc:///tmp/feeds/0"); assert (rc == 0);
    +
    +

    SEE ALSO

    zmq_bind(3) @@ -645,17 +638,20 @@ 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>.

    +
    diff --git a/doc/zmq_msg_close.3 b/doc/zmq_msg_close.3 index 1aa60c6..99efcab 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_MSG_CLOSE" "3" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_MSG_CLOSE" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_msg_close.html b/doc/zmq_msg_close.html index caa7741..8fd8d1b 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 +586,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 +608,8 @@ Invalid message.
    +
    +

    SEE ALSO

    zmq_msg_init(3) @@ -630,16 +619,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>.

    +
    diff --git a/doc/zmq_msg_copy.3 b/doc/zmq_msg_copy.3 index e820f14..22e669a 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_MSG_COPY" "3" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_MSG_COPY" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_msg_copy.html b/doc/zmq_msg_copy.html index d492905..6098a48 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 +595,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 +617,8 @@ Invalid message.
    +
    +

    SEE ALSO

    zmq_msg_move(3) @@ -639,16 +628,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>.

    +
    diff --git a/doc/zmq_msg_data.3 b/doc/zmq_msg_data.3 index 74d4943..b623cb6 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_MSG_DATA" "3" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_MSG_DATA" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_msg_data.html b/doc/zmq_msg_data.html index dbce1bc..3e06bd6 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 +581,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 +605,20 @@ 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>.

    +
    diff --git a/doc/zmq_msg_init.3 b/doc/zmq_msg_init.3 index 13c3e23..94e7f4a 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_MSG_INIT" "3" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_MSG_INIT" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_msg_init.html b/doc/zmq_msg_init.html index 227b6df..5ecfe77 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 +592,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 +619,8 @@ rc = zmq_recv (socket, &msg, 0); assert (rc == 0);
    + +

    SEE ALSO

    zmq_msg_init_size(3) @@ -639,17 +630,20 @@ 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>.

    +
    diff --git a/doc/zmq_msg_init_data.3 b/doc/zmq_msg_init_data.3 index 91aea9c..2dcad31 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_MSG_INIT_DATA" "3" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_MSG_INIT_DATA" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_msg_init_data.html b/doc/zmq_msg_init_data.html index aebd2a7..aa6d1c5 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 +606,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 +641,8 @@ rc = zmq_msg_init_data (&msg, data, 6, my_free, NULL); assert (rc == 0);
    +
    +

    SEE ALSO

    zmq_msg_init_size(3) @@ -661,17 +652,20 @@ 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>.

    +
    diff --git a/doc/zmq_msg_init_size.3 b/doc/zmq_msg_init_size.3 index 5a77611..31c37c4 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_MSG_INIT_SIZE" "3" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_MSG_INIT_SIZE" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_msg_init_size.html b/doc/zmq_msg_init_size.html index 706788f..34c62cc 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 +595,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 +617,8 @@ Insufficient storage space is available.
    +
    +

    SEE ALSO

    zmq_msg_init_data(3) @@ -639,17 +628,20 @@ 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>.

    +
    diff --git a/doc/zmq_msg_move.3 b/doc/zmq_msg_move.3 index 4c90bec..2f4573b 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_MSG_MOVE" "3" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_MSG_MOVE" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_msg_move.html b/doc/zmq_msg_move.html index ed36938..63baceb 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 +584,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 +606,8 @@ Invalid message.
    +
    +

    SEE ALSO

    zmq_msg_copy(3) @@ -628,16 +617,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>.

    +
    diff --git a/doc/zmq_msg_size.3 b/doc/zmq_msg_size.3 index e295722..e7557c1 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_MSG_SIZE" "3" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_MSG_SIZE" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -53,7 +53,7 @@ Never access \fIzmq_msg_t\fR members directly, instead always use the \fIzmq_msg .RE .SH "RETURN VALUE" .sp -Upon successful completion, \fIzmq_msg_data()\fR shall return the size of the message content in bytes\&. +Upon successful completion, \fIzmq_msg_size()\fR shall return the size of the message content in bytes\&. .SH "ERRORS" .sp No errors are defined\&. diff --git a/doc/zmq_msg_size.html b/doc/zmq_msg_size.html index 068232d..b498438 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 +581,21 @@ the message object referenced by msg.

    +
    +

    RETURN VALUE

    -

    Upon successful completion, zmq_msg_data() shall return the size of the +

    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 +605,20 @@ 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>.

    +
    diff --git a/doc/zmq_msg_size.txt b/doc/zmq_msg_size.txt index dd11235..354ca28 100644 --- a/doc/zmq_msg_size.txt +++ b/doc/zmq_msg_size.txt @@ -23,7 +23,7 @@ _zmq_msg_ family of functions. RETURN VALUE ------------ -Upon successful completion, _zmq_msg_data()_ shall return the size of the +Upon successful completion, _zmq_msg_size()_ shall return the size of the message content in bytes. diff --git a/doc/zmq_pgm.7 b/doc/zmq_pgm.7 index 8ee8ef3..66250f5 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_PGM" "7" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_PGM" "7" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -83,7 +83,7 @@ The interface name as defined by the operating system\&. .sp -1 .IP \(bu 2.3 .\} -The primary IPv4 address assigned to the interface, in it\(cqs numeric representation\&. +The primary IPv4 address assigned to the interface, in its numeric representation\&. .RE .if n \{\ .sp @@ -102,7 +102,7 @@ Interface names are not standardised in any way and should be assumed to be arbi .sp .5v .RE .sp -A \fImulticast address\fR is specified by an IPv4 multicast address in it\(cqs numeric representation\&. +A \fImulticast address\fR is specified by an IPv4 multicast address in its numeric representation\&. .SH "WIRE FORMAT" .sp Consecutive PGM datagrams are interpreted by 0MQ as a single continuous stream of data where 0MQ messages are not necessarily aligned with PGM datagram boundaries and a single 0MQ message may span several PGM datagrams\&. This stream of data consists of 0MQ messages encapsulated in \fIframes\fR as described in \fBzmq_tcp\fR(7)\&. diff --git a/doc/zmq_pgm.html b/doc/zmq_pgm.html index 9383d71..64e3e75 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 +593,8 @@ not require any special privileges.

    +
    +

    ADDRESSING

    A ØMQ address string consists of two parts as follows: @@ -618,7 +603,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 @@ -632,7 +618,7 @@ The interface name as defined by the operating system.

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

    • @@ -648,9 +634,12 @@ names exist, thus only the primary IPv4 address may be used to specify an interface.
    -

    A multicast address is specified by an IPv4 multicast address in it’s numeric +

    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 +647,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 +696,9 @@ Third datagram payload +--------------+----------------------------+-------------+
    +
    +
    +

    EXAMPLE

    @@ -723,6 +716,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 +727,20 @@ 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>.

    +
    diff --git a/doc/zmq_pgm.txt b/doc/zmq_pgm.txt index 9a48afd..68ec504 100644 --- a/doc/zmq_pgm.txt +++ b/doc/zmq_pgm.txt @@ -55,7 +55,7 @@ and a port number. An 'interface' may be specified by either of the following: * The interface name as defined by the operating system. -* The primary IPv4 address assigned to the interface, in it's numeric +* The primary IPv4 address assigned to the interface, in its numeric representation. NOTE: Interface names are not standardised in any way and should be assumed to @@ -63,7 +63,7 @@ be arbitrary and platform dependent. On Win32 platforms no short interface names exist, thus only the primary IPv4 address may be used to specify an 'interface'. -A 'multicast address' is specified by an IPv4 multicast address in it's numeric +A 'multicast address' is specified by an IPv4 multicast address in its numeric representation. diff --git a/doc/zmq_poll.3 b/doc/zmq_poll.3 index f66aa94..38d76be 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: 05/07/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_POLL" "3" "05/07/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_POLL" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_poll.html b/doc/zmq_poll.html index ffbcbc0..eb1c214 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 +656,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 +665,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 +698,8 @@ available.
    +
    +

    EXAMPLE

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

    SEE ALSO

    zmq_socket(3) @@ -738,17 +729,20 @@ 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>.

    +
    diff --git a/doc/zmq_recv.3 b/doc/zmq_recv.3 index 0df4e82..6ea3446 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: 05/07/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_RECV" "3" "05/07/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_RECV" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_recv.html b/doc/zmq_recv.html index db436f0..6fa3751 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 +587,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 +601,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 +676,8 @@ The message passed to the function was invalid.
    +
    +

    EXAMPLE

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

    SEE ALSO

    zmq_send(3) @@ -729,17 +722,20 @@ 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>.

    +
    diff --git a/doc/zmq_send.3 b/doc/zmq_send.3 index ade1b3c..3c8ce2e 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: 05/07/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_SEND" "3" "05/07/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_SEND" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_send.html b/doc/zmq_send.html index 0e17363..559eb38 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 +607,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 +621,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 +696,8 @@ Invalid message.
    +
    +

    EXAMPLE

    @@ -732,23 +723,28 @@ 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>.

    +
    diff --git a/doc/zmq_setsockopt.3 b/doc/zmq_setsockopt.3 index 16e64b1..c700d41 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: 05/07/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_SETSOCKOPT" "3" "05/07/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_SETSOCKOPT" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -84,7 +84,7 @@ T} .sp 1 .SS "ZMQ_SWAP: Set disk offload size" .sp -The \fIZMQ_SWAP\fR option shall set 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 it\(cqs high water mark; in this case outstanding messages shall be offloaded to storage on disk rather than held in memory\&. +The \fIZMQ_SWAP\fR option shall set 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\&. .sp The value of \fIZMQ_SWAP\fR defines the maximum size of the swap space in bytes\&. .TS diff --git a/doc/zmq_setsockopt.html b/doc/zmq_setsockopt.html index de672eb..6686dc3 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 +576,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,9 +634,11 @@ 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 it’s +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 storage on disk rather than held in memory.

    The value of ZMQ_SWAP defines the maximum size of the swap space in bytes.

    @@ -702,7 +688,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 +748,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 +808,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 +865,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 +919,9 @@ ZMQ_SUB

    -

    ZMQ_RATE: Set multicast data rate

    +
    +
    +

    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 +970,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 +1033,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 +1101,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 +1157,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 +1210,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 +1263,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 +1343,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 +1405,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 +1468,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 +1522,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 +1570,8 @@ The operation was interrupted by delivery of a signal.
    +
    +

    EXAMPLE

    @@ -1580,23 +1601,28 @@ 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>.

    +
    diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index 4a43d65..5911b7f 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -50,7 +50,7 @@ Applicable socket types:: all 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 it's +'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 storage on disk rather than held in memory. diff --git a/doc/zmq_socket.3 b/doc/zmq_socket.3 index 7fc7d1c..a7254e4 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_SOCKET" "3" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_SOCKET" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -237,7 +237,7 @@ T{ Compatible peer sockets T}:T{ .sp -\fIZMQ_ROUTER\fR, \fIZMQ_REP\fR +\fIZMQ_ROUTER\fR, \fIZMQ_REQ\fR, \fIZMQ_REP\fR T} T{ .sp @@ -312,7 +312,7 @@ T{ Compatible peer sockets T}:T{ .sp -\fIZMQ_DEALER\fR, \fIZMQ_REQ\fR +\fIZMQ_DEALER\fR, \fIZMQ_REQ\fR, \fIZMQ_REP\fR T} T{ .sp diff --git a/doc/zmq_socket.html b/doc/zmq_socket.html index d688fa9..9a8266d 100644 --- a/doc/zmq_socket.html +++ b/doc/zmq_socket.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_socket(3) - +
    +

    SYNOPSIS

    void *zmq_socket (void *context, int type);

    +
    +

    DESCRIPTION

    The zmq_socket() function shall create a ØMQ socket within the specified @@ -617,10 +600,12 @@ from multiple threads except after migrating a socket from one thread to another with a "full fence" memory barrier.

    Socket types

    The following sections present the socket types defined by ØMQ, grouped by the general messaging pattern which is built from related socket types.

    -

    Request-reply pattern

    +
    +

    Request-reply pattern

    The request-reply pattern is used for sending requests from a client to one or more instances of a service, and receiving subsequent replies to each request sent.

    +

    ZMQ_REQ

    A socket of type ZMQ_REQ is used by a client to send requests to and receive replies from a service. This socket type allows only an alternating @@ -700,6 +685,8 @@ Block

    +
    +

    ZMQ_REP

    A socket of type ZMQ_REP is used by a service to receive requests from and send replies to a client. This socket type allows only an alternating @@ -778,6 +765,8 @@ Drop

    +
    +

    ZMQ_DEALER

    A socket of type ZMQ_DEALER is an advanced pattern used for extending request/reply sockets. Each message sent is load-balanced among all connected @@ -800,7 +789,7 @@ Compatible peer sockets

    -ZMQ_ROUTER, ZMQ_REP +ZMQ_ROUTER, ZMQ_REQ, ZMQ_REP

    @@ -860,6 +849,8 @@ Block
    +
    +

    ZMQ_ROUTER

    A socket of type ZMQ_ROUTER is an advanced pattern used for extending request/reply sockets. When receiving messages a ZMQ_ROUTER socket shall @@ -890,7 +881,7 @@ Compatible peer sockets

    -ZMQ_DEALER, ZMQ_REQ +ZMQ_DEALER, ZMQ_REQ, ZMQ_REP

    @@ -950,9 +941,13 @@ Drop
    -

    Publish-subscribe pattern

    +
    +
    +
    +

    Publish-subscribe pattern

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

    +

    ZMQ_PUB

    A socket of type ZMQ_PUB is used by a publisher to distribute data. Messages sent are distributed in a fan out fashion to all connected peers. @@ -1029,6 +1024,8 @@ Drop

    +
    +

    ZMQ_SUB

    A socket of type ZMQ_SUB is used by a subscriber to subscribe to data distributed by a publisher. Initially a ZMQ_SUB socket is not subscribed to @@ -1103,11 +1100,15 @@ Drop

    -

    Pipeline pattern

    +
    +
    +
    +

    Pipeline pattern

    The pipeline pattern is used for distributing data to nodes arranged in a pipeline. Data always flows down the pipeline, and each stage of the pipeline is connected to at least one node. When a pipeline stage is connected to multiple nodes data is load-balanced among all connected nodes.

    +

    ZMQ_PUSH

    A socket of type ZMQ_PUSH is used by a pipeline node to send messages to downstream pipeline nodes. Messages are load-balanced to all connected @@ -1187,6 +1188,8 @@ Block

    +
    +

    ZMQ_PULL

    A socket of type ZMQ_PULL is used by a pipeline node to receive messages from upstream pipeline nodes. Messages are fair-queued from among all @@ -1261,10 +1264,14 @@ N/A

    -

    Exclusive pair pattern

    +
    +
    +
    +

    Exclusive pair pattern

    The exclusive pair pattern is used to connect a peer to precisely one other peer. This pattern is used for inter-thread communication across the inproc transport.

    +

    ZMQ_PAIR

    A socket of type ZMQ_PAIR can only be connected to a single peer at any one time. No message routing or filtering is performed on messages sent over a @@ -1353,12 +1360,18 @@ Block

    +
    +
    +
    +

    RETURN VALUE

    The zmq_socket() function shall return an opaque handle to the newly created socket if successful. Otherwise, it shall return NULL and set errno to one of the values defined below.

    +
    +

    ERRORS

    @@ -1396,6 +1409,8 @@ The context specified was terminated.
    +
    +

    SEE ALSO

    zmq_init(3) @@ -1407,17 +1422,20 @@ The context specified was terminated. zmq_inproc(7) zmq(7)

    +
    +

    AUTHORS

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

    +
    diff --git a/doc/zmq_socket.txt b/doc/zmq_socket.txt index 7428a91..3adf9b7 100644 --- a/doc/zmq_socket.txt +++ b/doc/zmq_socket.txt @@ -131,7 +131,7 @@ _body parts_. [horizontal] .Summary of ZMQ_DEALER characteristics -Compatible peer sockets:: 'ZMQ_ROUTER', 'ZMQ_REP' +Compatible peer sockets:: 'ZMQ_ROUTER', 'ZMQ_REQ', 'ZMQ_REP' Direction:: Bidirectional Send/receive pattern:: Unrestricted Outgoing routing strategy:: Load-balanced @@ -168,7 +168,7 @@ application must include the _delimiter_ part. [horizontal] .Summary of ZMQ_ROUTER characteristics -Compatible peer sockets:: 'ZMQ_DEALER', 'ZMQ_REQ' +Compatible peer sockets:: 'ZMQ_DEALER', 'ZMQ_REQ', 'ZMQ_REP' Direction:: Bidirectional Send/receive pattern:: Unrestricted Outgoing routing strategy:: See text diff --git a/doc/zmq_strerror.3 b/doc/zmq_strerror.3 index dfeaa3f..4544538 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_STRERROR" "3" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_STRERROR" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_strerror.html b/doc/zmq_strerror.html index 2648aa5..944c7cc 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 +575,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 +602,26 @@ 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>.

    +
    diff --git a/doc/zmq_tcp.7 b/doc/zmq_tcp.7 index 5f2f6df..673f362 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_TCP" "7" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_TCP" "7" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -115,7 +115,7 @@ The DNS name of the peer\&. .sp -1 .IP \(bu 2.3 .\} -The IPv4 address of the peer, in it\(cqs numeric representation\&. +The IPv4 address of the peer, in its numeric representation\&. .RE .SH "WIRE FORMAT" .sp diff --git a/doc/zmq_tcp.html b/doc/zmq_tcp.html index 78356f5..5256a84 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 +610,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.

    @@ -639,11 +625,14 @@ The DNS name of the peer.

  • -The IPv4 address of the peer, in it’s numeric representation. +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 +692,8 @@ exceeding 254 octets:

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

    EXAMPLES

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

    SEE ALSO

    zmq_bind(3) @@ -738,17 +731,20 @@ 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>.

    +
    diff --git a/doc/zmq_tcp.txt b/doc/zmq_tcp.txt index a0c945a..0117ccf 100644 --- a/doc/zmq_tcp.txt +++ b/doc/zmq_tcp.txt @@ -49,7 +49,7 @@ a colon and the TCP port number to use. A 'peer address' may be specified by either of the following: * The DNS name of the peer. -* The IPv4 address of the peer, in it's numeric representation. +* The IPv4 address of the peer, in its numeric representation. WIRE FORMAT diff --git a/doc/zmq_term.3 b/doc/zmq_term.3 index f7f3b4b..8a741b0 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: 05/07/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_TERM" "3" "05/07/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_TERM" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_term.html b/doc/zmq_term.html index db7b9d2..3a948fe 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 +605,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 +635,8 @@ Termination was interrupted by a signal. It can be restarted if needed.
    +
    +

    SEE ALSO

    zmq(7) @@ -655,17 +644,20 @@ 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>.

    +
    diff --git a/doc/zmq_version.3 b/doc/zmq_version.3 index 0acf575..c64f7d3 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: 05/06/2011 +.\" Date: 08/29/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.6 +.\" Source: 0MQ 2.1.9 .\" Language: English .\" -.TH "ZMQ_VERSION" "3" "05/06/2011" "0MQ 2\&.1\&.6" "0MQ Manual" +.TH "ZMQ_VERSION" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_version.html b/doc/zmq_version.html index fc59a72..9a91e09 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 +576,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 +600,26 @@ 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>.

    +
    -- cgit v1.2.3