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

man pages are more specific on NIC name issue

Browse Source
This commit is contained in:
Martin Sustrik 2010-01-14 14:11:34 +01:00
parent 067ba3b9f7
commit b60342ae1a
5 changed files with 31 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
man/man3/zmq_bind.3
View File

@ -5,16 +5,20 @@ zmq_bind \- binds the socket to the specified address
.B int zmq_bind (void *s, const char *addr); .B int zmq_bind (void *s, const char *addr);
.SH DESCRIPTION .SH DESCRIPTION
The function binds socket The function binds socket
.IR s to a particular transport. Actual semantics of the .IR s
to a particular transport. Actual semantics of the
command depend on the underlying transport mechanism, however, in cases where command depend on the underlying transport mechanism, however, in cases where
peers connect in an asymetric manner, peers connect in an asymetric manner,
.IR zmq_bind .IR zmq_bind
should be called first, should be called first,
.IR zmq_connect .IR zmq_connect
afterwards. For actual formats of afterwards. Actual formats of
.IR addr .IR addr
parameter for different types of transport have a look at parameter are defined by individual transports. For a list of supported
.IR zmq(7) . transports have a look at
.IR zmq(7)
manual page.
Note that single socket can be bound (and connected) to Note that single socket can be bound (and connected) to
arbitrary number of peers using different transport mechanisms. arbitrary number of peers using different transport mechanisms.
.SH RETURN VALUE .SH RETURN VALUE

12
man/man3/zmq_connect.3
View File

@ -5,17 +5,21 @@ zmq_connect \- connect the socket to the specified peer
.B int zmq_connect (void *s, const char *addr); .B int zmq_connect (void *s, const char *addr);
.SH DESCRIPTION .SH DESCRIPTION
The function connect socket The function connect socket
.IR s to the peer identified by .IR s
to the peer identified by
.IR addr . .IR addr .
Actual semantics of the command depend on the underlying transport mechanism, Actual semantics of the command depend on the underlying transport mechanism,
however, in cases where peers connect in an asymetric manner, however, in cases where peers connect in an asymetric manner,
.IR zmq_bind .IR zmq_bind
should be called first, should be called first,
.IR zmq_connect .IR zmq_connect
afterwards. For actual formats of afterwards. Formats of the
.IR addr .IR addr
parameter for different types of transport have a look at parameter are defined by individual transports. For a list of supported
.IR zmq(7) . transports have a look at
.IR zmq(7)
manual page.
Note that single socket can be connected (and bound) to Note that single socket can be connected (and bound) to
arbitrary number of peers using different transport mechanisms. arbitrary number of peers using different transport mechanisms.
.SH RETURN VALUE .SH RETURN VALUE

5
man/man7/zmq_pgm.7
View File

@ -32,6 +32,11 @@ mutlicast group should be specified in the numeric representation. For example:
pgm://192.168.0.111:224.0.0.1:5555 pgm://192.168.0.111:224.0.0.1:5555
.fi .fi
Note that NIC names are not standardised by POSIX. They tend to be rather
arbitrary and platform dependent. Say, "eth0" on Linux would correspond to "en0"
on OSX and "e1000g" on Solaris. On Windows platform, as there are no short NIC
names available, you have to use numeric IP addresses instead.
.SH WIRE FORMAT .SH WIRE FORMAT
Consecutive PGM packets are interpreted as a single continuous stream of data. Consecutive PGM packets are interpreted as a single continuous stream of data.

5
man/man7/zmq_tcp.7
View File

@ -18,6 +18,11 @@ a NIC name or a hostname (resolved by DNS):
tcp://lo:32768 tcp://lo:32768
.fi .fi
Note that NIC names are not standardised by POSIX. They tend to be rather
arbitrary and platform dependent. Say, "eth0" on Linux would correspond to "en0"
on OSX and "e1000g" on Solaris. On Windows platform, as there are no short NIC
names available, you have to use numeric IP addresses instead.
.SH WIRE FORMAT .SH WIRE FORMAT
A message consists of a message length followed by message data. A message consists of a message length followed by message data.

5
man/man7/zmq_udp.7
View File

@ -24,6 +24,11 @@ mutlicast group should be specified in the numeric representation. For example:
udp://192.168.0.111:224.0.0.1:5555 udp://192.168.0.111:224.0.0.1:5555
.fi .fi
Note that NIC names are not standardised by POSIX. They tend to be rather
arbitrary and platform dependent. Say, "eth0" on Linux would correspond to "en0"
on OSX and "e1000g" on Solaris. On Windows platform, as there are no short NIC
names available, you have to use numeric IP addresses instead.
.SH WIRE FORMAT .SH WIRE FORMAT
Same as with PGM transport except for UDP packet headers. Same as with PGM transport except for UDP packet headers.