Buzzware.Cascade.IModelClassCache Interface Reference

Interface for a cache to store model instances for a specified model class. More...

Inheritance diagram for Buzzware.Cascade.IModelClassCache:

Public Member Functions
Task	Setup ()
	Implement this for any setup required.
Task	Store (object id, object model, long arrivedAt)
	Caches a model instance with a specific id.
Task	StoreAll (IReadOnlyList< object > results, long arrivedAt)
Task	StoreCollection (string key, IEnumerable ids, long aArrivedAt)
	Stores a collection of model ids under a specific key.
Task< OpResponse >	Fetch (RequestOp requestOp)
	Fetches data based on a request operation.
Task	Remove (object id)
	Removes a model instance from the cache for a given id.
Task	ClearAll (bool exceptHeld, DateTime? olderThan=null)
	Clears all cached items, with options to preserve certain data based on flags and timestamps.

Properties
CascadeDataLayer	Cascade [get, set]
	CascadeDataLayer reference.

Detailed Description

Interface for a cache to store model instances for a specified model class.

Member Function Documentation

ClearAll()

Task Buzzware.Cascade.IModelClassCache.ClearAll	(	bool	exceptHeld,
		DateTime?	olderThan = null )

Clears all cached items, with options to preserve certain data based on flags and timestamps.

Parameters

exceptHeld	If true, items marked as 'held' will not be cleared.
olderThan	Optional: if provided, only items older than this date will be cleared.

Returns

bool indicating success of the clear operation.

Implemented in Buzzware.Cascade.ConcurrentFileSystemClassCache< Model, IdType >, Buzzware.Cascade.FastFileClassCache< Model, IdType >, Buzzware.Cascade.FileSystemClassCache< Model, IdType >, and Buzzware.Cascade.ModelClassCache< Model, IdType >.

Fetch()

Task< OpResponse > Buzzware.Cascade.IModelClassCache.Fetch

(

RequestOp

requestOp

)

Fetches data based on a request operation.

Parameters

requestOp

The operation describing what data should be fetched.

Returns

An OpResponse containing the results of the fetch operation

Implemented in Buzzware.Cascade.ConcurrentFileSystemClassCache< Model, IdType >, Buzzware.Cascade.FastFileClassCache< Model, IdType >, Buzzware.Cascade.FileSystemClassCache< Model, IdType >, and Buzzware.Cascade.ModelClassCache< Model, IdType >.

Remove()

Task Buzzware.Cascade.IModelClassCache.Remove

(

object

id

)

Removes a model instance from the cache for a given id.

Parameters

id	The identifier of the model to be removed from the cache.

Returns

bool indicating success of the remove operation.

Implemented in Buzzware.Cascade.ConcurrentFileSystemClassCache< Model, IdType >, Buzzware.Cascade.FastFileClassCache< Model, IdType >, Buzzware.Cascade.FileSystemClassCache< Model, IdType >, and Buzzware.Cascade.ModelClassCache< Model, IdType >.

Setup()

Task Buzzware.Cascade.IModelClassCache.Setup

(

)

Implement this for any setup required.

Returns

Implemented in Buzzware.Cascade.ConcurrentFileSystemClassCache< Model, IdType >, Buzzware.Cascade.FastFileClassCache< Model, IdType >, Buzzware.Cascade.FileSystemClassCache< Model, IdType >, and Buzzware.Cascade.ModelClassCache< Model, IdType >.

Store()

Task Buzzware.Cascade.IModelClassCache.Store	(	object	id,
		object	model,
		long	arrivedAt )

Caches a model instance with a specific id.

Parameters

id	The identifier for the model to be stored in the cache.
model	The actual model instance to cache.
arrivedAt	Timestamp indicating when the model was fetched or created.

Returns

bool indicating success of the store operation.

Implemented in Buzzware.Cascade.ConcurrentFileSystemClassCache< Model, IdType >, Buzzware.Cascade.FastFileClassCache< Model, IdType >, Buzzware.Cascade.FileSystemClassCache< Model, IdType >, and Buzzware.Cascade.ModelClassCache< Model, IdType >.

StoreCollection()

Task Buzzware.Cascade.IModelClassCache.StoreCollection	(	string	key,
		IEnumerable	ids,
		long	aArrivedAt )

Stores a collection of model ids under a specific key.

Parameters

key	String key under which the collection of ids will be stored.
ids	The collection of identifiers to store.
aArrivedAt	Timestamp indicating when the collection was fetched or created.

Returns

bool indicating success of the store operation.

Implemented in Buzzware.Cascade.ConcurrentFileSystemClassCache< Model, IdType >, Buzzware.Cascade.FastFileClassCache< Model, IdType >, Buzzware.Cascade.FileSystemClassCache< Model, IdType >, and Buzzware.Cascade.ModelClassCache< Model, IdType >.

Property Documentation

Cascade

CascadeDataLayer Buzzware.Cascade.IModelClassCache.Cascade

getset

CascadeDataLayer reference.

Implemented in Buzzware.Cascade.ConcurrentFileSystemClassCache< Model, IdType >, Buzzware.Cascade.FastFileClassCache< Model, IdType >, Buzzware.Cascade.FileSystemClassCache< Model, IdType >, and Buzzware.Cascade.ModelClassCache< Model, IdType >.

---

The documentation for this interface was generated from the following file:

• Buzzware.Cascade/interfaces/IModelClassCache.cs