src/DelayPools.h

   1 /*
   2  * $Id: DelayPools.h,v 1.5 2008/02/26 21:49:34 amosjeffries Exp $
   3  *
   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  *
  32  * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
  33  */
  34 #ifndef SQUID_DELAYPOOLS_H
  35 #define SQUID_DELAYPOOLS_H
  36
  37 /**
  38  \defgroup DelayPoolsAPI Delay Pools API
  39  \ingroup Components
  40  */
  41
  42 /// \ingroup DelayPoolsAPI
  43 class Updateable
  44 {
  45
  46 public:
  47     virtual ~Updateable(){}
  48
  49     virtual void update(int) = 0;
  50 };
  51
  52 /* forward decls */
  53 class CacheManager;
  54 class DelayPool;
  55 class Updateable;
  56 class StoreEntry;
  57
  58 /* for Vector<> */
  59 #include "Array.h"
  60
  61 /// \ingroup DelayPoolsAPI
  62 class DelayPools
  63 {
  64
  65 public:
  66     static void Init();
  67     static void RegisterWithCacheManager(void);
  68     static void Update(void *);
  69     static unsigned short pools();
  70     static void pools (u_short pools);
  71     static void FreePools();
  72     static unsigned char *DelayClasses();
  73     static void registerForUpdates(Updateable *);
  74     static void deregisterForUpdates (Updateable *);
  75     static long MemoryUsed;
  76     static DelayPool *delay_data;
  77
  78 private:
  79     static void Stats(StoreEntry *);
  80     static void InitDelayData();
  81     static time_t LastUpdate;
  82     static unsigned short pools_;
  83     static void FreeDelayData ();
  84     static Vector<Updateable *> toUpdate;
  85 };
  86
  87 #endif /* SQUID_DELAYPOOLS_H */