summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJörgen Scott <jorgen.scott@gmail.com>2015-01-13 11:27:39 +0100
committerJörgen Scott <jorgen.scott@gmail.com>2015-01-13 11:27:39 +0100
commitba790cba2f7b48dd66f4418de0b7b366422926b0 (patch)
treea31f4fce6227b549561f53fb6f10e455070871f0 /doc
parent593c130b1e6848a08b30a84732ebd6862ef2e3b7 (diff)
downloaddabmod-ba790cba2f7b48dd66f4418de0b7b366422926b0.tar.gz
dabmod-ba790cba2f7b48dd66f4418de0b7b366422926b0.tar.bz2
dabmod-ba790cba2f7b48dd66f4418de0b7b366422926b0.zip
added zmq remote control
Diffstat (limited to 'doc')
-rw-r--r--doc/example.ini22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/example.ini b/doc/example.ini
index 49f6eda..9a80eeb 100644
--- a/doc/example.ini
+++ b/doc/example.ini
@@ -8,6 +8,28 @@
telnet=1
telnetport=2121
+; Enable zmq remote control.
+; The zmq remote control is intended for machine-to-machine
+; integration and requires that the odr-mod is build with zmq support.
+; The zmq remote control may run in parallell with Telnet.
+; Protocol:
+; The odr-dabmod binds a zmq rep socket so clients must connect
+; using either req or dealer socket.
+; [] denotes message part as zmq multi-part message are used for delimitation.
+; All message parts are utf-8 encoded strings and matches the Telnet command set.
+; Explicit codes are denoted with "".
+; The following commands are supported:
+; REQ: ["ping"]
+; REP: ["ok"]
+;
+; REQ: ["get"][module name][parameter]
+; REP: [value] _OR_ ["fail"][error description]
+;
+; REQ: ["set"][module name][parameter][value]
+; REP: ["ok"] _OR_ ["fail"][error description]
+zmqctrl=1
+zmqctrlendpoint=tcp://127.0.0.1:9400
+
[log]
; Write to a logfile or to syslog.
; Setting filename to stderr is very useful during tests and development