src/lib/job_manager.h

   1 /*
   2     Copyright (C) 2012 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 <list>
  25 #include <boost/thread/mutex.hpp>
  26
  27 class Job;
  28
  29 /** @class JobManager
  30  *  @brief A simple scheduler for jobs.
  31  *
  32  *  JobManager simply keeps a list of pending jobs, and assumes that all the jobs
  33  *  are sufficiently CPU intensive that there is no point running them in parallel;
  34  *  so jobs are just run one after the other.
  35  */
  36 class JobManager
  37 {
  38 public:
  39
  40         void add (boost::shared_ptr<Job>);
  41         void add_after (boost::shared_ptr<Job> after, boost::shared_ptr<Job> j);
  42         std::list<boost::shared_ptr<Job> > get () const;
  43         bool work_to_do () const;
  44
  45         static JobManager* instance ();
  46
  47 private:
  48         JobManager ();
  49         void scheduler ();
  50
  51         mutable boost::mutex _mutex;
  52         std::list<boost::shared_ptr<Job> > _jobs;
  53
  54         static JobManager* _instance;
  55 };