src/RemovalPolicy.h

   1
   2 /*
   3  * $Id$
   4  *
   5  *
   6  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   7  * ----------------------------------------------------------
   8  *
   9  *  Squid is the result of efforts by numerous individuals from
  10  *  the Internet community; see the CONTRIBUTORS file for full
  11  *  details.   Many organizations have provided support for Squid's
  12  *  development; see the SPONSORS file for full details.  Squid is
  13  *  Copyrighted (C) 2001 by the Regents of the University of
  14  *  California; see the COPYRIGHT file for full details.  Squid
  15  *  incorporates software developed and/or copyrighted by other
  16  *  sources; see the CREDITS file for full details.
  17  *
  18  *  This program is free software; you can redistribute it and/or modify
  19  *  it under the terms of the GNU General Public License as published by
  20  *  the Free Software Foundation; either version 2 of the License, or
  21  *  (at your option) any later version.
  22  *
  23  *  This program is distributed in the hope that it will be useful,
  24  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  *  GNU General Public License for more details.
  27  *
  28  *  You should have received a copy of the GNU General Public License
  29  *  along with this program; if not, write to the Free Software
  30  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  31  *
  32  * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
  33  */
  34
  35 #ifndef   SQUID_REMOVALPOLICY_H
  36 #define   SQUID_REMOVALPOLICY_H
  37
  38 #include "cbdata.h"
  39
  40 class RemovalPolicyWalker;
  41 class RemovalPurgeWalker;
  42
  43 class RemovalPolicySettings
  44 {
  45
  46 public:
  47     RemovalPolicySettings() : type(NULL), args(NULL) {};
  48
  49     char *type;
  50     wordlist *args;
  51 };
  52
  53 class RemovalPolicyNode
  54 {
  55
  56 public:
  57     RemovalPolicyNode() : data(NULL) {}
  58
  59     void *data;
  60 };
  61
  62 class RemovalPolicy
  63 {
  64 public:
  65     const char *_type;
  66     void *_data;
  67     void (*Free) (RemovalPolicy * policy);
  68     void (*Add) (RemovalPolicy * policy, StoreEntry * entry, RemovalPolicyNode * node);
  69     void (*Remove) (RemovalPolicy * policy, StoreEntry * entry, RemovalPolicyNode * node);
  70     void (*Referenced) (RemovalPolicy * policy, const StoreEntry * entry, RemovalPolicyNode * node);
  71     void (*Dereferenced) (RemovalPolicy * policy, const StoreEntry * entry, RemovalPolicyNode * node);
  72     RemovalPolicyWalker *(*WalkInit) (RemovalPolicy * policy);
  73     RemovalPurgeWalker *(*PurgeInit) (RemovalPolicy * policy, int max_scan);
  74     void (*Stats) (RemovalPolicy * policy, StoreEntry * entry);
  75 private:
  76     CBDATA_CLASS2(RemovalPolicy);
  77 };
  78
  79 class RemovalPolicyWalker
  80 {
  81 public:
  82     RemovalPolicy *_policy;
  83     void *_data;
  84     const StoreEntry *(*Next) (RemovalPolicyWalker * walker);
  85     void (*Done) (RemovalPolicyWalker * walker);
  86 private:
  87     CBDATA_CLASS2(RemovalPolicyWalker);
  88 };
  89
  90 class RemovalPurgeWalker
  91 {
  92 public:
  93     RemovalPolicy *_policy;
  94     void *_data;
  95     int scanned, max_scan, locked;
  96     StoreEntry *(*Next) (RemovalPurgeWalker * walker);
  97     void (*Done) (RemovalPurgeWalker * walker);
  98 private:
  99     CBDATA_CLASS2(RemovalPurgeWalker);
 100 };
 101
 102 extern RemovalPolicy *createRemovalPolicy(RemovalPolicySettings * settings);
 103
 104 typedef RemovalPolicy *REMOVALPOLICYCREATE(wordlist * args);
 105
 106 #endif /* SQUID_REMOVALPOLICY_H */