src/DelayUser.h

   1 /*
   2  * $Id$
   3  *
   4  * DEBUG: section 77    Delay Pools
   5  * AUTHOR: Robert Collins <robertc@squid-cache.org>
   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 DELAYUSER_H
  37 #define DELAYUSER_H
  38
  39 #include "config.h"
  40
  41 #if DELAY_POOLS
  42
  43 #include "squid.h"
  44 #include "auth/Gadgets.h"
  45 #include "auth/User.h"
  46 #include "CompositePoolNode.h"
  47 #include "DelayIdComposite.h"
  48 #include "DelayBucket.h"
  49 #include "DelaySpec.h"
  50 #include "Array.h"
  51 #include "splay.h"
  52
  53 /// \ingroup DelayPoolsAPI
  54 class DelayUserBucket : public RefCountable
  55 {
  56
  57 public:
  58     typedef RefCount<DelayUserBucket> Pointer;
  59     void *operator new(size_t);
  60     void operator delete (void *);
  61
  62     void stats(StoreEntry *)const;
  63     DelayUserBucket(AuthUser::Pointer);
  64     ~DelayUserBucket();
  65     DelayBucket theBucket;
  66     AuthUser::Pointer authUser;
  67 };
  68
  69 /// \ingroup DelayPoolsAPI
  70 class DelayUser : public CompositePoolNode
  71 {
  72
  73 public:
  74     typedef RefCount<DelayUser> Pointer;
  75     void *operator new(size_t);
  76     void operator delete (void *);
  77     DelayUser();
  78     virtual ~DelayUser();
  79     virtual void stats(StoreEntry * sentry);
  80     virtual void dump(StoreEntry *entry) const;
  81     virtual void update(int incr);
  82     virtual void parse();
  83
  84     virtual DelayIdComposite::Pointer id(CompositeSelectionDetails &);
  85
  86 private:
  87
  88     /// \ingroup DelayPoolsInternal
  89     class Id:public DelayIdComposite
  90     {
  91
  92     public:
  93         void *operator new(size_t);
  94         void operator delete (void *);
  95         Id(RefCount<DelayUser>, AuthUser::Pointer);
  96         ~Id();
  97         virtual int bytesWanted (int min, int max) const;
  98         virtual void bytesIn(int qty);
  99
 100     private:
 101         RefCount<DelayUser> theUser;
 102         DelayUserBucket::Pointer theBucket;
 103     };
 104
 105     friend class Id;
 106
 107     DelaySpec spec;
 108     Splay<DelayUserBucket::Pointer> buckets;
 109 };
 110
 111 #endif /* DELAY_POOLS */
 112 #endif /* DELAYUSER_H */