2009-03-13 18:43:16 +01:00
|
|
|
/*
|
2017-01-03 20:48:59 +01:00
|
|
|
* Copyright 2003-2017 The Music Player Daemon Project
|
2009-03-13 18:43:16 +01:00
|
|
|
* http://www.musicpd.org
|
2006-07-31 01:32:47 +02:00
|
|
|
*
|
|
|
|
* 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.
|
2009-03-13 18:43:16 +01:00
|
|
|
*
|
|
|
|
* 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.
|
2006-07-31 01:32:47 +02:00
|
|
|
*/
|
|
|
|
|
2013-01-02 19:52:57 +01:00
|
|
|
#ifndef MPD_STATE_FILE_HXX
|
|
|
|
#define MPD_STATE_FILE_HXX
|
2006-07-31 01:32:47 +02:00
|
|
|
|
2017-08-29 16:52:02 +02:00
|
|
|
#include "event/TimerEvent.hxx"
|
2013-10-17 21:59:35 +02:00
|
|
|
#include "fs/AllocatedPath.hxx"
|
2013-10-15 09:21:13 +02:00
|
|
|
#include "Compiler.h"
|
2013-01-14 11:00:22 +01:00
|
|
|
|
|
|
|
#include <string>
|
2016-12-27 23:06:34 +01:00
|
|
|
#include <chrono>
|
2013-01-14 11:00:22 +01:00
|
|
|
|
2013-01-04 22:42:05 +01:00
|
|
|
struct Partition;
|
2014-07-30 20:58:14 +02:00
|
|
|
class OutputStream;
|
|
|
|
class BufferedOutputStream;
|
2013-01-14 11:00:22 +01:00
|
|
|
|
2017-08-29 16:52:02 +02:00
|
|
|
class StateFile final {
|
2014-08-24 13:00:30 +02:00
|
|
|
const AllocatedPath path;
|
|
|
|
const std::string path_utf8;
|
2013-01-14 11:00:22 +01:00
|
|
|
|
2016-12-27 23:06:34 +01:00
|
|
|
const std::chrono::steady_clock::duration interval;
|
2017-08-29 16:52:02 +02:00
|
|
|
TimerEvent timer_event;
|
2014-08-24 12:59:45 +02:00
|
|
|
|
2013-01-14 11:00:22 +01:00
|
|
|
Partition &partition;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* These version numbers determine whether we need to save the state
|
|
|
|
* file. If nothing has changed, we won't let the hard drive spin up.
|
|
|
|
*/
|
2016-12-27 23:13:03 +01:00
|
|
|
unsigned prev_volume_version = 0, prev_output_version = 0,
|
|
|
|
prev_playlist_version = 0;
|
2009-11-03 21:08:48 +01:00
|
|
|
|
2017-11-25 11:20:32 +01:00
|
|
|
#ifdef ENABLE_DATABASE
|
|
|
|
unsigned prev_storage_version = 0;
|
|
|
|
#endif
|
|
|
|
|
2013-01-14 11:00:22 +01:00
|
|
|
public:
|
2016-12-27 23:06:34 +01:00
|
|
|
static constexpr std::chrono::steady_clock::duration DEFAULT_INTERVAL = std::chrono::minutes(2);
|
2014-08-24 12:59:45 +02:00
|
|
|
|
2016-12-27 23:06:34 +01:00
|
|
|
StateFile(AllocatedPath &&path, std::chrono::steady_clock::duration interval,
|
2014-08-24 12:59:45 +02:00
|
|
|
Partition &partition, EventLoop &loop);
|
2009-01-18 18:09:50 +01:00
|
|
|
|
2013-01-14 11:00:22 +01:00
|
|
|
void Read();
|
|
|
|
void Write();
|
2009-01-18 18:09:50 +01:00
|
|
|
|
2013-04-08 22:31:51 +02:00
|
|
|
/**
|
|
|
|
* Schedules a write if MPD's state was modified.
|
|
|
|
*/
|
|
|
|
void CheckModified();
|
|
|
|
|
2013-01-14 11:00:22 +01:00
|
|
|
private:
|
2015-12-16 10:24:43 +01:00
|
|
|
void Write(OutputStream &os);
|
2014-07-30 20:58:14 +02:00
|
|
|
void Write(BufferedOutputStream &os);
|
|
|
|
|
2013-04-08 22:34:44 +02:00
|
|
|
/**
|
|
|
|
* Save the current state versions for use with IsModified().
|
|
|
|
*/
|
2017-05-08 14:44:49 +02:00
|
|
|
void RememberVersions() noexcept;
|
2013-04-08 22:34:44 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Check if MPD's state was modified since the last
|
|
|
|
* RememberVersions() call.
|
|
|
|
*/
|
|
|
|
gcc_pure
|
2017-05-08 14:44:49 +02:00
|
|
|
bool IsModified() const noexcept;
|
2013-04-08 22:34:44 +02:00
|
|
|
|
2017-08-29 16:52:02 +02:00
|
|
|
/* callback for #timer_event */
|
|
|
|
void OnTimeout();
|
2013-01-14 11:00:22 +01:00
|
|
|
};
|
2006-07-31 01:32:47 +02:00
|
|
|
|
|
|
|
#endif /* STATE_FILE_H */
|