summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2009-07-05 08:46:53 +0200
committerMax Kellermann <max@duempel.org>2009-07-05 08:46:53 +0200
commitd4914fc9ef4fda21f833e88a59d50d54fafd6379 (patch)
treee9a7f3bab19ac13227e9e44e75e91fd27a15ef95 /doc
parent46c19b82494c9954fd6dafb955a1a5851e20d44d (diff)
idle: added "update" event
Some clients have visual feedback for "database update is running". Using the "database" idle event is unreliable, because it is only emitted when the database was actually modified. This patch adds the "update" event, which is emitted when the update is started, and again when the update is finished, disregarding whether it has been modified.
Diffstat (limited to 'doc')
-rw-r--r--doc/protocol.xml11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/protocol.xml b/doc/protocol.xml
index 7ef1dc379..6b2ff587f 100644
--- a/doc/protocol.xml
+++ b/doc/protocol.xml
@@ -134,7 +134,16 @@
<listitem>
<para>
<returnvalue>database</returnvalue>: the song database
- has been updated
+ has been modified
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <returnvalue>update</returnvalue>: a database update
+ has started or finished. If the database was
+ modified during the update, the
+ <returnvalue>database</returnvalue> event is also
+ emitted.
</para>
</listitem>
<listitem>