src/ICAP/ICAPInOut.h

   1
   2 /*
   3  * $Id: ICAPInOut.h,v 1.1 2007/04/06 04:50:07 rousskov Exp $
   4  *
   5  *
   6  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   7  * ----------------------------------------------------------
   8  *
   9  *  Squid is the result of efforts by numerous individuals from
  10  *  the Internet community; see the CONTRIBUTORS file for full
  11  *  details.   Many organizations have provided support for Squid's
  12  *  development; see the SPONSORS file for full details.  Squid is
  13  *  Copyrighted (C) 2001 by the Regents of the University of
  14  *  California; see the COPYRIGHT file for full details.  Squid
  15  *  incorporates software developed and/or copyrighted by other
  16  *  sources; see the CREDITS file for full details.
  17  *
  18  *  This program is free software; you can redistribute it and/or modify
  19  *  it under the terms of the GNU General Public License as published by
  20  *  the Free Software Foundation; either version 2 of the License, or
  21  *  (at your option) any later version.
  22  *
  23  *  This program is distributed in the hope that it will be useful,
  24  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  *  GNU General Public License for more details.
  27  *
  28  *  You should have received a copy of the GNU General Public License
  29  *  along with this program; if not, write to the Free Software
  30  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  31  *
  32  */
  33
  34 #ifndef SQUID_ICAPINOUT_H
  35 #define SQUID_ICAPINOUT_H
  36
  37 #include "HttpMsg.h"
  38 #include "HttpRequest.h"
  39 #include "HttpReply.h"
  40
  41 // IcapInOut manages a pointer to the HTTP message being worked on.
  42 // For HTTP responses, request header information is also available
  43 // as the "cause". ICAP transactions use this class to store virgin
  44 // and adapted HTTP messages.
  45
  46 class ICAPInOut
  47 {
  48
  49 public:
  50     typedef HttpMsg Header;
  51
  52     ICAPInOut(): header(0), cause(0) {}
  53
  54     ~ICAPInOut()
  55     {
  56         HTTPMSGUNLOCK(cause);
  57         HTTPMSGUNLOCK(header);
  58     }
  59
  60     void setCause(HttpRequest *r)
  61     {
  62         if (r) {
  63             HTTPMSGUNLOCK(cause);
  64             cause = HTTPMSGLOCK(r);
  65         } else {
  66             assert(!cause);
  67         }
  68     }
  69
  70     void setHeader(Header *h)
  71     {
  72         HTTPMSGUNLOCK(header);
  73         header = HTTPMSGLOCK(h);
  74                 body_pipe = header->body_pipe;
  75     }
  76
  77 public:
  78     // virgin or adapted message being worked on
  79     Header *header;   // parsed HTTP status/request line and headers
  80
  81     // HTTP request header for HTTP responses (the cause of the response)
  82     HttpRequest *cause;
  83
  84         // Copy of header->body_pipe, in case somebody moves the original.
  85         BodyPipe::Pointer body_pipe;
  86 };
  87
  88 // TODO: s/Header/Message/i ?
  89
  90 #endif /* SQUID_ICAPINOUT_H */