input/tidal: add API documentation

This commit is contained in:
Max Kellermann
2018-01-19 10:50:22 +01:00
parent 187cc573a7
commit 1ecad094bd
3 changed files with 37 additions and 0 deletions

View File

@@ -31,6 +31,11 @@
class CurlRequest;
/**
* Callback class for #TidalTrackRequest.
*
* Its methods must be thread-safe.
*/
class TidalTrackHandler
: public boost::intrusive::list_base_hook<boost::intrusive::link_mode<boost::intrusive::safe_link>>
{
@@ -39,6 +44,9 @@ public:
virtual void OnTidalTrackError(std::exception_ptr error) noexcept = 0;
};
/**
* An asynchronous request for the streaming URL of a Tidal track.
*/
class TidalTrackRequest final : CurlResponseHandler {
CurlSlist request_headers;