From 32baeb610e779862b58c56f66571b01599743a9e Mon Sep 17 00:00:00 2001 From: Martin Lucina Date: Sat, 4 Sep 2010 15:55:11 +0200 Subject: Revert "Various changes to documentation project:" This reverts commit 77a3c36ff1f11215229a4efdb821a3cb83a9d6fc. --- doc/zmq_deviced.txt | 123 ---------------------------------------------------- 1 file changed, 123 deletions(-) delete mode 100644 doc/zmq_deviced.txt (limited to 'doc/zmq_deviced.txt') diff --git a/doc/zmq_deviced.txt b/doc/zmq_deviced.txt deleted file mode 100644 index e5ba83f..0000000 --- a/doc/zmq_deviced.txt +++ /dev/null @@ -1,123 +0,0 @@ -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: - ----- - - - - - ... - ... - ... - - - ... - ... - ... - - - ----- - -*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 - - - - - - - - - - - - - - - - - ----- - - -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] -- cgit v1.2.3