X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fjob.h;h=96f0acbe5a0c886d54a9b96128eed3c5a11a439d;hb=dcd9afacd67975a9e20a6d1c4b3998c2890f1c16;hp=804755ef829413850e3b5ffc120ab3a19ab2c2a3;hpb=fe4a806a8685e8f6932465e10d09723f75bfb1cb;p=dcpomatic.git diff --git a/src/lib/job.h b/src/lib/job.h index 804755ef8..96f0acbe5 100644 --- a/src/lib/job.h +++ b/src/lib/job.h @@ -27,7 +27,6 @@ #include "signaller.h" #include -#include #include #include #include @@ -37,12 +36,15 @@ class Film; /** @class Job * @brief A parent class to represent long-running tasks which are run in their own thread. */ -class Job : public boost::enable_shared_from_this, public Signaller, public boost::noncopyable +class Job : public std::enable_shared_from_this, public Signaller { public: - Job (boost::shared_ptr); + explicit Job (std::shared_ptr film); virtual ~Job (); + Job (Job const&) = delete; + Job& operator= (Job const&) = delete; + /** @return user-readable name of this job */ virtual std::string name () const = 0; virtual std::string json_name () const = 0; @@ -50,7 +52,8 @@ public: virtual void run () = 0; void start (); - void pause (); + bool pause_by_user (); + void pause_by_priority (); void resume (); void cancel (); @@ -60,11 +63,14 @@ public: bool finished_ok () const; bool finished_in_error () const; bool finished_cancelled () const; - bool paused () const; + bool paused_by_user () const; + bool paused_by_priority () const; std::string error_summary () const; std::string error_details () const; + boost::optional message () const; + virtual std::string status () const; std::string json_status () const; std::string sub_name () const { @@ -76,15 +82,17 @@ public: void sub (std::string); boost::optional progress () const; - boost::shared_ptr film () const { + std::shared_ptr film () const { return _film; } - void when_finished (boost::signals2::connection& connection, boost::function finished); + void when_finished (boost::signals2::connection& connection, std::function finished); boost::signals2::signal Progress; /** Emitted from the UI thread when the job is finished */ boost::signals2::signal Finished; + /** Emitted from the job thread when the job is finished */ + boost::signals2::signal FinishedImmediate; protected: @@ -94,7 +102,8 @@ protected: enum State { NEW, ///< the job hasn't been started yet RUNNING, ///< the job is running - PAUSED, ///< the job has been paused + PAUSED_BY_USER, ///< the job has been paused + PAUSED_BY_PRIORITY, ///< the job has been paused FINISHED_OK, ///< the job has finished successfully FINISHED_ERROR, ///< the job has finished in error FINISHED_CANCELLED ///< the job was cancelled @@ -102,24 +111,29 @@ protected: void set_state (State); void set_error (std::string s, std::string d); + void set_message (std::string m); int elapsed_sub_time () const; + void check_for_interruption_or_pause (); + void stop_thread (); - boost::shared_ptr _film; + std::shared_ptr _film; private: void run_wrapper (); void set_progress_common (boost::optional p); - boost::thread* _thread; + boost::thread _thread; - /** mutex for _state and _error */ + /** mutex for _state, _error*, _message */ mutable boost::mutex _state_mutex; /** current state of the job */ State _state; /** summary of an error that has occurred (when state == FINISHED_ERROR) */ std::string _error_summary; std::string _error_details; + /** a message that should be given to the user when the job finishes */ + boost::optional _message; /** time that this job was started */ time_t _start_time;