src/lib/job.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21 /** @file src/job.h
  22  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  23  */
  24
  25 #ifndef DCPOMATIC_JOB_H
  26 #define DCPOMATIC_JOB_H
  27
  28 #include "signaller.h"
  29 #include <boost/thread/mutex.hpp>
  30 #include <boost/signals2.hpp>
  31 #include <boost/thread.hpp>
  32 #include <string>
  33
  34 class Film;
  35
  36 /** @class Job
  37  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  38  */
  39 class Job : public std::enable_shared_from_this<Job>, public Signaller, public boost::noncopyable
  40 {
  41 public:
  42         explicit Job (std::shared_ptr<const Film> film);
  43         virtual ~Job ();
  44
  45         /** @return user-readable name of this job */
  46         virtual std::string name () const = 0;
  47         virtual std::string json_name () const = 0;
  48         /** Run this job in the current thread. */
  49         virtual void run () = 0;
  50
  51         void start ();
  52         bool pause_by_user ();
  53         void pause_by_priority ();
  54         void resume ();
  55         void cancel ();
  56
  57         bool is_new () const;
  58         bool running () const;
  59         bool finished () const;
  60         bool finished_ok () const;
  61         bool finished_in_error () const;
  62         bool finished_cancelled () const;
  63         bool paused_by_user () const;
  64         bool paused_by_priority () const;
  65
  66         std::string error_summary () const;
  67         std::string error_details () const;
  68
  69         boost::optional<std::string> message () const;
  70
  71         virtual std::string status () const;
  72         std::string json_status () const;
  73         std::string sub_name () const {
  74                 return _sub_name;
  75         }
  76
  77         void set_progress_unknown ();
  78         void set_progress (float, bool force = false);
  79         void sub (std::string);
  80         boost::optional<float> progress () const;
  81
  82         std::shared_ptr<const Film> film () const {
  83                 return _film;
  84         }
  85
  86         void when_finished (boost::signals2::connection& connection, boost::function<void()> finished);
  87
  88         boost::signals2::signal<void()> Progress;
  89         /** Emitted from the UI thread when the job is finished */
  90         boost::signals2::signal<void()> Finished;
  91         /** Emitted from the job thread when the job is finished */
  92         boost::signals2::signal<void()> FinishedImmediate;
  93
  94 protected:
  95
  96         virtual int remaining_time () const;
  97
  98         /** Description of a job's state */
  99         enum State {
 100                 NEW,            ///< the job hasn't been started yet
 101                 RUNNING,        ///< the job is running
 102                 PAUSED_BY_USER, ///< the job has been paused
 103                 PAUSED_BY_PRIORITY, ///< the job has been paused
 104                 FINISHED_OK,    ///< the job has finished successfully
 105                 FINISHED_ERROR, ///< the job has finished in error
 106                 FINISHED_CANCELLED ///< the job was cancelled
 107         };
 108
 109         void set_state (State);
 110         void set_error (std::string s, std::string d);
 111         void set_message (std::string m);
 112         int elapsed_sub_time () const;
 113         void check_for_interruption_or_pause ();
 114         void stop_thread ();
 115
 116         std::shared_ptr<const Film> _film;
 117
 118 private:
 119
 120         void run_wrapper ();
 121         void set_progress_common (boost::optional<float> p);
 122
 123         boost::thread _thread;
 124
 125         /** mutex for _state, _error*, _message */
 126         mutable boost::mutex _state_mutex;
 127         /** current state of the job */
 128         State _state;
 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;
 134
 135         /** time that this job was started */
 136         time_t _start_time;
 137         /** time that this sub-job was started */
 138         time_t _sub_start_time;
 139         std::string _sub_name;
 140
 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;
 145
 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.
 148         */
 149         boost::condition_variable _pause_changed;
 150
 151         int _ran_for;
 152 };
 153
 154 #endif