ScheduleTaskHelper.Infrastructure 1.0.7

ScheduleTaskHelper.Infrastructure

ScheduleTaskHelper.Infrastructure is a robust task scheduling and execution framework designed for .NET applications. It supports various task scheduling modes (including timed and Cron expressions) and integrates distributed lock mechanisms, task retry queues, and event-driven architecture to ensure reliable and efficient task execution. Additionally, the framework supports a plugin-based architecture, allowing dynamic loading of external plugins, making it suitable for distributed systems or applications requiring efficient task management.

Features

• Distributed Lock Mechanisms: Provides Redis-based and in-memory distributed lock implementations to ensure safe execution across multiple nodes.
• Task Scheduling: Includes interfaces and utilities for defining and executing scheduled tasks.
• Retry Queues: Supports task retry mechanisms for handling failures.
• Event-Driven Architecture: Enables event-based task execution and monitoring.
• Plugin Architecture: Allows dynamic loading and management of external plugins.

Key Components

Locks

• RedisDistributedLockProvider: Implements distributed locks using Redis.
• InMemoryDistributedLockProvider: Provides an in-memory implementation of distributed locks for simpler use cases.
• RedisLockOptions: Configuration options for Redis-based locks.

Tasks

• IScheduledTask: Interface for defining scheduled tasks with properties like name, group, priority, and execution logic.
• ICronScheduledTask: Extends IScheduledTask to support Cron-based scheduling.

Rules

• IRules: Interface for defining validation rules for tasks.

Reports

• IReport: Interface for generating reports from tasks.

Utilities

• BatchProcessingUtils: Utility class for batch processing tasks.

Cache

• CacheManager: Provides caching capabilities for task management.

Getting Started

Prerequisites

• .NET 8.0 SDK
• Redis (if using RedisDistributedLockProvider)

Installation

1. Clone the repository.
2. Navigate to the ScheduleTaskHelper.Infrastructure project directory.
3. Build the project using the .NET CLI:

   dotnet build
   

Usage

Define a Task

Implement the IScheduledTask or ICronScheduledTask interface to define your task logic:

public class MyTask : IScheduledTask
{
    public string Name => "MyTask";
    public string Group => "Default";
    public TimeSpan InitialDelay => TimeSpan.FromSeconds(10);
    public TimeSpan Period => TimeSpan.FromMinutes(1);
    public int Priority => 1;

    public Task<int> Execute()
    {
        Console.WriteLine("Executing MyTask");
        return Task.FromResult(0);
    }

    public void Stop()
    {
        Console.WriteLine("Stopping MyTask");
    }
}

Use Distributed Locks

Configure and use the RedisDistributedLockProvider or InMemoryDistributedLockProvider:

var redisLockProvider = new RedisDistributedLockProvider(redisConnection, options);
var distributedLock = await redisLockProvider.AcquireLockAsync("resourceName", "owner", TimeSpan.FromSeconds(30), TimeSpan.FromSeconds(10));

if (distributedLock != null)
{
    // Perform critical section
    await distributedLock.ReleaseAsync();
}

Contributing

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

License

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