src/DelayId.h

   1 /*
   2  * $Id$
   3  *
   4  *
   5  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   6  * ----------------------------------------------------------
   7  *
   8  *  Squid is the result of efforts by numerous individuals from
   9  *  the Internet community; see the CONTRIBUTORS file for full
  10  *  details.   Many organizations have provided support for Squid's
  11  *  development; see the SPONSORS file for full details.  Squid is
  12  *  Copyrighted (C) 2001 by the Regents of the University of
  13  *  California; see the COPYRIGHT file for full details.  Squid
  14  *  incorporates software developed and/or copyrighted by other
  15  *  sources; see the CREDITS file for full details.
  16  *
  17  *  This program is free software; you can redistribute it and/or modify
  18  *  it under the terms of the GNU General Public License as published by
  19  *  the Free Software Foundation; either version 2 of the License, or
  20  *  (at your option) any later version.
  21  *
  22  *  This program is distributed in the hope that it will be useful,
  23  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *  GNU General Public License for more details.
  26  *
  27  *  You should have received a copy of the GNU General Public License
  28  *  along with this program; if not, write to the Free Software
  29  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  30  *
  31  *
  32  * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
  33  */
  34
  35 #ifndef SQUID_DELAYID_H
  36 #define SQUID_DELAYID_H
  37
  38 #if DELAY_POOLS
  39
  40 class ClientHttpRequest;
  41 #include "DelayIdComposite.h"
  42
  43 /// \ingroup DelayPoolsAPI
  44 class DelayId
  45 {
  46
  47 public:
  48     static DelayId DelayClient (ClientHttpRequest *);
  49     DelayId ();
  50     DelayId (unsigned short);
  51     ~DelayId ();
  52     unsigned short pool() const;
  53     DelayIdComposite::Pointer compositePosition();
  54     DelayIdComposite::Pointer const compositePosition() const;
  55     void compositePosition(DelayIdComposite::Pointer );
  56     bool operator == (DelayId const &rhs) const;
  57     operator bool() const;
  58     int bytesWanted(int min, int max) const;
  59     void bytesIn (int qty);
  60     void setNoDelay(bool const);
  61     void delayRead(DeferredRead const &);
  62
  63 private:
  64     unsigned short pool_;
  65     DelayIdComposite::Pointer compositeId;
  66     bool markedAsNoDelay;
  67 };
  68
  69 #endif /* DELAY_POOLS */
  70 #endif /* SQUID_DELAYID_H */