2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 * @brief A parent class to represent long-running tasks which are run in their own thread.
25 #ifndef DCPOMATIC_JOB_H
26 #define DCPOMATIC_JOB_H
28 #include "signaller.h"
29 #include <boost/thread/mutex.hpp>
30 #include <boost/enable_shared_from_this.hpp>
31 #include <boost/signals2.hpp>
32 #include <boost/thread.hpp>
38 * @brief A parent class to represent long-running tasks which are run in their own thread.
40 class Job : public boost::enable_shared_from_this<Job>, public Signaller, public boost::noncopyable
43 explicit Job (boost::shared_ptr<const Film> film);
46 /** @return user-readable name of this job */
47 virtual std::string name () const = 0;
48 virtual std::string json_name () const = 0;
49 /** Run this job in the current thread. */
50 virtual void run () = 0;
53 void pause_by_user ();
54 void pause_by_priority ();
59 bool running () const;
60 bool finished () const;
61 bool finished_ok () const;
62 bool finished_in_error () const;
63 bool finished_cancelled () const;
64 bool paused_by_user () const;
65 bool paused_by_priority () const;
67 std::string error_summary () const;
68 std::string error_details () const;
70 virtual std::string status () const;
71 std::string json_status () const;
72 std::string sub_name () const {
76 void set_progress_unknown ();
77 void set_progress (float, bool force = false);
78 void sub (std::string);
79 boost::optional<float> progress () const;
81 boost::shared_ptr<const Film> film () const {
85 void when_finished (boost::signals2::connection& connection, boost::function<void()> finished);
87 boost::signals2::signal<void()> Progress;
88 /** Emitted from the UI thread when the job is finished */
89 boost::signals2::signal<void()> Finished;
93 virtual int remaining_time () const;
95 /** Description of a job's state */
97 NEW, ///< the job hasn't been started yet
98 RUNNING, ///< the job is running
99 PAUSED_BY_USER, ///< the job has been paused
100 PAUSED_BY_PRIORITY, ///< the job has been paused
101 FINISHED_OK, ///< the job has finished successfully
102 FINISHED_ERROR, ///< the job has finished in error
103 FINISHED_CANCELLED ///< the job was cancelled
106 void set_state (State);
107 void set_error (std::string s, std::string d);
108 int elapsed_sub_time () const;
109 void check_for_interruption_or_pause ();
111 boost::shared_ptr<const Film> _film;
116 void set_progress_common (boost::optional<float> p);
118 boost::thread* _thread;
120 /** mutex for _state and _error */
121 mutable boost::mutex _state_mutex;
122 /** current state of the job */
124 /** summary of an error that has occurred (when state == FINISHED_ERROR) */
125 std::string _error_summary;
126 std::string _error_details;
128 /** time that this job was started */
130 /** time that this sub-job was started */
131 time_t _sub_start_time;
132 std::string _sub_name;
134 /** mutex for _progress and _last_progress_update */
135 mutable boost::mutex _progress_mutex;
136 boost::optional<float> _progress;
137 boost::optional<struct timeval> _last_progress_update;
139 /** condition to signal changes to pause/resume so that we know when to wake;
140 this could be a general _state_change if it made more sense.
142 boost::condition_variable _pause_changed;