2001-02-23 13:18:01 +00:00
|
|
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
|
|
*
|
|
|
|
* The contents of this file are subject to the Mozilla Public
|
|
|
|
* License Version 1.1 (the "License"); you may not use this file
|
|
|
|
* except in compliance with the License. You may obtain a copy of
|
|
|
|
* the License at http://www.mozilla.org/MPL/
|
|
|
|
*
|
|
|
|
* Software distributed under the License is distributed on an "AS
|
|
|
|
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
|
|
|
* implied. See the License for the specific language governing
|
|
|
|
* rights and limitations under the License.
|
|
|
|
*
|
|
|
|
* The Original Code is nsMemoryCacheDevice.h, released February 20, 2001.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is Netscape Communications
|
|
|
|
* Corporation. Portions created by Netscape are
|
|
|
|
* Copyright (C) 2001 Netscape Communications Corporation. All
|
|
|
|
* Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
* Gordon Sheridan, 20-February-2001
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _nsDiskCacheDevice_h_
|
|
|
|
#define _nsDiskCacheDevice_h_
|
|
|
|
|
|
|
|
#include "nsCacheDevice.h"
|
2001-02-28 04:00:08 +00:00
|
|
|
#include "nsILocalFile.h"
|
|
|
|
#include "nsCacheEntry.h"
|
2001-03-14 03:35:09 +00:00
|
|
|
#include "nsIObserver.h"
|
2001-02-23 13:18:01 +00:00
|
|
|
|
2001-03-11 00:19:09 +00:00
|
|
|
class DiskCacheEntry;
|
2001-03-12 19:31:21 +00:00
|
|
|
class nsISupportsArray;
|
2001-03-11 00:19:09 +00:00
|
|
|
|
2001-03-09 19:01:15 +00:00
|
|
|
class nsDiskCacheDevice : public nsCacheDevice {
|
2001-02-23 13:18:01 +00:00
|
|
|
public:
|
|
|
|
nsDiskCacheDevice();
|
|
|
|
virtual ~nsDiskCacheDevice();
|
|
|
|
|
|
|
|
nsresult Init();
|
|
|
|
|
|
|
|
static nsresult Create(nsCacheDevice **result);
|
|
|
|
|
2001-03-03 03:41:38 +00:00
|
|
|
virtual const char * GetDeviceID(void);
|
|
|
|
virtual nsCacheEntry * FindEntry(nsCString * key);
|
|
|
|
virtual nsresult DeactivateEntry(nsCacheEntry * entry);
|
|
|
|
virtual nsresult BindEntry(nsCacheEntry * entry);
|
2001-03-08 05:37:00 +00:00
|
|
|
virtual void DoomEntry( nsCacheEntry * entry );
|
2001-02-23 13:18:01 +00:00
|
|
|
|
2001-03-03 03:41:38 +00:00
|
|
|
virtual nsresult GetTransportForEntry(nsCacheEntry * entry,
|
2001-02-28 10:04:27 +00:00
|
|
|
nsCacheAccessMode mode,
|
2001-02-28 04:00:08 +00:00
|
|
|
nsITransport ** result);
|
2001-02-24 01:02:37 +00:00
|
|
|
|
2001-03-08 21:22:18 +00:00
|
|
|
virtual nsresult GetFileForEntry(nsCacheEntry * entry,
|
|
|
|
nsIFile ** result);
|
|
|
|
|
2001-03-03 03:41:38 +00:00
|
|
|
virtual nsresult OnDataSizeChange(nsCacheEntry * entry, PRInt32 deltaSize);
|
2001-03-08 21:00:02 +00:00
|
|
|
|
|
|
|
virtual nsresult Visit(nsICacheVisitor * visitor);
|
2001-02-28 04:00:08 +00:00
|
|
|
|
2001-03-03 03:41:38 +00:00
|
|
|
/* private: */
|
2001-03-14 03:35:09 +00:00
|
|
|
void setPrefsObserver(nsIObserver* observer);
|
|
|
|
void getPrefsObserver(nsIObserver ** result);
|
2001-03-03 03:41:38 +00:00
|
|
|
void setCacheDirectory(nsILocalFile* directory);
|
2001-03-08 21:00:02 +00:00
|
|
|
void setCacheCapacity(PRUint32 capacity);
|
2001-03-09 19:01:15 +00:00
|
|
|
PRUint32 getCacheCapacity();
|
|
|
|
PRUint32 getCacheSize();
|
2001-02-24 01:02:37 +00:00
|
|
|
|
2001-02-23 13:18:01 +00:00
|
|
|
private:
|
2001-03-11 00:19:09 +00:00
|
|
|
nsresult getFileForKey(const char* key, PRBool meta, PRUint32 generation, nsIFile ** result);
|
|
|
|
nsresult getFileForDiskCacheEntry(DiskCacheEntry * diskEntry, PRBool meta, nsIFile ** result);
|
2001-03-01 17:31:06 +00:00
|
|
|
static nsresult getTransportForFile(nsIFile* file, nsCacheAccessMode mode, nsITransport ** result);
|
|
|
|
|
2001-03-09 00:04:03 +00:00
|
|
|
nsresult visitEntries(nsICacheVisitor * visitory);
|
2001-03-11 00:19:09 +00:00
|
|
|
nsresult updateDiskCacheEntry(nsCacheEntry * entry);
|
2001-03-02 04:57:09 +00:00
|
|
|
nsresult readDiskCacheEntry(nsCString * key, nsCacheEntry ** entry);
|
2001-03-11 00:19:09 +00:00
|
|
|
|
|
|
|
nsresult checkForCollision(nsCacheEntry * entry, nsCacheEntry ** collidingEntry);
|
|
|
|
|
|
|
|
nsresult deleteDiskCacheEntry(DiskCacheEntry * diskEntry);
|
|
|
|
nsresult scavengeDiskCacheEntries(DiskCacheEntry * diskEntry);
|
2001-02-23 13:18:01 +00:00
|
|
|
|
2001-03-12 19:31:21 +00:00
|
|
|
nsresult scanDiskCacheEntries(nsISupportsArray ** result);
|
|
|
|
nsresult evictDiskCacheEntries();
|
|
|
|
|
2001-02-28 04:00:08 +00:00
|
|
|
private:
|
2001-03-14 03:35:09 +00:00
|
|
|
nsCOMPtr<nsIObserver> mPrefsObserver;
|
2001-03-08 21:00:02 +00:00
|
|
|
nsCOMPtr<nsILocalFile> mCacheDirectory;
|
|
|
|
nsCacheEntryHashTable mBoundEntries;
|
|
|
|
PRUint32 mCacheCapacity;
|
|
|
|
PRUint32 mCacheSize;
|
2001-02-23 13:18:01 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif // _nsDiskCacheDevice_h_
|