Cenome memory based cache to store key/value pairs (elements) limited time and/or limited size. More...

Inheritance diagram for OpenSim.Framework.CnmMemoryCache< TKey, TValue >:

Collaboration diagram for OpenSim.Framework.CnmMemoryCache< TKey, TValue >:

Classes
interface	IGeneration
	Cache element generation interface More...

Public Member Functions
	CnmMemoryCache ()
	Initializes a new instance of the CnmMemoryCache{TKey,TValue} class. More...

	CnmMemoryCache (long maximalSize)
	Initializes a new instance of the CnmMemoryCache{TKey,TValue} class. More...

	CnmMemoryCache (long maximalSize, int maximalCount)
	Initializes a new instance of the CnmMemoryCache{TKey,TValue} class. More...

	CnmMemoryCache (long maximalSize, int maximalCount, TimeSpan expirationTime)
	Initializes a new instance of the CnmMemoryCache{TKey,TValue} class. More...

	CnmMemoryCache (long maximalSize, int maximalCount, TimeSpan expirationTime, IEqualityComparer< TKey > comparer)
	Initializes a new instance of the CnmMemoryCache{TKey,TValue} class. More...

void	Clear ()
	Removes all elements from the ICnmCache{TKey,TValue}. More...

IEnumerator< KeyValuePair < TKey, TValue > >	GetEnumerator ()
	Returns an enumerator that iterates through the elements stored to CnmMemoryCache{TKey,TValue}. More...

void	PurgeExpired ()
	Purge expired elements from the ICnmCache{TKey,TValue}. More...

void	Remove (TKey key)
	Removes element associated with key from the ICnmCache{TKey,TValue}. More...

void	RemoveRange (IEnumerable< TKey > keys)
	Removes elements that are associated with one of keys from the ICnmCache{TKey,TValue}. More...

bool	Set (TKey key, TValue value, long size)
	Add or replace an element with the provided key , value and size to ICnmCache{TKey,TValue}. More...

bool	TryGetValue (TKey key, out TValue value)
	Gets the value associated with the specified key . More...

Public Attributes
const int	DefaultMaxCount = 4096
	Default maximal count. More...

const long	DefaultMaxSize = 134217728
	Default maximal size. More...

readonly IEqualityComparer< TKey >	Comparer
	Comparer used to compare element keys. More...

Static Public Attributes
static readonly TimeSpan	DefaultExpirationTime = TimeSpan.FromMinutes(30.0)
	Default expiration time. More...

static readonly TimeSpan	MinExpirationTime = TimeSpan.FromSeconds(10.0)
	Minimal allowed expiration time. More...

Protected Member Functions
virtual void	AddToNewGeneration (int bucketIndex, TKey key, TValue value, long size)
	Add element to new generation. More...

virtual int	GetBucketIndex (TKey key)

virtual void	PurgeGeneration (IGeneration generation)
	Purge generation from the cache. More...

Properties
int	Count `[get]`
	Gets current count of elements stored to ICnmCache{TKey,TValue}. More...

TimeSpan	ExpirationTime `[get, set]`
	Gets or sets elements expiration time. More...

bool	IsCountLimited `[get]`
	Gets a value indicating whether ICnmCache{TKey,TValue} is limiting count of elements. More...

bool	IsSizeLimited `[get]`
	Gets a value indicating whether ICnmCache{TKey,TValue} is limiting size of elements. More...

bool	IsSynchronized `[get]`
	Gets a value indicating whether or not access to the ICnmCache{TKey,TValue} is synchronized (thread safe). More...

bool	IsTimeLimited `[get]`
	Gets a value indicating whether elements stored to ICnmCache{TKey,TValue} have limited inactivity time. More...

int	MaxCount `[get, set]`
	Gets or sets maximal allowed count of elements that can be stored to ICnmCache{TKey,TValue}. More...

long	MaxElementSize `[get, set]`

long	MaxSize `[get, set]`
	Gets or sets maximal allowed total size for elements stored to ICnmCache{TKey,TValue}. More...

long	Size `[get]`
	Gets total size of elements stored to ICnmCache{TKey,TValue}. More...

object	SyncRoot `[get]`
	Gets an object that can be used to synchronize access to the ICnmCache{TKey,TValue}. More...

Properties inherited from OpenSim.Framework.ICnmCache< TKey, TValue >
int	Count `[get]`
	Gets current count of elements stored to ICnmCache{TKey,TValue}. More...

TimeSpan	ExpirationTime `[get, set]`
	Gets or sets elements expiration time. More...

bool	IsSynchronized `[get]`
	Gets a value indicating whether or not access to the ICnmCache{TKey,TValue} is synchronized (thread safe). More...

bool	IsCountLimited `[get]`
	Gets a value indicating whether ICnmCache{TKey,TValue} is limiting count of elements. More...

bool	IsSizeLimited `[get]`
	Gets a value indicating whether ICnmCache{TKey,TValue} is limiting size of elements. More...

bool	IsTimeLimited `[get]`
	Gets a value indicating whether elements stored to ICnmCache{TKey,TValue} have limited inactivity time. More...

int	MaxCount `[get, set]`
	Gets or sets maximal allowed count of elements that can be stored to ICnmCache{TKey,TValue}. More...

long	MaxElementSize `[get]`

long	MaxSize `[get, set]`
	Gets or sets maximal allowed total size for elements stored to ICnmCache{TKey,TValue}. More...

long	Size `[get]`
	Gets total size of elements stored to ICnmCache{TKey,TValue}. More...

object	SyncRoot `[get]`
	Gets an object that can be used to synchronize access to the ICnmCache{TKey,TValue}. More...

Detailed Description

Cenome memory based cache to store key/value pairs (elements) limited time and/or limited size.

Template Parameters

TKey	The type of keys in the cache.
TValue	The type of values in the dictionary.

Cenome memory cache stores elements to hash table generations. When new element is being added to cache, and new size would exceed maximal allowed size or maximal amount of allowed element count, then elements in oldest generation are deleted. Last access time is also tracked in generation level - thus it is possible that some elements are staying in cache far beyond their expiration time. If elements in older generations are accessed through TryGetValue method, they are moved to newest generation.

Definition at line 52 of file CnmMemoryCache.cs.