gecko/netwerk/cache/nsMemoryCacheDevice.h
Nicholas Nethercote cfabe434d4 Bug 829439 (part 1) - Add MemoryReporterBase class that promotes better encapsulation within nsIMemoryReporter sub-classes. r=jlebar.
--HG--
extra : rebase_source : 53a77ea456f2aedafe05954ceece7e64db743e66
2013-01-14 16:26:47 -08:00

129 lines
4.1 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* vim: set ts=8 sts=4 et sw=4 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef _nsMemoryCacheDevice_h_
#define _nsMemoryCacheDevice_h_
#include "nsCacheDevice.h"
#include "pldhash.h"
#include "nsCacheEntry.h"
class nsIMemoryReporter;
class nsMemoryCacheDeviceInfo;
/******************************************************************************
* nsMemoryCacheDevice
******************************************************************************/
class nsMemoryCacheDevice : public nsCacheDevice
{
public:
nsMemoryCacheDevice();
virtual ~nsMemoryCacheDevice();
virtual nsresult Init();
virtual nsresult Shutdown();
virtual const char * GetDeviceID(void);
virtual nsresult BindEntry( nsCacheEntry * entry );
virtual nsCacheEntry * FindEntry( nsCString * key, bool *collision );
virtual void DoomEntry( nsCacheEntry * entry );
virtual nsresult DeactivateEntry( nsCacheEntry * entry );
virtual nsresult OpenInputStreamForEntry(nsCacheEntry * entry,
nsCacheAccessMode mode,
uint32_t offset,
nsIInputStream ** result);
virtual nsresult OpenOutputStreamForEntry(nsCacheEntry * entry,
nsCacheAccessMode mode,
uint32_t offset,
nsIOutputStream ** result);
virtual nsresult GetFileForEntry( nsCacheEntry * entry,
nsIFile ** result );
virtual nsresult OnDataSizeChange( nsCacheEntry * entry, int32_t deltaSize );
virtual nsresult Visit( nsICacheVisitor * visitor );
virtual nsresult EvictEntries(const char * clientID);
nsresult EvictPrivateEntries();
void SetCapacity(int32_t capacity);
void SetMaxEntrySize(int32_t maxSizeInKilobytes);
bool EntryIsTooBig(int64_t entrySize);
size_t TotalSize();
private:
friend class nsMemoryCacheDeviceInfo;
enum { DELETE_ENTRY = true,
DO_NOT_DELETE_ENTRY = false };
void AdjustMemoryLimits( int32_t softLimit, int32_t hardLimit);
void EvictEntry( nsCacheEntry * entry , bool deleteEntry);
void EvictEntriesIfNecessary();
int EvictionList(nsCacheEntry * entry, int32_t deltaSize);
typedef bool (*EvictionMatcherFn)(nsCacheEntry* entry, void* args);
nsresult DoEvictEntries(EvictionMatcherFn matchFn, void* args);
#ifdef DEBUG
void CheckEntryCount();
#endif
/*
* Data members
*/
enum {
kQueueCount = 24 // entries > 2^23 (8Mb) start in last queue
};
nsCacheEntryHashTable mMemCacheEntries;
bool mInitialized;
PRCList mEvictionList[kQueueCount];
int32_t mHardLimit;
int32_t mSoftLimit;
int32_t mTotalSize;
int32_t mInactiveSize;
int32_t mEntryCount;
int32_t mMaxEntryCount;
int32_t mMaxEntrySize; // internal unit is bytes
// XXX what other stats do we want to keep?
nsCOMPtr<nsIMemoryReporter> mReporter;
};
/******************************************************************************
* nsMemoryCacheDeviceInfo - used to call nsIVisitor for about:cache
******************************************************************************/
class nsMemoryCacheDeviceInfo : public nsICacheDeviceInfo {
public:
NS_DECL_ISUPPORTS
NS_DECL_NSICACHEDEVICEINFO
nsMemoryCacheDeviceInfo(nsMemoryCacheDevice* device)
: mDevice(device)
{
}
virtual ~nsMemoryCacheDeviceInfo() {}
private:
nsMemoryCacheDevice* mDevice;
};
#endif // _nsMemoryCacheDevice_h_