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

SYNOPSIS

#include <zmq.h>

cc [flags] files -lzmq [libraries]

+
+

DESCRIPTION

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

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

-

Context

+
+

Context

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

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

+

Thread safety

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

+
+

Multiple contexts

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

-

Messages

+
+
+
+

Messages

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

-

Sockets

+
+
+

Sockets

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

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

-

Transports

+
+
+

Transports

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

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

-

Devices

+
+
+

Devices

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

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

+ + +

ERROR HANDLING

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

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

+
+

MISCELLANEOUS

The following miscellaneous functions are provided:

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

LANGUAGE BINDINGS

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

-

C++ language binding

+
+

C++ language binding

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

-

Other language bindings

+
+
+

Other language bindings

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

+
+
+

AUTHORS

-

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

+

This manual page was written by the ØMQ community.

+
+

RESOURCES

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

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

+
+

COPYING

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

+
diff --git a/doc/zmq.txt b/doc/zmq.txt index 16a5d30..1a00c56 100644 --- a/doc/zmq.txt +++ b/doc/zmq.txt @@ -200,8 +200,7 @@ of the 0MQ community and pointers can be found on the 0MQ website. AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. RESOURCES diff --git a/doc/zmq_bind.3 b/doc/zmq_bind.3 index ace7588..8aa0ad0 100644 --- a/doc/zmq_bind.3 +++ b/doc/zmq_bind.3 @@ -2,12 +2,12 @@ .\" Title: zmq_bind .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_BIND" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_BIND" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -157,15 +157,4 @@ assert (rc == 0); \fBzmq_connect\fR(3) \fBzmq_socket\fR(3) \fBzmq\fR(7) .SH "AUTHORS" .sp -This 0MQ manual page was written by Martin Sustrik <\m[blue]\fBsustrik@250bpm\&.com\fR\m[]\&\s-2\u[1]\d\s+2> and Martin Lucina <\m[blue]\fBmato@kotelna\&.sk\fR\m[]\&\s-2\u[2]\d\s+2>\&. -.SH "NOTES" -.IP " 1." 4 -sustrik@250bpm.com -.RS 4 -\%mailto:sustrik@250bpm.com -.RE -.IP " 2." 4 -mato@kotelna.sk -.RS 4 -\%mailto:mato@kotelna.sk -.RE +This manual page was written by the 0MQ community\&. diff --git a/doc/zmq_bind.html b/doc/zmq_bind.html index e3b1da2..6cb5e28 100644 --- a/doc/zmq_bind.html +++ b/doc/zmq_bind.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_bind(3) - +
+

SYNOPSIS

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

+
+

DESCRIPTION

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

+
+

RETURN VALUE

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

+
+

ERRORS

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

EXAMPLE

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

SEE ALSO

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

+
+

AUTHORS

-

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

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_bind.txt b/doc/zmq_bind.txt index 1d7c2ff..078e619 100644 --- a/doc/zmq_bind.txt +++ b/doc/zmq_bind.txt @@ -89,5 +89,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_close.3 b/doc/zmq_close.3 index d47f494..03a8091 100644 --- a/doc/zmq_close.3 +++ b/doc/zmq_close.3 @@ -2,12 +2,12 @@ .\" Title: zmq_close .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_CLOSE" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_CLOSE" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -67,15 +67,4 @@ was invalid\&. \fBzmq_socket\fR(3) \fBzmq_term\fR(3) \fBzmq_setsockopt\fR(3) \fBzmq\fR(7) .SH "AUTHORS" .sp -This 0MQ manual page was written by Martin Sustrik <\m[blue]\fBsustrik@250bpm\&.com\fR\m[]\&\s-2\u[1]\d\s+2> and Martin Lucina <\m[blue]\fBmato@kotelna\&.sk\fR\m[]\&\s-2\u[2]\d\s+2>\&. -.SH "NOTES" -.IP " 1." 4 -sustrik@250bpm.com -.RS 4 -\%mailto:sustrik@250bpm.com -.RE -.IP " 2." 4 -mato@kotelna.sk -.RS 4 -\%mailto:mato@kotelna.sk -.RE +This manual page was written by the 0MQ community\&. diff --git a/doc/zmq_close.html b/doc/zmq_close.html index f30c3a3..bb7f925 100644 --- a/doc/zmq_close.html +++ b/doc/zmq_close.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_close(3) - +
+

SYNOPSIS

int zmq_close (void *socket);

+
+

DESCRIPTION

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

+
+

RETURN VALUE

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

+
+

ERRORS

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

SEE ALSO

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

+
+

AUTHORS

-

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

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_close.txt b/doc/zmq_close.txt index 47f9bb2..7d727da 100644 --- a/doc/zmq_close.txt +++ b/doc/zmq_close.txt @@ -48,5 +48,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_connect.3 b/doc/zmq_connect.3 index eb0eb03..641e488 100644 --- a/doc/zmq_connect.3 +++ b/doc/zmq_connect.3 @@ -2,12 +2,12 @@ .\" Title: zmq_connect .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_CONNECT" "3" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_CONNECT" "3" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -152,15 +152,4 @@ assert (rc == 0); \fBzmq_bind\fR(3) \fBzmq_socket\fR(3) \fBzmq\fR(7) .SH "AUTHORS" .sp -This 0MQ manual page was written by Martin Sustrik <\m[blue]\fBsustrik@250bpm\&.com\fR\m[]\&\s-2\u[1]\d\s+2> and Martin Lucina <\m[blue]\fBmato@kotelna\&.sk\fR\m[]\&\s-2\u[2]\d\s+2>\&. -.SH "NOTES" -.IP " 1." 4 -sustrik@250bpm.com -.RS 4 -\%mailto:sustrik@250bpm.com -.RE -.IP " 2." 4 -mato@kotelna.sk -.RS 4 -\%mailto:mato@kotelna.sk -.RE +This manual page was written by the 0MQ community\&. diff --git a/doc/zmq_connect.html b/doc/zmq_connect.html index b6353b6..5dc35f8 100644 --- a/doc/zmq_connect.html +++ b/doc/zmq_connect.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_connect(3) - +
+

SYNOPSIS

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

+
+

DESCRIPTION

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

+
+

RETURN VALUE

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

+
+

ERRORS

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

EXAMPLE

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

SEE ALSO

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

+
+

AUTHORS

-

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

+

This manual page was written by the ØMQ community.

+
diff --git a/doc/zmq_connect.txt b/doc/zmq_connect.txt index 6ec56b0..f260dd5 100644 --- a/doc/zmq_connect.txt +++ b/doc/zmq_connect.txt @@ -87,5 +87,4 @@ linkzmq:zmq[7] AUTHORS ------- -This 0MQ manual page was written by Martin Sustrik and -Martin Lucina . +This manual page was written by the 0MQ community. diff --git a/doc/zmq_cpp.7 b/doc/zmq_cpp.7 index 0008023..38bd1b4 100644 --- a/doc/zmq_cpp.7 +++ b/doc/zmq_cpp.7 @@ -2,12 +2,12 @@ .\" Title: zmq_cpp .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 11/22/2011 +.\" Date: 04/04/2012 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.1.10 +.\" Source: 0MQ 2.2.0 .\" Language: English .\" -.TH "ZMQ_CPP" "7" "11/22/2011" "0MQ 2\&.1\&.10" "0MQ Manual" +.TH "ZMQ_CPP" "7" "04/04/2012" "0MQ 2\&.2\&.0" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -396,15 +396,4 @@ s\&.send (msg); \fBzmq\fR(7) .SH "AUTHORS" .sp -This 0MQ manual page was written by Martin Sustrik <\m[blue]\fBsustrik@250bpm\&.com\fR\m[]\&\s-2\u[1]\d\s+2> and Martin Lucina <\m[blue]\fBmato@kotelna\&.sk\fR\m[]\&\s-2\u[2]\d\s+2>\&. -.SH "NOTES" -.IP " 1." 4 -sustrik@250bpm.com -.RS 4 -\%mailto:sustrik@250bpm.com -.RE -.IP " 2." 4 -mato@kotelna.sk -.RS 4 -\%mailto:mato@kotelna.sk -.RE +This manual page was written by the 0MQ community\&. diff --git a/doc/zmq_cpp.html b/doc/zmq_cpp.html index c59c01d..ff44f57 100644 --- a/doc/zmq_cpp.html +++ b/doc/zmq_cpp.html @@ -2,15 +2,28 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + zmq_cpp(7) - +
+

SYNOPSIS

#include <zmq.hpp>

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

+
+

DESCRIPTION

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

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

The following classes are provided in the zmq namespace:

-

Context

+
+

Context

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

+

Constructor

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

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

+
+

Destructor

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

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

+
+

Methods

None.

-

Socket

+
+
+
+

Socket

The socket_t class encapsulates a ØMQ socket.

+

Constructor

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

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

+
+

Destructor

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

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

+
+

Methods

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

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

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

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

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