X.Helper.Cache 1.0.4

X.Helper.Cache

Special Explanation

if you are plainning to need ServiceStackRedisHelper, you need to review following description In .NetFramework 4.6.1 referenced ServiceStack.Redis Version is 3.9.71 (the last free version) In .Net Standard 2.0/2.1 or .Net 6.0 referenced ServiceStack.Redis Version is 8.2.2. You may need to purchase a license for this version. Please go to https://servicestack.net for more details.

Config File

App.Config

	<appSettings>
		<add key="RedisServer" value="10.0.0.254"/>	
		<add key="RedisPort" value="6379"/>		
		<add key="RedisPassword" value=""/>		

		
		<add key="RedisMaxReadPoolSize" value="100"/>
		<add key="RedisMaxWritePoolSize" value="100"/>
		<add key="RedisAutoStart" value="true"/>

		
		<add key="RedisAbortOnConnectFail" value="false"/>
		<add key="RedisConnectRetry" value="3"/>
		<add key="RedisSyncTimeout" value="5000"/>
		<add key="RedisAsyncTimeout" value="5000"/>
		<add key="RedisConnectTimeout" value="5000"/>
	</appSettings>

appsettings.json

  "Cache": {
	"RedisServer": "10.0.0.254",
	"RedisPort": "6379",
	"RedisPassword": "",

	"RedisMaxReadPoolSize": "100",
	"RedisMaxWritePoolSize": "100",
	"RedisAutoStart": "true",

	"RedisAbortOnConnectFail": "false",
	"RedisConnectRetry": "3",
	"RedisSyncTimeout": "5000",
	"RedisAsyncTimeout": "5000",
	"RedisConnectTimeout": "5000"
  }

System Environment Variables

# key names are same as App.Config keys
RedisServer=10.0.0.254
RedisPort=6379
RedisPassword=

# ServiceStack.Redis config
RedisMaxReadPoolSize=100
RedisMaxWritePoolSize=100
RedisAutoStart=true

# StackExchange.Redis config
RedisAbortOnConnectFail=false
RedisConnectRetry=3
RedisSyncTimeout=5000
RedisAsyncTimeout=5000
RedisConnectTimeout=5000

Notes:

• Environment variable names can use App.Config keys directly (recommended), e.g. RedisServer.

Windows (PowerShell):

[System.Environment]::SetEnvironmentVariable("RedisServer", "10.0.0.254", "Machine")
[System.Environment]::SetEnvironmentVariable("RedisPort", "6379", "Machine")
[System.Environment]::SetEnvironmentVariable("RedisPassword", "", "Machine")

# ServiceStack.Redis config
[System.Environment]::SetEnvironmentVariable("RedisMaxReadPoolSize", "100", "Machine")
[System.Environment]::SetEnvironmentVariable("RedisMaxWritePoolSize", "100", "Machine")
[System.Environment]::SetEnvironmentVariable("RedisAutoStart", "true", "Machine")

# StackExchange.Redis config
[System.Environment]::SetEnvironmentVariable("RedisAbortOnConnectFail", "false", "Machine")
[System.Environment]::SetEnvironmentVariable("RedisConnectRetry", "3", "Machine")
[System.Environment]::SetEnvironmentVariable("RedisSyncTimeout", "5000", "Machine")
[System.Environment]::SetEnvironmentVariable("RedisAsyncTimeout", "5000", "Machine")
[System.Environment]::SetEnvironmentVariable("RedisConnectTimeout", "5000", "Machine")

Linux (bash):

# current session
export RedisServer=10.0.0.254
export RedisPort=6379
export RedisPassword=

# ServiceStack.Redis config
export RedisMaxReadPoolSize=100
export RedisMaxWritePoolSize=100
export RedisAutoStart=true

# StackExchange.Redis config
export RedisAbortOnConnectFail=false
export RedisConnectRetry=3
export RedisSyncTimeout=5000
export RedisAsyncTimeout=5000
export RedisConnectTimeout=5000

# persist for current user (~/.bashrc)
echo 'export RedisServer=10.0.0.254' >> ~/.bashrc
echo 'export RedisPort=6379' >> ~/.bashrc
echo 'export RedisPassword=' >> ~/.bashrc

# ServiceStack.Redis config
echo 'export RedisMaxReadPoolSize=100' >> ~/.bashrc
echo 'export RedisMaxWritePoolSize=100' >> ~/.bashrc
echo 'export RedisAutoStart=true' >> ~/.bashrc

# StackExchange.Redis config
echo 'export RedisAbortOnConnectFail=false' >> ~/.bashrc
echo 'export RedisConnectRetry=3' >> ~/.bashrc
echo 'export RedisSyncTimeout=5000' >> ~/.bashrc
echo 'export RedisAsyncTimeout=5000' >> ~/.bashrc
echo 'export RedisConnectTimeout=5000' >> ~/.bashrc
source ~/.bashrc

Linux (systemd/service) - /etc/environment:

RedisServer=10.0.0.254
RedisPort=6379
RedisPassword=

# ServiceStack.Redis config
RedisMaxReadPoolSize=100
RedisMaxWritePoolSize=100
RedisAutoStart=true

# StackExchange.Redis config
RedisAbortOnConnectFail=false
RedisConnectRetry=3
RedisSyncTimeout=5000
RedisAsyncTimeout=5000
RedisConnectTimeout=5000

Linux (systemd/service) - unit file Environment=:

[Service]
Environment="RedisServer=10.0.0.254"
Environment="RedisPort=6379"
Environment="RedisPassword="

# ServiceStack.Redis config
Environment="RedisMaxReadPoolSize=100"
Environment="RedisMaxWritePoolSize=100"
Environment="RedisAutoStart=true"

# StackExchange.Redis config
Environment="RedisAbortOnConnectFail=false"
Environment="RedisConnectRetry=3"
Environment="RedisSyncTimeout=5000"
Environment="RedisAsyncTimeout=5000"
Environment="RedisConnectTimeout=5000"

General Configration

Config.DefaultTimeout = 20		//Minute
Config.DefaultDatabaseIndex = 0		//0-15

Config Accessors

//common
Config.RedisServer = "10.0.0.254";
Config.RedisPort = "6379";
Config.RedisPassword = "";

//for ServiceStack.Redis
Config.RedisMaxReadPoolSize = 100;
Config.RedisMaxWritePoolSize = 100;
Config.RedisAutoStart = true;

//for StackExchange.Redis
Config.RedisAbortOnConnectFail = false;
Config.RedisConnectRetry = 3;
Config.RedisSyncTimeout = 5000;
Config.RedisAsyncTimeout = 5000;
Config.RedisConnectTimeout = 5000;

Note:

• ServiceStackRedisHelper uses RedisMaxReadPoolSize, RedisMaxWritePoolSize, RedisAutoStart.
• StackExchangeRedisHelper uses RedisAbortOnConnectFail, RedisConnectRetry, RedisSyncTimeout, RedisAsyncTimeout, RedisConnectTimeout.

Use ServiceStack.Redis

//default database index uses the value from Config.DefaultDatabaseIndex 
ICacheHelper helper = new X.Helper.Cache.ServiceStackRedisHelper();
//use the specified database index
ICacheHelper helper = new X.Helper.Cache.ServiceStackRedisHelper(dbIndex);

//ServiceStack.Redis related config
Config.RedisMaxReadPoolSize = 100;
Config.RedisMaxWritePoolSize = 100;
Config.RedisAutoStart = true;

Use StackExchange.Redis

//default database index uses the value from Config.DefaultDatabaseIndex 
ICacheHelper helper = new X.Helper.Cache.StackExchangeRedisHelper();
//use the specified database index
ICacheHelper helper = new X.Helper.Cache.StackExchangeRedisHelper(dbIndex);

//StackExchange.Redis related config
Config.RedisAbortOnConnectFail = false;
Config.RedisConnectRetry = 3;
Config.RedisSyncTimeout = 5000;
Config.RedisAsyncTimeout = 5000;
Config.RedisConnectTimeout = 5000;

Switch database index

helper = helper.GetDatabase(dbIndex);