Skip to content

L
libzmq
Commit 77a3c36f authored by Pieter Hintjens's avatar Pieter Hintjens
Browse files
Options

Various changes to documentation project: 

* Added documentation for zmq_deviced, which we're developing
* Created consistent page footer in documentation template
* Page footer notes doc authors and copyright statement
parent 6cd90304
Hide whitespace changes
Inline Side-by-side
Showing with 156 additions and 155 deletions
doc/asciidoc.conf
View file @ 77a3c36f
......@@ -33,6 +33,21 @@ template::[header-declarations]
<refname>{manname}</refname>
<refpurpose>{manpurpose}</refpurpose>
</refnamediv>
[footer]
<refsect1 id="_authors">
<title>AUTHORS</title>
<simpara>Man pages by Martin Lucina &lt;<ulink url="mailto:mato@kotelna.sk">mato@kotelna.sk</ulink>&gt;, Martin Sustrik &lt;<ulink url="mailto:sustrik@250bpm.com">sustrik@250bpm.com</ulink>&gt;, and Pieter Hintjens &lt;<ulink url="mailto:ph@imatix.com">ph@imatix.com</ulink>&gt;.</simpara>
</refsect1>
<refsect1 id="_resources">
<title>RESOURCES</title>
<simpara>Main web site: <ulink url="http://www.zeromq.org/">http://www.zeromq.org/</ulink></simpara>
<simpara>Report bugs to the 0MQ development mailing list: &lt;<ulink url="mailto:zeromq-dev@lists.zeromq.org">zeromq-dev@lists.zeromq.org</ulink>&gt;</simpara>
</refsect1>
<refsect1 id="_copyright">
<title>COPYRIGHT</title>
<simpara>Copyright (c) 2007-2010 iMatix Corporation and contributors. License LGPLv3+: GNU LGPL 3 or later &lt;<ulink url="http://gnu.org/licenses/lgpl.html">http://gnu.org/licenses/lgpl.html</ulink>&gt;. This is free software: you are free to change it and redistribute it. There is NO WARRANTY, to the extent permitted by law. For details see the files <literal>COPYING</literal> and <literal>COPYING.LESSER</literal> included with the 0MQ distribution.</simpara>
</refsect1>
</refentry>
endif::backend-docbook[]
endif::doctype-manpage[]
......
doc/zmq.txt
View file @ 77a3c36f
......@@ -200,22 +200,3 @@ Other language bindings
Other language bindings (Python, Ruby, Java and more) are provided by members
of the 0MQ community and pointers can be found on the 0MQ website.
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
RESOURCES
---------
Main web site: <http://www.zeromq.org/>
Report bugs to the 0MQ development mailing list: <zeromq-dev@lists.zeromq.org>
COPYING
-------
Free use of this software is granted under the terms of the GNU Lesser General
Public License (LGPL). For details see the files `COPYING` and `COPYING.LESSER`
included with the 0MQ distribution.
doc/zmq_bind.txt
View file @ 77a3c36f
......@@ -68,8 +68,8 @@ assert (socket);
/* Bind it to a in-process transport with the address 'my_publisher' */
int rc = zmq_bind (socket, "inproc://my_publisher");
assert (rc == 0);
/* Bind it to a TCP transport on port 5555 of the 'eth0' interface */
rc = zmq_bind (socket, "tcp://eth0:5555");
/* Bind it to a TCP transport on port 5555 of all local interfaces */
rc = zmq_bind (socket, "tcp://*:5555");
assert (rc == 0);
----
......@@ -80,8 +80,3 @@ linkzmq:zmq_connect[3]
linkzmq:zmq_socket[3]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_close.txt
View file @ 77a3c36f
......@@ -41,7 +41,3 @@ linkzmq:zmq_term[3]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_connect.txt
View file @ 77a3c36f
......@@ -79,7 +79,3 @@ linkzmq:zmq_socket[3]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_cpp.txt
View file @ 77a3c36f
......@@ -204,7 +204,3 @@ SEE ALSO
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_deviced.txt 0 → 100644
View file @ 77a3c36f
zmq_deviced(1)
==============
NAME
----
zmq_deviced - start built-in 0MQ devices
SYNOPSIS
--------
*zmq_deviced _DEVICE_ _FRONTEND_ _BACKEND_*
*zmq_deviced [_CONFIGFILE_]*
DESCRIPTION
-----------
Starts one or more 0MQ devices. If you specify a DEVICE, FRONTEND, and BACKEND then _zmq_device_ starts a single device acting as a mini-broker. If you specify a CONFIGFILE, you can configure _zmq_device_ to start multiple concurrent devices with arbitrary configurations.
*Note* - zmq_deviced is not yet implemented. This is a design.
MINI-BROKER USAGE
-----------------
Runs as a mini-broker that accepts connects to both frontend and backend. This creates a hub-and-spoke topology in which all peers connect to the device. This is a robust and easy to manage topology.
DEVICE is one of: *queue*, *forwarder*, or *streamer*. See linkzmq:zmq_device[3] for a specification of these device types.
FRONTEND and BACKEND are endpoints in the format 'transport'`://`'address', See linkzmq:zmq_bind[3] for a specification of valid transports and addresses.
CONFIGURED USAGE
----------------
CONFIGFILE is the name of an XML file, readable by 'zmq_device'. This file provides a specification of the devices to start and how to connect and/or bind their frontends and backends. If CONFIGFILE is absent or *-* then the configuration is read from standard input.
The configuration file has this general syntax:
----
<?xml?>
<config [ iothreads="..." ] >
<device type="...">
<frontend [ type="..." ] >
<set name = "..." value = "..." />...
<bind endpoint="..." /> ...
<connect address="..." /> ...
</frontend>
<backend [ type="..." ] >
<set name = "..." value = "..." />...
<bind address="..." /> ...
<connect address="..." /> ...
</backend>
</device>
</config>
----
*iothreads*::
specifies the number of I/O threads for the process. Specify this only for high-volume scenarios. See linkzmq:zmq_init[3].
*device*::
defines one device. For each device element you define, 'zmq_device' will start a thread.
*frontend*::
defines the frontend for the device. Occurs once per device element. You may override the default socket type.
*backend*::
defines the backend for the device. Occurs once per device element. You may override the default socket type.
*set*::
defines a socket option for the frontend or backend. The valid names are *hwm*, *swap*, *identity*, *subscribe*, *unsubscribe*, *rate*, *recovery_ivl*, *mcast_loop*, *sndbuf*, and *rcvbuf*. See linkzmq:zmq_setsockopt[3].
*bind*::
binds the frontend or backend to the specified endpoint. See linkzmq:zmq_bind[3].
*connect*::
binds the frontend or backend to the specified endpoint. See linkzmq:zmq_connect[3].
SOCKET TYPES
------------
By default 'zmq_device' uses these socket types:
*queue* device::
frontend is *xrep*, backend is *xreq*.
*forwarder* device::
frontend is *sub*, backend is *pub*.
*streamer* device::
frontend is *pull*, backend is *push*.
You can override the socket type for frontend or backend. The valid types are: *req*, *rep*, *xreq*, *xrep*, *sub*, *pub*, *pull*, *push*, and *pair*. See linkzmq:zmq_socket[3].
*Note*: if you use a *sub* socket you must explicitly set a subscription filter or your socket will not receive any data.
EXAMPLE
-------
.Creating a queue broker
----
zmq_device queue tcp://*:5050 tcp://*:5051
----
.A TCP-to-multicast proxy forwarder
----
zmq_device -
<?xml?>
<config>
<device type="forwarder">
<frontend>
<!-- subscribe to everything -->
<set name = "subscribe" value = "" />
<!-- connect to two publishers -->
<connect address="tcp://192.168.55.112:5055" />
<connect address="tcp://192.168.55.114:5055" />
</frontend>
<backend>
<!-- bind to epgm group via eth0 -->
<bind address="epgm://eth0;239.192.1.1:5555" />
</backend>
</device>
</config>
----
SEE ALSO
--------
linkzmq:zmq_device[3]
linkzmq:zmq_init[3]
linkzmq:zmq_setsockopt[3]
linkzmq:zmq_bind[3]
linkzmq:zmq_connect[3]
linkzmq:zmq[7]
doc/zmq_errno.txt
View file @ 77a3c36f
......@@ -44,7 +44,3 @@ SEE ALSO
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_forwarder.txt
View file @ 77a3c36f
......@@ -27,7 +27,3 @@ SEE ALSO
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_getsockopt.txt
View file @ 77a3c36f
......@@ -235,7 +235,3 @@ linkzmq:zmq_socket[3]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_init.txt
View file @ 77a3c36f
......@@ -40,7 +40,3 @@ linkzmq:zmq[7]
linkzmq:zmq_term[3]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_inproc.txt
View file @ 77a3c36f
......@@ -83,7 +83,3 @@ linkzmq:zmq_pgm[7]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_ipc.txt
View file @ 77a3c36f
......@@ -74,7 +74,3 @@ linkzmq:zmq_pgm[7]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_msg_close.txt
View file @ 77a3c36f
......@@ -48,7 +48,3 @@ linkzmq:zmq_msg_size[3]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_msg_copy.txt
View file @ 77a3c36f
......@@ -50,7 +50,3 @@ linkzmq:zmq_msg_close[3]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_msg_data.txt
View file @ 77a3c36f
......@@ -42,7 +42,3 @@ linkzmq:zmq_msg_close[3]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_msg_init.txt
View file @ 77a3c36f
......@@ -59,7 +59,3 @@ linkzmq:zmq_msg_size[3]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_msg_init_data.txt
View file @ 77a3c36f
......@@ -74,7 +74,3 @@ linkzmq:zmq_msg_size[3]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_msg_init_size.txt
View file @ 77a3c36f
......@@ -52,7 +52,3 @@ linkzmq:zmq_msg_size[3]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_msg_move.txt
View file @ 77a3c36f
......@@ -45,7 +45,3 @@ linkzmq:zmq_msg_close[3]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_msg_size.txt
View file @ 77a3c36f
......@@ -42,7 +42,3 @@ linkzmq:zmq_msg_close[3]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_pgm.txt
View file @ 77a3c36f
......@@ -151,7 +151,4 @@ linkzmq:zmq_ipc[7]
linkzmq:zmq_inproc[7]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_poll.txt
View file @ 77a3c36f
......@@ -127,7 +127,3 @@ linkzmq:zmq[7]
Your operating system documentation for the _poll()_ system call.
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_queue.txt
View file @ 77a3c36f
......@@ -27,7 +27,3 @@ SEE ALSO
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_recv.txt
View file @ 77a3c36f
......@@ -105,7 +105,3 @@ linkzmq:zmq_socket[7]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_send.txt
View file @ 77a3c36f
......@@ -103,7 +103,3 @@ linkzmq:zmq_socket[7]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_setsockopt.txt
View file @ 77a3c36f
......@@ -267,7 +267,3 @@ linkzmq:zmq_socket[3]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_socket.txt
View file @ 77a3c36f
......@@ -157,22 +157,24 @@ is connected to at least one _node_. When a pipeline stage is connected to
multiple _nodes_ data is load-balanced among all connected _nodes_.
ZMQ_DOWNSTREAM
^^^^^^^^^^^^^^
A socket of type 'ZMQ_DOWNSTREAM' is used by a pipeline _node_ to send messages
ZMQ_PUSH
^^^^^^^^
A socket of type 'ZMQ_PUSH' is used by a pipeline _node_ to send messages
to downstream pipeline _nodes_. Messages are load-balanced to all connected
downstream _nodes_. The _zmq_recv()_ function is not implemented for this
socket type.
When a 'ZMQ_DOWNSTREAM' socket enters an exceptional state due to having
When a 'ZMQ_PUSH' socket enters an exceptional state due to having
reached the high water mark for all downstream _nodes_, or if there are no
downstream _nodes_ at all, then any linkzmq:zmq_send[3] operations on the
socket shall block until the exceptional state ends or at least one downstream
_node_ becomes available for sending; messages are not discarded.
Deprecated alias: ZMQ_DOWNSTREAM.
[horizontal]
.Summary of ZMQ_DOWNSTREAM characteristics
Compatible peer sockets:: 'ZMQ_UPSTREAM'
.Summary of ZMQ_PUSH characteristics
Compatible peer sockets:: 'ZMQ_PULL'
Direction:: Unidirectional
Send/receive pattern:: Send only
Incoming routing strategy:: N/A
......@@ -180,16 +182,18 @@ Outgoing routing strategy:: Load-balanced
ZMQ_HWM option action:: Block
ZMQ_UPSTREAM
^^^^^^^^^^^^
A socket of type 'ZMQ_UPSTREAM' is used by a pipeline _node_ to receive
ZMQ_PULL
^^^^^^^^
A socket of type 'ZMQ_PULL' is used by a pipeline _node_ to receive
messages from upstream pipeline _nodes_. Messages are fair-queued from among
all connected upstream _nodes_. The _zmq_send()_ function is not implemented
for this socket type.
Deprecated alias: ZMQ_UPSTREAM.
[horizontal]
.Summary of ZMQ_UPSTREAM characteristics
Compatible peer sockets:: 'ZMQ_DOWNSTREAM'
.Summary of ZMQ_PULL characteristics
Compatible peer sockets:: 'ZMQ_PUSH'
Direction:: Unidirectional
Send/receive pattern:: Receive only
Incoming routing strategy:: Fair-queued
......@@ -253,8 +257,3 @@ linkzmq:zmq_send[3]
linkzmq:zmq_recv[3]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_streamer.txt
View file @ 77a3c36f
......@@ -27,7 +27,3 @@ SEE ALSO
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_strerror.txt
View file @ 77a3c36f
......@@ -49,7 +49,3 @@ SEE ALSO
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_tcp.txt
View file @ 77a3c36f
......@@ -155,7 +155,3 @@ linkzmq:zmq_inproc[7]
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_term.txt
View file @ 77a3c36f
......@@ -51,8 +51,3 @@ SEE ALSO
linkzmq:zmq[7]
linkzmq:zmq_init[3]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
doc/zmq_version.txt
View file @ 77a3c36f
......@@ -47,7 +47,3 @@ SEE ALSO
--------
linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment