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 DCPOMATIC_JOB_H
25 #define DCPOMATIC_JOB_H
27 #include "signaller.h"
28 #include <boost/thread/mutex.hpp>
29 #include <boost/enable_shared_from_this.hpp>
30 #include <boost/signals2.hpp>
31 #include <boost/thread.hpp>
37 * @brief A parent class to represent long-running tasks which are run in their own thread.
39 class Job : public boost::enable_shared_from_this<Job>, public Signaller, public boost::noncopyable
42 Job (boost::shared_ptr<const Film>);
45 /** @return user-readable name of this job */
46 virtual std::string name () const = 0;
47 virtual std::string json_name () const = 0;
48 /** Run this job in the current thread. */
49 virtual void run () = 0;
57 bool running () const;
58 bool finished () const;
59 bool finished_ok () const;
60 bool finished_in_error () const;
61 bool finished_cancelled () const;
64 std::string error_summary () const;
65 std::string error_details () const;
67 int elapsed_time () const;
68 virtual std::string status () const;
69 std::string json_status () const;
70 std::string sub_name () const {
74 void set_progress_unknown ();
75 void set_progress (float, bool force = false);
76 void sub (std::string);
77 boost::optional<float> progress () const;
79 boost::shared_ptr<const Film> film () const {
83 boost::signals2::signal<void()> Progress;
84 /** Emitted from the UI thread when the job is finished */
85 boost::signals2::signal<void()> Finished;
89 virtual int remaining_time () const;
91 /** Description of a job's state */
93 NEW, ///< the job hasn't been started yet
94 RUNNING, ///< the job is running
95 PAUSED, ///< the job has been paused
96 FINISHED_OK, ///< the job has finished successfully
97 FINISHED_ERROR, ///< the job has finished in error
98 FINISHED_CANCELLED ///< the job was cancelled
101 void set_state (State);
102 void set_error (std::string s, std::string d);
104 boost::shared_ptr<const Film> _film;
110 boost::thread* _thread;
112 /** mutex for _state and _error */
113 mutable boost::mutex _state_mutex;
114 /** current state of the job */
116 /** summary of an error that has occurred (when state == FINISHED_ERROR) */
117 std::string _error_summary;
118 std::string _error_details;
120 /** time that this sub-job was started */
122 std::string _sub_name;
124 /** mutex for _progress */
125 mutable boost::mutex _progress_mutex;
126 boost::optional<float> _progress;
128 /** condition to signal changes to pause/resume so that we know when to wake;
129 this could be a general _state_change if it made more sense.
131 boost::condition_variable _pause_changed;