src/StoreHashIndex.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  */
  33
  34 #ifndef SQUID_STOREHASHINDEX_H
  35 #define SQUID_STOREHASHINDEX_H
  36
  37 #include "Store.h"
  38 #include "StoreSearch.h"
  39
  40 /* A summary store that indexs all its children
  41  * into a memory hash
  42  */
  43
  44 class StoreSearch;
  45
  46 class StoreHashIndex : public Store
  47 {
  48
  49 public:
  50     StoreHashIndex();
  51     StoreHashIndex(StoreHashIndex const &); /* to cause link failures */
  52     virtual ~StoreHashIndex();
  53     virtual int callback();
  54     virtual void create();
  55
  56     virtual StoreEntry * get
  57     (const cache_key *);
  58
  59     virtual void get
  60     (String const, STOREGETCLIENT, void * cbdata);
  61
  62     virtual void init();
  63
  64     virtual void sync();
  65
  66     virtual size_t maxSize() const;
  67
  68     virtual size_t minSize() const;
  69
  70     virtual void stat(StoreEntry&) const;
  71
  72     virtual void reference(StoreEntry&);
  73
  74     virtual void dereference(StoreEntry&);
  75
  76     virtual void maintain();
  77
  78     virtual void updateSize(int64_t, int);
  79
  80     virtual StoreSearch *search(String const url, HttpRequest *);
  81
  82 private:
  83     /* migration logic */
  84     StorePointer store(int const x) const;
  85 };
  86
  87 class StoreHashIndexEntry : public StoreEntry
  88     {};
  89
  90 class StoreSearchHashIndex : public StoreSearch
  91 {
  92
  93 public:
  94     StoreSearchHashIndex(RefCount<StoreHashIndex> sd);
  95     StoreSearchHashIndex(StoreSearchHashIndex const &);
  96     virtual ~StoreSearchHashIndex();
  97     /* Iterator API - garh, wrong place */
  98     /* callback the client when a new StoreEntry is available
  99      * or an error occurs
 100      */
 101     virtual void next(void (callback)(void *cbdata), void *cbdata);
 102     /* return true if a new StoreEntry is immediately available */
 103     virtual bool next();
 104     virtual bool error() const;
 105     virtual bool isDone() const;
 106     virtual StoreEntry *currentItem();
 107
 108     RefCount<StoreHashIndex> sd;
 109
 110 private:
 111     CBDATA_CLASS2(StoreSearchHashIndex);
 112     void copyBucket();
 113     void (*callback)(void *cbdata);
 114     void *cbdata;
 115     bool _done;
 116     int bucket;
 117     Vector<StoreEntry *> entries;
 118 };
 119
 120 #endif /* SQUID_STOREHASHINDEX_H */