]>
git.ipfire.org Git - thirdparty/squid.git/blob - src/HttpReply.h
3 * SQUID Web Proxy Cache http://www.squid-cache.org/
4 * ----------------------------------------------------------
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.
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.
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.
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.
30 #ifndef SQUID_HTTPREPLY_H
31 #define SQUID_HTTPREPLY_H
35 #include "HttpRequest.h"
36 #include "HttpStatusLine.h"
38 void httpReplyInitModule(void);
41 /** do everything in one call: init, set, pack, clean, return MemBuf */
42 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 typedef HttpMsgPointerT
<HttpReply
> Pointer
;
57 MEMPROXY_CLASS(HttpReply
);
63 /// \par use HTTPMSGLOCK() instead of calling this directly
64 virtual HttpReply
*_lock() {
65 return static_cast<HttpReply
*>(HttpMsg::_lock());
68 //virtual void unlock(); // only needed for debugging
71 \retval true on success
72 \retval false and sets *error to zero when needs more data
73 \retval false and sets *error to a positive http_status code on error
75 virtual bool sanityCheckStartLine(MemBuf
*buf
, const size_t hdr_len
, http_status
*error
);
77 /** \par public, readable; never update these or their .hdr equivalents directly */
86 HttpHdrSc
*surrogate_control
;
88 HttpHdrContRange
*content_range
;
92 /** \par public, writable, but use httpReply* interfaces when possible */
95 HttpBody body
; /**< for small constant memory-resident text bodies only */
97 String protoPrefix
; /**< e.g., "HTTP/" */
102 virtual int httpMsgParseError();
104 virtual bool expectingBody(const HttpRequestMethod
&, int64_t&) const;
106 virtual bool inheritProperties(const HttpMsg
*aMsg
);
108 void updateOnNotModified(HttpReply
const *other
);
110 /** set commonly used info with one call */
111 void setHeaders(http_status status
,
112 const char *reason
, const char *ctype
, int64_t clen
, time_t lmt
, time_t expires
);
114 /** \return a ready to use mem buffer with a packed reply */
117 /** construct a 304 reply and return it */
118 HttpReply
*make304() const;
120 void redirect(http_status
, const char *);
122 int64_t bodySize(const HttpRequestMethod
&) const;
124 /** Checks whether received body exceeds known maximum size.
125 * Requires a prior call to calcMaxBodySize().
127 bool receivedBodyTooLarge(HttpRequest
&, int64_t receivedBodySize
);
129 /** Checks whether expected body exceeds known maximum size.
130 * Requires a prior call to calcMaxBodySize().
132 bool expectedBodyTooLarge(HttpRequest
& request
);
134 int validatorsMatch (HttpReply
const *other
) const;
136 void packHeadersInto(Packer
* p
) const;
138 /** Clone this reply.
139 * Could be done as a copy-contructor but we do not want to accidently copy a HttpReply..
141 HttpReply
*clone() const;
143 /// Remove Warnings with warn-date different from Date value
144 void removeStaleWarnings();
152 void hdrCacheClean();
154 void packInto(Packer
* p
);
157 /** \return construct 304 reply and pack it into a MemBuf */
158 MemBuf
*packed304Reply();
160 /* header manipulation */
161 time_t hdrExpirationTime();
163 /** Calculates and stores maximum body size if needed.
164 * Used by receivedBodyTooLarge() and expectedBodyTooLarge().
166 void calcMaxBodySize(HttpRequest
& request
);
168 String
removeStaleWarningValues(const String
&value
);
170 mutable int64_t bodySizeMax
; /**< cached result of calcMaxBodySize */
173 virtual void packFirstLineInto(Packer
* p
, bool) const;
175 virtual bool parseFirstLine(const char *start
, const char *end
);
177 virtual void hdrCacheInit();
180 MEMPROXY_CLASS_INLINE(HttpReply
);
182 #endif /* SQUID_HTTPREPLY_H */