ChatCurrentStateCacheWrapper<TData, TKey> Class

This cache wrapper holds Dictionary of items called 'current state', which is bascically an key-value collection of items. Items in this collections can be modified by FetchChangedDataFunc. It takes two functions: FetchAllDataFunc - this function is used to load initial current state FetchChangedDataFunc - this function is used to load changes to current state in time

Inheritance Hierarchy

System.Object
  CMS.Chat.ChatCurrentStateCacheWrapper<TData, TKey>

Namespace: CMS.Chat
Assembly: CMS.Chat (in CMS.Chat.dll) Version: 8.2.23

Syntax

public class ChatCurrentStateCacheWrapper<TData, TKey>
where TData : Object, IChatCacheableWithCurrentState<TKey>

Type Parameters

TData

Type of cached items

TKey

Type of primary key of items

The ChatCurrentStateCacheWrapper<TData, TKey> type exposes the following members.

Constructors

	Name	Description
Public method	ChatCurrentStateCacheWrapper<TData, TKey>	Constructor.

Methods

	Name	Description
Public method	ForceTryGetItem	Tries to get item from CurrentState. If item wasn't found, current state is reloaded and then it tries again.
Public method	GetCurrentStateWithLastChange	Gets current state together with time of last change.
Protected method	GetDataFromCache	Gets data (CurrentStateCacheWrapperData) from classic CMS Cache. If data are not present, the new empty object is created and immediately inserted into cache. Only this method should be used to get data from Cache, because it is thread safe.
Public method	Invalidate	Invalidates data - this means, that before next getting of data (get CurrentState) data will be updated. Across web farms.
Public method	InvalidateLocally	Invalidates data - this means, that before next getting of data (get CurrentState) data will be updated. Only on this machine.
Protected method	LoadCurrentState	Perform the first load of data and fills passed structure with results. fetchAllDataFunc function is used.
Public method	UpdateAndTryGetItem	Invalidates cache and then tries to get item.
Protected method	UpdateCurrentState	Updates data in current state data structure. Update means that only data changed since currentState.LastChange are loaded using fetchChangedDataFunc.
Protected method	UpdateIfOutdated	This method checks cache beacon and if it is needed (timeout or invalidation) it reloads data.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	CurrentState	Current state of items. It is not older than 'maxDelay'