2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * @brief A parent class to represent long-running tasks which are run in their own thread.
24 #ifndef DVDOMATIC_JOB_H
25 #define DVDOMATIC_JOB_H
28 #include <boost/thread/mutex.hpp>
29 #include <boost/enable_shared_from_this.hpp>
30 #include <boost/signals2.hpp>
35 * @brief A parent class to represent long-running tasks which are run in their own thread.
37 class Job : public boost::enable_shared_from_this<Job>
40 Job (boost::shared_ptr<Film> s, boost::shared_ptr<Job> req);
43 /** @return user-readable name of this job */
44 virtual std::string name () const = 0;
45 /** Run this job in the current thread. */
46 virtual void run () = 0;
51 bool running () const;
52 bool finished () const;
53 bool finished_ok () const;
54 bool finished_in_error () const;
56 std::string error () const;
58 int elapsed_time () const;
59 virtual std::string status () const;
61 void set_progress_unknown ();
62 void set_progress (float);
65 float overall_progress () const;
67 boost::shared_ptr<Job> required () const {
71 boost::signals2::signal<void()> Finished;
75 virtual int remaining_time () const;
77 /** Description of a job's state */
79 NEW, ///< the job hasn't been started yet
80 RUNNING, ///< the job is running
81 FINISHED_OK, ///< the job has finished successfully
82 FINISHED_ERROR ///< the job has finished in error
85 void set_state (State);
86 void set_error (std::string e);
88 /** Film for this job */
89 boost::shared_ptr<Film> _film;
95 boost::shared_ptr<Job> _required;
97 /** mutex for _state and _error */
98 mutable boost::mutex _state_mutex;
99 /** current state of the job */
101 /** message for an error that has occurred (when state == FINISHED_ERROR) */
104 /** time that this job was started */
107 /** mutex for _stack and _progress_unknown */
108 mutable boost::mutex _progress_mutex;
111 Level (float a) : allocation (a), normalised (0) {}
117 std::list<Level> _stack;
119 /** true if this job's progress will always be unknown */
120 bool _progress_unknown;