zmq.txt 7.99 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
The 0MQ 'context' keeps the list of sockets and manages the async I/O thread
and internal queries.

36 37 38 39 40 41 42 43 44 45 46 47
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::
48
    linkzmq:zmq_ctx_shutdown[3]
49
    linkzmq:zmq_ctx_term[3]
50

Martin Lucina's avatar
Martin Lucina committed
51 52 53
Thread safety
^^^^^^^^^^^^^
A 0MQ 'context' is thread safe and may be shared among as many application
54 55 56 57 58 59 60
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
61
initialisation, for example via a structure passed as an argument to
62
_pthread_create()_.
Martin Lucina's avatar
Martin Lucina committed
63 64 65 66 67 68 69 70 71 72 73 74 75 76


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
77 78
from the point of view of 0MQ itself they are considered to be opaque binary
data.
Martin Lucina's avatar
Martin Lucina committed
79 80

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

82 83
Initialise a message::
    linkzmq:zmq_msg_init[3]
Martin Lucina's avatar
Martin Lucina committed
84 85
    linkzmq:zmq_msg_init_size[3]
    linkzmq:zmq_msg_init_data[3]
86

87 88 89 90
Sending and receiving a message::
    linkzmq:zmq_msg_send[3]
    linkzmq:zmq_msg_recv[3]

Martin Lucina's avatar
Martin Lucina committed
91
Release a message::
92
    linkzmq:zmq_msg_close[3]
Martin Sustrik's avatar
Martin Sustrik committed
93

94 95 96
Access message content::
    linkzmq:zmq_msg_data[3]
    linkzmq:zmq_msg_size[3]
97
    linkzmq:zmq_msg_more[3]
Martin Sustrik's avatar
Martin Sustrik committed
98

99
Work with message properties::
100
    linkzmq:zmq_msg_gets[3]
101 102
    linkzmq:zmq_msg_get[3]
    linkzmq:zmq_msg_set[3]
103

104 105 106
Message manipulation::
    linkzmq:zmq_msg_copy[3]
    linkzmq:zmq_msg_move[3]
Martin Sustrik's avatar
Martin Sustrik committed
107 108


Martin Lucina's avatar
Martin Lucina committed
109 110
Sockets
~~~~~~~
Emanuel Koczwara's avatar
Emanuel Koczwara committed
111
0MQ sockets present an abstraction of an asynchronous _message queue_, with the
112 113
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
114 115

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

117 118 119 120 121
Creating a socket::
    linkzmq:zmq_socket[3]

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

Martin Lucina's avatar
Martin Lucina committed
123 124
Manipulating socket options::
    linkzmq:zmq_getsockopt[3]
125
    linkzmq:zmq_setsockopt[3]
Martin Sustrik's avatar
Martin Sustrik committed
126

127 128 129
Establishing a message flow::
    linkzmq:zmq_bind[3]
    linkzmq:zmq_connect[3]
Martin Sustrik's avatar
Martin Sustrik committed
130

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

138
Monitoring socket events::
139 140
    linkzmq:zmq_socket_monitor[3]

141
.Input/output multiplexing
Martin Lucina's avatar
Martin Lucina committed
142 143 144
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
145 146 147 148
linkzmq:zmq_poll[3]. This API is deprecated, however.

There is a new DRAFT API with multiple zmq_poller_* function, which is described
in linkzmq:zmq_poller[3].
149 150


Martin Lucina's avatar
Martin Lucina committed
151 152 153 154 155
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
156

Martin Lucina's avatar
Martin Lucina committed
157
The following transport mechanisms are provided:
Martin Sustrik's avatar
Martin Sustrik committed
158

Martin Lucina's avatar
Martin Lucina committed
159
Unicast transport using TCP::
160
    linkzmq:zmq_tcp[7]
Martin Sustrik's avatar
Martin Sustrik committed
161

Martin Lucina's avatar
Martin Lucina committed
162
Reliable multicast transport using PGM::
163
    linkzmq:zmq_pgm[7]
Martin Sustrik's avatar
Martin Sustrik committed
164

Martin Lucina's avatar
Martin Lucina committed
165
Local inter-process communication transport::
166
    linkzmq:zmq_ipc[7]
167

Martin Lucina's avatar
Martin Lucina committed
168
Local in-process (inter-thread) communication transport::
169
    linkzmq:zmq_inproc[7]
Martin Sustrik's avatar
Martin Sustrik committed
170

Ilya Kulakov's avatar
Ilya Kulakov committed
171 172 173
Virtual Machine Communications Interface (VMC) transport::
    linkzmq:zmq_vmci[7]

174 175 176
Unreliable unicast and multicast using UDP::
    linkzmq:zmq_udp[7]

177

178
Proxies
Pieter Hintjens's avatar
Pieter Hintjens committed
179
~~~~~~~
180 181 182 183
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
184 185


186 187 188 189 190 191 192 193 194 195
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]

196 197
Plain-text authentication using username and password::
    linkzmq:zmq_plain[7]
198

199
Elliptic curve authentication and encryption::
200 201
    linkzmq:zmq_curve[7]

202
Generate a CURVE keypair in armored text format::
203 204
    linkzmq:zmq_curve_keypair[3]

205 206 207
Derive a CURVE public key from a secret key:
    linkzmq:zmq_curve_public[3]

208
Converting keys to/from armoured text strings::
209 210 211
    linkzmq:zmq_z85_decode[3]
    linkzmq:zmq_z85_encode[3]

212

Martin Lucina's avatar
Martin Lucina committed
213 214 215 216 217 218 219 220
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.

221 222 223 224 225 226
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
227 228


229 230 231 232 233 234 235 236 237 238 239 240 241
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]


242 243 244 245 246 247 248 249
MISCELLANEOUS
-------------
The following miscellaneous functions are provided:

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


Martin Lucina's avatar
Martin Lucina committed
250 251 252 253 254 255 256
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.
257

258 259
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
260

261 262 263

AUTHORS
-------
264 265
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>.
266 267 268 269 270 271 272 273 274 275 276 277 278 279


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.