TreeifyTask - A DotNet library to efficiently manage a mix of synchronous and asynchronous tasks in a hierarchical fashion
A DotNet component that helps C# application developers to manage synchronous and asynchronous tasks in a custom hierarchical fashion. For example, a parent task depends on multiple child tasks to be completed in a sequence or parallel mode. Also, along with the execution, the parent task should be able to access the progress information of all its child tasks.
With this library, ITaskNode
lets you to Create a task, set up a custom asynchronous function Func<IProgressReporter, CancellationToken, Task>
for it. It allows to create one or more child tasks and get overall progress.
Please see below code snippet for the better understanding.
Create structured Tasks
ITaskNode rootTask = new TaskNode("root");
ITaskNode childTask_1 = new TaskNode("Task-1");
ITaskNode childTask_2 = new TaskNode("Task-2");
rootTask.AddChild(childTask_1);
rootTask.AddChild(childTask_2);
Set actions
childTask_1.SetAction(async (reporter, cancellationToken) => {
// Simple delay function.
reporter.ReportProgress(TaskStatus.InProgress, 10, "Started...");
await Task.Delay(1000);
reporter.ReportProgress(TaskStatus.InProgress, 100, "Finished...");
});
childTask_2.SetAction(async (reporter, cancellationToken) => {
// Simple delay function.
reporter.ReportProgress(TaskStatus.InProgress, 5, "Started...");
await Task.Delay(2500);
reporter.ReportProgress(TaskStatus.InProgress, 100, "Finished...");
});
Subscribe to reporting event to get overall progress
// Before starting the execution, you need to subscribe for progress report.
rootTask.Reporting += (object sender, ProgressReportingEventArgs eventArgs) => {
eventArgs.ProgressValue; // -> this will represent the overall progress
};
Start execution
// Create and pass the cancellation token
var tokenSource = new CancellationTokenSource();
var token = tokenSource.Token;
// Start the execution concurrently
rootTask.ExecuteConcurrently(cancellationToken: token, throwOnError: true);
// OR
// Start the execution in series
rootTask.ExecuteInSeries(cancellationToken: token, throwOnError: true);
Please note: If
rootTask
has action set to it then the action will run after executing all child tasks in case of series execution. However in concurrent execution,rootTask
's action will also be executed along with child tasks and gets the overall progress.
This is the initial version of the component. Please raise issues if you find any. Comments, suggestions and contributions are always welcome.
Here's the list of items in backlog for the upcoming releases:
- Core Component
- Wpf Sample
- Blazor Server Sample
- Syntax Enhancement on subtasks creation and settings
- Json/Xml config loader
- Extend to Java, Python
Sample tree below:
var rootTask =
new TaskNode("Root", null,
new TaskNode("Task1", Task1_Action,
new TaskNode("Task1.1", Task1_1_Action),
new TaskNode("Task1.2", Task1_2_Action)),
new TaskNode("Task2", null,
new TaskNode("Task2.1", null,
new TaskNode("Task2.1.1", Task2_1_1_Action),
new TaskNode("Task2.1.2", Task_2_1_2_Action)),
new TaskNode("Task2.2", Task2_2_Action)),
new TaskNode("Task3", Task3_Action),
new TaskNode("Task4", Task4_Action),
new TaskNode("Task5", Task5_Action),
new TaskNode("Task6", Task6_Action));
private async Task Task1_Action(IProgressReporter reporter, CancellationToken token)
{
reporter.ReportProgress(TaskStatus.InProgress, 10, "Started...");
await Task.Delay(1000);
reporter.ReportProgress(TaskStatus.InProgress, 40, "InProgress...");
await Task.Delay(1000);
reporter.ReportProgress(TaskStatus.Completed, 100, "Done...");
}
- Find a Child and Set Preferences to it.
var task2_1_2 = rootTask.Find("Task2/Task2.1/Task2.1.2");
// Preferences
task2_1_2.ExecutionMode = ExecutionMode.Series;
task2_1_2.ThrowOnError = false;
rootTask.ExecuteConcurrently(cancellationToken: token, throwOnError: true);