diff options
author | Martin Sustrik <sustrik@fastmq.commkdir> | 2009-12-13 18:32:22 +0100 |
---|---|---|
committer | Martin Sustrik <sustrik@fastmq.commkdir> | 2009-12-13 18:32:22 +0100 |
commit | 68488215da8e03a74ca4da6b822e4cfa3b71d73a (patch) | |
tree | 59addf470f32cb05b9764123f9210c9d342b6fac /man/man3 | |
parent | 0637e06387ac0676e9595246eb60a6809664b01a (diff) |
Man pages for XREQ/XREP/zmq_queue updated
Diffstat (limited to 'man/man3')
-rw-r--r-- | man/man3/zmq_socket.3 | 37 |
1 files changed, 35 insertions, 2 deletions
diff --git a/man/man3/zmq_socket.3 b/man/man3/zmq_socket.3 index a73bba5..de32d5f 100644 --- a/man/man3/zmq_socket.3 +++ b/man/man3/zmq_socket.3 @@ -18,33 +18,66 @@ from any other thread. Socket to communicate with a single peer. Allows for only a single connect or a single bind. There's no message routing or message filtering involved. +Compatible peer sockets: ZMQ_P2P. + .IP "\fBZMQ_PUB\fP" Socket to distribute data. Recv fuction is not implemented for this socket type. Messages are distributed in fanout fashion to all the peers. +Compatible peer sockets: ZMQ_SUB. + .IP "\fBZMQ_SUB\fP" Socket to subscribe for data. Send function is not implemented for this socket type. Initially, socket is subscribed for no messages. Use ZMQ_SUBSCRIBE option to specify which messages to subscribe for. +Compatible peer sockets: ZMQ_PUB. + .IP "\fBZMQ_REQ\fP" Socket to send requests and receive replies. Requests are load-balanced among all the peers. This socket type allows only an alternated sequence of send's and recv's. +Compatible peer sockets: ZMQ_REP, ZMQ_XREP. + .IP "\fBZMQ_REP\fP" Socket to receive requests and send replies. This socket type allows only an alternated sequence of recv's and send's. Each send is routed to the peer that issued the last received request. +Compatible peer sockets: ZMQ_REQ, ZMQ_XREQ. + +.IP "\fBZMQ_XREQ\fP" +Special socket type to be used in request/reply middleboxes such as +.BR zmq_queue(7) . +Requests forwarded using this socket type should be tagged by a proper postix +identifying the original requester. Replies received by this socket are tagged +with a proper postfix that can be use to route the reply back to the original +requester. + +Compatible peer sockets: ZMQ_REP, ZMQ_XREP. + +.IP "\fBZMQ_XREP\fP" +Special socket type to be used in request/reply middleboxes such as +.BR zmq_queue(7) . +Requests received using this socket are already properly tagged with postfix +identifying the original requester. When sending a reply via XREP socket the +message should be tagged with a postfix from a corresponding request. + +Compatible peer sockets: ZMQ_REQ, ZMQ_XREQ. + .IP "\fBZMQ_UPSTREAM\fP" Socket to receive messages from up the stream. Messages are fair-queued from among all the connected peers. Send function is not implemented for -this socket type. +this socket type. + +Compatible peer sockets: ZMQ_DOWNSTREAM. .IP "\fBZMQ_DOWNSTREAM\fP" Socket to send messages down stream. Messages are load-balanced among all the -connected peers. Send function is not implemented for this socket type. +connected peers. Send function is not implemented for this socket type. + +Compatible peer sockets: ZMQ_UPSTREAM. .SH RETURN VALUE Function returns socket handle is successful. Otherwise it returns NULL and |