oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

output/httpd: add more API documentation about locking

Browse Source
This commit is contained in:
Max Kellermann 2019-04-03 22:49:25 +02:00
parent 37b54179d8
commit 9111bc2c21
2 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/output/plugins/httpd/HttpdClient.hxx
View File

@ -142,6 +142,8 @@ public:
/** /**
* Frees the client and removes it from the server's client list. * Frees the client and removes it from the server's client list.
*
* Caller must lock the mutex.
*/ */
void Close() noexcept; void Close() noexcept;

12
src/output/plugins/httpd/HttpdInternal.hxx
View File

@ -208,10 +208,15 @@ public:
return HasClients(); return HasClients();
} }
/**
* Caller must lock the mutex.
*/
void AddClient(UniqueSocketDescriptor fd) noexcept; void AddClient(UniqueSocketDescriptor fd) noexcept;
/** /**
* Removes a client from the httpd_output.clients linked list. * Removes a client from the httpd_output.clients linked list.
*
* Caller must lock the mutex.
*/ */
void RemoveClient(HttpdClient &client) noexcept; void RemoveClient(HttpdClient &client) noexcept;
@ -239,10 +244,14 @@ public:
/** /**
* Broadcasts data from the encoder to all clients. * Broadcasts data from the encoder to all clients.
*
* Mutext must not be locked.
*/ */
void BroadcastFromEncoder(); void BroadcastFromEncoder();
/** /**
* Mutext must not be locked.
*
* Throws #std::runtime_error on error. * Throws #std::runtime_error on error.
*/ */
void EncodeAndPlay(const void *chunk, size_t size); void EncodeAndPlay(const void *chunk, size_t size);
@ -251,6 +260,9 @@ public:
size_t Play(const void *chunk, size_t size) override; size_t Play(const void *chunk, size_t size) override;
/**
* Mutext must not be locked.
*/
void CancelAllClients() noexcept; void CancelAllClients() noexcept;
void Cancel() noexcept override; void Cancel() noexcept override;