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         bool pause_by_user ();
  66         void pause_by_priority ();
  67         void resume ();
  68         void cancel ();
  69
  70         bool is_new () const;
  71         bool running () const;
  72         bool finished () const;
  73         bool finished_ok () const;
  74         bool finished_in_error () const;
  75         bool finished_cancelled () const;
  76         bool paused_by_user () const;
  77         bool paused_by_priority () const;
  78
  79         std::string error_summary () const;
  80         std::string error_details () const;
  81
  82         boost::optional<std::string> message () const;
  83
  84         virtual std::string status () const;
  85         std::string json_status () const;
  86         std::string sub_name () const {
  87                 return _sub_name;
  88         }
  89
  90         void set_progress_unknown ();
  91         void set_progress (float, bool force = false);
  92         void sub (std::string);
  93         boost::optional<float> progress () const;
  94         boost::optional<float> seconds_since_last_progress_update () const;
  95
  96         std::shared_ptr<const Film> film () const {
  97                 return _film;
  98         }
  99
 100         enum class Result {
 101                 RESULT_OK,
 102                 RESULT_ERROR,     // we can't have plain ERROR on Windows
 103                 RESULT_CANCELLED
 104         };
 105
 106         void when_finished(boost::signals2::connection& connection, std::function<void(Result)> finished);
 107
 108         void set_rate_limit_progress(bool rate_limit);
 109
 110         boost::signals2::signal<void()> Progress;
 111         /** Emitted from the UI thread when the job is finished */
 112         boost::signals2::signal<void (Result)> Finished;
 113         /** Emitted from the job thread when the job is finished */
 114         boost::signals2::signal<void (Result)> FinishedImmediate;
 115
 116 protected:
 117
 118         virtual int remaining_time () const;
 119
 120         /** Description of a job's state */
 121         enum State {
 122                 NEW,            ///< the job hasn't been started yet
 123                 RUNNING,        ///< the job is running
 124                 PAUSED_BY_USER, ///< the job has been paused
 125                 PAUSED_BY_PRIORITY, ///< the job has been paused
 126                 FINISHED_OK,    ///< the job has finished successfully
 127                 FINISHED_ERROR, ///< the job has finished in error
 128                 FINISHED_CANCELLED ///< the job was cancelled
 129         };
 130
 131         Result state_to_result(State state) const;
 132         void set_state (State);
 133         void set_error (std::string s, std::string d = "");
 134         void set_message (std::string m);
 135         int elapsed_sub_time () const;
 136         void check_for_interruption_or_pause ();
 137         void stop_thread ();
 138
 139         std::shared_ptr<const Film> _film;
 140
 141         time_t _start_time = 0;
 142         time_t _finish_time = 0;
 143
 144 private:
 145
 146         void run_wrapper ();
 147         void set_progress_common (boost::optional<float> p);
 148
 149         boost::thread _thread;
 150
 151         /** mutex for _state, _error*, _message */
 152         mutable boost::mutex _state_mutex;
 153         /** current state of the job */
 154         State _state;
 155         /** summary of an error that has occurred (when state == FINISHED_ERROR) */
 156         std::string _error_summary;
 157         std::string _error_details;
 158         /** a message that should be given to the user when the job finishes */
 159         boost::optional<std::string> _message;
 160
 161         /** time that this sub-job was started */
 162         time_t _sub_start_time;
 163         std::string _sub_name;
 164
 165         /** mutex for _progress and _last_progress_update */
 166         mutable boost::mutex _progress_mutex;
 167         boost::optional<float> _progress;
 168         boost::optional<struct timeval> _last_progress_update;
 169
 170         /** true to limit emissions of the progress signal so that they don't
 171          *  come too often.
 172          */
 173         boost::atomic<bool> _rate_limit_progress;
 174
 175         /** condition to signal changes to pause/resume so that we know when to wake;
 176             this could be a general _state_change if it made more sense.
 177         */
 178         boost::condition_variable _pause_changed;
 179 };
 180
 181 #endif