src/DiskIO/DiskIOModule.h

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