/*
Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
- This program is free software; you can redistribute it and/or modify
+ This file is part of DCP-o-matic.
+
+ DCP-o-matic 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,
+ DCP-o-matic 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+ along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef DCPOMATIC_JOB_H
#define DCPOMATIC_JOB_H
-#include <string>
+#include "signaller.h"
#include <boost/thread/mutex.hpp>
-#include <boost/enable_shared_from_this.hpp>
#include <boost/signals2.hpp>
#include <boost/thread.hpp>
+#include <string>
class Film;
/** @class Job
* @brief A parent class to represent long-running tasks which are run in their own thread.
*/
-class Job : public boost::enable_shared_from_this<Job>, public boost::noncopyable
+class Job : public std::enable_shared_from_this<Job>, public Signaller
{
public:
- Job (boost::shared_ptr<const Film>);
- virtual ~Job() {}
+ explicit Job (std::shared_ptr<const Film> film);
+ virtual ~Job ();
+
+ Job (Job const&) = delete;
+ Job& operator= (Job const&) = delete;
/** @return user-readable name of this job */
virtual std::string name () const = 0;
+ virtual std::string json_name () const = 0;
/** Run this job in the current thread. */
virtual void run () = 0;
-
+ /** @return true if it should be possible to notify when this job finishes */
+ virtual bool enable_notify () const {
+ return false;
+ }
+
void start ();
- void pause ();
+ bool pause_by_user ();
+ void pause_by_priority ();
void resume ();
void cancel ();
bool finished_ok () const;
bool finished_in_error () const;
bool finished_cancelled () const;
- bool paused () const;
+ bool paused_by_user () const;
+ bool paused_by_priority () const;
std::string error_summary () const;
std::string error_details () const;
- int elapsed_time () const;
+ boost::optional<std::string> message () const;
+
virtual std::string status () const;
+ std::string json_status () const;
std::string sub_name () const {
return _sub_name;
}
void set_progress_unknown ();
void set_progress (float, bool force = false);
void sub (std::string);
- float progress () const;
- bool progress_unknown () const {
- return !_progress;
- }
+ boost::optional<float> progress () const;
+ boost::optional<float> seconds_since_last_progress_update () const;
- boost::shared_ptr<const Film> film () const {
+ std::shared_ptr<const Film> film () const {
return _film;
}
+ void when_finished (boost::signals2::connection& connection, std::function<void()> finished);
+
boost::signals2::signal<void()> Progress;
/** Emitted from the UI thread when the job is finished */
boost::signals2::signal<void()> Finished;
+ /** Emitted from the job thread when the job is finished */
+ boost::signals2::signal<void()> FinishedImmediate;
protected:
enum State {
NEW, ///< the job hasn't been started yet
RUNNING, ///< the job is running
- PAUSED, ///< the job has been paused
+ PAUSED_BY_USER, ///< the job has been paused
+ PAUSED_BY_PRIORITY, ///< the job has been paused
FINISHED_OK, ///< the job has finished successfully
FINISHED_ERROR, ///< the job has finished in error
FINISHED_CANCELLED ///< the job was cancelled
};
-
+
void set_state (State);
- void set_error (std::string s, std::string d);
+ void set_error (std::string s, std::string d = "");
+ void set_message (std::string m);
+ int elapsed_sub_time () const;
+ void check_for_interruption_or_pause ();
+ void stop_thread ();
- boost::shared_ptr<const Film> _film;
+ std::shared_ptr<const Film> _film;
private:
void run_wrapper ();
+ void set_progress_common (boost::optional<float> p);
- boost::thread* _thread;
+ boost::thread _thread;
- /** mutex for _state and _error */
+ /** mutex for _state, _error*, _message */
mutable boost::mutex _state_mutex;
/** current state of the job */
State _state;
/** summary of an error that has occurred (when state == FINISHED_ERROR) */
std::string _error_summary;
std::string _error_details;
+ /** a message that should be given to the user when the job finishes */
+ boost::optional<std::string> _message;
- /** time that this sub-job was started */
+ /** time that this job was started */
time_t _start_time;
+ /** time that this sub-job was started */
+ time_t _sub_start_time;
std::string _sub_name;
- /** mutex for _progress */
+ /** mutex for _progress and _last_progress_update */
mutable boost::mutex _progress_mutex;
boost::optional<float> _progress;
+ boost::optional<struct timeval> _last_progress_update;
+
+ /** condition to signal changes to pause/resume so that we know when to wake;
+ this could be a general _state_change if it made more sense.
+ */
+ boost::condition_variable _pause_changed;
int _ran_for;
};
projects / dcpomatic.git / blobdiff