src/ICAP/MsgPipeData.h

   1
   2 /*
   3  * $Id: MsgPipeData.h,v 1.8 2006/10/31 23:30:58 wessels 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_MSGPIPEDATA_H
  35 #define SQUID_MSGPIPEDATA_H
  36
  37 #include "HttpMsg.h"
  38 #include "HttpRequest.h"
  39 #include "HttpReply.h"
  40 #include "MemBuf.h"
  41
  42 // MsgPipeData contains information about the HTTP message being sent
  43 // from the pipe source to the sink. Since the entire message body may be
  44 // large, only partial information about the body is kept. For HTTP
  45 // responses, request header information is also available as metadata.
  46
  47 class HttpRequest;
  48
  49 class MsgPipeData
  50 {
  51
  52 public:
  53     MsgPipeData(): header(0), body(0), cause(0) {}
  54
  55     ~MsgPipeData()
  56     {
  57         HTTPMSGUNLOCK(cause);
  58         HTTPMSGUNLOCK(header);
  59
  60         if (body) {
  61             body->clean();
  62             delete body;
  63         }
  64     }
  65
  66     void setCause(HttpRequest *r)
  67     {
  68         if (r) {
  69             HTTPMSGUNLOCK(cause);
  70             cause = HTTPMSGLOCK(r);
  71         } else {
  72             assert(!cause);
  73         }
  74     }
  75
  76     void setHeader(HttpMsg *msg)
  77     {
  78         HTTPMSGUNLOCK(header);
  79         header = HTTPMSGLOCK(msg);
  80     }
  81
  82 public:
  83     typedef HttpMsg Header;
  84     typedef MemBuf Body;
  85
  86     // message being piped
  87     Header *header;   // parsed HTTP status/request line and headers
  88     Body *body;     // a buffer for decoded HTTP body piping
  89
  90     // HTTP request header for piped responses (the cause of the response)
  91     HttpRequest *cause;
  92
  93 };
  94
  95 #endif /* SQUID_MSGPIPEDATA_H */