X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fjob.h;h=a0e988fc8ccd11df26983127e347691da43cd2f2;hb=3b31d2d8a129ae6d8d267427bd6b5bc444b40b2a;hp=1caa5a90458368e4cdd0d6af696044966efeed93;hpb=0ec7c9d0b1f3ea58ffe17dd70bea04ad702d164b;p=dcpomatic.git diff --git a/src/lib/job.h b/src/lib/job.h index 1caa5a904..a0e988fc8 100644 --- a/src/lib/job.h +++ b/src/lib/job.h @@ -1,19 +1,20 @@ /* Copyright (C) 2012 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ @@ -39,7 +40,7 @@ class Film; class Job : public boost::enable_shared_from_this, public Signaller, public boost::noncopyable { public: - Job (boost::shared_ptr); + explicit Job (boost::shared_ptr film); virtual ~Job (); /** @return user-readable name of this job */ @@ -49,7 +50,8 @@ public: virtual void run () = 0; void start (); - void pause (); + bool pause_by_user (); + void pause_by_priority (); void resume (); void cancel (); @@ -59,12 +61,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; - int elapsed_time () const; + boost::optional message () const; + virtual std::string status () const; std::string json_status () const; std::string sub_name () const { @@ -80,9 +84,13 @@ public: return _film; } + void when_finished (boost::signals2::connection& connection, boost::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: @@ -92,7 +100,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 @@ -100,6 +109,10 @@ 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; @@ -108,23 +121,28 @@ 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 sub-job was started */ + /** time that this job was started */ time_t _start_time; + /** time that this sub-job was started */ + time_t _sub_start_time; std::string _sub_name; - /** mutex for _progress */ + /** mutex for _progress and _last_progress_update */ mutable boost::mutex _progress_mutex; boost::optional _progress; + boost::optional _last_progress_update; /** condition to signal changes to pause/resume so that we know when to wake; this could be a general _state_change if it made more sense.