ScheduleTaskHelper.Tasks 1.0.6

ScheduleTaskHelper.Tasks

?? Overview

ScheduleTaskHelper.Tasks is a task scheduling framework designed for .NET applications. It provides support for various scheduling modes, including periodic tasks and Cron-based scheduling. The framework is highly extensible and integrates seamlessly with plugin architectures, making it ideal for applications requiring efficient task management.

??? Key Features

• Periodic and Cron Scheduling: Supports both fixed-interval and Cron-based task scheduling.
• Task Prioritization: Manage task execution order within groups.
• Retry Mechanism: Automatically retries failed tasks with configurable retry policies.
• Extensibility: Easily integrates with plugin-based architectures.
• Task Execution Tracking: Monitor task execution status and history.
• Distributed Locking: Ensures safe execution in multi-node environments.

??? Architecture

Core Components

1. Scheduled Task Interface (IScheduledTask)

Defines the contract for all scheduled tasks, including properties for task name, group, priority, and execution intervals.

public interface IScheduledTask
{
    string Name { get; }
    string Group { get; }
    TimeSpan InitialDelay { get; }
    TimeSpan Period { get; }
    int Priority { get; }

    Task<int> Execute();
    void Stop();
}

2. Cron Scheduled Task Interface (ICronScheduledTask)

Extends IScheduledTask to support Cron-based scheduling.

public interface ICronScheduledTask : IScheduledTask
{
    bool Immediate { get; }
    string CronExpression { get; }
    DateTime GetNextExecution(DateTime now);
}

3. Base Task (BaseTask)

Provides a default implementation of IScheduledTask, simplifying task development.

4. Base Cron Task (BaseCronTask)

Extends BaseTask to support Cron-based scheduling.

5. Task Retry Queue (TaskRetryQueue)

Manages failed tasks and retries them based on configurable policies.

6. Scheduled Thread Pool (ScheduledThreadPool)

Manages task execution, including scheduling, prioritization, and concurrency control.

?? Configuration

Task Configuration File (pluginconfig.json)

Defines task-specific settings, including scheduling intervals, priorities, and parameters.

{
  "TaskConfigurations": {
    "SampleTask": {
      "Enabled": true,
      "Group": "SampleTasks",
      "Priority": 1,
      "InitialDelay": "00:00:10",
      "Period": "00:05:00"
    },
    "SampleCronTask": {
      "Enabled": true,
      "Group": "SampleTasks",
      "CronExpression": "0 */5 * * * *",
      "ExecuteImmediately": true
    }
  }
}

Key Configuration Fields

• Enabled: Whether the task is enabled.
• Group: The group to which the task belongs.
• Priority: Execution priority within the group.
• InitialDelay: Delay before the first execution.
• Period: Interval between executions for periodic tasks.
• CronExpression: Cron expression for scheduling.
• ExecuteImmediately: Whether to execute the task immediately upon startup.

?? Getting Started

1. Create a Task

Implement the IScheduledTask or ICronScheduledTask interface to create a new task.

public class SampleTask : BaseTask
{
    public SampleTask(string name, string group, TimeSpan initDelay, TimeSpan period, int priority)
        : base(name, group, initDelay, period, priority)
    {
    }

    public override Task<int> Execute()
    {
        Console.WriteLine($"Executing task: {Name}");
        return Task.FromResult(0);
    }
}

2. Schedule Tasks

Use the ScheduledThreadPool to schedule tasks dynamically.

var threadPool = new ScheduledThreadPool();
var task = new SampleTask("Task1", "Group1", TimeSpan.FromSeconds(10), TimeSpan.FromMinutes(5), 1);
threadPool.Schedule(task, task.InitialDelay, task.Period, task.Priority);

3. Use Cron Tasks

Create tasks using the BaseCronTask class for Cron-based scheduling.

public class SampleCronTask : BaseCronTask
{
    public SampleCronTask(string name, string cronExpression)
        : base(name, cronExpression, 1, "CronGroup", true)
    {
    }

    public override Task<int> Execute()
    {
        Console.WriteLine($"Executing Cron task: {Name}");
        return Task.FromResult(0);
    }
}

?? API Documentation

Scheduled Thread Pool (ScheduledThreadPool)

• Schedule: Schedules a periodic task.
• ScheduleCron: Schedules a Cron-based task.
• Shutdown: Stops all scheduled tasks.

Task Retry Queue (TaskRetryQueue)

• AddForRetry: Adds a failed task to the retry queue.
• CheckRetryQueue: Processes tasks in the retry queue.

?? License

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