VIEApps.Components.Caching 10.9.2506.1

VIEApps.Components.Caching

A wrapper component for working with distributed cache

• Ready with .NET Core 2.0+/.NET Framework 4.6.1+
• Supported: Redis & Memcached

NuGet

Dependencies

• Redis: StackExchange.Redis
• Memcached: VIEApps.Enyim.Caching

Configuration (stand-alone/classical apps)

Add the configuration settings into your app.config/web.config file

Configure with two seperated sections

<?xml version="1.0" encoding="utf-8"?>
<configuration>
	<configSections>
		<section name="memcached" type="Enyim.Caching.Configuration.MemcachedClientConfigurationSectionHandler,Enyim.Caching" />
		<section name="redis" type="net.vieapps.Components.Caching.RedisClientConfigurationSectionHandler,VIEApps.Components.Caching" />
	</configSections>
	<memcached>
		<servers>
			<add address="192.168.1.2" port="11211" />
			<add address="192.168.1.3" port="11211" />
		</servers>
		<socketPool minPoolSize="10" maxPoolSize="512" deadTimeout="00:01:00" connectionTimeout="00:00:05" receiveTimeout="00:00:05" />
	</memcached>
	<redis>
		<servers>
			<add address="192.168.1.4" port="6379" />
			<add address="192.168.1.5" port="6379" />
		</servers>
		<options abortConnect="false" allowAdmin="false" connectTimeout="5000" syncTimeout="2000" />
	</redis>
</configuration>

Configure with only one section

<?xml version="1.0" encoding="utf-8"?>
<configuration>
	<configSections>
		<section name="cache" type="net.vieapps.Components.Caching.CacheConfigurationSectionHandler,VIEApps.Components.Caching" />
	</configSections>
	<cache provider="Redis" expirationTime="30">
		<servers>
			<add address="192.168.1.2" port="11211" type="Memcached" />
			<add address="192.168.1.3" port="11211" type="Memcached" />
			<add address="192.168.1.4" port="6379" type="Redis" />
			<add address="192.168.1.5" port="6379" type="Redis" />
		</servers>
		<socketPool minPoolSize="10" maxPoolSize="512" deadTimeout="00:01:00" connectionTimeout="00:00:05" receiveTimeout="00:00:05" />
		<options abortConnect="false" allowAdmin="false" connectTimeout="5000" syncTimeout="2000" />
	</cache>
</configuration>

Example of usage (stand-alone/classical apps)

public class CreativeService
{	
	using net.vieapps.Components.Caching;

	Cache _cache;
	Cache _memcached;
	Cache _redis;

	public CreativeService()
	{
		this._cache = new Cache("Region-Name"); // with default caching provider is 'Redis'
		this._memcached = new Cache("Region-Name", "memcached");
		this._redis = new Cache("Region-Name", "redis");
	}

	public async Task<IList<CreativeDTO>> GetCreativesAsync(string unitName)
	{
		return await this._cache.GetAsync<IList<CreativeDTO>>($"creatives_{unitName}");
	}

	public async Task<IList<CreativeDTO>> GetMemcachedCreativesAsync(string unitName)
	{
		return await this._memcached.GetAsync<IList<CreativeDTO>>($"creatives_{unitName}");
	}

	public async Task<IList<CreativeDTO>> GetRedisCreativesAsync(string unitName)
	{
		return await this._redis.GetAsync<IList<CreativeDTO>>($"creatives_{unitName}");
	}
}

Configuration (ASP.NET Core 2.0+ apps)

TBD

Example of usage (ASP.NET Core 2.0+ apps)

TBD

Listing of all methods

bool Set(string key, object value, int expirationTime = 0);
bool Set(string key, object value, TimeSpan validFor);
bool Set(string key, object value, DateTime expiresAt);
Task<bool> SetAsync(string key, object value, int expirationTime = 0);
Task<bool> SetAsync(string key, object value, TimeSpan validFor);
Task<bool> SetAsync(string key, object value, DateTime expiresAt);
void Set(IDictionary<string, object> items, string keyPrefix = null, int expirationTime = 0);
void Set<T>(IDictionary<string, T> items, string keyPrefix = null, int expirationTime = 0);
Task SetAsync(IDictionary<string, object> items, string keyPrefix = null, int expirationTime = 0);
Task SetAsync<T>(IDictionary<string, T> items, string keyPrefix = null, int expirationTime = 0);
bool SetFragments(string key, List<byte[]> fragments, int expirationTime = 0);
Task<bool> SetFragmentsAsync(string key, List<byte[]> fragments, int expirationTime = 0);
bool SetAsFragments(string key, object value, int expirationTime = 0);
Task<bool> SetAsFragmentsAsync(string key, object value, int expirationTime = 0);
bool Add(string key, object value, int expirationTime = 0);
bool Add(string key, object value, TimeSpan validFor);
bool Add(string key, object value, DateTime expiresAt);
Task<bool> AddAsync(string key, object value, int expirationTime = 0);
Task<bool> AddAsync(string key, object value, TimeSpan validFor);
Task<bool> AddAsync(string key, object value, DateTime expiresAt);
bool Replace(string key, object value, int expirationTime = 0);
bool Replace(string key, object value, TimeSpan validFor);
bool Replace(string key, object value, DateTime expiresAt);
Task<bool> ReplaceAsync(string key, object value, int expirationTime = 0);
Task<bool> ReplaceAsync(string key, object value, TimeSpan validFor);
Task<bool> ReplaceAsync(string key, object value, DateTime expiresAt);
object Get(string key);
T Get<T>(string key);
Task<object> GetAsync(string key);
Task<T> GetAsync<T>(string key);
IDictionary<string, object> Get(IEnumerable<string> keys);
Task<IDictionary<string, object>> GetAsync(IEnumerable<string> keys);
IDictionary<string, T> Get<T>(IEnumerable<string> keys);
Task<IDictionary<string, T>> GetAsync<T>(IEnumerable<string> keys);
Tuple<int, int> GetFragments(string key);
Task<Tuple<int, int>> GetFragmentsAsync(string key);
List<byte[]> GetAsFragments(string key, List<int> indexes);
Task<List<byte[]>> GetAsFragmentsAsync(string key, List<int> indexes);
List<byte[]> GetAsFragments(string key, params int[] indexes);
Task<List<byte[]>> GetAsFragmentsAsync(string key, params int[] indexes);
bool Remove(string key);
Task<bool> RemoveAsync(string key);
void Remove(IEnumerable<string> keys, string keyPrefix = null);
Task RemoveAsync(IEnumerable<string> keys, string keyPrefix = null);
void RemoveFragments(string key);
Task RemoveFragmentsAsync(string key);
bool Exists(string key);
Task<bool> ExistsAsync(string key);
void Clear();
Task ClearAsync();
HashSet<string> GetKeys();
Task<HashSet<string>> GetKeysAsync();