src/lib/job.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file src/job.h
  21  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  22  */
  23
  24 #ifndef DCPOMATIC_JOB_H
  25 #define DCPOMATIC_JOB_H
  26
  27 #include <boost/thread/mutex.hpp>
  28 #include <boost/enable_shared_from_this.hpp>
  29 #include <boost/signals2.hpp>
  30 #include <boost/thread.hpp>
  31 #include <string>
  32
  33 class Film;
  34
  35 /** @class Job
  36  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  37  */
  38 class Job : public boost::enable_shared_from_this<Job>, public boost::noncopyable
  39 {
  40 public:
  41         Job (boost::shared_ptr<const Film>);
  42         virtual ~Job() {}
  43
  44         /** @return user-readable name of this job */
  45         virtual std::string name () const = 0;
  46         /** Run this job in the current thread. */
  47         virtual void run () = 0;
  48
  49         void start ();
  50         void pause ();
  51         void resume ();
  52         void cancel ();
  53
  54         bool is_new () const;
  55         bool running () const;
  56         bool finished () const;
  57         bool finished_ok () const;
  58         bool finished_in_error () const;
  59         bool finished_cancelled () const;
  60         bool paused () const;
  61
  62         std::string error_summary () const;
  63         std::string error_details () const;
  64
  65         int elapsed_time () const;
  66         virtual std::string status () const;
  67         std::string sub_name () const {
  68                 return _sub_name;
  69         }
  70
  71         void set_progress_unknown ();
  72         void set_progress (float, bool force = false);
  73         void sub (std::string);
  74         boost::optional<float> progress () const;
  75
  76         boost::shared_ptr<const Film> film () const {
  77                 return _film;
  78         }
  79
  80         boost::signals2::signal<void()> Progress;
  81         /** Emitted from the UI thread when the job is finished */
  82         boost::signals2::signal<void()> Finished;
  83
  84 protected:
  85
  86         virtual int remaining_time () const;
  87
  88         /** Description of a job's state */
  89         enum State {
  90                 NEW,            ///< the job hasn't been started yet
  91                 RUNNING,        ///< the job is running
  92                 PAUSED,         ///< the job has been paused
  93                 FINISHED_OK,    ///< the job has finished successfully
  94                 FINISHED_ERROR, ///< the job has finished in error
  95                 FINISHED_CANCELLED ///< the job was cancelled
  96         };
  97
  98         void set_state (State);
  99         void set_error (std::string s, std::string d);
 100
 101         boost::shared_ptr<const Film> _film;
 102
 103 private:
 104
 105         void run_wrapper ();
 106
 107         boost::thread* _thread;
 108
 109         /** mutex for _state and _error */
 110         mutable boost::mutex _state_mutex;
 111         /** current state of the job */
 112         State _state;
 113         /** summary of an error that has occurred (when state == FINISHED_ERROR) */
 114         std::string _error_summary;
 115         std::string _error_details;
 116
 117         /** time that this sub-job was started */
 118         time_t _start_time;
 119         std::string _sub_name;
 120
 121         /** mutex for _progress */
 122         mutable boost::mutex _progress_mutex;
 123         boost::optional<float> _progress;
 124
 125         /** condition to signal changes to pause/resume so that we know when to wake;
 126             this could be a general _state_change if it made more sense.
 127         */
 128         boost::condition_variable _pause_changed;
 129
 130         int _ran_for;
 131 };
 132
 133 #endif