diff options
| author | Max Kellermann <max@musicpd.org> | 2020-01-20 12:50:48 +0100 |
|---|---|---|
| committer | Max Kellermann <max@musicpd.org> | 2020-01-20 12:50:48 +0100 |
| commit | 77271ebc1faecb569b6a012752973d9eed9d216f (patch) | |
| tree | 80c69a453e143d3b0eec3a1bb575282a029d3b57 | |
| parent | fd2b2cf0bc7078090c58bba84b785b4db559b229 (diff) | |
Partition,Instance: add EmitIdle() documentation
| -rw-r--r-- | src/Instance.hxx | 5 | ||||
| -rw-r--r-- | src/Partition.hxx | 6 |
2 files changed, 11 insertions, 0 deletions
diff --git a/src/Instance.hxx b/src/Instance.hxx index e1af7b529..5a679b23f 100644 --- a/src/Instance.hxx +++ b/src/Instance.hxx @@ -143,6 +143,11 @@ struct Instance final event_loop.Break(); } + /** + * Emit an "idle" event to all clients of all partitions. + * + * This method can be called from any thread. + */ void EmitIdle(unsigned mask) noexcept { idle_monitor.OrMask(mask); } diff --git a/src/Partition.hxx b/src/Partition.hxx index 7c7d30673..186ab39e7 100644 --- a/src/Partition.hxx +++ b/src/Partition.hxx @@ -80,6 +80,12 @@ struct Partition final : QueueListener, PlayerListener, MixerListener { global_events.OrMask(mask); } + /** + * Emit an "idle" event to all clients of this partition. + * + * This method is not thread-safe and may only be called from + * the main thread. + */ void EmitIdle(unsigned mask) noexcept; /** |