zmq_socket.txt 22.9 KB
Newer Older
1 2 3 4 5 6
zmq_socket(3)
=============


NAME
----
Martin Lucina's avatar
Martin Lucina committed
7
zmq_socket - create 0MQ socket
8 9 10 11


SYNOPSIS
--------
Martin Lucina's avatar
Martin Lucina committed
12
*void *zmq_socket (void '*context', int 'type');*
13 14 15 16


DESCRIPTION
-----------
Martin Lucina's avatar
Martin Lucina committed
17 18
The 'zmq_socket()' function shall create a 0MQ socket within the specified
'context' and return an opaque handle to the newly created socket. The 'type'
Martin Lucina's avatar
Martin Lucina committed
19
argument specifies the socket type, which determines the semantics of
Martin Lucina's avatar
Martin Lucina committed
20 21
communication over the socket.

22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
The newly created socket is initially unbound, and not associated with any
endpoints. In order to establish a message flow a socket must first be
connected to at least one endpoint with linkzmq:zmq_connect[3], or at least one
endpoint must be created for accepting incoming connections with
linkzmq:zmq_bind[3].

.Key differences to conventional sockets
Generally speaking, conventional sockets present a _synchronous_ interface to
either connection-oriented reliable byte streams (SOCK_STREAM), or
connection-less unreliable datagrams (SOCK_DGRAM). In comparison, 0MQ sockets
present an abstraction of an asynchronous _message queue_, with the exact
queueing semantics depending on the socket type in use. Where conventional
sockets transfer streams of bytes or discrete datagrams, 0MQ sockets transfer
discrete _messages_.

0MQ sockets being _asynchronous_ means that the timings of the physical
38
connection setup and tear down, reconnect and effective delivery are transparent
39 40 41 42 43 44 45 46 47 48
to the user and organized by 0MQ itself. Further, messages may be _queued_ in
the event that a peer is unavailable to receive them.

Conventional sockets allow only strict one-to-one (two peers), many-to-one
(many clients, one server), or in some cases one-to-many (multicast)
relationships. With the exception of 'ZMQ_PAIR', 0MQ sockets may be connected
*to multiple endpoints* using _zmq_connect()_, while simultaneously accepting
incoming connections *from multiple endpoints* bound to the socket using
_zmq_bind()_, thus allowing many-to-many relationships.

49
.Thread safety
50 51
0MQ has both thread safe socket type and _not_ thread safe socket types.
Applications MUST NOT use a _not_ thread safe socket
52
from multiple threads except after migrating a socket from one thread to
53
another with a "full fence" memory barrier.
54

55 56 57 58 59 60 61 62
Following are the thread safe sockets:
* ZMQ_CLIENT
* ZMQ_SERVER
* ZMQ_DISH
* ZMQ_RADIO
* ZMQ_SCATTER
* ZMQ_GATHER

63
.Socket types
64 65
The following sections present the socket types defined by 0MQ, grouped by the
general _messaging pattern_ which is built from related socket types.
66 67


68 69 70 71 72 73 74 75 76
Client-server pattern
~~~~~~~~~~~~~~~~~~~~~

The client-server pattern is used to allow a single 'ZMQ_SERVER' _server_ talk
to one or more 'ZMQ_CLIENT' _clients_. The client always starts the conversation,
after which either peer can send messages asynchronously, to the other.

The client-server pattern is formally defined by http://rfc.zeromq.org/spec:41.

77 78
NOTE: Server-client is still in draft phase.

79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
ZMQ_CLIENT
^^^^^^^^^^
A 'ZMQ_CLIENT' socket talks to a 'ZMQ_SERVER' socket. Either peer can connect,
though the usual and recommended model is to bind the 'ZMQ_SERVER' and connect
the 'ZMQ_CLIENT'.

If the 'ZMQ_CLIENT' socket has established a connection, linkzmq:zmq_send[3]
will accept messages, queue them, and send them as rapidly as the network
allows. The outgoing buffer limit is defined by the high water mark for the
socket. If the outgoing buffer is full, or if there is no connected peer,
linkzmq:zmq_send[3] will block, by default. The 'ZMQ_CLIENT' socket will not
drop messages.

When a 'ZMQ_CLIENT' socket is connected to multiple 'ZMQ_SERVER' sockets,
outgoing messages are distributed between connected peers on a round-robin
basis. Likewise, the 'ZMQ_CLIENT' socket receives messages fairly from each
connected  peer. This usage is sensible only for stateless protocols.

'ZMQ_CLIENT' sockets are threadsafe and can be used from multiple threads
at the same time. Note that replies from a 'ZMQ_SERVER' socket will go to
99
the first client thread that calls linkzmq:zmq_msg_recv[3]. If you need to get
100 101 102
replies back to the originating thread, use one 'ZMQ_CLIENT' socket per
thread.

103 104 105 106 107
NOTE: 'ZMQ_CLIENT' sockets are threadsafe. They do not accept the ZMQ_SNDMORE
option on sends not ZMQ_RCVMORE on receives. This limits them to single part
data. The intention is to extend the API to allow scatter/gather of multi-part
data.

108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
[horizontal]
.Summary of ZMQ_CLIENT characteristics
Compatible peer sockets:: 'ZMQ_SERVER'
Direction:: Bidirectional
Send/receive pattern:: Unrestricted
Outgoing routing strategy:: Round-robin
Incoming routing strategy:: Fair-queued
Action in mute state:: Block


ZMQ_SERVER
^^^^^^^^^^
A 'ZMQ_SERVER' socket talks to a set of 'ZMQ_CLIENT' sockets. A 'ZMQ_SERVER'
socket can only reply to an incoming message: the 'ZMQ_CLIENT' peer must
always initiate a conversation.

Each received message has a 'routing_id' that is a 32-bit unsigned integer.
The application can fetch this with linkzmq:zmq_msg_routing_id[3]. To send
a message to a given 'ZMQ_CLIENT' peer the application must set the peer's
'routing_id' on the message, using linkzmq:zmq_msg_set_routing_id[3].

If the 'routing_id' is not specified, or does not refer to a connected client
peer, the send call will fail with EHOSTUNREACH. If the outgoing buffer for
131 132 133
the client peer is full, the send call shall block, unless ZMQ_DONT_WAIT is
used in the send, in which case it shall fail with EAGAIN. The 'ZMQ_SERVER'
socket shall not drop messages in any case.
134

135 136 137 138 139
NOTE: 'ZMQ_SERVER' sockets are threadsafe. They do not accept the ZMQ_SNDMORE
option on sends not ZMQ_RCVMORE on receives. This limits them to single part
data. The intention is to extend the API to allow scatter/gather of multi-part
data.

140 141 142 143 144 145 146 147 148 149
[horizontal]
.Summary of ZMQ_SERVER characteristics
Compatible peer sockets:: 'ZMQ_CLIENT'
Direction:: Bidirectional
Send/receive pattern:: Unrestricted
Outgoing routing strategy:: See text
Incoming routing strategy:: Fair-queued
Action in mute state:: Return EAGAIN


150
Radio-dish pattern
151 152
~~~~~~~~~~~~~~~~~~

153 154 155 156 157 158 159 160
The radio-dish pattern is used for one-to-many distribution of data from
a single _publisher_ to multiple _subscribers_ in a fan out fashion.

Radio-dish is using groups (vs Pub-sub topics), Dish sockets can join a group
and each message sent by Radio sockets belong to a group.

Groups are null terminated strings limited to 16 chars length (including null).
The intention is to increase the length to 40 chars (including null).
161
The encoding of groups shall be UTF8.
162 163 164 165 166 167 168 169

Groups are matched using exact matching (vs prefix matching of PubSub).

NOTE: Radio-dish is still in draft phase.

ZMQ_RADIO
^^^^^^^
A socket of type 'ZMQ_RADIO' is used by a _publisher_ to distribute data.
170
Each message belong to a group, a group is specified with linkzmq:zmq_msg_set_group[3].
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
Messages are distributed to all members of a group.
The linkzmq:zmq_recv[3] function is not implemented for this socket type.

When a 'ZMQ_RADIO' socket enters the 'mute' state due to having reached the
high water mark for a _subscriber_, then any messages that would be sent to the
_subscriber_ in question shall instead be dropped until the mute state
ends. The _zmq_send()_ function shall never block for this socket type.

NOTE: 'ZMQ_RADIO' sockets are threadsafe. They do not accept the ZMQ_SNDMORE
option on sends. This limits them to single part data.

[horizontal]
.Summary of ZMQ_RADIO characteristics
Compatible peer sockets:: 'ZMQ_DISH'
Direction:: Unidirectional
Send/receive pattern:: Send only
Incoming routing strategy:: N/A
Outgoing routing strategy:: Fan out
Action in mute state:: Drop


ZMQ_DISH
^^^^^^^
A socket of type 'ZMQ_DISH' is used by a _subscriber_ to subscribe to groups
distributed by a _radio_. Initially a 'ZMQ_DISH' socket is not subscribed to
any groups, use linkzmq:zmq_join[3] to
join a group.
To get the group the message belong to call linkzmq:zmq_msg_group[3].
The _zmq_send()_ function is not implemented for this socket type.

NOTE: 'ZMQ_DISH' sockets are threadsafe. They do not accept ZMQ_RCVMORE on receives.
This limits them to single part data.

[horizontal]
.Summary of ZMQ_DISH characteristics
Compatible peer sockets:: 'ZMQ_RADIO'
Direction:: Unidirectional
Send/receive pattern:: Receive only
Incoming routing strategy:: Fair-queued
Outgoing routing strategy:: N/A


Martin Lucina's avatar
Martin Lucina committed
213 214 215
Publish-subscribe pattern
~~~~~~~~~~~~~~~~~~~~~~~~~
The publish-subscribe pattern is used for one-to-many distribution of data from
216
a single _publisher_ to multiple _subscribers_ in a fan out fashion.
Martin Lucina's avatar
Martin Lucina committed
217

218
The publish-subscribe pattern is formally defined by http://rfc.zeromq.org/spec:29.
Martin Lucina's avatar
Martin Lucina committed
219

220 221
ZMQ_PUB
^^^^^^^
Martin Lucina's avatar
Martin Lucina committed
222
A socket of type 'ZMQ_PUB' is used by a _publisher_ to distribute data.
223
Messages sent are distributed in a fan out fashion to all connected peers.
224
The linkzmq:zmq_recv[3] function is not implemented for this socket type.
Martin Lucina's avatar
Martin Lucina committed
225

Pieter Hintjens's avatar
Pieter Hintjens committed
226
When a 'ZMQ_PUB' socket enters the 'mute' state due to having reached the
227
high water mark for a _subscriber_, then any messages that would be sent to the
Pieter Hintjens's avatar
Pieter Hintjens committed
228
_subscriber_ in question shall instead be dropped until the mute state
229
ends. The _zmq_send()_ function shall never block for this socket type.
Martin Lucina's avatar
Martin Lucina committed
230

231 232
[horizontal]
.Summary of ZMQ_PUB characteristics
233
Compatible peer sockets:: 'ZMQ_SUB', 'ZMQ_XSUB'
234
Direction:: Unidirectional
235 236
Send/receive pattern:: Send only
Incoming routing strategy:: N/A
237
Outgoing routing strategy:: Fan out
Pieter Hintjens's avatar
Pieter Hintjens committed
238
Action in mute state:: Drop
239 240 241 242


ZMQ_SUB
^^^^^^^
Martin Lucina's avatar
Martin Lucina committed
243 244
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
245 246 247 248 249 250
any messages, use the 'ZMQ_SUBSCRIBE' option of linkzmq:zmq_setsockopt[3] to
specify which messages to subscribe to. The _zmq_send()_ function is not
implemented for this socket type.

[horizontal]
.Summary of ZMQ_SUB characteristics
251
Compatible peer sockets:: 'ZMQ_PUB', 'ZMQ_XPUB'
252
Direction:: Unidirectional
253 254 255
Send/receive pattern:: Receive only
Incoming routing strategy:: Fair-queued
Outgoing routing strategy:: N/A
Martin Lucina's avatar
Martin Lucina committed
256 257


258 259 260 261 262
ZMQ_XPUB
^^^^^^^^
Same as ZMQ_PUB except that you can receive subscriptions from the peers
in form of incoming messages. Subscription message is a byte 1 (for
subscriptions) or byte 0 (for unsubscriptions) followed by the subscription
263 264
body. Messages without a sub/unsub prefix are also received, but have no
effect on subscription status.
265 266 267 268

[horizontal]
.Summary of ZMQ_XPUB characteristics
Compatible peer sockets:: 'ZMQ_SUB', 'ZMQ_XSUB'
269
Direction:: Unidirectional
270 271 272
Send/receive pattern:: Send messages, receive subscriptions
Incoming routing strategy:: N/A
Outgoing routing strategy:: Fan out
Pieter Hintjens's avatar
Pieter Hintjens committed
273
Action in mute state:: Drop
274 275


276 277
ZMQ_XSUB
^^^^^^^^
278 279
Same as ZMQ_SUB except that you subscribe by sending subscription messages to
the socket. Subscription message is a byte 1 (for subscriptions) or byte 0
280 281
(for unsubscriptions) followed by the subscription body. Messages without a
sub/unsub prefix may also be sent, but have no effect on subscription status.
282 283 284 285

[horizontal]
.Summary of ZMQ_XSUB characteristics
Compatible peer sockets:: 'ZMQ_PUB', 'ZMQ_XPUB'
286
Direction:: Unidirectional
287 288 289
Send/receive pattern:: Receive messages, send subscriptions
Incoming routing strategy:: Fair-queued
Outgoing routing strategy:: N/A
Pieter Hintjens's avatar
Pieter Hintjens committed
290
Action in mute state:: Drop
291 292


293 294 295
Pipeline pattern
~~~~~~~~~~~~~~~~
The pipeline pattern is used for distributing data to _nodes_ arranged in
Martin Lucina's avatar
Martin Lucina committed
296 297
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
298
multiple _nodes_ data is round-robined among all connected _nodes_.
Martin Lucina's avatar
Martin Lucina committed
299

300
The pipeline pattern is formally defined by http://rfc.zeromq.org/spec:30.
Martin Lucina's avatar
Martin Lucina committed
301

302 303 304
ZMQ_PUSH
^^^^^^^^
A socket of type 'ZMQ_PUSH' is used by a pipeline _node_ to send messages
305
to downstream pipeline _nodes_. Messages are round-robined to all connected
306 307
downstream _nodes_. The _zmq_recv()_ function is not implemented for this
socket type.
Martin Lucina's avatar
Martin Lucina committed
308

Pieter Hintjens's avatar
Pieter Hintjens committed
309
When a 'ZMQ_PUSH' socket enters the 'mute' state due to having reached the
310 311
high water mark for all downstream _nodes_, or if there are no downstream
_nodes_ at all, then any linkzmq:zmq_send[3] operations on the socket shall
Pieter Hintjens's avatar
Pieter Hintjens committed
312
block until the mute state ends or at least one downstream _node_
313 314
becomes available for sending; messages are not discarded.

315
[horizontal]
316 317
.Summary of ZMQ_PUSH characteristics
Compatible peer sockets:: 'ZMQ_PULL'
318 319 320
Direction:: Unidirectional
Send/receive pattern:: Send only
Incoming routing strategy:: N/A
321
Outgoing routing strategy:: Round-robin
Pieter Hintjens's avatar
Pieter Hintjens committed
322
Action in mute state:: Block
323

Martin Lucina's avatar
Martin Lucina committed
324

325 326 327 328 329 330 331
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
connected upstream _nodes_. The _zmq_send()_ function is not implemented for
this socket type.

332
[horizontal]
333 334
.Summary of ZMQ_PULL characteristics
Compatible peer sockets:: 'ZMQ_PUSH'
335 336 337 338
Direction:: Unidirectional
Send/receive pattern:: Receive only
Incoming routing strategy:: Fair-queued
Outgoing routing strategy:: N/A
Pieter Hintjens's avatar
Pieter Hintjens committed
339
Action in mute state:: Block
340

Martin Lucina's avatar
Martin Lucina committed
341

342 343
Exclusive pair pattern
~~~~~~~~~~~~~~~~~~~~~~
344 345 346
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.
Martin Lucina's avatar
Martin Lucina committed
347

348
The exclusive pair pattern is formally defined by http://rfc.zeromq.org/spec:31.
Martin Lucina's avatar
Martin Lucina committed
349

350 351
ZMQ_PAIR
^^^^^^^^
352 353 354
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
'ZMQ_PAIR' socket.
Martin Lucina's avatar
Martin Lucina committed
355

Pieter Hintjens's avatar
Pieter Hintjens committed
356
When a 'ZMQ_PAIR' socket enters the 'mute' state due to having reached the
357 358 359 360
high water mark for the connected peer, or if no peer is connected, then
any linkzmq:zmq_send[3] operations on the socket shall block until the peer
becomes available for sending; messages are not discarded.

361 362 363 364 365
While 'ZMQ_PAIR' sockets can be used over transports other than linkzmq:zmq_inproc[7],
their inability to auto-reconnect coupled with the fact new incoming connections will
be terminated while any previous connections (including ones in a closing state)
exist makes them unsuitable for TCP in most cases.

366 367
NOTE: 'ZMQ_PAIR' sockets are designed for inter-thread communication across
the linkzmq:zmq_inproc[7] transport and do not implement functionality such
368
as auto-reconnection.
369

370 371 372 373 374 375 376
[horizontal]
.Summary of ZMQ_PAIR characteristics
Compatible peer sockets:: 'ZMQ_PAIR'
Direction:: Bidirectional
Send/receive pattern:: Unrestricted
Incoming routing strategy:: N/A
Outgoing routing strategy:: N/A
Pieter Hintjens's avatar
Pieter Hintjens committed
377
Action in mute state:: Block
378

379

380 381
Native Pattern
~~~~~~~~~~~~~~
382
The native pattern is used for communicating with TCP peers and allows
383 384 385 386 387
asynchronous requests and replies in either direction.


ZMQ_STREAM
^^^^^^^^^^
388 389
A socket of type 'ZMQ_STREAM' is used to send and receive TCP data from a
non-0MQ peer, when using the tcp:// transport. A 'ZMQ_STREAM' socket can
390 391 392
act as client and/or server, sending and/or receiving TCP data asynchronously.

When receiving TCP data, a 'ZMQ_STREAM' socket shall prepend a message part
393
containing the _routing id_ of the originating peer to the message before passing
394 395
it to the application. Messages received are fair-queued from among all
connected peers.
396

397
When sending TCP data, a 'ZMQ_STREAM' socket shall remove the first part of the
398
message and use it to determine the _routing id_ of the peer the message shall be
399 400
routed to, and unroutable messages shall cause an EHOSTUNREACH or EAGAIN error.

401
To open a connection to a server, use the zmq_connect call, and then fetch the
402
socket routing id using the zmq_getsockopt call with the ZMQ_ROUTING_ID option.
403

404
To close a specific connection, send the routing id frame followed by a
405 406 407 408 409
zero-length message (see EXAMPLE section).

When a connection is made, a zero-length message will be received by the
application.  Similarly, when the peer disconnects (or the connection is lost),
a zero-length message will be received by the application.
410

411 412
You must send one routing id frame followed by one data frame. The ZMQ_SNDMORE
flag is required for routing id frames but is ignored on data frames.
413

414 415 416 417 418 419 420 421 422 423
[horizontal]
.Summary of ZMQ_STREAM characteristics
Compatible peer sockets:: none.
Direction:: Bidirectional
Send/receive pattern:: Unrestricted
Outgoing routing strategy:: See text
Incoming routing strategy:: Fair-queued
Action in mute state:: EAGAIN


424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
Request-reply pattern
~~~~~~~~~~~~~~~~~~~~~
The request-reply pattern is used for sending requests from a ZMQ_REQ _client_
to one or more ZMQ_REP _services_, and receiving subsequent replies to each
request sent.

The request-reply pattern is formally defined by http://rfc.zeromq.org/spec:28.

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
sequence of _zmq_send(request)_ and subsequent _zmq_recv(reply)_ calls. Each
request sent is round-robined among all _services_, and each reply received is
matched with the last issued request.

If no services are available, then any send operation on the socket shall
block until at least one _service_ becomes available. The REQ socket shall
not discard messages.

[horizontal]
.Summary of ZMQ_REQ characteristics
Compatible peer sockets:: 'ZMQ_REP', 'ZMQ_ROUTER'
Direction:: Bidirectional
Send/receive pattern:: Send, Receive, Send, Receive, ...
Outgoing routing strategy:: Round-robin
Incoming routing strategy:: Last peer
Action in mute state:: 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
sequence of _zmq_recv(request)_ and subsequent _zmq_send(reply)_ calls. Each
request received is fair-queued from among all _clients_, and each reply sent
is routed to the _client_ that issued the last request. If the original
requester does not exist any more the reply is silently discarded.

[horizontal]
.Summary of ZMQ_REP characteristics
Compatible peer sockets:: 'ZMQ_REQ', 'ZMQ_DEALER'
Direction:: Bidirectional
Send/receive pattern:: Receive, Send, Receive, Send, ...
Incoming routing strategy:: Fair-queued
Outgoing routing strategy:: Last peer


ZMQ_DEALER
^^^^^^^^^^
A socket of type 'ZMQ_DEALER' is an advanced pattern used for extending
request/reply sockets. Each message sent is round-robined among all connected
peers, and each message received is fair-queued from all connected peers.

When a 'ZMQ_DEALER' socket enters the 'mute' state due to having reached the
high water mark for all peers, or if there are no peers at all, then any
linkzmq:zmq_send[3] operations on the socket shall block until the mute
state ends or at least one peer becomes available for sending; messages are not
discarded.

When a 'ZMQ_DEALER' socket is connected to a 'ZMQ_REP' socket each message sent
must consist of an empty message part, the _delimiter_, followed by one or more
_body parts_.

[horizontal]
.Summary of ZMQ_DEALER characteristics
Compatible peer sockets:: 'ZMQ_ROUTER', 'ZMQ_REP', 'ZMQ_DEALER'
Direction:: Bidirectional
Send/receive pattern:: Unrestricted
Outgoing routing strategy:: Round-robin
Incoming routing strategy:: Fair-queued
Action in mute state:: Block


ZMQ_ROUTER
^^^^^^^^^^
A socket of type 'ZMQ_ROUTER' is an advanced socket type used for extending
request/reply sockets. When receiving messages a 'ZMQ_ROUTER' socket shall
502
prepend a message part containing the _routing id_ of the originating peer to the
503 504
message before passing it to the application. Messages received are fair-queued
from among all connected peers. When sending messages a 'ZMQ_ROUTER' socket shall
505
remove the first part of the message and use it to determine the _routing id _ of
506 507 508 509
the peer the message shall be routed to. If the peer does not exist anymore, or
has never existed, the message shall be silently discarded. However, if
'ZMQ_ROUTER_MANDATORY' socket option is set to '1', the socket shall fail
with EHOSTUNREACH in both cases.
510 511 512 513

When a 'ZMQ_ROUTER' socket enters the 'mute' state due to having reached the
high water mark for all peers, then any messages sent to the socket shall be dropped
until the mute state ends. Likewise, any messages routed to a peer for which
514 515 516 517 518 519 520 521
the individual high water mark has been reached shall also be dropped. If,
'ZMQ_ROUTER_MANDATORY' is set to '1', the socket shall block or return EAGAIN in
both cases.

When a 'ZMQ_ROUTER' socket has 'ZMQ_ROUTER_MANDATORY' flag set to '1', the
socket shall generate 'ZMQ_POLLIN' events upon reception of messages from one
or more peers. Likewise, the socket shall generate 'ZMQ_POLLOUT' events when
at least one message can be sent to one or more peers.
522 523

When a 'ZMQ_REQ' socket is connected to a 'ZMQ_ROUTER' socket, in addition to the
524
_routing id_ of the originating peer each message received shall contain an empty
525
_delimiter_ message part. Hence, the entire structure of each received message
526
as seen by the application becomes: one or more _routing id_ parts, _delimiter_
527 528 529 530 531 532 533 534 535 536
part, one or more _body parts_. When sending replies to a 'ZMQ_REQ' socket the
application must include the _delimiter_ part.

[horizontal]
.Summary of ZMQ_ROUTER characteristics
Compatible peer sockets:: 'ZMQ_DEALER', 'ZMQ_REQ', 'ZMQ_ROUTER'
Direction:: Bidirectional
Send/receive pattern:: Unrestricted
Outgoing routing strategy:: See text
Incoming routing strategy:: Fair-queued
537
Action in mute state:: Drop (see text)
538 539


540 541
RETURN VALUE
------------
Martin Lucina's avatar
Martin Lucina committed
542 543 544
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.
545 546 547 548 549


ERRORS
------
*EINVAL*::
Martin Lucina's avatar
Martin Lucina committed
550
The requested socket 'type' is invalid.
551
*EFAULT*::
552
The provided 'context' is invalid.
553 554
*EMFILE*::
The limit on the total number of open 0MQ sockets has been reached.
555 556
*ETERM*::
The context specified was terminated.
557

558 559 560 561 562 563 564 565 566 567 568
EXAMPLE
-------
.Creating a simple HTTP server using ZMQ_STREAM
----
void *ctx = zmq_ctx_new ();
assert (ctx);
/* Create ZMQ_STREAM socket */
void *socket = zmq_socket (ctx, ZMQ_STREAM);
assert (socket);
int rc = zmq_bind (socket, "tcp://*:8080");
assert (rc == 0);
569 570 571
/* Data structure to hold the ZMQ_STREAM routing id */
uint8_t routing_id [256];
size_t routing_id_size = 256;
572 573 574
/* Data structure to hold the ZMQ_STREAM received data */
uint8_t raw [256];
size_t raw_size = 256;
575
while (1) {
576 577 578
	/*  Get HTTP request; routing id frame and then request */
	routing_id_size = zmq_recv (socket, routing_id, 256, 0);
	assert (routing_id_size > 0);
579 580 581 582
	do {
		raw_size = zmq_recv (socket, raw, 256, 0);
		assert (raw_size >= 0);
	} while (raw_size == 256);
583 584 585 586 587 588
	/* Prepares the response */
	char http_response [] =
		"HTTP/1.0 200 OK\r\n"
		"Content-Type: text/plain\r\n"
		"\r\n"
		"Hello, World!";
589 590
	/* Sends the routing id frame followed by the response */
	zmq_send (socket, routing_id, routing_id_size, ZMQ_SNDMORE);
591
	zmq_send (socket, http_response, strlen (http_response), 0);
592 593
	/* Closes the connection by sending the routing id frame followed by a zero response */
	zmq_send (socket, routing_id, routing_id_size, ZMQ_SNDMORE);
594
	zmq_send (socket, 0, 0, 0);
595 596 597 598 599 600
}
zmq_close (socket);
zmq_ctx_destroy (ctx);
----


601 602 603 604 605 606 607 608
SEE ALSO
--------
linkzmq:zmq_init[3]
linkzmq:zmq_setsockopt[3]
linkzmq:zmq_bind[3]
linkzmq:zmq_connect[3]
linkzmq:zmq_send[3]
linkzmq:zmq_recv[3]
609
linkzmq:zmq_inproc[7]
610
linkzmq:zmq[7]
611

612 613 614

AUTHORS
-------
615 616
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>.