zmq.txt 7.67 KB
Newer Older
1 2
zmq(7)
======
Martin Sustrik's avatar
Martin Sustrik committed
3

4 5 6 7 8 9 10 11

NAME
----
zmq - 0MQ lightweight messaging kernel


SYNOPSIS
--------
Martin Lucina's avatar
Martin Lucina committed
12
*#include <zmq.h>*
Martin Sustrik's avatar
Martin Sustrik committed
13

Martin Lucina's avatar
Martin Lucina committed
14
*cc* ['flags'] 'files' *-lzmq* ['libraries']
Martin Sustrik's avatar
Martin Sustrik committed
15 16


Martin Lucina's avatar
Martin Lucina committed
17 18 19 20 21
DESCRIPTION
-----------
The 0MQ lightweight messaging kernel is a library which extends the standard
socket interfaces with features traditionally provided by specialised
_messaging middleware_ products. 0MQ sockets provide an abstraction of
22
asynchronous _message queues_, multiple _messaging patterns_, message
Martin Lucina's avatar
Martin Lucina committed
23 24
filtering (_subscriptions_), seamless access to multiple _transport protocols_
and more.
Martin Sustrik's avatar
Martin Sustrik committed
25

Martin Lucina's avatar
Martin Lucina committed
26 27 28
This documentation presents an overview of 0MQ concepts, describes how 0MQ
abstracts standard sockets and provides a reference manual for the functions
provided by the 0MQ library.
Martin Sustrik's avatar
Martin Sustrik committed
29 30


Martin Lucina's avatar
Martin Lucina committed
31 32
Context
~~~~~~~
33 34 35 36 37 38 39 40 41 42 43 44
Before using any 0MQ library functions you must create a 0MQ 'context'. When
you exit your application you must destroy the 'context'. These functions let
you work with 'contexts':

Create a new 0MQ context::
    linkzmq:zmq_ctx_new[3]

Work with context properties::
    linkzmq:zmq_ctx_set[3]
    linkzmq:zmq_ctx_get[3]

Destroy a 0MQ context::
45
    linkzmq:zmq_ctx_shutdown[3]
46
    linkzmq:zmq_ctx_term[3]
47

Martin Lucina's avatar
Martin Lucina committed
48 49 50
Thread safety
^^^^^^^^^^^^^
A 0MQ 'context' is thread safe and may be shared among as many application
51 52 53 54 55 56 57
threads as necessary, without any additional locking required on the part of
the caller.

Individual 0MQ 'sockets' are _not_ thread safe except in the case where full
memory barriers are issued when migrating a socket from one thread to another.
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
58
initialisation, for example via a structure passed as an argument to
59
_pthread_create()_.
Martin Lucina's avatar
Martin Lucina committed
60 61 62 63 64 65 66 67 68 69 70 71 72 73


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


Messages
~~~~~~~~
A 0MQ message is a discrete unit of data passed between applications or
components of the same application. 0MQ messages have no internal structure and
Martin Lucina's avatar
Martin Lucina committed
74 75
from the point of view of 0MQ itself they are considered to be opaque binary
data.
Martin Lucina's avatar
Martin Lucina committed
76 77

The following functions are provided to work with messages:
Martin Sustrik's avatar
Martin Sustrik committed
78

79 80
Initialise a message::
    linkzmq:zmq_msg_init[3]
Martin Lucina's avatar
Martin Lucina committed
81 82
    linkzmq:zmq_msg_init_size[3]
    linkzmq:zmq_msg_init_data[3]
83

84 85 86 87
Sending and receiving a message::
    linkzmq:zmq_msg_send[3]
    linkzmq:zmq_msg_recv[3]

Martin Lucina's avatar
Martin Lucina committed
88
Release a message::
89
    linkzmq:zmq_msg_close[3]
Martin Sustrik's avatar
Martin Sustrik committed
90

91 92 93
Access message content::
    linkzmq:zmq_msg_data[3]
    linkzmq:zmq_msg_size[3]
94
    linkzmq:zmq_msg_more[3]
Martin Sustrik's avatar
Martin Sustrik committed
95

96
Work with message properties::
97
    linkzmq:zmq_msg_gets[3]
98 99
    linkzmq:zmq_msg_get[3]
    linkzmq:zmq_msg_set[3]
100

101 102 103
Message manipulation::
    linkzmq:zmq_msg_copy[3]
    linkzmq:zmq_msg_move[3]
Martin Sustrik's avatar
Martin Sustrik committed
104 105


Martin Lucina's avatar
Martin Lucina committed
106 107
Sockets
~~~~~~~
108 109 110
0MQ sockets present an abstraction of a asynchronous _message queue_, with the
exact queueing semantics depending on the socket type in use. See
linkzmq:zmq_socket[3] for the socket types provided.
Martin Lucina's avatar
Martin Lucina committed
111 112

The following functions are provided to work with sockets:
Martin Sustrik's avatar
Martin Sustrik committed
113

114 115 116 117 118
Creating a socket::
    linkzmq:zmq_socket[3]

Closing a socket::
    linkzmq:zmq_close[3]
Martin Sustrik's avatar
Martin Sustrik committed
119

Martin Lucina's avatar
Martin Lucina committed
120 121
Manipulating socket options::
    linkzmq:zmq_getsockopt[3]
122
    linkzmq:zmq_setsockopt[3]
Martin Sustrik's avatar
Martin Sustrik committed
123

124 125 126
Establishing a message flow::
    linkzmq:zmq_bind[3]
    linkzmq:zmq_connect[3]
Martin Sustrik's avatar
Martin Sustrik committed
127

Martin Lucina's avatar
Martin Lucina committed
128
Sending and receiving messages::
Pieter Hintjens's avatar
Pieter Hintjens committed
129 130
    linkzmq:zmq_msg_send[3]
    linkzmq:zmq_msg_recv[3]
131 132
    linkzmq:zmq_send[3]
    linkzmq:zmq_recv[3]
133
    linkzmq:zmq_send_const[3]
Martin Sustrik's avatar
Martin Sustrik committed
134

135
Monitoring socket events::
136 137
    linkzmq:zmq_socket_monitor[3]

138
.Input/output multiplexing
Martin Lucina's avatar
Martin Lucina committed
139 140 141 142
0MQ provides a mechanism for applications to multiplex input/output events over
a set containing both 0MQ sockets and standard sockets. This mechanism mirrors
the standard _poll()_ system call, and is described in detail in
linkzmq:zmq_poll[3].
143 144


Martin Lucina's avatar
Martin Lucina committed
145 146 147 148 149
Transports
~~~~~~~~~~
A 0MQ socket can use multiple different underlying transport mechanisms.
Each transport mechanism is suited to a particular purpose and has its own
advantages and drawbacks.
Martin Sustrik's avatar
Martin Sustrik committed
150

Martin Lucina's avatar
Martin Lucina committed
151
The following transport mechanisms are provided:
Martin Sustrik's avatar
Martin Sustrik committed
152

Martin Lucina's avatar
Martin Lucina committed
153
Unicast transport using TCP::
154
    linkzmq:zmq_tcp[7]
Martin Sustrik's avatar
Martin Sustrik committed
155

Martin Lucina's avatar
Martin Lucina committed
156
Reliable multicast transport using PGM::
157
    linkzmq:zmq_pgm[7]
Martin Sustrik's avatar
Martin Sustrik committed
158

Martin Lucina's avatar
Martin Lucina committed
159
Local inter-process communication transport::
160
    linkzmq:zmq_ipc[7]
161

Martin Lucina's avatar
Martin Lucina committed
162
Local in-process (inter-thread) communication transport::
163
    linkzmq:zmq_inproc[7]
Martin Sustrik's avatar
Martin Sustrik committed
164

Ilya Kulakov's avatar
Ilya Kulakov committed
165 166 167
Virtual Machine Communications Interface (VMC) transport::
    linkzmq:zmq_vmci[7]

168 169 170
Unreliable unicast and multicast using UDP::
    linkzmq:zmq_udp[7]

171

172
Proxies
Pieter Hintjens's avatar
Pieter Hintjens committed
173
~~~~~~~
174 175 176 177
0MQ provides 'proxies' to create fanout and fan-in topologies. A proxy connects
a 'frontend' socket to a 'backend' socket and switches all messages between the
two sockets, opaquely. A proxy may optionally capture all traffic to a third
socket. To start a proxy in an application thread, use linkzmq:zmq_proxy[3].
Pieter Hintjens's avatar
Pieter Hintjens committed
178 179


180 181 182 183 184 185 186 187 188 189
Security
~~~~~~~~
A 0MQ socket can select a security mechanism. Both peers must use the same
security mechanism.

The following security mechanisms are provided for IPC and TCP connections:

Null security::
    linkzmq:zmq_null[7]

190 191
Plain-text authentication using username and password::
    linkzmq:zmq_plain[7]
192

193
Elliptic curve authentication and encryption::
194 195
    linkzmq:zmq_curve[7]

196
Generate a CURVE keypair in armored text format::
197 198
    linkzmq:zmq_curve_keypair[3]

199
Converting keys to/from armoured text strings::
200 201 202
    linkzmq:zmq_z85_decode[3]
    linkzmq:zmq_z85_encode[3]

203

Martin Lucina's avatar
Martin Lucina committed
204 205 206 207 208 209 210 211
ERROR HANDLING
--------------
The 0MQ library functions handle errors using the standard conventions found on
POSIX systems. Generally, this means that upon failure a 0MQ library function
shall return either a NULL value (if returning a pointer) or a negative value
(if returning an integer), and the actual error code shall be stored in the
'errno' variable.

212 213 214 215 216 217
On non-POSIX systems some users may experience issues with retrieving the
correct value of the 'errno' variable. The _zmq_errno()_ function is provided
to assist in these cases; for details refer to linkzmq:zmq_errno[3].

The _zmq_strerror()_ function is provided to translate 0MQ-specific error codes
into error message strings; for details refer to linkzmq:zmq_strerror[3].
Martin Lucina's avatar
Martin Lucina committed
218 219


220 221 222 223 224 225 226 227 228 229 230 231 232
UTILITY
-------
The following utility functions are provided:

Working with atomic counters::
    linkzmq:zmq_atomic_counter_new[3]
    linkzmq:zmq_atomic_counter_set[3]
    linkzmq:zmq_atomic_counter_inc[3]
    linkzmq:zmq_atomic_counter_dec[3]
    linkzmq:zmq_atomic_counter_value[3]
    linkzmq:zmq_atomic_counter_destroy[3]


233 234 235 236 237 238 239 240
MISCELLANEOUS
-------------
The following miscellaneous functions are provided:

Report 0MQ library version::
    linkzmq:zmq_version[3]


Martin Lucina's avatar
Martin Lucina committed
241 242 243 244 245 246 247
LANGUAGE BINDINGS
-----------------
The 0MQ library provides interfaces suitable for calling from programs in any
language; this documentation documents those interfaces as they would be used
by C programmers. The intent is that programmers using 0MQ from other languages
shall refer to this documentation alongside any documentation provided by the
vendor of their language binding.
248

249 250
Language bindings ($$C++$$, Python, PHP, Ruby, Java and more) are provided by
members of the 0MQ community and pointers can be found on the 0MQ website.
Martin Sustrik's avatar
Martin Sustrik committed
251

252 253 254

AUTHORS
-------
255 256
This page was written by the 0MQ community. To make a change please
read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.
257 258 259 260 261 262 263 264 265 266 267 268 269 270


RESOURCES
---------
Main web site: <http://www.zeromq.org/>

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


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