Interface ICache

Represents a cache of expiring objects, which are identified by a key and stored in a pile. Pile allows to store hundreds of millions of objects without overloading the managed GC. The cache may be local or distributed

Inherited Members
System.IDisposable.Dispose()
Namespace: NFX.ApplicationModel.Pile
Assembly: NFX.dll
Syntax
public interface ICache : IApplicationComponent, IDisposable

Properties

Count

Returns how many records are kept in cache

Declaration
long Count { get; }
Property Value
Type Description
System.Int64

Locality

Returns whether the cache key:value mappings are local or distributed

Declaration
LocalityKind Locality { get; }
Property Value
Type Description
LocalityKind

Persistence

Returns the model of key:value mapping persistence that this cache supports

Declaration
ObjectPersistence Persistence { get; }
Property Value
Type Description
ObjectPersistence

PileStatus

Returns the status of the pile where object are stored

Declaration
IPileStatus PileStatus { get; }
Property Value
Type Description
IPileStatus

Tables

Tables that this cache contains

Declaration
IRegistry<ICacheTable> Tables { get; }
Property Value
Type Description
IRegistry<ICacheTable>

Methods

GetOrCreateTable<TKey>(String, out Boolean, IEqualityComparer<TKey>)

Returns existing table by name, if it does not exist creates a new table. For existing table the types must be identical to the ones used at creation

Declaration
ICacheTable<TKey> GetOrCreateTable<TKey>(string tableName, out bool createdNew, IEqualityComparer<TKey> keyComparer = null)
Parameters
Type Name Description
System.String tableName
System.Boolean createdNew
System.Collections.Generic.IEqualityComparer<TKey> keyComparer
Returns
Type Description
ICacheTable<TKey>
Type Parameters
Name Description
TKey

GetOrCreateTable<TKey>(String, IEqualityComparer<TKey>)

Returns existing table by name, if it does not exist creates a new table. For existing table the types must be identical to the ones used at creation

Declaration
ICacheTable<TKey> GetOrCreateTable<TKey>(string tableName, IEqualityComparer<TKey> keyComparer = null)
Parameters
Type Name Description
System.String tableName
System.Collections.Generic.IEqualityComparer<TKey> keyComparer
Returns
Type Description
ICacheTable<TKey>
Type Parameters
Name Description
TKey

GetTable<TKey>(String)

Returns existing table by name, if it does not exist thorws. The TKey must correspond to existing table

Declaration
ICacheTable<TKey> GetTable<TKey>(string tableName)
Parameters
Type Name Description
System.String tableName
Returns
Type Description
ICacheTable<TKey>
Type Parameters
Name Description
TKey

PurgeAll()

Removes all data from all tables stored in the cache

Declaration
void PurgeAll()

Extension Methods