RecurringTaskScheduler Class

A scheduler for recurring tasks that attempts to run all of its tasks in a fair manner. The number of threads to be used to run tasks can be specified.

Inheritance Hierarchy

SystemObject
AGI.Foundation.Infrastructure.ThreadingRecurringTaskScheduler

Namespace: AGI.Foundation.Infrastructure.Threading
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

C++

Copy

public sealed class RecurringTaskScheduler : IDisposable

Public NotInheritable Class RecurringTaskScheduler
	Implements IDisposable

public ref class RecurringTaskScheduler sealed : IDisposable

[<SealedAttribute>]
type RecurringTaskScheduler =  
    class
        interface IDisposable
    end

The RecurringTaskScheduler type exposes the following members.

Constructors

	Name	Description
	RecurringTaskScheduler	Initializes a new instance. The scheduler uses the number of threads indicated by the ThreadingPolicy.
	RecurringTaskScheduler(Int32)	Initializes a new instance to use a specified number of threads.

Top

Properties

	Name	Description
	IsRunning	Gets a value indicating whether the scheduler is running.
	NumberOfThreads	Gets the number of threads used to execute the recurring tasks.
	TaskCount	Gets the number of tasks.
	Tasks	Gets the list of tasks.

Top

Methods

	Name	Description
	AddTask	Adds a task to be executed on a recurring basis.
	Dispose	Stops running the scheduler if it is active.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetTaskData	Gets a copy of the performance metrics associated with the given recurring task.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	RemoveTask	Removes a task so that it is no longer executed on a recurring basis.
	Start	Starts running the scheduler. This method returns once NumberOfThreads threads have been started.
	Stop	Stops running the scheduler. This method does not return until all threads have stopped.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

While every effort is made to ensure that tasks are run at their desired period, the accuracy of the scheduler is directly tied to both the precision and accuracy of GetTimestamp as well as Sleep(Int32).

Reference

AGI.Foundation.Infrastructure.Threading Namespace