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 nsCacheDevice.h, released
17 : * February 22, 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, 22-February-2001
26 : *
27 : * Alternatively, the contents of this file may be used under the terms of
28 : * either the GNU General Public License Version 2 or later (the "GPL"), or
29 : * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
30 : * in which case the provisions of the GPL or the LGPL are applicable instead
31 : * of those above. If you wish to allow use of your version of this file only
32 : * under the terms of either the GPL or the LGPL, and not to allow others to
33 : * use your version of this file under the terms of the MPL, indicate your
34 : * decision by deleting the provisions above and replace them with the notice
35 : * and other provisions required by the GPL or the LGPL. If you do not delete
36 : * the provisions above, a recipient may use your version of this file under
37 : * the terms of any one of the MPL, the GPL or the LGPL.
38 : *
39 : * ***** END LICENSE BLOCK ***** */
40 :
41 : #ifndef _nsCacheDevice_h_
42 : #define _nsCacheDevice_h_
43 :
44 : #include "nspr.h"
45 : #include "nsError.h"
46 : #include "nsICache.h"
47 :
48 : class nsIFile;
49 : class nsCString;
50 : class nsCacheEntry;
51 : class nsICacheVisitor;
52 : class nsIInputStream;
53 : class nsIOutputStream;
54 :
55 : /******************************************************************************
56 : * nsCacheDevice
57 : *******************************************************************************/
58 : class nsCacheDevice {
59 : public:
60 280 : nsCacheDevice() { MOZ_COUNT_CTOR(nsCacheDevice); }
61 560 : virtual ~nsCacheDevice() { MOZ_COUNT_DTOR(nsCacheDevice); }
62 :
63 : virtual nsresult Init() = 0;
64 : virtual nsresult Shutdown() = 0;
65 :
66 : virtual const char * GetDeviceID(void) = 0;
67 : virtual nsCacheEntry * FindEntry( nsCString * key, bool *collision ) = 0;
68 :
69 : virtual nsresult DeactivateEntry( nsCacheEntry * entry ) = 0;
70 : virtual nsresult BindEntry( nsCacheEntry * entry ) = 0;
71 : virtual void DoomEntry( nsCacheEntry * entry ) = 0;
72 :
73 : virtual nsresult OpenInputStreamForEntry(nsCacheEntry * entry,
74 : nsCacheAccessMode mode,
75 : PRUint32 offset,
76 : nsIInputStream ** result) = 0;
77 :
78 : virtual nsresult OpenOutputStreamForEntry(nsCacheEntry * entry,
79 : nsCacheAccessMode mode,
80 : PRUint32 offset,
81 : nsIOutputStream ** result) = 0;
82 :
83 : virtual nsresult GetFileForEntry( nsCacheEntry * entry,
84 : nsIFile ** result ) = 0;
85 :
86 : virtual nsresult OnDataSizeChange( nsCacheEntry * entry, PRInt32 deltaSize ) = 0;
87 :
88 : virtual nsresult Visit(nsICacheVisitor * visitor) = 0;
89 :
90 : /**
91 : * Device must evict entries associated with clientID. If clientID == nsnull, all
92 : * entries must be evicted. Active entries must be doomed, rather than evicted.
93 : */
94 : virtual nsresult EvictEntries(const char * clientID) = 0;
95 : };
96 :
97 : #endif // _nsCacheDevice_h_
|