Class QueueTaskScheduler

Namespace

Hi.Parallels

Assembly

HiGeom.dll

A task scheduler that queues tasks and executes them in a controlled manner. Limits the number of concurrent tasks and provides mechanisms for waiting for all tasks to complete.

public class QueueTaskScheduler : TaskScheduler, IDisposable

Inheritance

object

TaskScheduler

QueueTaskScheduler

Implements

IDisposable

Inherited Members

TaskScheduler.FromCurrentSynchronizationContext()

TaskScheduler.TryDequeue(Task)

TaskScheduler.TryExecuteTask(Task)

TaskScheduler.Current

TaskScheduler.Default

TaskScheduler.Id

TaskScheduler.MaximumConcurrencyLevel

TaskScheduler.UnobservedTaskException

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

ColorUtil.GetGloomyColor(object, double, double)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

QueueTaskScheduler(int, int)

Initializes a new instance of the QueueTaskScheduler class.

public QueueTaskScheduler(int maxIdlingTaskNum, int maxWorkingTaskNum = 0)

Parameters

maxIdlingTaskNum int

The maximum number of tasks that can be queued.

maxWorkingTaskNum int

The maximum number of tasks that can be executed concurrently. If 0, defaults to the number of processors.

Properties

CancellationToken

Gets the cancellation token used to cancel the working task.

public CancellationToken CancellationToken { get; }

Property Value

CancellationToken

IdlingTaskNum

Gets the number of tasks currently waiting in the queue.

public int IdlingTaskNum { get; }

Property Value

int

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Dispose(bool)

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

GetScheduledTasks()

Gets the tasks currently scheduled for execution.

protected override IEnumerable<Task> GetScheduledTasks()

Returns

IEnumerable<Task>

An enumerable of the tasks currently scheduled.

QueueTask(Task)

Queues a task to the scheduler.

protected override void QueueTask(Task task)

Parameters

task Task

The task to be queued.

Test()

Tests the QueueTaskScheduler by running multiple tasks concurrently.

public static void Test()

TryExecuteTaskInline(Task, bool)

Tries to execute a task synchronously on the current thread.

protected override bool TryExecuteTaskInline(Task task, bool taskWasPreviouslyQueued)

Parameters

task Task

The task to be executed.

taskWasPreviouslyQueued bool

Whether the task was previously queued to the scheduler.

Returns

bool

true if the task was successfully executed; otherwise, false.

WaitAll()

Waits for all queued tasks to complete.

public void WaitAll()