3party/libzmq
0
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2025-03-09 15:26:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update bind and connect documentation for clarity

Browse Source 
Based on discussion with Steve O on the list, make the difference
between bind and connect usage more clear, and add a note reflecting the
fact that inproc must have bind before connect to reinforce the
information in zmq_inproc.
This commit is contained in:
Ian Barber 2012-06-12 15:46:26 +01:00
parent b448de926b
commit 7b78ed9d60
2 changed files with 18 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/zmq_bind.txt
View File

@ -29,11 +29,13 @@ The following transports are defined:
'tcp':: unicast transport using TCP, see linkzmq:zmq_tcp[7]
'pgm', 'epgm':: reliable multicast transport using PGM, see linkzmq:zmq_pgm[7]
With the exception of 'ZMQ_PAIR' sockets, a single socket may be connected to
multiple endpoints using _zmq_connect()_, while simultaneously accepting
incoming connections from multiple endpoints bound to the socket using
_zmq_bind()_. Refer to linkzmq:zmq_socket[3] for a description of the exact
semantics involved when connecting or binding a socket to multiple endpoints.
ZeroMQ sockets support one-to-many and many-to-one semantics. With the exception
of 'ZMQ_PAIR' sockets every ZeroMQ socket type supports being bound with
_zmq_bind()_ as a singular endpoint or connecting with _zmq_connect()_ as one
of many endpoints. This allows combinations such as 1 ZMQ_REP to 100 ZMQ_REP and
100 ZMQ_REQ to 1 ZMQ_REP socket connections. Refer to linkzmq:zmq_socket[3] for
a description of the exact semantics involved when connecting or binding a socket
to multiple endpoints.
RETURN VALUE

17
doc/zmq_connect.txt
View File

@ -29,15 +29,20 @@ The following transports are defined:
'tcp':: unicast transport using TCP, see linkzmq:zmq_tcp[7]
'pgm', 'epgm':: reliable multicast transport using PGM, see linkzmq:zmq_pgm[7]
With the exception of 'ZMQ_PAIR' sockets, a single socket may be connected to
multiple endpoints using _zmq_connect()_, while simultaneously accepting
incoming connections from multiple endpoints bound to the socket using
_zmq_bind()_. Refer to linkzmq:zmq_socket[3] for a description of the exact
semantics involved when connecting or binding a socket to multiple endpoints.
ZeroMQ sockets support one-to-many and many-to-one semantics. With the exception
of 'ZMQ_PAIR' sockets every ZeroMQ socket type supports being bound with
_zmq_bind()_ as a singular endpoint or connecting with _zmq_connect()_ as one
of many endpoints. This allows combinations such as 1 ZMQ_REP to 100 ZMQ_REP and
100 ZMQ_REQ to 1 ZMQ_REP socket connections. Refer to linkzmq:zmq_socket[3] for
a description of the exact semantics involved when connecting or binding a socket
to multiple endpoints.
NOTE: The connection will not be performed immediately but as needed by 0MQ.
Thus a successful invocation of _zmq_connect()_ does not indicate that a
physical connection was or can actually be established.
physical connection was or can actually be established. Because of this, for most
socket types the order in which a listening socket is bound and a connecting socket
is connected does not matter. However, for inproc:// scheme sockets, the zmq_bind()
must be executed before any sockets zmq_connect() to that endpoint
RETURN VALUE