X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fjob.h;h=5562afc16cc89cae1e9dec8941ee837622598d8b;hp=e5552e49ea8f63acec13443fccf29cc3d6f6b7a9;hb=a6c4b4fa16d9c6597e362044b875f3d6df80753f;hpb=a69d242f3f00207d6ea7320e6723775f4b0dbfb3 diff --git a/src/lib/job.h b/src/lib/job.h index e5552e49e..5562afc16 100644 --- a/src/lib/job.h +++ b/src/lib/job.h @@ -27,7 +27,6 @@ #include "signaller.h" #include -#include #include #include #include @@ -37,20 +36,27 @@ 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: - explicit Job (boost::shared_ptr film); + 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; /** Run this job in the current thread. */ virtual void run () = 0; + /** @return true if it should be possible to notify when this job finishes */ + virtual bool enable_notify () const { + return false; + } void start (); - void pause_by_user (); + bool pause_by_user (); void pause_by_priority (); void resume (); void cancel (); @@ -67,6 +73,8 @@ public: 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 { @@ -77,16 +85,25 @@ public: void set_progress (float, bool force = false); void sub (std::string); boost::optional progress () const; + boost::optional seconds_since_last_progress_update () const; - boost::shared_ptr film () const { + std::shared_ptr film () const { return _film; } - void when_finished (boost::signals2::connection& connection, boost::function finished); + enum class Result { + RESULT_OK, + RESULT_ERROR, // we can't have plain ERROR on Windows + RESULT_CANCELLED + }; + + 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; + boost::signals2::signal Finished; + /** Emitted from the job thread when the job is finished */ + boost::signals2::signal FinishedImmediate; protected: @@ -103,27 +120,32 @@ protected: FINISHED_CANCELLED ///< the job was cancelled }; + Result state_to_result(State state) const; void set_state (State); - void set_error (std::string s, std::string d); + 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;