From 354efc513fdb4096f8830e6c2e3e8f1311303e61 Mon Sep 17 00:00:00 2001 From: Martin Lucina Date: Wed, 10 Feb 2010 16:18:46 +0100 Subject: Convert documentation to AsciiDoc --- doc/zmq_udp.txt | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 doc/zmq_udp.txt (limited to 'doc/zmq_udp.txt') diff --git a/doc/zmq_udp.txt b/doc/zmq_udp.txt new file mode 100644 index 0000000..ecc6bdf --- /dev/null +++ b/doc/zmq_udp.txt @@ -0,0 +1,56 @@ +zmq_udp(7) +========== + + +NAME +---- +zmq_udp - 0MQ reliable multicast transport using UDP + + +SYNOPSIS +-------- +UDP transport is exactly the same as PGM transport except that PGM packets +are encapsulated in UDP packets. Rationale for this transport is that user-space +implementation of PGM requires right to create raw sockets (PGM is located +directly on top of IP layer in the networking stack), which is often not +available. UDP encapsulation solves this problem, however, it adds some overhead +related to creating and transferring UDP packet headers. + + +CONNECTION STRING +----------------- +Connection string for UDP transport is "udp://" followed by an IP address +of the NIC to use, semicolon, IP address of the multicast group, colon and +port number. IP address of the NIC can be either its numeric representation +or the name of the NIC as reported by operating system. IP address of the +multicast group should be specified in the numeric representation. For example: + +---- + udp://eth0;224.0.0.1:5555 + udp://lo;230.0.0.0:6666 + udp://192.168.0.111;224.0.0.1:5555 +---- + +NOTE: 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. + + +WIRE FORMAT +----------- +Same as with PGM transport except for UDP packet headers. + + +SEE ALSO +-------- +linkzmq:zmq_pgm[7] +linkzmq:zmq_tcp[7] +linkzmq:zmq_ipc[7] +linkzmq:zmq_inproc[7] + + +AUTHOR +------ +Martin Sustrik + -- cgit v1.2.3