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