Class RedisConfiguration

Namespace

OpenSettings.Configurations

Assembly

OpenSettings.dll

Represents the configuration for Redis. These settings determine whether Redis is active, how to connect to Redis, and how to interact with Redis channels.

public class RedisConfiguration

Inheritance

object

RedisConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Channel

Gets or sets the Redis channel used for communication. This channel is used to send or receive messages related to settings.

public string Channel { get; set; }

Property Value

string

A string representing the Redis channel name. The default value is "Settings".

Configuration

Gets or sets the configuration string for Redis. This property is used to parse the configuration string for Redis connections, typically via Parse(string) in the Redis StackExchange library.

public string Configuration { get; set; }

Property Value

string

A string representing the configuration for Redis, which is parsed using Parse(string) to establish Redis connection settings.

Exceptions

ArgumentNullException

Thrown when value is null or whitespace while IsActive is true.

IsActive

Gets or sets a value indicating whether Redis is active. When true, Redis is enabled and used for communication.

public bool IsActive { get; set; }

Property Value

bool

A bool indicating if Redis is active. Default is false.