output/Control: more locking information in API docs
This commit is contained in:
parent
b4cce80727
commit
67232453d4
@ -353,6 +353,8 @@ public:
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Caller must lock the mutex.
|
||||||
|
*
|
||||||
* Throws #std::runtime_error on error.
|
* Throws #std::runtime_error on error.
|
||||||
*/
|
*/
|
||||||
void InternalOpen2(AudioFormat in_audio_format);
|
void InternalOpen2(AudioFormat in_audio_format);
|
||||||
@ -405,30 +407,37 @@ public:
|
|||||||
|
|
||||||
private:
|
private:
|
||||||
/**
|
/**
|
||||||
* Runs inside the OutputThread. Handles exceptions.
|
* Runs inside the OutputThread.
|
||||||
|
* Caller must lock the mutex.
|
||||||
|
* Handles exceptions.
|
||||||
*
|
*
|
||||||
* @return true on success
|
* @return true on success
|
||||||
*/
|
*/
|
||||||
bool InternalEnable() noexcept;
|
bool InternalEnable() noexcept;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs inside the OutputThread. Handles exceptions.
|
* Runs inside the OutputThread.
|
||||||
|
* Caller must lock the mutex.
|
||||||
*/
|
*/
|
||||||
void InternalDisable() noexcept;
|
void InternalDisable() noexcept;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs inside the OutputThread. Handles exceptions.
|
* Runs inside the OutputThread.
|
||||||
|
* Caller must lock the mutex.
|
||||||
|
* Handles exceptions.
|
||||||
*/
|
*/
|
||||||
void InternalOpen(AudioFormat audio_format,
|
void InternalOpen(AudioFormat audio_format,
|
||||||
const MusicPipe &pipe) noexcept;
|
const MusicPipe &pipe) noexcept;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs inside the OutputThread.
|
* Runs inside the OutputThread.
|
||||||
|
* Caller must lock the mutex.
|
||||||
*/
|
*/
|
||||||
void InternalClose(bool drain) noexcept;
|
void InternalClose(bool drain) noexcept;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs inside the OutputThread.
|
* Runs inside the OutputThread.
|
||||||
|
* Caller must lock the mutex.
|
||||||
*/
|
*/
|
||||||
void InternalCheckClose(bool drain) noexcept;
|
void InternalCheckClose(bool drain) noexcept;
|
||||||
|
|
||||||
@ -440,8 +449,14 @@ private:
|
|||||||
*/
|
*/
|
||||||
bool WaitForDelay() noexcept;
|
bool WaitForDelay() noexcept;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Caller must lock the mutex.
|
||||||
|
*/
|
||||||
bool FillSourceOrClose();
|
bool FillSourceOrClose();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Caller must lock the mutex.
|
||||||
|
*/
|
||||||
bool PlayChunk() noexcept;
|
bool PlayChunk() noexcept;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -449,7 +464,9 @@ private:
|
|||||||
* been reached (and no more chunks are queued), or until a
|
* been reached (and no more chunks are queued), or until a
|
||||||
* command is received.
|
* command is received.
|
||||||
*
|
*
|
||||||
* Runs inside the OutputThread. Handles exceptions.
|
* Runs inside the OutputThread.
|
||||||
|
* Caller must lock the mutex.
|
||||||
|
* Handles exceptions.
|
||||||
*
|
*
|
||||||
* @return true if at least one chunk has been available,
|
* @return true if at least one chunk has been available,
|
||||||
* false if the tail of the pipe was already reached
|
* false if the tail of the pipe was already reached
|
||||||
@ -457,7 +474,9 @@ private:
|
|||||||
bool InternalPlay() noexcept;
|
bool InternalPlay() noexcept;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs inside the OutputThread. Handles exceptions.
|
* Runs inside the OutputThread.
|
||||||
|
* Caller must lock the mutex.
|
||||||
|
* Handles exceptions.
|
||||||
*/
|
*/
|
||||||
void InternalPause() noexcept;
|
void InternalPause() noexcept;
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user