Interface IDataTypeManager

This interface contains create and get operations for the ICounter and remove operation for all distributed data structures.

Inherited Members
Assembly: Alachisoft.NCache.Client.dll
Syntax
public interface IDataTypeManager : ICollectionManager

Methods

CreateCounter(String, DataTypeAttributes, Int64, WriteThruOptions)

Creates the counter against the provided name and configures it according to the provided user configuration as attributes.

Declaration
ICounter CreateCounter(string name, DataTypeAttributes attributes, long initialValue = 0L, WriteThruOptions options = null)
Parameters
Type Name Description
System.String name

This is the unqiue identifier for the counter object.
DataTypeAttributes attributes

DataTypeAttributes for providing user configuration for this collection.
System.Int64 initialValue

This is the starting index of the counter object. The default value is zero.
WriteThruOptions options

WriteThruOptions regarding updating data source. This can be WriteThru, WriteBehind or none.
Returns
Type Description
ICounter

Interface for using counters.
Examples

The following example demonstrates how to create a distributed counter with absolute expiration of 1 minute.

ICache cache = CacheManager.GetCache("demoClusteredCache");
string dataTypeName = "DistributedCounter";

DataTypeAttributes attributes = new DataTypeAttributes();
attributes.Expiration = new Expiration(ExpirationType.Absolute, new TimeSpan(0, 1, 0));

ICounter counter = cache.DataTypeManager.CreateCounter(dataTypeName, attributes);

CreateCounter(String, Int64)

Creates the counter against the provided name.

Declaration
ICounter CreateCounter(string key, long initialValue = 0L)
Parameters
Type Name Description
System.String key

This is the unqiue identifier for counter object.

System.Int64 initialValue

This is the starting index of counter object. The default value is zero.
Returns
Type Description
ICounter

Interface for using counters
Examples

The following example demonstrates how to create a distributed counter.

ICache cache = CacheManager.GetCache("demoClusteredCache");
string dataTypeName = "DistributedCounter";

ICounter counter = cache.DataTypeManager.CreateCounter(dataTypeName);

GetCounter(String, ReadThruOptions)

Returns instance of the counter specified with backing source ReadThruOptions.

Declaration
ICounter GetCounter(string key, ReadThruOptions options = null)
Parameters
Type Name Description
System.String key

Name of counter.
ReadThruOptions options

ReadThruOptions to read from data source. These can be either ReadThru, ReadThruForced or none
Returns
Type Description
ICounter

Interface for using counters.
Examples

The following example demonstrates how to get a distributed counter handler from ICache.

ICache cache = CacheManager.GetCache("demoClusteredCache");
string dataTypeName = "DistributedCounter";

ICounter counter = cache.DataTypeManager.GetCounter(dataTypeName);

Remove(String, WriteThruOptions)

Remove the specified data type.

Declaration
void Remove(string key, WriteThruOptions writeThruOptions = null)
Parameters
Type Name Description
System.String key

Name of the data type.
WriteThruOptions writeThruOptions

WriteThruOptions regarding updating data source. This can be WriteThru, WriteBehind or none.
Examples

The following example demonstrates how to remove a DataType from ICache.

ICache cache = CacheManager.GetCache("demoClusteredCache");
string dataTypeName = "DataType0";

cache.DataTypeManager.Remove(dataTypeName);