summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorMartin Sustrik <sustrik@fastmq.commkdir>2010-01-15 14:11:39 +0100
committerMartin Sustrik <sustrik@fastmq.commkdir>2010-01-15 14:11:39 +0100
commit2bb57ac57ace37203c505ff17147210feca34d73 (patch)
treef28f6479436fa59101228cb5b3050948ff010ab3 /man
parent56c369272c279224562d11b0a66590ac7826f4f3 (diff)
ZMQII-39: Implement IPC transport
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am2
-rw-r--r--man/convert2html.sh1
-rwxr-xr-xman/convert2pdf.sh2
-rw-r--r--man/man7/zmq.73
-rw-r--r--man/man7/zmq_inproc.73
-rw-r--r--man/man7/zmq_ipc.734
-rw-r--r--man/man7/zmq_pgm.71
-rw-r--r--man/man7/zmq_tcp.71
-rw-r--r--man/man7/zmq_udp.71
9 files changed, 46 insertions, 2 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
index a292082..26867ab 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -7,7 +7,7 @@ dist_man_MANS = man1/zmq_forwarder.1 man1/zmq_streamer.1 man1/zmq_queue.1 \
man3/zmq_msg_data.3 man3/zmq_msg_size.3 man3/zmq_strerror.3 \
man7/zmq.7 man7/zmq_cpp.7 man7/zmq_python.7 man7/zmq_ruby.7 \
man7/zmq_cl.7 man7/zmq_tcp.7 man7/zmq_udp.7 man7/zmq_pgm.7 \
- man7/zmq_inproc.7
+ man7/zmq_inproc.7 man7/zmq_ipc.7
distclean-local:
-rm *.pdf
diff --git a/man/convert2html.sh b/man/convert2html.sh
index 26f443f..b92e8f6 100644
--- a/man/convert2html.sh
+++ b/man/convert2html.sh
@@ -51,4 +51,5 @@ groff -man -Thtml man7/zmq_tcp.7 > man7/zmq_tcp.7.html
groff -man -Thtml man7/zmq_udp.7 > man7/zmq_udp.7.html
groff -man -Thtml man7/zmq_pgm.7 > man7/zmq_pgm.7.html
groff -man -Thtml man7/zmq_inproc.7 > man7/zmq_inproc.7.html
+groff -man -Thtml man7/zmq_ipc.7 > man7/zmq_ipc.7.html
diff --git a/man/convert2pdf.sh b/man/convert2pdf.sh
index f8ab00c..dcd2901 100755
--- a/man/convert2pdf.sh
+++ b/man/convert2pdf.sh
@@ -83,4 +83,6 @@ groff -man -Tps man7/zmq_pgm.7 > man7/zmq_pgm.7.ps
ps2pdf man7/zmq_pgm.7.ps zmq_pgm.pdf
groff -man -Tps man7/zmq_inproc.7 > man7/zmq_inproc.7.ps
ps2pdf man7/zmq_inproc.7.ps zmq_inproc.pdf
+groff -man -Tps man7/zmq_ipc.7 > man7/zmq_ipc.7.ps
+ps2pdf man7/zmq_ipc.7.ps zmq_ipc.pdf
diff --git a/man/man7/zmq.7 b/man/man7/zmq.7
index 740726c..61543a7 100644
--- a/man/man7/zmq.7
+++ b/man/man7/zmq.7
@@ -112,6 +112,9 @@ UDP reliable multicast transport:
PGM reliable multicast transport:
.BR zmq_pgm(7)
+Inter-process transport:
+.BR zmq_ipc (7)
+
In-process (inter-thread) transport:
.BR zmq_inproc(7)
diff --git a/man/man7/zmq_inproc.7 b/man/man7/zmq_inproc.7
index bc09f90..0c84641 100644
--- a/man/man7/zmq_inproc.7
+++ b/man/man7/zmq_inproc.7
@@ -3,7 +3,7 @@
In-process (inter-thread) tranport for 0MQ
.SH SYNOPSIS
-In-process transport is optimised for passing messages betweem threads in the
+In-process transport is optimised for passing messages between threads in the
same process.
Messages are passed directly from one application thread to
@@ -32,6 +32,7 @@ wire format specification.
.SH "SEE ALSO"
+.BR zmq_ipc (7)
.BR zmq_tcp (7)
.BR zmq_udp (7)
.BR zmq_pgm (7)
diff --git a/man/man7/zmq_ipc.7 b/man/man7/zmq_ipc.7
new file mode 100644
index 0000000..28e57d0
--- /dev/null
+++ b/man/man7/zmq_ipc.7
@@ -0,0 +1,34 @@
+.TH zmq_ipc 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals"
+.SH NAME
+Inter-process tranport for 0MQ
+.SH SYNOPSIS
+
+In-process transport is optimised for passing messages between processes on the
+same physical machine.
+
+.SH CONNECTION STRING
+
+Connection string for inproc transport is "inproc://" followed by a file name.
+The file will be used as placeholder for a message endpoint. (UNIX domain
+sockets associate a file with the listening socket in a similar way.)
+
+.nf
+ ipc:///tmp/my_ipc_endpoint
+ ipc:///tmp/prices.ipc
+.fi
+
+.SH WIRE FORMAT
+
+IPC transport doesn't transfer messages across the network thus there is no need
+for a wire format specification.
+
+.SH "SEE ALSO"
+
+.BR zmq_inproc (7)
+.BR zmq_tcp (7)
+.BR zmq_udp (7)
+.BR zmq_pgm (7)
+
+.SH AUTHOR
+Martin Sustrik <sustrik at 250bpm dot com>
+
diff --git a/man/man7/zmq_pgm.7 b/man/man7/zmq_pgm.7
index 68af978..39f639b 100644
--- a/man/man7/zmq_pgm.7
+++ b/man/man7/zmq_pgm.7
@@ -80,6 +80,7 @@ Following example shows how messages are arranged in subsequent packets:
.BR zmq_udp (7)
.BR zmq_tcp (7)
+.BR zmq_ipc (7)
.BR zmq_inproc (7)
.BR zmq_setsockopt (3)
diff --git a/man/man7/zmq_tcp.7 b/man/man7/zmq_tcp.7
index f5504c8..41a116b 100644
--- a/man/man7/zmq_tcp.7
+++ b/man/man7/zmq_tcp.7
@@ -72,6 +72,7 @@ Binary layout of a larger message:
.BR zmq_udp (7)
.BR zmq_pgm (7)
+.BR zmq_ipc (7)
.BR zmq_inproc (7)
.SH AUTHOR
diff --git a/man/man7/zmq_udp.7 b/man/man7/zmq_udp.7
index 151a6d4..d0bf46c 100644
--- a/man/man7/zmq_udp.7
+++ b/man/man7/zmq_udp.7
@@ -37,6 +37,7 @@ Same as with PGM transport except for UDP packet headers.
.BR zmq_pgm (7)
.BR zmq_tcp (7)
+.BR zmq_ipc (7)
.BR zmq_inproc (7)
.SH AUTHOR