output/SharedPipeConsumer: add thread-safety documentation

This commit is contained in:
Max Kellermann 2016-12-26 20:09:10 +01:00
parent b6004b6837
commit 6fec269844

View File

@ -30,6 +30,11 @@ class MusicPipe;
/**
* A utility class which helps with consuming data from a #MusicPipe.
*
* This class is intentionally not thread-safe. Since it is designed
* to be called from two distinct threads (PlayerThread=feeder and
* OutputThread=consumer), all methods must be called with a mutex
* locked to serialize access. Usually, this is #AudioOutput::mutex.
*/
class SharedPipeConsumer {
/**