src/DiskIO/DiskIOModule.h

   1
   2 /*
   3  * $Id$
   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 "Array.h"
  38
  39 /* forward decls */
  40
  41 class CacheManager;
  42
  43 class DiskIOStrategy;
  44
  45 class DiskIOModule
  46 {
  47
  48 public:
  49     static void SetupAllModules();
  50     static void ModuleAdd(DiskIOModule &);
  51     static void FreeAllModules();
  52
  53     /** Poke all compiled modules for self-setup */
  54     static void PokeAllModules();
  55
  56     static DiskIOModule *Find(char const *type);
  57
  58     /** Find *any* usable disk module. This will look for the 'best'
  59      * available module for this system.
  60      */
  61     static DiskIOModule *FindDefault();
  62     static Vector<DiskIOModule*> const &Modules();
  63     typedef Vector<DiskIOModule*>::iterator iterator;
  64     typedef Vector<DiskIOModule*>::const_iterator const_iterator;
  65     DiskIOModule();
  66     virtual ~DiskIOModule() {}
  67
  68     virtual void init() = 0;
  69     //virtual void registerWithCacheManager(void);
  70     virtual void shutdown() = 0;
  71     virtual DiskIOStrategy *createStrategy() = 0;
  72
  73     virtual char const *type () const = 0;
  74     // Not implemented
  75     DiskIOModule(DiskIOModule const &);
  76     DiskIOModule &operator=(DiskIOModule const&);
  77
  78 protected:
  79     //bool initialised;
  80     static void RegisterAllModulesWithCacheManager(void);
  81
  82 private:
  83     static Vector<DiskIOModule*> &GetModules();
  84     static Vector<DiskIOModule*> *_Modules;
  85 };
  86
  87 #endif /* SQUID_DISKIOMODULE_H */