src/lib/job_manager.h

   1 /*
   2     Copyright (C) 2012-2015 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_manager.h
  21  *  @brief A simple scheduler for jobs.
  22  */
  23
  24 #include "signaller.h"
  25 #include <boost/thread/mutex.hpp>
  26 #include <boost/thread.hpp>
  27 #include <boost/signals2.hpp>
  28 #include <list>
  29
  30 class Job;
  31 class Film;
  32 class Playlist;
  33
  34 extern void wait_for_jobs ();
  35
  36 /** @class JobManager
  37  *  @brief A simple scheduler for jobs.
  38  */
  39 class JobManager : public Signaller, public boost::noncopyable
  40 {
  41 public:
  42
  43         boost::shared_ptr<Job> add (boost::shared_ptr<Job>);
  44         std::list<boost::shared_ptr<Job> > get () const;
  45         bool work_to_do () const;
  46         bool errors () const;
  47
  48         void analyse_audio (
  49                 boost::shared_ptr<const Film> film,
  50                 boost::shared_ptr<const Playlist> playlist,
  51                 boost::signals2::connection& connection,
  52                 boost::function<void()> ready
  53                 );
  54
  55         boost::signals2::signal<void (boost::weak_ptr<Job>)> JobAdded;
  56         boost::signals2::signal<void (boost::optional<std::string>, boost::optional<std::string>)> ActiveJobsChanged;
  57
  58         static JobManager* instance ();
  59         static void drop ();
  60
  61 private:
  62         /* This function is part of the test suite */
  63         friend void ::wait_for_jobs ();
  64
  65         JobManager ();
  66         ~JobManager ();
  67         void scheduler ();
  68         void start ();
  69
  70         mutable boost::mutex _mutex;
  71         std::list<boost::shared_ptr<Job> > _jobs;
  72         bool _terminate;
  73
  74         boost::optional<std::string> _last_active_job;
  75         boost::thread* _scheduler;
  76
  77         static JobManager* _instance;
  78 };