mpd/src/input/AsyncInputStream.hxx

173 lines
4.2 KiB
C++
Raw Normal View History

/*
2017-01-03 20:48:59 +01:00
* Copyright 2003-2017 The Music Player Daemon Project
* http://www.musicpd.org
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef MPD_ASYNC_INPUT_STREAM_HXX
#define MPD_ASYNC_INPUT_STREAM_HXX
#include "InputStream.hxx"
#include "event/DeferEvent.hxx"
2016-06-17 18:06:02 +02:00
#include "util/HugeAllocator.hxx"
#include "util/CircularBuffer.hxx"
#include <exception>
/**
* Helper class for moving asynchronous (non-blocking) InputStream
* implementations to the I/O thread. Data is being read into a ring
* buffer, and that buffer is then consumed by another thread using
* the regular #InputStream API.
*/
2016-06-17 18:30:45 +02:00
class AsyncInputStream : public InputStream {
enum class SeekState : uint8_t {
NONE, SCHEDULED, PENDING
};
DeferEvent deferred_resume;
DeferEvent deferred_seek;
2016-06-17 18:30:45 +02:00
HugeArray<uint8_t> allocation;
2016-06-17 18:06:02 +02:00
CircularBuffer<uint8_t> buffer;
const size_t resume_at;
2017-09-19 19:54:07 +02:00
bool open = true;
/**
* Is the connection currently paused? That happens when the
* buffer was getting too large. It will be unpaused when the
* buffer is below the threshold again.
*/
2017-09-19 19:54:07 +02:00
bool paused = false;
2017-09-19 19:54:07 +02:00
SeekState seek_state = SeekState::NONE;
/**
* The #Tag object ready to be requested via
* InputStream::ReadTag().
*/
std::unique_ptr<Tag> tag;
offset_type seek_offset;
protected:
std::exception_ptr postponed_exception;
public:
AsyncInputStream(EventLoop &event_loop, const char *_url,
Mutex &_mutex, Cond &_cond,
2016-06-17 18:06:02 +02:00
size_t _buffer_size,
size_t _resume_at);
virtual ~AsyncInputStream();
2017-01-25 23:15:52 +01:00
EventLoop &GetEventLoop() {
return deferred_resume.GetEventLoop();
}
/* virtual methods from InputStream */
void Check() final;
bool IsEOF() noexcept final;
void Seek(offset_type new_offset) final;
std::unique_ptr<Tag> ReadTag() final;
bool IsAvailable() noexcept final;
size_t Read(void *ptr, size_t read_size) final;
protected:
2014-07-10 10:33:43 +02:00
/**
* Pass an tag from the I/O thread to the client thread.
*/
void SetTag(std::unique_ptr<Tag> _tag) noexcept;
void ClearTag() noexcept;
void Pause() noexcept;
bool IsPaused() const noexcept {
2014-09-02 20:02:56 +02:00
return paused;
}
2014-07-10 10:33:43 +02:00
/**
* Declare that the underlying stream was closed. We will
* continue feeding Read() calls from the buffer until it runs
* empty.
*/
void SetClosed() noexcept {
open = false;
}
bool IsBufferEmpty() const noexcept {
return buffer.empty();
}
bool IsBufferFull() const noexcept {
return buffer.IsFull();
}
2014-07-10 10:33:43 +02:00
/**
* Determine how many bytes can be added to the buffer.
*/
gcc_pure
size_t GetBufferSpace() const noexcept {
return buffer.GetSpace();
}
CircularBuffer<uint8_t>::Range PrepareWriteBuffer() noexcept {
return buffer.Write();
}
void CommitWriteBuffer(size_t nbytes) noexcept;
2014-07-10 10:33:43 +02:00
/**
* Append data to the buffer. The size must fit into the
* buffer; see GetBufferSpace().
*/
void AppendToBuffer(const void *data, size_t append_size) noexcept;
2014-07-10 10:33:43 +02:00
/**
* Implement code here that will resume the stream after it
* has been paused due to full input buffer.
*/
virtual void DoResume() = 0;
/**
* The actual Seek() implementation. This virtual method will
* be called from within the I/O thread. When the operation
* is finished, call SeekDone() to notify the caller.
*/
virtual void DoSeek(offset_type new_offset) = 0;
bool IsSeekPending() const noexcept {
return seek_state == SeekState::PENDING;
}
2014-07-10 10:33:43 +02:00
/**
* Call this after seeking has finished. It will notify the
* client thread.
*/
void SeekDone() noexcept;
private:
void Resume();
/* for DeferEvent */
void DeferredResume() noexcept;
void DeferredSeek() noexcept;
};
#endif