]>
git.ipfire.org Git - thirdparty/squid.git/blob - src/HttpReply.h
3 * $Id: HttpReply.h,v 1.24 2008/02/26 21:49:34 amosjeffries Exp $
6 * SQUID Web Proxy Cache http://www.squid-cache.org/
7 * ----------------------------------------------------------
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.
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.
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.
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.
34 #ifndef SQUID_HTTPREPLY_H
35 #define SQUID_HTTPREPLY_H
38 #include "HttpStatusLine.h"
40 extern void httpReplyInitModule(void);
41 /* do everything in one call: init, set, pack, clean, return MemBuf */
42 extern MemBuf
*httpPackedReply(HttpVersion ver
, http_status status
, const char *ctype
, int64_t clen
, time_t lmt
, time_t expires
);
44 /* Sync changes here with HttpReply.cc */
46 class HttpHdrContRange
;
50 class HttpReply
: public HttpMsg
54 MEMPROXY_CLASS(HttpReply
);
60 // use HTTPMSGLOCK() instead of calling this directly
61 virtual HttpReply
*_lock()
63 return static_cast<HttpReply
*>(HttpMsg::_lock());
66 //virtual void unlock(); // only needed for debugging
68 // returns true on success
69 // returns false and sets *error to zero when needs more data
70 // returns false and sets *error to a positive http_status code on error
71 virtual bool sanityCheckStartLine(MemBuf
*buf
, http_status
*error
);
73 /* public, readable; never update these or their .hdr equivalents directly */
82 HttpHdrSc
*surrogate_control
;
84 HttpHdrContRange
*content_range
;
88 /* public, writable, but use httpReply* interfaces when possible */
91 HttpBody body
; /* for small constant memory-resident text bodies only */
93 String protoPrefix
; // e.g., "HTTP/"
98 virtual int httpMsgParseError();
100 virtual bool expectingBody(const HttpRequestMethod
&, int64_t&) const;
102 void updateOnNotModified(HttpReply
const *other
);
104 /* set commonly used info with one call */
105 void setHeaders(HttpVersion ver
, http_status status
,
106 const char *reason
, const char *ctype
, int64_t clen
, time_t lmt
, time_t expires
);
108 /* mem-pack: returns a ready to use mem buffer with a packed reply */
111 /* construct a 304 reply and return it */
112 HttpReply
*make304() const;
114 void redirect(http_status
, const char *);
116 int64_t bodySize(const HttpRequestMethod
&) const;
118 /// Checks whether received body exceeds known maximum size.
119 /// Requires a prior call to calcMaxBodySize().
120 bool receivedBodyTooLarge(HttpRequest
&, int64_t receivedBodySize
);
122 /// Checks whether expected body exceeds known maximum size.
123 /// Requires a prior call to calcMaxBodySize().
124 bool expectedBodyTooLarge(HttpRequest
& request
);
126 int validatorsMatch (HttpReply
const *other
) const;
128 void packHeadersInto(Packer
* p
) const;
130 /// Clone this reply.
131 /// Could be done as a copy-contructor but we do not want to
132 /// accidently copy a HttpReply..
133 HttpReply
*clone() const;
141 void hdrCacheClean();
143 void packInto(Packer
* p
);
146 /* construct 304 reply and pack it into MemBuf, return MemBuf */
147 MemBuf
*packed304Reply();
149 /* header manipulation */
150 time_t hdrExpirationTime();
152 // Calculates and stores maximum body size if needed. Used by
153 // receivedBodyTooLarge() and expectedBodyTooLarge().
154 void calcMaxBodySize(HttpRequest
& request
);
156 mutable int64_t bodySizeMax
; // cached result of calcMaxBodySize
159 virtual void packFirstLineInto(Packer
* p
, bool) const;
161 virtual bool parseFirstLine(const char *start
, const char *end
);
163 virtual void hdrCacheInit();
166 MEMPROXY_CLASS_INLINE(HttpReply
) /**DOCS_NOSEMI*/
168 #endif /* SQUID_HTTPREPLY_H */