#include "signaller.h"
#include <boost/thread/mutex.hpp>
-#include <boost/enable_shared_from_this.hpp>
#include <boost/signals2.hpp>
#include <boost/thread.hpp>
#include <string>
/** @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<Job>, public Signaller, public boost::noncopyable
+class Job : public std::enable_shared_from_this<Job>, public Signaller
{
public:
- Job (boost::shared_ptr<const Film>);
+ explicit Job (std::shared_ptr<const Film> 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;
virtual void run () = 0;
void start ();
- void pause_by_user ();
+ bool pause_by_user ();
void pause_by_priority ();
void resume ();
void cancel ();
std::string error_summary () const;
std::string error_details () const;
+ boost::optional<std::string> message () const;
+
virtual std::string status () const;
std::string json_status () const;
std::string sub_name () const {
void sub (std::string);
boost::optional<float> progress () const;
- boost::shared_ptr<const Film> film () const {
+ std::shared_ptr<const Film> film () const {
return _film;
}
- void when_finished (boost::signals2::connection& connection, boost::function<void()> finished);
+ void when_finished (boost::signals2::connection& connection, std::function<void()> finished);
boost::signals2::signal<void()> Progress;
/** Emitted from the UI thread when the job is finished */
boost::signals2::signal<void()> Finished;
+ /** Emitted from the job thread when the job is finished */
+ boost::signals2::signal<void()> FinishedImmediate;
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<const Film> _film;
+ std::shared_ptr<const Film> _film;
private:
void run_wrapper ();
void set_progress_common (boost::optional<float> 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<std::string> _message;
/** time that this job was started */
time_t _start_time;