src/adaptation/icap/OptXact.h

   1 /*
   2  *
   3  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   4  * ----------------------------------------------------------
   5  *
   6  *  Squid is the result of efforts by numerous individuals from
   7  *  the Internet community; see the CONTRIBUTORS file for full
   8  *  details.   Many organizations have provided support for Squid's
   9  *  development; see the SPONSORS file for full details.  Squid is
  10  *  Copyrighted (C) 2001 by the Regents of the University of
  11  *  California; see the COPYRIGHT file for full details.  Squid
  12  *  incorporates software developed and/or copyrighted by other
  13  *  sources; see the CREDITS file for full details.
  14  *
  15  *  This program is free software; you can redistribute it and/or modify
  16  *  it under the terms of the GNU General Public License as published by
  17  *  the Free Software Foundation; either version 2 of the License, or
  18  *  (at your option) any later version.
  19  *
  20  *  This program is distributed in the hope that it will be useful,
  21  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  *  GNU General Public License for more details.
  24  *
  25  *  You should have received a copy of the GNU General Public License
  26  *  along with this program; if not, write to the Free Software
  27  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  28  *
  29  */
  30
  31 #ifndef SQUID_ICAPOPTXACT_H
  32 #define SQUID_ICAPOPTXACT_H
  33
  34 #include "adaptation/icap/Xaction.h"
  35 #include "adaptation/icap/Launcher.h"
  36
  37 namespace Adaptation
  38 {
  39 namespace Icap
  40 {
  41
  42 /* OptXact sends an ICAP OPTIONS request to the ICAP service,
  43  * parses the ICAP response, and sends it to the initiator. A NULL response
  44  * means the ICAP service could not be contacted or did not return any
  45  * valid response. */
  46
  47 class OptXact: public Xaction
  48 {
  49
  50 public:
  51     OptXact(ServiceRep::Pointer &aService);
  52
  53 protected:
  54     virtual void start();
  55     virtual void handleCommConnected();
  56     virtual void handleCommWrote(size_t size);
  57     virtual void handleCommRead(size_t size);
  58
  59     void makeRequest(MemBuf &buf);
  60     bool parseResponse();
  61
  62     void startReading();
  63     virtual bool doneReading() const { return commEof || readAll; }
  64
  65     virtual void swanSong();
  66
  67 private:
  68     virtual void finalizeLogInfo();
  69
  70     bool readAll; ///< read the entire OPTIONS response
  71
  72     CBDATA_CLASS2(OptXact);
  73 };
  74
  75 // An Launcher that stores OptXact construction info and
  76 // creates OptXact when needed
  77 class OptXactLauncher: public Launcher
  78 {
  79 public:
  80     OptXactLauncher(Adaptation::ServicePointer aService);
  81
  82 protected:
  83     virtual Xaction *createXaction();
  84
  85 private:
  86     CBDATA_CLASS2(OptXactLauncher);
  87 };
  88
  89 } // namespace Icap
  90 } // namespace Adaptation
  91
  92 #endif /* SQUID_ICAPOPTXACT_H */