-
/*
- * $Id: HttpReply.h,v 1.24 2008/02/26 21:49:34 amosjeffries Exp $
- *
- *
- * SQUID Web Proxy Cache http://www.squid-cache.org/
- * ----------------------------------------------------------
- *
- * Squid is the result of efforts by numerous individuals from
- * the Internet community; see the CONTRIBUTORS file for full
- * details. Many organizations have provided support for Squid's
- * development; see the SPONSORS file for full details. Squid is
- * Copyrighted (C) 2001 by the Regents of the University of
- * California; see the COPYRIGHT file for full details. Squid
- * incorporates software developed and/or copyrighted by other
- * sources; see the CREDITS file for full details.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
+ * Copyright (C) 1996-2015 The Squid Software Foundation and contributors
*
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
*/
#ifndef SQUID_HTTPREPLY_H
#define SQUID_HTTPREPLY_H
+#include "http/StatusLine.h"
+#include "HttpBody.h"
#include "HttpMsg.h"
-#include "HttpStatusLine.h"
+#include "HttpRequest.h"
-extern void httpReplyInitModule(void);
-/* do everything in one call: init, set, pack, clean, return MemBuf */
-extern MemBuf *httpPackedReply(HttpVersion ver, http_status status, const char *ctype, int64_t clen, time_t lmt, time_t expires);
+void httpReplyInitModule(void);
/* Sync changes here with HttpReply.cc */
class HttpReply: public HttpMsg
{
+ MEMPROXY_CLASS(HttpReply);
public:
- MEMPROXY_CLASS(HttpReply);
+ typedef RefCount<HttpReply> Pointer;
+
HttpReply();
~HttpReply();
virtual void reset();
- // use HTTPMSGLOCK() instead of calling this directly
- virtual HttpReply *_lock()
- {
- return static_cast<HttpReply*>(HttpMsg::_lock());
- };
-
- //virtual void unlock(); // only needed for debugging
-
- // returns true on success
- // returns false and sets *error to zero when needs more data
- // returns false and sets *error to a positive http_status code on error
- virtual bool sanityCheckStartLine(MemBuf *buf, http_status *error);
+ /**
+ \retval true on success
+ \retval false and sets *error to zero when needs more data
+ \retval false and sets *error to a positive Http::StatusCode on error
+ */
+ virtual bool sanityCheckStartLine(MemBuf *buf, const size_t hdr_len, Http::StatusCode *error);
- /* public, readable; never update these or their .hdr equivalents directly */
+ /** \par public, readable; never update these or their .hdr equivalents directly */
time_t date;
time_t last_modified;
short int keep_alive;
- /* public, writable, but use httpReply* interfaces when possible */
- HttpStatusLine sline;
+ /** \par public, writable, but use httpReply* interfaces when possible */
+ Http::StatusLine sline;
- HttpBody body; /* for small constant memory-resident text bodies only */
+ HttpBody body; /**< for small constant memory-resident text bodies only */
- String protoPrefix; // e.g., "HTTP/"
+ String protoPrefix; /**< e.g., "HTTP/" */
bool do_clean;
virtual bool expectingBody(const HttpRequestMethod&, int64_t&) const;
+ virtual bool inheritProperties(const HttpMsg *aMsg);
+
void updateOnNotModified(HttpReply const *other);
- /* set commonly used info with one call */
- void setHeaders(HttpVersion ver, http_status status,
+ /** set commonly used info with one call */
+ void setHeaders(Http::StatusCode status,
const char *reason, const char *ctype, int64_t clen, time_t lmt, time_t expires);
- /* mem-pack: returns a ready to use mem buffer with a packed reply */
+ /** \return a ready to use mem buffer with a packed reply */
MemBuf *pack();
- /* construct a 304 reply and return it */
+ /** construct a 304 reply and return it */
HttpReply *make304() const;
- void redirect(http_status, const char *);
+ void redirect(Http::StatusCode, const char *);
int64_t bodySize(const HttpRequestMethod&) const;
- /// Checks whether received body exceeds known maximum size.
- /// Requires a prior call to calcMaxBodySize().
+ /** Checks whether received body exceeds known maximum size.
+ * Requires a prior call to calcMaxBodySize().
+ */
bool receivedBodyTooLarge(HttpRequest&, int64_t receivedBodySize);
- /// Checks whether expected body exceeds known maximum size.
- /// Requires a prior call to calcMaxBodySize().
+ /** Checks whether expected body exceeds known maximum size.
+ * Requires a prior call to calcMaxBodySize().
+ */
bool expectedBodyTooLarge(HttpRequest& request);
int validatorsMatch (HttpReply const *other) const;
void packHeadersInto(Packer * p) const;
- /// Clone this reply.
- /// Could be done as a copy-contructor but we do not want to
- /// accidently copy a HttpReply..
+ /** Clone this reply.
+ * Could be done as a copy-contructor but we do not want to accidently copy a HttpReply..
+ */
HttpReply *clone() const;
+ /// Remove Warnings with warn-date different from Date value
+ void removeStaleWarnings();
+
+ virtual void hdrCacheInit();
+
private:
- /* initialize */
+ /** initialize */
void init();
void clean();
void packInto(Packer * p);
/* ez-routines */
- /* construct 304 reply and pack it into MemBuf, return MemBuf */
+ /** \return construct 304 reply and pack it into a MemBuf */
MemBuf *packed304Reply();
/* header manipulation */
time_t hdrExpirationTime();
- // Calculates and stores maximum body size if needed. Used by
- // receivedBodyTooLarge() and expectedBodyTooLarge().
- void calcMaxBodySize(HttpRequest& request);
+ /** Calculates and stores maximum body size if needed.
+ * Used by receivedBodyTooLarge() and expectedBodyTooLarge().
+ */
+ void calcMaxBodySize(HttpRequest& request) const;
+
+ String removeStaleWarningValues(const String &value);
- mutable int64_t bodySizeMax; // cached result of calcMaxBodySize
+ mutable int64_t bodySizeMax; /**< cached result of calcMaxBodySize */
protected:
- virtual void packFirstLineInto(Packer * p, bool) const;
+ virtual void packFirstLineInto(Packer * p, bool) const { sline.packInto(p); }
virtual bool parseFirstLine(const char *start, const char *end);
-
- virtual void hdrCacheInit();
};
-MEMPROXY_CLASS_INLINE(HttpReply) /**DOCS_NOSEMI*/
-
#endif /* SQUID_HTTPREPLY_H */
+
projects / thirdparty / squid.git / blobdiff