BackgroundCalculation Class |
Used to perform a computation in the background. This is modeled after
BackgroundWorker, with a few important differences.
Inheritance HierarchySystemObject
SystemMarshalByRefObject
System.ComponentModelComponent
System.ComponentModelBackgroundWorker
AGI.Foundation.Infrastructure.ThreadingBackgroundCalculation
SystemMarshalByRefObject
System.ComponentModelComponent
System.ComponentModelBackgroundWorker
AGI.Foundation.Infrastructure.ThreadingBackgroundCalculation
Namespace: AGI.Foundation.Infrastructure.Threading
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.2.419.0 (24.2.419.0)
SyntaxThe BackgroundCalculation type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BackgroundCalculation |
Initializes a new instance. Also captures the CalculationContext from the
thread constructing the new instance in order to pass the context to the new thread when
RunWorkerAsync is called. To capture the context again
later, call CaptureCalculationContext.
|
Properties| Name | Description | |
|---|---|---|
 | AsyncWaitHandle |
Gets a WaitHandle that is used to wait for the operation to complete.
When the DoWork event handler has finished, this event will be signaled.
|
| CancellationPending |
Gets a value indicating whether the application has requested cancellation of a background operation.
|
 | CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component.) |
| Container | Gets the IContainer that contains the Component. (Inherited from Component.) |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.) |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component.) |
| IsBusy | Gets a value indicating whether the BackgroundWorker is running an asynchronous operation. (Inherited from BackgroundWorker.) |
| Site | (Inherited from Component.) |
| WorkerReportsProgress | Gets or sets a value indicating whether the BackgroundWorker can report progress updates. (Inherited from BackgroundWorker.) |
| WorkerSupportsCancellation | Gets or sets a value indicating whether the BackgroundWorker supports asynchronous cancellation. (Inherited from BackgroundWorker.) |
Methods| Name | Description | |
|---|---|---|
| CancelAsync | Requests cancellation of a pending background operation. (Inherited from BackgroundWorker.) |
| CaptureCalculationContext |
Captures the calculation context of the calling thread. This is the context that
will be passed to the new thread when RunWorkerAsync is called. This method cannot
be called after RunWorkerAsync.
|
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| Dispose | Releases all resources used by the Component. (Inherited from Component.) |
 | Dispose(Boolean) | Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetService | (Inherited from Component.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| OnDoWork |
Raises the DoWork event.
(Overrides BackgroundWorkerOnDoWork(DoWorkEventArgs).) |
| OnProgressChanged | Raises the ProgressChanged event. (Inherited from BackgroundWorker.) |
| OnRunWorkerCompleted |
Raises the RunWorkerCompleted event.
(Overrides BackgroundWorkerOnRunWorkerCompleted(RunWorkerCompletedEventArgs).) |
| ReportProgress(Int32) | Raises the ProgressChanged event. (Inherited from BackgroundWorker.) |
| ReportProgress(Int32, Object) |
Raises the ProgressChanged event.
|
| RunWorkerAsync | Starts execution of a background operation. (Inherited from BackgroundWorker.) |
| RunWorkerAsync(Object) | Starts execution of a background operation. (Inherited from BackgroundWorker.) |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.) |
Events| Name | Description | |
|---|---|---|
 | Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.) |
| DoWork | Occurs when RunWorkerAsync is called. (Inherited from BackgroundWorker.) |
| ProgressChanged | Occurs when ReportProgress(Int32) is called. (Inherited from BackgroundWorker.) |
| RunWorkerCompleted | Occurs when the background operation has completed, has been canceled, or has raised an exception. (Inherited from BackgroundWorker.) |
RemarksThis type differs from BackgroundWorker in the following ways:
- It configures the CalculationContext for the new thread by copying the context of the thread that initiates the Background Computation.
- It implements the ITrackCalculationProgress interface so that it can be passed directly to long running operations to support progress reporting and cancellation.
- The WorkerReportsProgress and WorkerSupportsCancellation properties are set to true by default.
- An AsyncWaitHandle property is available. It returns a WaitHandle that is set to signaled when the DoWork event handler completes.
See Also