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 bool 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 boost::optional<std::string> message () const;
72 virtual std::string status () const;
73 std::string json_status () const;
74 std::string sub_name () const {
78 void set_progress_unknown ();
79 void set_progress (float, bool force = false);
80 void sub (std::string);
81 boost::optional<float> progress () const;
83 boost::shared_ptr<const Film> film () const {
87 void when_finished (boost::signals2::connection& connection, boost::function<void()> finished);
89 boost::signals2::signal<void()> Progress;
90 /** Emitted from the UI thread when the job is finished */
91 boost::signals2::signal<void()> Finished;
92 /** Emitted from the job thread when the job is finished */
93 boost::signals2::signal<void()> FinishedImmediate;
97 virtual int remaining_time () const;
99 /** Description of a job's state */
101 NEW, ///< the job hasn't been started yet
102 RUNNING, ///< the job is running
103 PAUSED_BY_USER, ///< the job has been paused
104 PAUSED_BY_PRIORITY, ///< the job has been paused
105 FINISHED_OK, ///< the job has finished successfully
106 FINISHED_ERROR, ///< the job has finished in error
107 FINISHED_CANCELLED ///< the job was cancelled
110 void set_state (State);
111 void set_error (std::string s, std::string d);
112 void set_message (std::string m);
113 int elapsed_sub_time () const;
114 void check_for_interruption_or_pause ();
116 boost::shared_ptr<const Film> _film;
121 void set_progress_common (boost::optional<float> p);
123 boost::thread* _thread;
125 /** mutex for _state, _error*, _message */
126 mutable boost::mutex _state_mutex;
127 /** current state of the job */
129 /** summary of an error that has occurred (when state == FINISHED_ERROR) */
130 std::string _error_summary;
131 std::string _error_details;
132 /** a message that should be given to the user when the job finishes */
133 boost::optional<std::string> _message;
135 /** time that this job was started */
137 /** time that this sub-job was started */
138 time_t _sub_start_time;
139 std::string _sub_name;
141 /** mutex for _progress and _last_progress_update */
142 mutable boost::mutex _progress_mutex;
143 boost::optional<float> _progress;
144 boost::optional<struct timeval> _last_progress_update;
146 /** condition to signal changes to pause/resume so that we know when to wake;
147 this could be a general _state_change if it made more sense.
149 boost::condition_variable _pause_changed;