class Job : public boost::enable_shared_from_this<Job>, public Signaller, public boost::noncopyable
{
public:
- Job (boost::shared_ptr<const Film>);
+ explicit Job (boost::shared_ptr<const Film> film);
virtual ~Job ();
/** @return user-readable name of this job */
virtual void run () = 0;
void start ();
- void pause ();
+ bool pause_by_user ();
+ void pause_by_priority ();
void resume ();
void cancel ();
bool finished_ok () const;
bool finished_in_error () const;
bool finished_cancelled () const;
- bool paused () const;
+ bool paused_by_user () const;
+ bool paused_by_priority () const;
std::string error_summary () const;
std::string error_details () const;
- int elapsed_time () const;
+ boost::optional<std::string> message () const;
+
virtual std::string status () const;
std::string json_status () const;
std::string sub_name () const {
enum State {
NEW, ///< the job hasn't been started yet
RUNNING, ///< the job is running
- PAUSED, ///< the job has been paused
+ PAUSED_BY_USER, ///< the job has been paused
+ PAUSED_BY_PRIORITY, ///< 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);
+ void set_message (std::string m);
+ int elapsed_sub_time () const;
+ void check_for_interruption_or_pause ();
boost::shared_ptr<const Film> _film;
boost::thread* _thread;
- /** mutex for _state and _error */
+ /** mutex for _state, _error*, _message */
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;
+ /** a message that should be given to the user when the job finishes */
+ boost::optional<std::string> _message;
- /** time that this sub-job was started */
+ /** time that this job was started */
time_t _start_time;
+ /** time that this sub-job was started */
+ time_t _sub_start_time;
std::string _sub_name;
/** mutex for _progress and _last_progress_update */