src/HttpHdrCc.h

   1 /*
   2  * HttpHdrCc.h
   3  *
   4  *
   5  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   6  * ----------------------------------------------------------
   7  *
   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.
  16  *
  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.
  21  *
  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.
  26  *
  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.
  30  */
  31
  32 #ifndef SQUID_HTTPHEADERCACHECONTROL_H_
  33 #define SQUID_HTTPHEADERCACHECONTROL_H_
  34
  35 #include "config.h"
  36 #include "MemPool.h"
  37 #include "SquidString.h"
  38
  39 /** Http Cache-Control header representation
  40  *
  41  * Store and parse the Cache-Control HTTP header.
  42  */
  43 class HttpHdrCc
  44 {
  45
  46 public:
  47     explicit HttpHdrCc() :
  48             mask(0), max_age(-1), s_maxage(-1),
  49             max_stale(-1), stale_if_error(0),
  50             min_fresh(-1) {}
  51
  52     /// reset to the after-default-construction state.
  53     void clear();
  54
  55     /**parse the supplied string filling in HttpHdrCc's fields.
  56      *
  57      * \note: internal structures are not cleaned-up beforehand.
  58      *        caller must explicitly clear() beforehand if he wants that
  59      */
  60     bool parse(const String &s);
  61
  62     /** set the max_age value
  63      *
  64      * \param max_age the new max age. Values <0 clear it.
  65      */
  66     void setMaxAge(int32_t max_age);
  67
  68     MEMPROXY_CLASS(HttpHdrCc);
  69
  70     /// bit-mask for the various Cc directives, keyed on http_hdr_cc_type
  71     int32_t mask;
  72     int32_t max_age;
  73     int32_t s_maxage;
  74     int32_t max_stale;
  75     int32_t stale_if_error;
  76     int32_t min_fresh;
  77     /// comma-separated string accumulating unknown Cache-control directives.
  78     String other;
  79 };
  80
  81 MEMPROXY_CLASS_INLINE(HttpHdrCc);
  82
  83 #endif /* SQUID_HTTPHEADERCACHECONTROL_H_ */