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<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
  68         void set_progress_unknown ();
  69         void set_progress (float);
  70         void ascend ();
  71         void descend (float);
  72         float overall_progress () const;
  73
  74         /** Emitted by the JobManagerView from the UI thread */
  75         boost::signals2::signal<void()> Finished;
  76
  77 protected:
  78
  79         virtual int remaining_time () const;
  80
  81         /** Description of a job's state */
  82         enum State {
  83                 NEW,            ///< the job hasn't been started yet
  84                 RUNNING,        ///< the job is running
  85                 PAUSED,         ///< the job has been paused
  86                 FINISHED_OK,    ///< the job has finished successfully
  87                 FINISHED_ERROR, ///< the job has finished in error
  88                 FINISHED_CANCELLED ///< the job was cancelled
  89         };
  90
  91         void set_state (State);
  92         void set_error (std::string s, std::string d);
  93
  94         boost::shared_ptr<const Film> _film;
  95
  96 private:
  97
  98         void run_wrapper ();
  99
 100         boost::thread* _thread;
 101
 102         /** mutex for _state and _error */
 103         mutable boost::mutex _state_mutex;
 104         /** current state of the job */
 105         State _state;
 106         /** summary of an error that has occurred (when state == FINISHED_ERROR) */
 107         std::string _error_summary;
 108         std::string _error_details;
 109
 110         /** time that this job was started */
 111         time_t _start_time;
 112
 113         /** mutex for _stack and _progress_unknown */
 114         mutable boost::mutex _progress_mutex;
 115
 116         struct Level {
 117                 Level (float a) : allocation (a), normalised (0) {}
 118
 119                 float allocation;
 120                 float normalised;
 121         };
 122
 123         std::list<Level> _stack;
 124
 125         /** true if this job's progress will always be unknown */
 126         bool _progress_unknown;
 127
 128         int _ran_for;
 129 };
 130
 131 #endif