From e2678b8b111ce75dd40e7a95323b19afa901ad1b Mon Sep 17 00:00:00 2001 From: f18m Date: Tue, 17 Oct 2017 11:08:09 +0200 Subject: [PATCH] Add documentation for new steerable proxy command --- doc/zmq_proxy_steerable.txt | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/doc/zmq_proxy_steerable.txt b/doc/zmq_proxy_steerable.txt index cd10d35d..3234f171 100644 --- a/doc/zmq_proxy_steerable.txt +++ b/doc/zmq_proxy_steerable.txt @@ -22,9 +22,20 @@ control flow provided by the socket passed as the fourth argument "control". If the control socket is not NULL, the proxy supports control flow. If 'PAUSE' is received on this socket, the proxy suspends its activities. If 'RESUME' is received, it goes on. If 'TERMINATE' is received, it terminates -smoothly. At start, the proxy runs normally as if zmq_proxy was used. +smoothly. If 'STATISTICS' is received, the proxy will reply on the control socket +sending 8 unsigned integers 64-bit wide that provide the + - number of messages received by the frontend socket + - number of bytes received by the frontend socket + - number of messages sent out the frontend socket + - number of bytes sent out the frontend socket + - number of messages received by the backend socket + - number of bytes received by the backend socket + - number of messages sent out the backend socket + - number of bytes sent out the backend socket -If the control socket is NULL, the function behave exactly as if zmq_proxy +At start, the proxy runs normally as if zmq_proxy was used. + +If the control socket is NULL, the function behave exactly as if linkzmq:zmq_proxy[3] had been called.