src/adaptation/icap/OptXact.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
  33 #ifndef SQUID_ICAPOPTXACT_H
  34 #define SQUID_ICAPOPTXACT_H
  35
  36 #include "adaptation/icap/Xaction.h"
  37 #include "adaptation/icap/Launcher.h"
  38
  39 namespace Adaptation
  40 {
  41 namespace Icap
  42 {
  43
  44 /* OptXact sends an ICAP OPTIONS request to the ICAP service,
  45  * parses the ICAP response, and sends it to the initiator. A NULL response
  46  * means the ICAP service could not be contacted or did not return any
  47  * valid response. */
  48
  49 class OptXact: public Xaction
  50 {
  51
  52 public:
  53     OptXact(ServiceRep::Pointer &aService);
  54
  55 protected:
  56     virtual void start();
  57     virtual void handleCommConnected();
  58     virtual void handleCommWrote(size_t size);
  59     virtual void handleCommRead(size_t size);
  60
  61     void makeRequest(MemBuf &buf);
  62     bool parseResponse();
  63
  64     void startReading();
  65     virtual bool doneReading() const { return commEof || readAll; }
  66
  67     virtual void swanSong();
  68
  69 private:
  70     virtual void finalizeLogInfo();
  71
  72     bool readAll; ///< read the entire OPTIONS response
  73
  74     CBDATA_CLASS2(OptXact);
  75 };
  76
  77 // An Launcher that stores OptXact construction info and
  78 // creates OptXact when needed
  79 class OptXactLauncher: public Launcher
  80 {
  81 public:
  82     OptXactLauncher(Adaptation::ServicePointer aService);
  83
  84 protected:
  85     virtual Xaction *createXaction();
  86
  87 private:
  88     CBDATA_CLASS2(OptXactLauncher);
  89 };
  90
  91 } // namespace Icap
  92 } // namespace Adaptation
  93
  94 #endif /* SQUID_ICAPOPTXACT_H */