]>
git.ipfire.org Git - thirdparty/squid.git/blob - src/HttpReply.h
5 * SQUID Web Proxy Cache http://www.squid-cache.org/
6 * ----------------------------------------------------------
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.
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.
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.
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.
32 #ifndef SQUID_HTTPREPLY_H
33 #define SQUID_HTTPREPLY_H
36 #include "HttpStatusLine.h"
38 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
);
45 /* Sync changes here with HttpReply.cc */
47 class HttpHdrContRange
;
51 class HttpReply
: public HttpMsg
55 MEMPROXY_CLASS(HttpReply
);
61 /// \par use HTTPMSGLOCK() instead of calling this directly
62 virtual HttpReply
*_lock() {
63 return static_cast<HttpReply
*>(HttpMsg::_lock());
66 //virtual void unlock(); // only needed for debugging
69 \retval true on success
70 \retval false and sets *error to zero when needs more data
71 \retval false and sets *error to a positive http_status code on error
73 virtual bool sanityCheckStartLine(MemBuf
*buf
, const size_t hdr_len
, http_status
*error
);
75 /** \par public, readable; never update these or their .hdr equivalents directly */
84 HttpHdrSc
*surrogate_control
;
86 HttpHdrContRange
*content_range
;
90 /** \par public, writable, but use httpReply* interfaces when possible */
93 HttpBody body
; /**< for small constant memory-resident text bodies only */
95 String protoPrefix
; /**< e.g., "HTTP/" */
100 virtual int httpMsgParseError();
102 virtual bool expectingBody(const HttpRequestMethod
&, int64_t&) const;
104 virtual bool inheritProperties(const HttpMsg
*aMsg
);
106 void updateOnNotModified(HttpReply
const *other
);
108 /** set commonly used info with one call */
109 void setHeaders(http_status status
,
110 const char *reason
, const char *ctype
, int64_t clen
, time_t lmt
, time_t expires
);
112 /** \return a ready to use mem buffer with a packed reply */
115 /** construct a 304 reply and return it */
116 HttpReply
*make304() const;
118 void redirect(http_status
, const char *);
120 int64_t bodySize(const HttpRequestMethod
&) const;
122 /** Checks whether received body exceeds known maximum size.
123 * Requires a prior call to calcMaxBodySize().
125 bool receivedBodyTooLarge(HttpRequest
&, int64_t receivedBodySize
);
127 /** Checks whether expected body exceeds known maximum size.
128 * Requires a prior call to calcMaxBodySize().
130 bool expectedBodyTooLarge(HttpRequest
& request
);
132 int validatorsMatch (HttpReply
const *other
) const;
134 void packHeadersInto(Packer
* p
) const;
136 /** Clone this reply.
137 * Could be done as a copy-contructor but we do not want to accidently copy a HttpReply..
139 HttpReply
*clone() const;
147 void hdrCacheClean();
149 void packInto(Packer
* p
);
152 /** \return construct 304 reply and pack it into a MemBuf */
153 MemBuf
*packed304Reply();
155 /* header manipulation */
156 time_t hdrExpirationTime();
158 /** Calculates and stores maximum body size if needed.
159 * Used by receivedBodyTooLarge() and expectedBodyTooLarge().
161 void calcMaxBodySize(HttpRequest
& request
);
163 mutable int64_t bodySizeMax
; /**< cached result of calcMaxBodySize */
166 virtual void packFirstLineInto(Packer
* p
, bool) const;
168 virtual bool parseFirstLine(const char *start
, const char *end
);
170 virtual void hdrCacheInit();
173 MEMPROXY_CLASS_INLINE(HttpReply
);
175 #endif /* SQUID_HTTPREPLY_H */