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