Commit b4591202 authored by Pieter Hintjens's avatar Pieter Hintjens

Merge pull request #791 from moteus/patch-1

Update doc for zmq_proxy_steerable [ci skip]
parents 5401c352 b7a2248e
...@@ -3,7 +3,7 @@ zmq_proxy_steerable(3) ...@@ -3,7 +3,7 @@ zmq_proxy_steerable(3)
NAME NAME
---- ----
zmq_proxy_steerable - start built-in 0MQ proxy with STOP/RESUME/TERMINATE zmq_proxy_steerable - start built-in 0MQ proxy with PAUSE/RESUME/TERMINATE
control flow control flow
...@@ -21,8 +21,8 @@ for the general description and usage. We describe here only the additional ...@@ -21,8 +21,8 @@ for the general description and usage. We describe here only the additional
control flow provided by the socket passed as the fourth argument "control". 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 If the control socket is not NULL, the proxy supports control flow. If
'SUSPEND\0' is received on this socket, the proxy suspends its activities. If 'PAUSE' is received on this socket, the proxy suspends its activities. If
'RESUME\0' is received, it goes on. If 'TERMINATE\0' is received, it terminates '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. At start, the proxy runs normally as if zmq_proxy was used.
If the control socket is NULL, the function behave exactly as if zmq_proxy If the control socket is NULL, the function behave exactly as if zmq_proxy
...@@ -69,12 +69,12 @@ zmq_proxy_steerable (frontend, backend, NULL, control); ...@@ -69,12 +69,12 @@ zmq_proxy_steerable (frontend, backend, NULL, control);
void *control = zmq_socket (context, ZMQ_PUB); void *control = zmq_socket (context, ZMQ_PUB);
assert (control); assert (control);
assert (zmq_bind (control, "tcp://*:5557") == 0); assert (zmq_bind (control, "tcp://*:5557") == 0);
// stop the proxy // pause the proxy
assert (zmq_send (control, "STOP", 5, 0) == 0); assert (zmq_send (control, "PAUSE", 5, 0) == 0);
// resume the proxy // resume the proxy
assert (zmq_send (control, "RESUME", 7, 0) == 0); assert (zmq_send (control, "RESUME", 6, 0) == 0);
// terminate the proxy // terminate the proxy
assert (zmq_send (control, "TERMINATE", 10, 0) == 0); assert (zmq_send (control, "TERMINATE", 9, 0) == 0);
--- ---
......
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