2001-02-23 13:18:01 +00:00
|
|
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
|
|
*
|
2004-04-18 22:01:16 +00:00
|
|
|
* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
|
|
*
|
|
|
|
* 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 nsDiskCacheDevice.h, released
|
|
|
|
* February 20, 2001.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Netscape Communications Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2001
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
* Gordon Sheridan <gordon@netscape.com>
|
|
|
|
* Patrick C. Beard <beard@netscape.com>
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
2001-02-23 13:18:01 +00:00
|
|
|
|
|
|
|
#ifndef _nsDiskCacheDevice_h_
|
|
|
|
#define _nsDiskCacheDevice_h_
|
|
|
|
|
|
|
|
#include "nsCacheDevice.h"
|
2001-05-18 23:24:09 +00:00
|
|
|
#include "nsDiskCacheBinding.h"
|
|
|
|
#include "nsDiskCacheBlockFile.h"
|
2001-03-20 22:42:03 +00:00
|
|
|
#include "nsDiskCacheEntry.h"
|
|
|
|
|
2001-02-28 04:00:08 +00:00
|
|
|
#include "nsILocalFile.h"
|
2001-03-14 03:35:09 +00:00
|
|
|
#include "nsIObserver.h"
|
2003-03-10 23:19:05 +00:00
|
|
|
#include "nsCOMArray.h"
|
2001-02-23 13:18:01 +00:00
|
|
|
|
2001-03-29 05:54:58 +00:00
|
|
|
class nsDiskCacheMap;
|
2001-03-11 00:19:09 +00:00
|
|
|
|
2002-08-07 01:13:29 +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();
|
|
|
|
|
2001-03-29 05:54:58 +00:00
|
|
|
virtual nsresult Init();
|
|
|
|
virtual nsresult Shutdown();
|
2001-02-23 13:18:01 +00:00
|
|
|
|
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
|
|
|
|
2003-01-18 02:15:14 +00:00
|
|
|
virtual nsresult OpenInputStreamForEntry(nsCacheEntry * entry,
|
|
|
|
nsCacheAccessMode mode,
|
|
|
|
PRUint32 offset,
|
|
|
|
nsIInputStream ** result);
|
|
|
|
|
|
|
|
virtual nsresult OpenOutputStreamForEntry(nsCacheEntry * entry,
|
|
|
|
nsCacheAccessMode mode,
|
|
|
|
PRUint32 offset,
|
|
|
|
nsIOutputStream ** 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-29 05:54:58 +00:00
|
|
|
virtual nsresult EvictEntries(const char * clientID);
|
|
|
|
|
2001-06-28 01:30:26 +00:00
|
|
|
/**
|
|
|
|
* Preference accessors
|
|
|
|
*/
|
|
|
|
void SetCacheParentDirectory(nsILocalFile * parentDir);
|
|
|
|
void SetCapacity(PRUint32 capacity);
|
|
|
|
|
|
|
|
|
2001-03-03 03:41:38 +00:00
|
|
|
/* private: */
|
2001-06-28 01:30:26 +00:00
|
|
|
|
2001-05-18 23:24:09 +00:00
|
|
|
void getCacheDirectory(nsILocalFile ** result);
|
2001-03-09 19:01:15 +00:00
|
|
|
PRUint32 getCacheCapacity();
|
|
|
|
PRUint32 getCacheSize();
|
2001-03-29 05:54:58 +00:00
|
|
|
PRUint32 getEntryCount();
|
2001-03-20 22:42:03 +00:00
|
|
|
|
2006-02-25 02:58:51 +00:00
|
|
|
nsDiskCacheMap * CacheMap() { return &mCacheMap; }
|
2002-08-07 01:13:29 +00:00
|
|
|
|
2001-05-18 23:24:09 +00:00
|
|
|
private:
|
|
|
|
/**
|
|
|
|
* Private methods
|
|
|
|
*/
|
2003-03-10 23:19:05 +00:00
|
|
|
|
2006-02-25 02:58:51 +00:00
|
|
|
PRBool Initialized() { return mInitialized; }
|
|
|
|
|
|
|
|
nsresult Shutdown_Private(PRBool flush);
|
2003-03-10 23:19:05 +00:00
|
|
|
|
2006-02-25 02:58:51 +00:00
|
|
|
nsresult OpenDiskCache();
|
|
|
|
nsresult ClearDiskCache();
|
2003-03-10 23:19:05 +00:00
|
|
|
|
2006-02-25 02:58:51 +00:00
|
|
|
nsresult EvictDiskCacheEntries(PRInt32 targetCapacity);
|
2001-03-29 05:54:58 +00:00
|
|
|
|
2001-05-18 23:24:09 +00:00
|
|
|
/**
|
|
|
|
* Member variables
|
|
|
|
*/
|
|
|
|
nsCOMPtr<nsILocalFile> mCacheDirectory;
|
|
|
|
nsDiskCacheBindery mBindery;
|
|
|
|
PRUint32 mCacheCapacity; // XXX need soft/hard limits, currentTotal
|
2006-02-25 02:58:51 +00:00
|
|
|
nsDiskCacheMap mCacheMap;
|
2002-08-29 04:30:54 +00:00
|
|
|
PRPackedBool mInitialized;
|
2001-02-23 13:18:01 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif // _nsDiskCacheDevice_h_
|