1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/*
Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
/** @file src/job.h
* @brief A parent class to represent long-running tasks which are run in their own thread.
*/
#ifndef DCPOMATIC_JOB_H
#define DCPOMATIC_JOB_H
#include <string>
#include <boost/thread/mutex.hpp>
#include <boost/enable_shared_from_this.hpp>
#include <boost/signals2.hpp>
#include <boost/thread.hpp>
class Film;
/** @class Job
* @brief A parent class to represent long-running tasks which are run in their own thread.
*/
class Job : public boost::enable_shared_from_this<Job>, public boost::noncopyable
{
public:
Job (boost::shared_ptr<const Film>);
virtual ~Job() {}
/** @return user-readable name of this job */
virtual std::string name () const = 0;
/** Run this job in the current thread. */
virtual void run () = 0;
void start ();
void pause ();
void resume ();
void cancel ();
bool is_new () const;
bool running () const;
bool finished () const;
bool finished_ok () const;
bool finished_in_error () const;
bool finished_cancelled () const;
bool paused () const;
std::string error_summary () const;
std::string error_details () const;
int elapsed_time () const;
virtual std::string status () const;
std::string sub_name () const {
return _sub_name;
}
void set_progress_unknown ();
void set_progress (float, bool force = false);
void sub (std::string);
float progress () const;
bool progress_unknown () const {
return !_progress;
}
boost::signals2::signal<void()> Progress;
/** Emitted from the UI thread when the job is finished */
boost::signals2::signal<void()> Finished;
protected:
virtual int remaining_time () const;
/** Description of a job's state */
enum State {
NEW, ///< the job hasn't been started yet
RUNNING, ///< the job is running
PAUSED, ///< the job has been paused
FINISHED_OK, ///< the job has finished successfully
FINISHED_ERROR, ///< the job has finished in error
FINISHED_CANCELLED ///< the job was cancelled
};
void set_state (State);
void set_error (std::string s, std::string d);
boost::shared_ptr<const Film> _film;
private:
void run_wrapper ();
boost::thread* _thread;
/** mutex for _state and _error */
mutable boost::mutex _state_mutex;
/** current state of the job */
State _state;
/** summary of an error that has occurred (when state == FINISHED_ERROR) */
std::string _error_summary;
std::string _error_details;
/** time that this sub-job was started */
time_t _start_time;
std::string _sub_name;
/** mutex for _progress */
mutable boost::mutex _progress_mutex;
boost::optional<float> _progress;
int _ran_for;
};
#endif
|
