JobServer.H

Go to the documentation of this file.
00001 /*!@file Util/JobServer.H Generic interface for running computation jobs */
00002 
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2005   //
00005 // by the University of Southern California (USC) and the iLab at USC.  //
00006 // See http://iLab.usc.edu for information about this project.          //
00007 // //////////////////////////////////////////////////////////////////// //
00008 // Major portions of the iLab Neuromorphic Vision Toolkit are protected //
00009 // under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
00010 // in Visual Environments, and Applications'' by Christof Koch and      //
00011 // Laurent Itti, California Institute of Technology, 2001 (patent       //
00012 // pending; application number 09/912,225 filed July 23, 2001; see      //
00013 // http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
00014 // //////////////////////////////////////////////////////////////////// //
00015 // This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
00016 //                                                                      //
00017 // The iLab Neuromorphic Vision C++ Toolkit is free software; you can   //
00018 // redistribute it and/or modify it under the terms of the GNU General  //
00019 // Public License as published by the Free Software Foundation; either  //
00020 // version 2 of the License, or (at your option) any later version.     //
00021 //                                                                      //
00022 // The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  //
00023 // that it will be useful, but WITHOUT ANY WARRANTY; without even the   //
00024 // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      //
00025 // PURPOSE.  See the GNU General Public License for more details.       //
00026 //                                                                      //
00027 // You should have received a copy of the GNU General Public License    //
00028 // along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
00029 // to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
00030 // Boston, MA 02111-1307 USA.                                           //
00031 // //////////////////////////////////////////////////////////////////// //
00032 //
00033 // Primary maintainer for this file: Rob Peters <rjpeters at usc dot edu>
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Util/JobServer.H $
00035 // $Id: JobServer.H 8384 2007-05-13 16:16:54Z rjpeters $
00036 //
00037 
00038 #ifndef UTIL_JOBSERVER_H_DEFINED
00039 #define UTIL_JOBSERVER_H_DEFINED
00040 
00041 #include "rutz/shared_ptr.h"
00042 
00043 #include <cstddef> // for size_t
00044 
00045 /// Abstract interface for running generic computation jobs
00046 class JobServer
00047 {
00048 public:
00049 
00050   /// Base class for jobs that can be submitted to a JobServer
00051   class Job
00052   {
00053   public:
00054     Job();
00055 
00056     virtual ~Job();
00057 
00058     virtual void run() = 0;
00059 
00060     virtual const char* jobType() const = 0;
00061 
00062     /// Default implementation returns 0 (lower value = higher priority)
00063     virtual int priority() const;
00064 
00065     /// Check if the job was dropped by the job server
00066     bool wasDropped() const { return itsDropped; }
00067 
00068     /// Mark the job as dropped (should be called by the job server as needed)
00069     void drop() { itsDropped = true; }
00070 
00071   private:
00072     bool itsDropped;
00073   };
00074 
00075   /// Virtual destructor for safe inheritance
00076   virtual ~JobServer();
00077 
00078   /// Submit a job to be run
00079   /** Depending on the JobServer subclass, the job may be run
00080       immediately or may be run at a later time, in a different
00081       thread, on a different machine, etc. */
00082   virtual void enqueueJob(const rutz::shared_ptr<Job>& job) = 0;
00083 
00084   /// Submit multiple jobs in a batch
00085   /** Depending on the JobServer subclass, this may be more efficient
00086       than a series of individual enqueueJob() calls (e.g., the
00087       subclass might be able to lock/unlock a mutex just once rather
00088       than once per submitted job).
00089 
00090       The default implementation just repeatedly calls enqueueJob().
00091   */
00092   virtual void enqueueJobs(const rutz::shared_ptr<Job>* jobs,
00093                            const size_t njobs);
00094 
00095   /// Return a hint as to how many jobs could naturally be run in parallel by this JobServer
00096   /** Clients might be able to use this hint to decide how to best
00097       decompose their overall algorithm into individual job
00098       requeusts. */
00099   virtual unsigned int getParallelismHint() = 0;
00100 };
00101 
00102 // ######################################################################
00103 /* So things look consistent in everyone's emacs... */
00104 /* Local Variables: */
00105 /* mode: c++ */
00106 /* indent-tabs-mode: nil */
00107 /* End: */
00108 
00109 #endif // UTIL_JOBSERVER_H_DEFINED
Generated on Sun May 8 08:42:26 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3