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 <string>
  28 #include <boost/thread/mutex.hpp>
  29 #include <boost/enable_shared_from_this.hpp>
  30 #include <boost/signals2.hpp>
  31 #include <boost/thread.hpp>
  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>
  39 {
  40 public:
  41         Job (boost::shared_ptr<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 cancel ();
  51
  52         bool is_new () const;
  53         bool running () const;
  54         bool finished () const;
  55         bool finished_ok () const;
  56         bool finished_in_error () const;
  57         bool finished_cancelled () const;
  58
  59         std::string error_summary () const;
  60         std::string error_details () const;
  61
  62         int elapsed_time () const;
  63         virtual std::string status () const;
  64
  65         void set_progress_unknown ();
  66         void set_progress (float);
  67         void ascend ();
  68         void descend (float);
  69         float overall_progress () const;
  70
  71         /** Emitted by the JobManagerView from the UI thread */
  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                 FINISHED_CANCELLED ///< the job was cancelled
  85         };
  86
  87         void set_state (State);
  88         void set_error (std::string s, std::string d);
  89
  90         boost::shared_ptr<Film> _film;
  91
  92 private:
  93
  94         void run_wrapper ();
  95
  96         boost::thread* _thread;
  97
  98         /** mutex for _state and _error */
  99         mutable boost::mutex _state_mutex;
 100         /** current state of the job */
 101         State _state;
 102         /** summary of an error that has occurred (when state == FINISHED_ERROR) */
 103         std::string _error_summary;
 104         std::string _error_details;
 105
 106         /** time that this job was started */
 107         time_t _start_time;
 108
 109         /** mutex for _stack and _progress_unknown */
 110         mutable boost::mutex _progress_mutex;
 111
 112         struct Level {
 113                 Level (float a) : allocation (a), normalised (0) {}
 114
 115                 float allocation;
 116                 float normalised;
 117         };
 118
 119         std::list<Level> _stack;
 120
 121         /** true if this job's progress will always be unknown */
 122         bool _progress_unknown;
 123
 124         int _ran_for;
 125 };
 126
 127 #endif