Merge 'next' into servicelinking

2 files changed, 85 insertions, 0 deletions

diff --git a/doc/example.mux b/doc/example.mux
index 5a65829..3f2d6f4 100644
--- a/doc/example.mux
+++ b/doc/example.mux
@@ -50,6 +50,16 @@ remotecontrol {
     ; Set the port to 0 to disable the server
     telnetport 12721
 
+    ; The remote control is also accessible through a ZMQ REQ/REP socket,
+    ; and is useful for machine-triggered interactions. It supports the
+    ; same commands as the telnet RC.
+    ; The example code in doc/zmq_remote.py illustrates how to use this rc.
+    ; To disable the zeromq endpoint, remove the zmqendpoint line.
+    ; By specifying "lo" in the URL, we make the server only accessible
+    ; from localhost. You can write tcp://*:12722 to make it accessible
+    ; on all interfaces.
+    zmqendpoint tcp://lo:12722
+
     ; the remote control server makes use of the unique identifiers
     ; for the subchannels, services and components. Make sure you
     ; chose them so that you can identify them.
diff --git a/doc/zmq_remote.py b/doc/zmq_remote.py
new file mode 100755
index 0000000..bc9dd5d
--- /dev/null
+++ b/doc/zmq_remote.py
@@ -0,0 +1,75 @@
+#!/usr/bin/env python
+#
+# This is an example program that illustrates
+# how to interact with the zeromq remote control
+#
+# LICENSE: see bottom of file
+
+import sys
+import zmq
+
+context = zmq.Context()
+
+sock = context.socket(zmq.REQ)
+
+if len(sys.argv) < 2:
+    print("Usage: program url cmd [args...]")
+    sys.exit(1)
+
+sock.connect(sys.argv[1])
+
+message_parts = sys.argv[2:]
+
+# first do a ping test
+
+print("ping")
+sock.send("ping")
+data = sock.recv_multipart()
+print("Received: {}".format(len(data)))
+for i,part in enumerate(data):
+    print("   {}".format(part))
+
+for i, part in enumerate(message_parts):
+    if i == len(message_parts) - 1:
+        f = 0
+    else:
+        f = zmq.SNDMORE
+
+    print("Send {}({}): '{}'".format(i, f, part))
+
+    sock.send(part, flags=f)
+
+data = sock.recv_multipart()
+
+print("Received: {}".format(len(data)))
+for i,part in enumerate(data):
+    print(" RX {}: {}".format(i, part))
+
+
+
+# This is free and unencumbered software released into the public domain.
+#
+# Anyone is free to copy, modify, publish, use, compile, sell, or
+# distribute this software, either in source code form or as a compiled
+# binary, for any purpose, commercial or non-commercial, and by any
+# means.
+#
+# In jurisdictions that recognize copyright laws, the author or authors
+# of this software dedicate any and all copyright interest in the
+# software to the public domain. We make this dedication for the benefit
+# of the public at large and to the detriment of our heirs and
+# successors. We intend this dedication to be an overt act of
+# relinquishment in perpetuity of all present and future rights to this
+# software under copyright law.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#
+# For more information, please refer to <http://unlicense.org>
+
+