netwerk/cache/nsCacheSession.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef _nsCacheSession_h_
   8 #define _nsCacheSession_h_
   9
  10 #include "nspr.h"
  11 #include "nsError.h"
  12 #include "nsCOMPtr.h"
  13 #include "nsICacheSession.h"
  14 #include "nsIFile.h"
  15 #include "nsString.h"
  16
  17 class nsCacheSession : public nsICacheSession {
  18   virtual ~nsCacheSession();
  19
  20  public:
  21   NS_DECL_ISUPPORTS
  22   NS_DECL_NSICACHESESSION
  23
  24   nsCacheSession(const char* clientID, nsCacheStoragePolicy storagePolicy,
  25                  bool streamBased);
  26
  27   nsCString* ClientID() { return &mClientID; }
  28
  29   enum SessionInfo {
  30     eStoragePolicyMask = 0x000000FF,
  31     eStreamBasedMask = 0x00000100,
  32     eDoomEntriesIfExpiredMask = 0x00001000,
  33     ePrivateMask = 0x00010000
  34   };
  35
  36   void MarkStreamBased() { mInfo |= eStreamBasedMask; }
  37   void ClearStreamBased() { mInfo &= ~eStreamBasedMask; }
  38   bool IsStreamBased() { return (mInfo & eStreamBasedMask) != 0; }
  39
  40   void MarkDoomEntriesIfExpired() { mInfo |= eDoomEntriesIfExpiredMask; }
  41   void ClearDoomEntriesIfExpired() { mInfo &= ~eDoomEntriesIfExpiredMask; }
  42   bool WillDoomEntriesIfExpired() {
  43     return (0 != (mInfo & eDoomEntriesIfExpiredMask));
  44   }
  45
  46   void MarkPrivate() { mInfo |= ePrivateMask; }
  47   void MarkPublic() { mInfo &= ~ePrivateMask; }
  48   bool IsPrivate() { return (mInfo & ePrivateMask) != 0; }
  49   nsCacheStoragePolicy StoragePolicy() {
  50     return (nsCacheStoragePolicy)(mInfo & eStoragePolicyMask);
  51   }
  52
  53   void SetStoragePolicy(nsCacheStoragePolicy policy) {
  54     NS_ASSERTION(policy <= 0xFF, "too many bits in nsCacheStoragePolicy");
  55     mInfo &= ~eStoragePolicyMask;  // clear storage policy bits
  56     mInfo |= policy;
  57   }
  58
  59   nsIFile* ProfileDir() { return mProfileDir; }
  60
  61  private:
  62   nsCString mClientID;
  63   uint32_t mInfo;
  64   nsCOMPtr<nsIFile> mProfileDir;
  65 };
  66
  67 #endif  // _nsCacheSession_h_