generic-library/libzmq
1
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2025-07-04 17:40:04 +02:00
Code Issues Projects Releases Wiki Activity

Documentation updates

Browse Source 
Clarify pipeline and exclusive pair patterns
This commit is contained in:
Martin Lucina 2010-05-31 17:21:12 +02:00
parent 8a4df431de
commit 7bbe754cb4
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/zmq_socket.txt
View File

@ -70,10 +70,9 @@ for this socket type.
Pipeline pattern Pipeline pattern
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
The pipeline pattern is used for distributing data to _nodes_ arranged in The pipeline pattern is used for distributing data to _nodes_ arranged in
a pipeline. Data always flows *down* the pipeline, and each stage of the a pipeline. Data always flows down the pipeline, and each stage of the pipeline
pipeline is connected to at least one _node_. When a pipeline stage is is connected to at least one _node_. When a pipeline stage is connected to
connected to multiple _nodes_ data is processed by all connected _nodes_ in multiple _nodes_ data is load-balanced among all connected _nodes_.
parallel.
Socket type:: 'ZMQ_DOWNSTREAM' Socket type:: 'ZMQ_DOWNSTREAM'
Compatible peer sockets:: 'ZMQ_UPSTREAM' Compatible peer sockets:: 'ZMQ_UPSTREAM'
@ -94,8 +93,8 @@ for this socket type.
Exclusive pair pattern Exclusive pair pattern
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
The exclusive pair pattern is used for communicating exclusively between two The exclusive pair is an advanced pattern used for communicating exclusively
peers. between two peers.
Socket type:: 'ZMQ_PAIR' Socket type:: 'ZMQ_PAIR'
Compatible peer sockets:: 'ZMQ_PAIR' Compatible peer sockets:: 'ZMQ_PAIR'
@ -105,8 +104,7 @@ time. No message routing or filtering is performed on messages sent over a
'ZMQ_PAIR' socket. 'ZMQ_PAIR' socket.
NOTE: 'ZMQ_PAIR' sockets are experimental, and are currently missing several NOTE: 'ZMQ_PAIR' sockets are experimental, and are currently missing several
features such as auto-reconnection. Developers should consider other patterns features such as auto-reconnection.
in preference to the exclusive pair pattern.
RETURN VALUE RETURN VALUE