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 #ifndef COMPOSITEPOOLNODE_H
  37 #define COMPOSITEPOOLNODE_H
  38
  39 #if USE_DELAY_POOLS
  40 #include "squid.h"
  41 #include "auth/UserRequest.h"
  42 #include "DelayPools.h"
  43 #include "DelayIdComposite.h"
  44 #include "CommRead.h"
  45 #include "ip/Address.h"
  46
  47 class StoreEntry;
  48
  49 /// \ingroup DelayPoolsAPI
  50 class CompositePoolNode : public RefCountable, public Updateable
  51 {
  52
  53 public:
  54     typedef RefCount<CompositePoolNode> Pointer;
  55     void *operator new(size_t);
  56     void operator delete (void *);
  57     virtual ~CompositePoolNode() {}
  58
  59     virtual void stats(StoreEntry * sentry) =0;
  60     virtual void dump(StoreEntry *entry) const =0;
  61     virtual void update(int incr) =0;
  62     virtual void parse() = 0;
  63
  64     class CompositeSelectionDetails;
  65     virtual DelayIdComposite::Pointer id(CompositeSelectionDetails &) = 0;
  66     void delayRead(DeferredRead const &);
  67
  68     /// \ingroup DelayPoolsAPI
  69     class CompositeSelectionDetails
  70     {
  71
  72     public:
  73         CompositeSelectionDetails() {}
  74
  75         Ip::Address src_addr;
  76 #if USE_AUTH
  77         AuthUserRequest::Pointer user;
  78 #endif
  79         String tag;
  80     };
  81
  82 protected:
  83     void kickReads();
  84     DeferredReadManager deferredReads;
  85 };
  86
  87 #endif /* USE_DELAY_POOLS */
  88 #endif /* COMPOSITEPOOLNODE_H */