Apache Ignite.NET
Apache.Ignite.Core.Cache.Store.CacheStoreAdapter< TK, TV > Class Template Referenceabstract

Cache storage convenience adapter. It provides default implementation for bulk operations, such as LoadAll, PutAll and RemoveAll by sequentially calling corresponding Load, Put and Remove operations. Use this adapter whenever such behaviour is acceptable. However in many cases it maybe more preferable to take advantage of database batch update functionality, and therefore default adapter implementation may not be the best option. Note that LoadCache method has empty implementation because it is essentially up to the user to invoke it with specific arguments. More...

Inheritance diagram for Apache.Ignite.Core.Cache.Store.CacheStoreAdapter< TK, TV >:
Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >

Public Member Functions

virtual void LoadCache (Action< TK, TV > act, params object[] args)
 Loads all values from underlying persistent storage. Note that keys are not passed, so it is up to implementation to figure out what to load. This method is called whenever ICache<K,V>.LocalLoadCache method is invoked which is usually to preload the cache from persistent storage. More...
 
virtual IEnumerable< KeyValuePair< TK, TV > > LoadAll (IEnumerable< TK > keys)
 Loads multiple objects. Application developers should implement this method to customize the loading of cache entries. This method is called when the requested object is not in the cache. If an object can't be loaded, it is not returned in the resulting map. More...
 
virtual void WriteAll (IEnumerable< KeyValuePair< TK, TV >> entries)
 Writes all. More...
 
virtual void DeleteAll (IEnumerable< TK > keys)
 Remove data and keys from the external resource for the given collection of keys, if present. More...
 
virtual void SessionEnd (bool commit)
 Tells store to commit or rollback a transaction depending on the value of the commit parameter. More...
 
abstract TV Load (TK key)
 Loads an object. Application developers should implement this method to customize the loading of a value for a cache entry. This method is called by a cache when a requested entry is not in the cache. If the object can't be loaded null should be returned. More...
 
abstract void Write (TK key, TV val)
 Write the specified value under the specified key to the external resource. More...
 
abstract void Delete (TK key)
 Delete the cache entry from the external resource. More...
 

Detailed Description

Template Parameters
TKKey type.
TVValue type.

Member Function Documentation

abstract void Apache.Ignite.Core.Cache.Store.CacheStoreAdapter< TK, TV >.Delete ( TK  key)
pure virtual

Expiry of a cache entry is not a delete hence will not cause this method to be invoked.

This method is invoked even if no mapping for the key exists.

Parameters
keyThe key that is used for the delete operation.

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.

virtual void Apache.Ignite.Core.Cache.Store.CacheStoreAdapter< TK, TV >.DeleteAll ( IEnumerable< TK >  keys)
virtual

The order that individual deletes occur is undefined.

If this operation fails (by throwing an exception) after a partial success, the writer must remove any successfully written entries from the entries collection so that the caching implementation knows what succeeded and can mutate the cache.

Expiry of a cache entry is not a delete hence will not cause this method to be invoked.

This method may include keys even if there is no mapping for that key, in which case the data represented by that key should be removed from the underlying resource.

Parameters
keysa mutable collection of keys for entries to delete. Upon invocation, it contains the keys to delete for write-through. Upon return the collection must only contain the keys that were not successfully deleted.

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.

abstract TV Apache.Ignite.Core.Cache.Store.CacheStoreAdapter< TK, TV >.Load ( TK  key)
pure virtual
Parameters
keyThe key identifying the object being loaded.
Returns
The value for the entry that is to be stored in the cache or null if the object can't be loaded

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.

virtual IEnumerable<KeyValuePair<TK, TV> > Apache.Ignite.Core.Cache.Store.CacheStoreAdapter< TK, TV >.LoadAll ( IEnumerable< TK >  keys)
virtual
Parameters
keysKeys identifying the values to be loaded.
Returns
A map of key, values to be stored in the cache.

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.

virtual void Apache.Ignite.Core.Cache.Store.CacheStoreAdapter< TK, TV >.LoadCache ( Action< TK, TV >  act,
params object[]  args 
)
virtual

This method is optional, and cache implementation does not depend on this method to do anything.

For every loaded value method provided action should be called. The action will then make sure that the loaded value is stored in cache.

Parameters
actAction for loaded values.
argsOptional arguemnts passed to ICache<K,V>.LocalLoadCache method.

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.

virtual void Apache.Ignite.Core.Cache.Store.CacheStoreAdapter< TK, TV >.SessionEnd ( bool  commit)
virtual
Parameters
commitTrue if transaction should commit, false for rollback.

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.

abstract void Apache.Ignite.Core.Cache.Store.CacheStoreAdapter< TK, TV >.Write ( TK  key,
TV  val 
)
pure virtual

This method is intended to support both key/value creation and value update.

Parameters
keyKey to write.
valValue to write.

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.

virtual void Apache.Ignite.Core.Cache.Store.CacheStoreAdapter< TK, TV >.WriteAll ( IEnumerable< KeyValuePair< TK, TV >>  entries)
virtual
Parameters
entriesThe map.

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.