src/DiskIO/DiskIOModule.h

   1
   2 /*
   3  * $Id: DiskIOModule.h,v 1.3 2006/09/14 00:51:10 robertc Exp $
   4  *
   5  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   6  * ----------------------------------------------------------
   7  *
   8  *  Squid is the result of efforts by numerous individuals from
   9  *  the Internet community; see the CONTRIBUTORS file for full
  10  *  details.   Many organizations have provided support for Squid's
  11  *  development; see the SPONSORS file for full details.  Squid is
  12  *  Copyrighted (C) 2001 by the Regents of the University of
  13  *  California; see the COPYRIGHT file for full details.  Squid
  14  *  incorporates software developed and/or copyrighted by other
  15  *  sources; see the CREDITS file for full details.
  16  *
  17  *  This program is free software; you can redistribute it and/or modify
  18  *  it under the terms of the GNU General Public License as published by
  19  *  the Free Software Foundation; either version 2 of the License, or
  20  *  (at your option) any later version.
  21  *
  22  *  This program is distributed in the hope that it will be useful,
  23  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *  GNU General Public License for more details.
  26  *
  27  *  You should have received a copy of the GNU General Public License
  28  *  along with this program; if not, write to the Free Software
  29  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  30  *
  31  * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
  32  */
  33
  34 #ifndef SQUID_DISKIOMODULE_H
  35 #define SQUID_DISKIOMODULE_H
  36
  37 #include "squid.h"
  38 #include "Array.h"
  39
  40 /* forward decls */
  41
  42 class CacheManager;
  43
  44 class DiskIOStrategy;
  45
  46 class DiskIOModule
  47 {
  48
  49 public:
  50     static void RegisterAllModulesWithCacheManager(void);
  51     static void SetupAllModules();
  52     static void ModuleAdd(DiskIOModule &);
  53     static void FreeAllModules();
  54     static DiskIOModule *Find(char const *type);
  55     /* find *any* usable disk module. This will look for the 'best'
  56      * available module for this system.
  57      */
  58     static DiskIOModule *FindDefault();
  59     static Vector<DiskIOModule*> const &Modules();
  60     typedef Vector<DiskIOModule*>::iterator iterator;
  61     typedef Vector<DiskIOModule*>::const_iterator const_iterator;
  62     DiskIOModule();
  63     virtual ~DiskIOModule(){}
  64
  65     virtual void init() = 0;
  66     virtual void registerWithCacheManager(void);
  67     virtual void shutdown() = 0;
  68     virtual DiskIOStrategy *createStrategy() = 0;
  69
  70     virtual char const *type () const = 0;
  71     // Not implemented
  72     DiskIOModule(DiskIOModule const &);
  73     DiskIOModule &operator=(DiskIOModule const&);
  74
  75 protected:
  76     //bool initialised;
  77
  78 private:
  79     static Vector<DiskIOModule*> &GetModules();
  80     static Vector<DiskIOModule*> *_Modules;
  81 };
  82
  83
  84 #endif /* SQUID_DISKIOMODULE_H */