src/CompositePoolNode.h

   1 /*
   2  * DEBUG: section 77    Delay Pools
   3  * AUTHOR: Robert Collins <robertc@squid-cache.org>
   4  * Based upon original delay pools code by
   5  *   David Luyer <david@luyer.net>
   6  *
   7  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   8  * ----------------------------------------------------------
   9  *
  10  *  Squid is the result of efforts by numerous individuals from
  11  *  the Internet community; see the CONTRIBUTORS file for full
  12  *  details.   Many organizations have provided support for Squid's
  13  *  development; see the SPONSORS file for full details.  Squid is
  14  *  Copyrighted (C) 2001 by the Regents of the University of
  15  *  California; see the COPYRIGHT file for full details.  Squid
  16  *  incorporates software developed and/or copyrighted by other
  17  *  sources; see the CREDITS file for full details.
  18  *
  19  *  This program is free software; you can redistribute it and/or modify
  20  *  it under the terms of the GNU General Public License as published by
  21  *  the Free Software Foundation; either version 2 of the License, or
  22  *  (at your option) any later version.
  23  *
  24  *  This program is distributed in the hope that it will be useful,
  25  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  *  GNU General Public License for more details.
  28  *
  29  *  You should have received a copy of the GNU General Public License
  30  *  along with this program; if not, write to the Free Software
  31  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  32  *
  33  *
  34  * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
  35  */
  36
  37 #include "config.h"
  38
  39 #ifndef COMPOSITEPOOLNODE_H
  40 #define COMPOSITEPOOLNODE_H
  41
  42 #if DELAY_POOLS
  43 #include "squid.h"
  44 #include "DelayPools.h"
  45 #include "DelayIdComposite.h"
  46 #include "CommRead.h"
  47 #include "ip/IpAddress.h"
  48
  49 class StoreEntry;
  50
  51 class AuthUserRequest;
  52
  53 /// \ingroup DelayPoolsAPI
  54 class CompositePoolNode : public RefCountable, public Updateable
  55 {
  56
  57 public:
  58     typedef RefCount<CompositePoolNode> Pointer;
  59     void *operator new(size_t);
  60     void operator delete (void *);
  61     virtual ~CompositePoolNode() {}
  62
  63     virtual void stats(StoreEntry * sentry) =0;
  64     virtual void dump(StoreEntry *entry) const =0;
  65     virtual void update(int incr) =0;
  66     virtual void parse() = 0;
  67
  68     class CompositeSelectionDetails;
  69     virtual DelayIdComposite::Pointer id(CompositeSelectionDetails &) = 0;
  70     void delayRead(DeferredRead const &);
  71
  72     /// \ingroup DelayPoolsAPI
  73     class CompositeSelectionDetails
  74     {
  75
  76     public:
  77         CompositeSelectionDetails() {}
  78
  79         IpAddress src_addr;
  80         AuthUserRequest *user;
  81         String tag;
  82     };
  83
  84 protected:
  85     void kickReads();
  86     DeferredReadManager deferredReads;
  87 };
  88
  89 #endif /* DELAY_POOLS */
  90 #endif /* COMPOSITEPOOLNODE_H */