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
  22 /** @file src/job.h
  23  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  24  */
  25
  26
  27 #ifndef DCPOMATIC_JOB_H
  28 #define DCPOMATIC_JOB_H
  29
  30
  31 #include "signaller.h"
  32 #include <boost/atomic.hpp>
  33 #include <boost/signals2.hpp>
  34 #include <boost/thread.hpp>
  35 #include <boost/thread/mutex.hpp>
  36 #include <string>
  37
  38
  39 class Film;
  40
  41
  42 /** @class Job
  43  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  44  */
  45 class Job : public std::enable_shared_from_this<Job>, public Signaller
  46 {
  47 public:
  48         explicit Job (std::shared_ptr<const Film> film);
  49         virtual ~Job ();
  50
  51         Job (Job const&) = delete;
  52         Job& operator= (Job const&) = delete;
  53
  54         /** @return user-readable name of this job */
  55         virtual std::string name () const = 0;
  56         virtual std::string json_name () const = 0;
  57         /** Run this job in the current thread. */
  58         virtual void run () = 0;
  59         /** @return true if it should be possible to notify when this job finishes */
  60         virtual bool enable_notify () const {
  61                 return false;
  62         }
  63
  64         void start ();
  65         virtual void pause() {}
  66         bool pause_by_user ();
  67         void pause_by_priority ();
  68         virtual void resume ();
  69         void cancel ();
  70
  71         bool is_new () const;
  72         bool running () const;
  73         bool finished () const;
  74         bool finished_ok () const;
  75         bool finished_in_error () const;
  76         bool finished_cancelled () const;
  77         bool paused_by_user () const;
  78         bool paused_by_priority () const;
  79
  80         std::string error_summary () const;
  81         std::string error_details () const;
  82
  83         boost::optional<std::string> message () const;
  84
  85         virtual std::string status () const;
  86         std::string json_status () const;
  87         std::string sub_name () const {
  88                 return _sub_name;
  89         }
  90
  91         void set_progress_unknown ();
  92         void set_progress (float, bool force = false);
  93         void sub (std::string);
  94         boost::optional<float> progress () const;
  95         boost::optional<float> seconds_since_last_progress_update () const;
  96
  97         std::shared_ptr<const Film> film () const {
  98                 return _film;
  99         }
 100
 101         enum class Result {
 102                 RESULT_OK,
 103                 RESULT_ERROR,     // we can't have plain ERROR on Windows
 104                 RESULT_CANCELLED
 105         };
 106
 107         void when_finished(boost::signals2::connection& connection, std::function<void(Result)> finished);
 108
 109         void set_rate_limit_progress(bool rate_limit);
 110
 111         boost::signals2::signal<void()> Progress;
 112         /** Emitted from the UI thread when the job is finished */
 113         boost::signals2::signal<void (Result)> Finished;
 114         /** Emitted from the job thread when the job is finished */
 115         boost::signals2::signal<void (Result)> FinishedImmediate;
 116
 117 protected:
 118
 119         virtual int remaining_time () const;
 120
 121         /** Description of a job's state */
 122         enum State {
 123                 NEW,            ///< the job hasn't been started yet
 124                 RUNNING,        ///< the job is running
 125                 PAUSED_BY_USER, ///< the job has been paused
 126                 PAUSED_BY_PRIORITY, ///< the job has been paused
 127                 FINISHED_OK,    ///< the job has finished successfully
 128                 FINISHED_ERROR, ///< the job has finished in error
 129                 FINISHED_CANCELLED ///< the job was cancelled
 130         };
 131
 132         Result state_to_result(State state) const;
 133         void set_state (State);
 134         void set_error (std::string s, std::string d = "");
 135         void set_message (std::string m);
 136         int elapsed_sub_time () const;
 137         void check_for_interruption_or_pause ();
 138         void stop_thread ();
 139
 140         std::shared_ptr<const Film> _film;
 141
 142         time_t _start_time = 0;
 143         time_t _finish_time = 0;
 144
 145 private:
 146
 147         void run_wrapper ();
 148         void set_progress_common (boost::optional<float> p);
 149
 150         boost::thread _thread;
 151
 152         /** mutex for _state, _error*, _message */
 153         mutable boost::mutex _state_mutex;
 154         /** current state of the job */
 155         State _state;
 156         /** summary of an error that has occurred (when state == FINISHED_ERROR) */
 157         std::string _error_summary;
 158         std::string _error_details;
 159         /** a message that should be given to the user when the job finishes */
 160         boost::optional<std::string> _message;
 161
 162         /** time that this sub-job was started */
 163         time_t _sub_start_time;
 164         std::string _sub_name;
 165
 166         /** mutex for _progress and _last_progress_update */
 167         mutable boost::mutex _progress_mutex;
 168         boost::optional<float> _progress;
 169         boost::optional<struct timeval> _last_progress_update;
 170
 171         /** true to limit emissions of the progress signal so that they don't
 172          *  come too often.
 173          */
 174         boost::atomic<bool> _rate_limit_progress;
 175
 176         /** condition to signal changes to pause/resume so that we know when to wake;
 177             this could be a general _state_change if it made more sense.
 178         */
 179         boost::condition_variable _pause_changed;
 180 };
 181
 182 #endif