From 978e33ba253a997b41b331b449b474a5cee7bccc Mon Sep 17 00:00:00 2001 From: Martin Lucina Date: Mon, 23 Jan 2012 08:54:31 +0100 Subject: Imported Upstream version 2.1.10 --- doc/zmq.7 | 6 +- doc/zmq.html | 158 ++++++++++++++---------------- doc/zmq_bind.3 | 6 +- doc/zmq_bind.html | 124 ++++++++++++------------ doc/zmq_close.3 | 6 +- doc/zmq_close.html | 122 ++++++++++++----------- doc/zmq_connect.3 | 6 +- doc/zmq_connect.html | 124 ++++++++++++------------ doc/zmq_cpp.7 | 6 +- doc/zmq_cpp.html | 236 +++++++++++++++++++++------------------------ doc/zmq_device.3 | 6 +- doc/zmq_device.html | 132 +++++++++++++------------ doc/zmq_epgm.7 | 6 +- doc/zmq_epgm.html | 132 ++++++++++++------------- doc/zmq_errno.3 | 6 +- doc/zmq_errno.html | 122 ++++++++++++----------- doc/zmq_getsockopt.3 | 6 +- doc/zmq_getsockopt.html | 196 ++++++++++++++++--------------------- 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 | 122 ++++++++++++----------- doc/zmq_msg_copy.3 | 6 +- doc/zmq_msg_copy.html | 122 ++++++++++++----------- 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 | 122 ++++++++++++----------- doc/zmq_msg_size.3 | 6 +- doc/zmq_msg_size.html | 122 ++++++++++++----------- doc/zmq_pgm.7 | 6 +- doc/zmq_pgm.html | 132 ++++++++++++------------- 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 | 6 +- doc/zmq_setsockopt.html | 188 ++++++++++++++++-------------------- doc/zmq_socket.3 | 6 +- doc/zmq_socket.html | 156 +++++++++++++----------------- doc/zmq_strerror.3 | 6 +- doc/zmq_strerror.html | 124 ++++++++++++------------ doc/zmq_tcp.7 | 6 +- doc/zmq_tcp.html | 130 +++++++++++++------------ doc/zmq_term.3 | 6 +- doc/zmq_term.html | 122 ++++++++++++----------- doc/zmq_version.3 | 6 +- doc/zmq_version.html | 124 ++++++++++++------------ 60 files changed, 2141 insertions(+), 2103 deletions(-) (limited to 'doc') diff --git a/doc/zmq.7 b/doc/zmq.7 index 07ec236..b774c13 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: 08/29/2011 +.\" Date: 07/01/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.9 +.\" Source: 0MQ 2.1.8 .\" Language: English .\" -.TH "ZMQ" "7" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" +.TH "ZMQ" "7" "07/01/2011" "0MQ 2\&.1\&.8" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq.html b/doc/zmq.html index bce168f..e44f8a1 100644 --- a/doc/zmq.html +++ b/doc/zmq.html @@ -2,28 +2,15 @@ "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 @@ -579,8 +596,7 @@ 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:

@@ -602,7 +618,6 @@ 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 @@ -613,17 +628,12 @@ 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 @@ -667,9 +677,7 @@ 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.

@@ -723,9 +731,7 @@ 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.

@@ -764,18 +770,13 @@ 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 @@ -789,8 +790,6 @@ 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:

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

LANGUAGE BINDINGS

The ØMQ library provides interfaces suitable for calling from programs in any @@ -814,33 +811,23 @@ 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 @@ -848,12 +835,11 @@ 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 997f7a0..addb501 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: 08/29/2011 +.\" Date: 09/08/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.9 +.\" Source: 0MQ 2.1.10 .\" Language: English .\" -.TH "ZMQ_BIND" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" +.TH "ZMQ_BIND" "3" "09/08/2011" "0MQ 2\&.1\&.10" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_bind.html b/doc/zmq_bind.html index ef04708..e3b1da2 100644 --- a/doc/zmq_bind.html +++ b/doc/zmq_bind.html @@ -2,28 +2,15 @@ "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 @@ -616,15 +633,11 @@ 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

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

EXAMPLE

@@ -720,28 +731,23 @@ 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_close.3 b/doc/zmq_close.3 index 82a3cc8..33c7368 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: 08/29/2011 +.\" Date: 09/08/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.9 +.\" Source: 0MQ 2.1.10 .\" Language: English .\" -.TH "ZMQ_CLOSE" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" +.TH "ZMQ_CLOSE" "3" "09/08/2011" "0MQ 2\&.1\&.10" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_close.html b/doc/zmq_close.html index bca12dc..f30c3a3 100644 --- a/doc/zmq_close.html +++ b/doc/zmq_close.html @@ -2,28 +2,15 @@ "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 @@ -586,15 +603,11 @@ 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

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

SEE ALSO

zmq_socket(3) @@ -617,20 +628,17 @@ 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 4f50086..e16874e 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: 08/29/2011 +.\" Date: 09/08/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.9 +.\" Source: 0MQ 2.1.10 .\" Language: English .\" -.TH "ZMQ_CONNECT" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" +.TH "ZMQ_CONNECT" "3" "09/08/2011" "0MQ 2\&.1\&.10" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_connect.html b/doc/zmq_connect.html index 52c0ad3..b6353b6 100644 --- a/doc/zmq_connect.html +++ b/doc/zmq_connect.html @@ -2,28 +2,15 @@ "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 @@ -626,15 +643,11 @@ 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

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

EXAMPLE

@@ -706,28 +717,23 @@ 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_cpp.7 b/doc/zmq_cpp.7 index 72c2f97..f96dd35 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: 08/29/2011 +.\" Date: 07/01/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.9 +.\" Source: 0MQ 2.1.8 .\" Language: English .\" -.TH "ZMQ_CPP" "7" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" +.TH "ZMQ_CPP" "7" "07/01/2011" "0MQ 2\&.1\&.8" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_cpp.html b/doc/zmq_cpp.html index 6b31c9f..c59c01d 100644 --- a/doc/zmq_cpp.html +++ b/doc/zmq_cpp.html @@ -2,28 +2,15 @@ "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 @@ -575,151 +592,126 @@ 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).

@@ -733,9 +725,6 @@ 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 @@ -743,8 +732,6 @@ 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

@@ -757,26 +744,21 @@ 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 7888546..42a262a 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: 08/29/2011 +.\" Date: 07/01/2011 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.9 +.\" Source: 0MQ 2.1.8 .\" Language: English .\" -.TH "ZMQ_DEVICE" "3" "08/29/2011" "0MQ 2\&.1\&.9" "0MQ Manual" +.TH "ZMQ_DEVICE" "3" "07/01/2011" "0MQ 2\&.1\&.8" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/doc/zmq_device.html b/doc/zmq_device.html index f5ea972..06ce951 100644 --- a/doc/zmq_device.html +++ b/doc/zmq_device.html @@ -2,28 +2,15 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_device(3)