src/HttpHdrScTarget.h

   1 /*
   2  * Copyright (C) 1996-2014 The Squid Software Foundation and contributors
   3  *
   4  * Squid software is distributed under GPLv2+ license and includes
   5  * contributions from numerous individuals and organizations.
   6  * Please see the COPYING and CONTRIBUTORS files for details.
   7  */
   8
   9 #ifndef SQUID_HTTPHDRSURROGATECONTROLTARGET_H
  10 #define SQUID_HTTPHDRSURROGATECONTROLTARGET_H
  11
  12 #include "defines.h"
  13 #include "dlink.h"
  14 #include "mem/forward.h"
  15 #include "SquidString.h"
  16 #include "typedefs.h"
  17
  18 class StatHist;
  19 class Packer;
  20 class StoreEntry;
  21
  22 /** Representation of HTTP Surogate-Control header field targeted directive
  23  *
  24  * \see HttpHdrSc
  25  */
  26 class HttpHdrScTarget
  27 {
  28     MEMPROXY_CLASS(HttpHdrScTarget);
  29
  30     // parsing is done in HttpHdrSc, need to grant them access.
  31     friend class HttpHdrSc;
  32 public:
  33     static const int MAX_AGE_UNSET=-1; //max-age is unset
  34     static const int MAX_STALE_UNSET=0; //max-stale is unset
  35
  36     HttpHdrScTarget(const char *target_):
  37         mask(0), max_age(MAX_AGE_UNSET), max_stale(MAX_STALE_UNSET),target(target_) {}
  38     HttpHdrScTarget(const String &target_):
  39         mask(0), max_age(MAX_AGE_UNSET), max_stale(MAX_STALE_UNSET),target(target_) {}
  40     HttpHdrScTarget(const HttpHdrScTarget &t):
  41         mask(t.mask), max_age(t.max_age), max_stale(t.max_stale),
  42         content_(t.content_), target(t.target) {}
  43
  44     bool hasNoStore() const {return isSet(SC_NO_STORE); }
  45     void noStore(bool v) { setMask(SC_NO_STORE,v); }
  46     bool noStore() const { return isSet(SC_NO_STORE); }
  47     void clearNoStore() { setMask(SC_NO_STORE, false); }
  48
  49     bool hasNoStoreRemote() const {return isSet(SC_NO_STORE_REMOTE); }
  50     void noStoreRemote(bool v) { setMask(SC_NO_STORE_REMOTE,v); }
  51     bool noStoreRemote() const { return isSet(SC_NO_STORE_REMOTE); }
  52     void clearNoStoreRemote() { setMask(SC_NO_STORE_REMOTE, false); }
  53
  54     bool hasMaxAge() const { return isSet(SC_MAX_AGE); }
  55     void maxAge(int v) {
  56         if (v >= 0) { //setting
  57             setMask(SC_MAX_AGE,true);
  58             max_age=v;
  59         } else {
  60             setMask(SC_MAX_AGE,false);
  61             max_age=MAX_AGE_UNSET;
  62         }
  63     }
  64     int maxAge() const { return max_age; }
  65     void clearMaxAge() { setMask(SC_MAX_AGE,false); max_age=MAX_AGE_UNSET; }
  66
  67     //max_stale has no associated status-bit
  68     bool hasMaxStale() const { return max_stale != MAX_STALE_UNSET; }
  69     void maxStale(int v) { max_stale=v; }
  70     int maxStale() const { return max_stale; }
  71     void clearMaxStale() { max_stale=MAX_STALE_UNSET; }
  72
  73     bool hasContent() const { return isSet(SC_CONTENT); }
  74     void Content(const String &v) {
  75         setMask(SC_CONTENT,true);
  76         content_=v;
  77     }
  78     String content() const { return content_; }
  79     void clearContent() { setMask(SC_CONTENT,false); content_.clean(); }
  80
  81     bool hasTarget() const { return target.size() != 0; }
  82     String Target() const { return target; }
  83
  84     void mergeWith(const HttpHdrScTarget * new_sc);
  85     void packInto (Packer *p) const;
  86     void updateStats(StatHist *) const;
  87
  88 private:
  89     bool isSet(http_hdr_sc_type id) const {
  90         assert (id >= SC_NO_STORE && id < SC_ENUM_END);
  91         return EBIT_TEST(mask,id);
  92     }
  93
  94     void setMask(http_hdr_sc_type id, bool newval) {
  95         if (newval) EBIT_SET(mask,id);
  96         else EBIT_CLR(mask,id);
  97     }
  98
  99     int mask;
 100     int max_age;
 101     int max_stale;
 102     String content_;
 103     String target;
 104     dlink_node node;
 105 };
 106
 107 void httpHdrScTargetStatDumper(StoreEntry * sentry, int idx, double val, double size, int count);
 108
 109 #endif /* SQUID_HTTPHDRSURROGATECONTROLTARGET_H */
 110