1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 : *
3 : * ***** BEGIN LICENSE BLOCK *****
4 : * Version: MPL 1.1/GPL 2.0/LGPL 2.1
5 : *
6 : * The contents of this file are subject to the Mozilla Public License Version
7 : * 1.1 (the "License"); you may not use this file except in compliance with
8 : * the License. You may obtain a copy of the License at
9 : * http://www.mozilla.org/MPL/
10 : *
11 : * Software distributed under the License is distributed on an "AS IS" basis,
12 : * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 : * for the specific language governing rights and limitations under the
14 : * License.
15 : *
16 : * The Original Code is nsCacheSession.h, released
17 : * February 23, 2001.
18 : *
19 : * The Initial Developer of the Original Code is
20 : * Netscape Communications Corporation.
21 : * Portions created by the Initial Developer are Copyright (C) 2001
22 : * the Initial Developer. All Rights Reserved.
23 : *
24 : * Contributor(s):
25 : * Gordon Sheridan <gordon@netscape.com>
26 : * Patrick Beard <beard@netscape.com>
27 : * Darin Fisher <darin@netscape.com>
28 : *
29 : * Alternatively, the contents of this file may be used under the terms of
30 : * either the GNU General Public License Version 2 or later (the "GPL"), or
31 : * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
32 : * in which case the provisions of the GPL or the LGPL are applicable instead
33 : * of those above. If you wish to allow use of your version of this file only
34 : * under the terms of either the GPL or the LGPL, and not to allow others to
35 : * use your version of this file under the terms of the MPL, indicate your
36 : * decision by deleting the provisions above and replace them with the notice
37 : * and other provisions required by the GPL or the LGPL. If you do not delete
38 : * the provisions above, a recipient may use your version of this file under
39 : * the terms of any one of the MPL, the GPL or the LGPL.
40 : *
41 : * ***** END LICENSE BLOCK ***** */
42 :
43 : #ifndef _nsCacheSession_h_
44 : #define _nsCacheSession_h_
45 :
46 : #include "nspr.h"
47 : #include "nsError.h"
48 : #include "nsICacheSession.h"
49 : #include "nsString.h"
50 :
51 : class nsCacheSession : public nsICacheSession
52 : {
53 : public:
54 : NS_DECL_ISUPPORTS
55 : NS_DECL_NSICACHESESSION
56 :
57 : nsCacheSession(const char * clientID, nsCacheStoragePolicy storagePolicy, bool streamBased);
58 : virtual ~nsCacheSession();
59 :
60 2739 : nsCString * ClientID() { return &mClientID; }
61 :
62 : enum SessionInfo {
63 : eStoragePolicyMask = 0x000000FF,
64 : eStreamBasedMask = 0x00000100,
65 : eDoomEntriesIfExpiredMask = 0x00001000
66 : };
67 :
68 2739 : void MarkStreamBased() { mInfo |= eStreamBasedMask; }
69 : void ClearStreamBased() { mInfo &= ~eStreamBasedMask; }
70 2739 : bool IsStreamBased() { return (mInfo & eStreamBasedMask) != 0; }
71 :
72 2739 : void MarkDoomEntriesIfExpired() { mInfo |= eDoomEntriesIfExpiredMask; }
73 2631 : void ClearDoomEntriesIfExpired() { mInfo &= ~eDoomEntriesIfExpiredMask; }
74 2739 : bool WillDoomEntriesIfExpired() { return (0 != (mInfo & eDoomEntriesIfExpiredMask)); }
75 :
76 2739 : nsCacheStoragePolicy StoragePolicy()
77 : {
78 2739 : return (nsCacheStoragePolicy)(mInfo & eStoragePolicyMask);
79 : }
80 :
81 2739 : void SetStoragePolicy(nsCacheStoragePolicy policy)
82 : {
83 2739 : NS_ASSERTION(policy <= 0xFF, "too many bits in nsCacheStoragePolicy");
84 2739 : mInfo &= ~eStoragePolicyMask; // clear storage policy bits
85 2739 : mInfo |= policy;
86 2739 : }
87 :
88 : private:
89 : nsCString mClientID;
90 : PRUint32 mInfo;
91 : };
92 :
93 : #endif // _nsCacheSession_h_
|