Tamkeen.CacheService.Core 1.0.4.1

Tamkeen CacheService

Overview

Tamkeen CacheService is a .NET library for interacting with Redis, providing easy-to-use interfaces and classes for caching, locking, and database operations. The library is compatible with both .NET Core 8 and .NET Framework 4.7.

Features

• Easy-to-use interfaces for cache operations
• Support for synchronous and asynchronous operations
• Redis connection management
• Key expiry and locking mechanisms

Getting Started

Prerequisites

• .NET Core 8.0 or .NET Framework 4.7
• Redis server (local or remote)

Installation

To include Tamkeen CacheService in your project, run the following command:

Install-Package Tamkeen.RateLimiter.Core -Version 1.0.0

Configuration

Define the Redis connection configuration using the CacheConfig class:

var config = new CacheConfig
{
    ClientName = "ExampleClient",
    DefaultDatabase = 0,
    AllowAdmin = true,
    AbortOnConnectFail = false,
    ConnectTimeout = 2000,
    SyncTimeout = 1000,
    EndPoint = "127.0.0.1:6379",  // Replace with your Redis server endpoint
    Password = "yourpassword"     // Replace with your Redis server password if needed
};

Creating a Redis Connection Factory

Create an instance of RedisConnectionFactory:

IRedisConnectionFactory factory = new RedisConnectionFactory(config);

Using the Connection

Get the ConnectionMultiplexer and perform cache operations:

var connection = factory.Connection();

if (connection.IsConnected)
{
    var db = factory.GetDatabase();
    db.StringSet("exampleKey", "exampleValue");
    string value = db.StringGet("exampleKey");
    Console.WriteLine($"Value for 'exampleKey': {value}");
}
else
{
    Console.WriteLine("Failed to connect to Redis.");
}

Cache Provider

Use the RedisCacheProvider for higher-level cache operations:

ICacheProvider cacheProvider = new RedisCacheProvider(factory);

cacheProvider.SetValue("exampleKey", "exampleValue", TimeSpan.FromMinutes(5));
string value = cacheProvider.GetValue<string>("exampleKey");
Console.WriteLine($"Cached value: {value}");

cacheProvider.DeleteValue("exampleKey");

Project Structure

Tamkeen.CacheService.Core
├── Classes
│   ├── CacheConfig.cs
│   ├── ConnectionMultiplexerWrapper.cs
│   ├── RedisCacheProvider.cs
│   ├── RedisConnectionFactory.cs
├── Interfaces
│   ├── ICacheProvider.cs
│   ├── IConnectionMultiplexerWrapper.cs
│   ├── IRedisConnectionFactory.cs

Running the Tests

To run the tests, use the following command:

dotnet test

This will execute the unit tests against both .NET Core 8 and .NET Framework 4.7.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your changes.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Documentation

• Project summary: docs/PROJECT_SUMMARY.md
• Architecture: docs/ARCHITECTURE.md
• Configuration: docs/CONFIGURATION.md
• Operations (build/run/test/coverage): docs/OPERATIONS.md
• Contributing: docs/CONTRIBUTING.md
• Code Style: docs/CODE_STYLE.md
• Security: docs/SECURITY.md

Contact

For questions or feedback, please contact support@tamkeen.com.ye.