PowerThreadPool 1.3.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package PowerThreadPool --version 1.3.1
NuGet\Install-Package PowerThreadPool -Version 1.3.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="PowerThreadPool" Version="1.3.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PowerThreadPool --version 1.3.1
#r "nuget: PowerThreadPool, 1.3.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install PowerThreadPool as a Cake Addin
#addin nuget:?package=PowerThreadPool&version=1.3.1

// Install PowerThreadPool as a Cake Tool
#tool nuget:?package=PowerThreadPool&version=1.3.1

PowerThreadPool

<img src="https://www.nuget.org/Content/gallery/img/logo-header.svg?sanitize=true" height="30px">

Enables efficient ThreadPool management with callback implementation, granular control, customizable concurrency, and support for diverse task submissions.

Download

PowerThreadPool is available as Nuget Package now.

Getting started

Without callback

PowerPool powerPool = new PowerPool(new ThreadPoolOption() { MaxThreads = 3 });
powerPool.QueueWorkItem(() => 
{
    // DO SOMETHING
    return result;
});

With callback

PowerPool powerPool = new PowerPool(new ThreadPoolOption() { MaxThreads = 3 });
powerPool.QueueWorkItem(() => 
{
    // DO SOMETHING
    return result;
}, (res) => 
{
    // this callback of thread
    // running result: res.Result
});

Stop all threads

powerPool.Stop();

Blocks the calling thread until all of the threads terminates.

powerPool.Wait();

Pause threads

PowerPool powerPool = new PowerPool(new ThreadPoolOption());
string id = powerPool.QueueWorkItem(() => 
{
    while (true)
    {
        // Pause here when user call Pause()
        powerPool.PauseIfRequested();
        // DO SOMETHING
    }
});
// DO SOMETHING
powerPool.Pause(id); // Pause by ID
powerPool.Pause(); // Pause all running thread
powerPool.Resume(true); // Resume all thread

API Summary

PowerPool

name summary result
QueueWorkItem<...>(...) Queues a method for execution. The method executes when a thread pool thread becomes available. thread id
Wait() Blocks the calling thread until all of the threads terminates. -
WaitAsync() Blocks the calling thread until all of the threads terminates. Task
Stop(bool forceStop = false) Stop all threads. If forceStop is true, Thread.Interrupt() and Thread.Join() will be called. -
StopAsync(bool forceStop = false) Stop all threads. If forceStop is true, Thread.Interrupt() and Thread.Join() will be called. Task
Stop(string id, bool forceStop = false) Stop thread by id. If forceStop is true, Thread.Interrupt() and Thread.Join() will be called. If thread is in progress during the invocation
StopAsync(string id, bool forceStop = false) Stop thread by id. If forceStop is true, Thread.Interrupt() and Thread.Join() will be called. (Task) If thread is in progress during the invocation
PauseIfRequested() Call this function inside the thread logic where you want to pause when user call Pause(...) -
StopIfRequested() Call this function inside the thread logic where you want to stop when user call Stop(...) -
CheckIfRequestedStop() Call this function inside the thread logic where you want to check if requested stop (if user call Stop(...)) -
Pause() Pause all threads -
Resume(bool resumeThreadPausedById = false) Resume all threads -
Pause(string id) Pause thread by id -
Resume(string id) Resume thread by id -
Cancel() Cancel all tasks that have not started running -
Cancel(string id) Cancel the task by id if the task has not started running is succeed

API List

PowerPool

Properties
ThreadPoolOption ThreadPoolOption; // Get, Set
int WaitingThreadCount; // Get
IEnumerable<string> WaitingThreadList; // Get
int RunningThreadCount; // Get
IEnumerable<string> RunningThreadList; // Get
Events
event ThreadPoolStartEventHandler ThreadPoolStart;
event IdleEventHandler Idle;
event ThreadStartEventHandler ThreadStart;
event ThreadEndEventHandler ThreadEnd;
event ThreadPoolTimeoutEventHandler ThreadPoolTimeout;
event ThreadTimeoutEventHandler ThreadTimeout;
Methods
string QueueWorkItem(Action action, Action<ExcuteResult<object>> callBack = null);
string QueueWorkItem(Action action, ThreadOption option);
string QueueWorkItem(Action<object[]> action, object[] param, Action<ExcuteResult<object>> callBack = null);
string QueueWorkItem(Action<object[]> action, object[] param, ThreadOption option);
string QueueWorkItem<T1>(Action<T1> action, T1 param1, Action<ExcuteResult<object>> callBack = null);
string QueueWorkItem<T1>(Action<T1> action, T1 param1, ThreadOption option);
string QueueWorkItem<T1, T2>(Action<T1, T2> action, T1 param1, T2 param2, Action<ExcuteResult<object>> callBack = null);
string QueueWorkItem<T1, T2>(Action<T1, T2> action, T1 param1, T2 param2, ThreadOption option);
string QueueWorkItem<T1, T2, T3>(Action<T1, T2, T3> action, T1 param1, T2 param2, T3 param3, Action<ExcuteResult<object>> callBack = null);
string QueueWorkItem<T1, T2, T3>(Action<T1, T2, T3> action, T1 param1, T2 param2, T3 param3, ThreadOption option);
string QueueWorkItem<T1, T2, T3, T4>(Action<T1, T2, T3, T4> action, T1 param1, T2 param2, T3 param3, T4 param4, Action<ExcuteResult<object>> callBack = null);
string QueueWorkItem<T1, T2, T3, T4>(Action<T1, T2, T3, T4> action, T1 param1, T2 param2, T3 param3, T4 param4, ThreadOption option);
string QueueWorkItem<T1, T2, T3, T4, T5>(Action<T1, T2, T3, T4, T5> action, T1 param1, T2 param2, T3 param3, T4 param4, T5 param5, Action<ExcuteResult<object>> callBack = null);
string QueueWorkItem<T1, T2, T3, T4, T5>(Action<T1, T2, T3, T4, T5> action, T1 param1, T2 param2, T3 param3, T4 param4, T5 param5, ThreadOption option);
string QueueWorkItem<T1, TResult>(Func<T1, TResult> function, T1 param1, Action<ExcuteResult<TResult>> callBack = null);
string QueueWorkItem<T1, TResult>(Func<T1, TResult> function, T1 param1, ThreadOption option);
string QueueWorkItem<T1, T2, TResult>(Func<T1, T2, TResult> function, T1 param1, T2 param2, Action<ExcuteResult<TResult>> callBack = null);
string QueueWorkItem<T1, T2, TResult>(Func<T1, T2, TResult> function, T1 param1, T2 param2, ThreadOption option);
string QueueWorkItem<T1, T2, T3, TResult>(Func<T1, T2, T3, TResult> function, T1 param1, T2 param2, T3 param3, Action<ExcuteResult<TResult>> callBack = null);
string QueueWorkItem<T1, T2, T3, TResult>(Func<T1, T2, T3, TResult> function, T1 param1, T2 param2, T3 param3, ThreadOption option);
string QueueWorkItem<T1, T2, T3, T4, TResult>(Func<T1, T2, T3, T4, TResult> function, T1 param1, T2 param2, T3 param3, T4 param4, Action<ExcuteResult<TResult>> callBack = null);
string QueueWorkItem<T1, T2, T3, T4, TResult>(Func<T1, T2, T3, T4, TResult> function, T1 param1, T2 param2, T3 param3, T4 param4, ThreadOption option);
string QueueWorkItem<T1, T2, T3, T4, T5, TResult>(Func<T1, T2, T3, T4, T5, TResult> function, T1 param1, T2 param2, T3 param3, T4 param4, T5 param5, Action<ExcuteResult<TResult>> callBack = null);
string QueueWorkItem<T1, T2, T3, T4, T5, TResult>(Func<T1, T2, T3, T4, T5, TResult> function, T1 param1, T2 param2, T3 param3, T4 param4, T5 param5, ThreadOption option);
string QueueWorkItem<TResult>(Func<TResult> function, Action<ExcuteResult<TResult>> callBack = null);
string QueueWorkItem<TResult>(Func<TResult> function, ThreadOption option);
string QueueWorkItem<TResult>(Func<object[], TResult> function, object[] param, Action<ExcuteResult<TResult>> callBack = null);
string QueueWorkItem<TResult>(Func<object[], TResult> function, object[] param, ThreadOption option);
void Wait();
async Task WaitAsync();
void Stop(bool forceStop = false);
async Task StopAsync(bool forceStop = false);
bool Stop(string id, bool forceStop = false);
async Task<bool> StopAsync(string id, bool forceStop = false);
void PauseIfRequested();
void StopIfRequested();
bool CheckIfRequestedStop();
void Pause();
void Resume(bool resumeThreadPausedById = false);
void Pause(string id);
void Resume(string id);
void Cancel();
bool Cancel(string id);

ExcuteResult<TResult>

Properties
string ID // Get
TResult Result; // Get
Status Status; // Get
Exception Exception; // Get

Status

enum Status { Succeed, Failed }

ThreadPoolOption

Properties
int MaxThreads; // Get, Set
TimeoutOption Timeout; // Get, Set
TimeoutOption DefaultThreadTimeout; // Get, Set
Action<ExecuteResult<object>> DefaultCallback; // Get, Set

ThreadOption

Properties
TimeoutOption Timeout; // Get, Set
Action<ExecuteResult<TResult>> Callback; // Get, Set
int Priority; // Get, Set
Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Framework net46 is compatible.  net461 is compatible.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 is compatible.  net48 is compatible.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETFramework 4.6

    • No dependencies.
  • .NETFramework 4.6.1

    • No dependencies.
  • .NETFramework 4.7.2

    • No dependencies.
  • .NETFramework 4.8

    • No dependencies.
  • net5.0

    • No dependencies.
  • net6.0

    • No dependencies.
  • net7.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.1.0 29 5/11/2024
4.0.4 52 5/9/2024
4.0.3 83 5/5/2024
4.0.2 86 5/4/2024
4.0.1 70 4/27/2024
4.0.0 78 4/24/2024
3.2.0 80 4/22/2024
3.1.0 86 4/20/2024
3.0.0 65 4/18/2024
2.5.11 86 4/15/2024
2.5.10 79 4/12/2024
2.5.9 79 4/8/2024
2.5.8 99 3/26/2024
2.5.7 100 3/22/2024
2.5.6 97 3/12/2024
2.5.5 113 3/2/2024
2.5.4 81 2/29/2024
2.5.3 94 2/29/2024
2.5.2 105 2/26/2024
2.5.1 94 2/25/2024
2.5.0 119 2/8/2024
2.4.0 182 12/5/2023
2.3.0 83 12/5/2023
2.2.3 84 12/4/2023
2.2.2 85 12/3/2023
2.2.1 125 11/21/2023
2.2.0 89 11/12/2023
2.1.4 70 11/11/2023
2.1.3 73 11/11/2023
2.1.2 82 11/11/2023
2.1.1 86 11/6/2023
2.1.0 76 11/5/2023
2.0.1 106 10/23/2023
2.0.0 102 10/22/2023
1.5.10 116 9/24/2023
1.5.9 104 9/24/2023
1.5.8 92 9/18/2023
1.5.7 82 9/17/2023
1.5.6 104 9/8/2023
1.5.5 106 9/7/2023
1.5.4 111 9/6/2023
1.5.3 114 9/5/2023
1.5.2 96 9/4/2023
1.5.1 116 9/3/2023
1.5.0 112 9/2/2023
1.4.5 110 9/1/2023
1.4.4 100 9/1/2023
1.4.3 102 8/31/2023
1.4.2 105 8/30/2023
1.4.1 178 8/30/2023
1.4.0 134 8/30/2023
1.3.2 122 8/29/2023
1.3.1 121 8/28/2023
1.3.0 129 8/28/2023
1.2.1 122 8/28/2023
1.2.0 122 8/27/2023
1.1.0 133 8/27/2023
1.0.2 115 8/26/2023
1.0.1 117 8/26/2023
1.0.0 120 8/26/2023