InterfaceIStorage
Represents a storage object used from the reporting engine to store internal state and cache rendered reports.
Definition
Namespace:Telerik.Reporting.Cache.Interfaces
Assembly:Telerik.Reporting.dll
Syntax:
public interface IStorageMethods
AcquireLock(string)
Acquires a lock on a named resource.
Declaration
IDisposable AcquireLock(string key)Parameters
key
string
The name of the lock. When a lock with particular key is acquired, a subsequent call on AcuireLock with the same key should wait until the original lock is released (disposed).
Returns
IDisposable
A disposable lock object. When disposed from the lock object owner, the lock of the used key is released.
Remarks
Acquires a lock on a named resource and returns a disposable lock object. When the lock object owner disposes it, the lock is released.
AcquireReadLock(string)
Acquires a lock on a named resource for reading, using less-restrictive locking mechanism.
Declaration
IDisposable AcquireReadLock(string key)Parameters
key
string
Returns
IDisposable
Remarks
Acquires a lock on a named resource and returns a disposable lock object. When the lock object owner disposes it, the lock is released.
AddInSet(string, string)
Adds a single string value to a set of values denoted from the given key.
Declaration
void AddInSet(string key, string value)Parameters
key
string
The key that denotes the stored set value.
value
string
The value that is added to the set.
Remarks
If a set with the given key does not exist in the storage, such set is created and the value is added as its member.
Delete(string)
Deletes a key with its value (string or byte array) from the storage.
Declaration
void Delete(string key)Parameters
key
string
The key that denotes the stored value that should be removed.
DeleteInSet(string, string)
Deletes a single string value from a set of values denoted from the given key.
Declaration
bool DeleteInSet(string key, string value)Parameters
key
string
The key that denotes the stored set value.
value
string
The value that should be deleted from the given set.
Returns
bool
True if set with the given key is found and it contained the given value before deleted. Otherwise false.
DeleteSet(string)
Deletes set of values denoted by the given key.
Declaration
void DeleteSet(string key)Parameters
key
string
The key that denotes the stored set.
Exists(string)
Retrieves a value indicating if a single value (string or byte array) exists in the storage.
Declaration
bool Exists(string key)Parameters
key
string
The key that denotes the stored value.
Returns
bool
True if the key with its value exists in the storage, otherwise false.
ExistsInSet(string, string)
Retrieves a value indicating if a set of values exists in the storage.
Declaration
bool ExistsInSet(string key, string value)Parameters
key
string
The key that denotes the stored set value.
value
string
The stored set value.
Returns
bool
True if the key with its value exists in the storage, otherwise false.
GetAllMembersInSet(string)
Retrieves all members in a set of string values.
Declaration
IEnumerable<string> GetAllMembersInSet(string key)Parameters
key
string
The key that denotes the stored set value.
Returns
IEnumerable<string>
An enumerable retrieving each value of the set denoted from the given key.
GetBytes(string)
Retrieves a byte array value stored under particular key.
Declaration
byte[] GetBytes(string key)Parameters
key
string
The key that denotes the stored byte array value.
Returns
byte[]
The byte array value stored under the given key. If no such key is found, null (Nothing).
GetCountInSet(string)
Retrieves the count of the values in a set value stored in the storage.
Declaration
long GetCountInSet(string key)Parameters
key
string
The key that denotes the stored set value.
Returns
long
The count of the values in the set. If no such set exists, zero.
GetString(string)
Retrieves a string value stored under particular key.
Declaration
string GetString(string key)Parameters
key
string
The key that denotes the stored string value.
Returns
string
The string value stored under the given key. If no such key is found, null (Nothing).
SetBytes(string, byte[])
Stores a byte array value under particular key.
Declaration
void SetBytes(string key, byte[] value)Parameters
key
string
The key that denotes the stored byte array value.
value
byte[]
The value that is stored.
SetString(string, string)
Stores a string value under particular key.
Declaration
void SetString(string key, string value)Parameters
key
string
The key that denotes the stored string value.
value
string
The value that is stored.