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 DVDOMATIC_JOB_H
  25 #define DVDOMATIC_JOB_H
  26
  27 #include <string>
  28 #include <boost/thread/mutex.hpp>
  29 #include <boost/enable_shared_from_this.hpp>
  30 #include <boost/signals2.hpp>
  31
  32 class Film;
  33 class Options;
  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>
  39 {
  40 public:
  41         Job (boost::shared_ptr<Film> s, boost::shared_ptr<Job> req);
  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
  51         bool is_new () const;
  52         bool running () const;
  53         bool finished () const;
  54         bool finished_ok () const;
  55         bool finished_in_error () const;
  56
  57         std::string error () const;
  58
  59         int elapsed_time () const;
  60         virtual std::string status () const;
  61
  62         void set_progress_unknown ();
  63         void set_progress (float);
  64         void ascend ();
  65         void descend (float);
  66         float overall_progress () const;
  67
  68         boost::shared_ptr<Job> required () const {
  69                 return _required;
  70         }
  71
  72         boost::signals2::signal<void()> Finished;
  73
  74 protected:
  75
  76         virtual int remaining_time () const;
  77
  78         /** Description of a job's state */
  79         enum State {
  80                 NEW,           ///< the job hasn't been started yet
  81                 RUNNING,       ///< the job is running
  82                 FINISHED_OK,   ///< the job has finished successfully
  83                 FINISHED_ERROR ///< the job has finished in error
  84         };
  85
  86         void set_state (State);
  87         void set_error (std::string e);
  88
  89         /** Film for this job */
  90         boost::shared_ptr<Film> _film;
  91
  92 private:
  93
  94         void run_wrapper ();
  95
  96         boost::shared_ptr<Job> _required;
  97
  98         /** mutex for _state and _error */
  99         mutable boost::mutex _state_mutex;
 100         /** current state of the job */
 101         State _state;
 102         /** message for an error that has occurred (when state == FINISHED_ERROR) */
 103         std::string _error;
 104
 105         /** time that this job was started */
 106         time_t _start_time;
 107
 108         /** mutex for _stack and _progress_unknown */
 109         mutable boost::mutex _progress_mutex;
 110
 111         struct Level {
 112                 Level (float a) : allocation (a), normalised (0) {}
 113
 114                 float allocation;
 115                 float normalised;
 116         };
 117
 118         std::list<Level> _stack;
 119
 120         /** true if this job's progress will always be unknown */
 121         bool _progress_unknown;
 122
 123         int _ran_for;
 124 };
 125
 126 #endif