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/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 std::enable_shared_from_this<Job>, public Signaller
42 explicit Job (std::shared_ptr<const Film> film);
45 Job (Job const&) = delete;
46 Job& operator= (Job const&) = delete;
48 /** @return user-readable name of this job */
49 virtual std::string name () const = 0;
50 virtual std::string json_name () const = 0;
51 /** Run this job in the current thread. */
52 virtual void run () = 0;
55 bool pause_by_user ();
56 void pause_by_priority ();
61 bool running () const;
62 bool finished () const;
63 bool finished_ok () const;
64 bool finished_in_error () const;
65 bool finished_cancelled () const;
66 bool paused_by_user () const;
67 bool paused_by_priority () const;
69 std::string error_summary () const;
70 std::string error_details () const;
72 boost::optional<std::string> message () const;
74 virtual std::string status () const;
75 std::string json_status () const;
76 std::string sub_name () const {
80 void set_progress_unknown ();
81 void set_progress (float, bool force = false);
82 void sub (std::string);
83 boost::optional<float> progress () const;
84 boost::optional<float> seconds_since_last_progress_update () const;
86 std::shared_ptr<const Film> film () const {
90 void when_finished (boost::signals2::connection& connection, std::function<void()> finished);
92 boost::signals2::signal<void()> Progress;
93 /** Emitted from the UI thread when the job is finished */
94 boost::signals2::signal<void()> Finished;
95 /** Emitted from the job thread when the job is finished */
96 boost::signals2::signal<void()> FinishedImmediate;
100 virtual int remaining_time () const;
102 /** Description of a job's state */
104 NEW, ///< the job hasn't been started yet
105 RUNNING, ///< the job is running
106 PAUSED_BY_USER, ///< the job has been paused
107 PAUSED_BY_PRIORITY, ///< the job has been paused
108 FINISHED_OK, ///< the job has finished successfully
109 FINISHED_ERROR, ///< the job has finished in error
110 FINISHED_CANCELLED ///< the job was cancelled
113 void set_state (State);
114 void set_error (std::string s, std::string d);
115 void set_message (std::string m);
116 int elapsed_sub_time () const;
117 void check_for_interruption_or_pause ();
120 std::shared_ptr<const Film> _film;
125 void set_progress_common (boost::optional<float> p);
127 boost::thread _thread;
129 /** mutex for _state, _error*, _message */
130 mutable boost::mutex _state_mutex;
131 /** current state of the job */
133 /** summary of an error that has occurred (when state == FINISHED_ERROR) */
134 std::string _error_summary;
135 std::string _error_details;
136 /** a message that should be given to the user when the job finishes */
137 boost::optional<std::string> _message;
139 /** time that this job was started */
141 /** time that this sub-job was started */
142 time_t _sub_start_time;
143 std::string _sub_name;
145 /** mutex for _progress and _last_progress_update */
146 mutable boost::mutex _progress_mutex;
147 boost::optional<float> _progress;
148 boost::optional<struct timeval> _last_progress_update;
150 /** condition to signal changes to pause/resume so that we know when to wake;
151 this could be a general _state_change if it made more sense.
153 boost::condition_variable _pause_changed;