path: root/DOCS
diff options
authorwm4 <wm4@nowhere>2017-05-16 12:20:39 +0200
committerwm4 <wm4@nowhere>2017-05-16 12:20:39 +0200
commit858bcea5b468641bfa1636805d0ef1323ea8bafd (patch)
treec9d0516f853b99ddc2527056b55bc058f1edce09 /DOCS
parent73a0ea4d877daae40b671b0411fa1aeb496a0a3f (diff)
manpage: document tricky issue with IPC observe_property command
Seems like people get confused by this.
Diffstat (limited to 'DOCS')
1 files changed, 8 insertions, 0 deletions
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.
Like ``observe_property``, but the resulting data will always be a string.