From 858bcea5b468641bfa1636805d0ef1323ea8bafd Mon Sep 17 00:00:00 2001 From: wm4 Date: Tue, 16 May 2017 12:20:39 +0200 Subject: [PATCH] manpage: document tricky issue with IPC observe_property command Seems like people get confused by this. --- DOCS/man/ipc.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/DOCS/man/ipc.rst b/DOCS/man/ipc.rst index 03be027a20..289ef5b799 100644 --- a/DOCS/man/ipc.rst +++ b/DOCS/man/ipc.rst @@ -201,6 +201,14 @@ extra commands can also be used as part of the protocol: { "error": "success" } { "event": "property-change", "id": 1, "data": 52.0, "name": "volume" } + .. warning:: + + If the connection is closed, the IPC client is destroyed internally, + and the observed properties are unregistered. This happens for example + when sending commands to a socket with separate ``socat`` invocations. + This can make it seem like property observation does not work. You must + keep the IPC connection open to make it work. + ``observe_property_string`` Like ``observe_property``, but the resulting data will always be a string.