BackgroundOperation Class

A background operation, that can be used to run a method in a background task. The method can be run at given intervals. Runs only one method at a time. Will delay the next run, if previous run is still ongoing.

Definition

Namespace: MFiles.VAF.Common
Assembly: MFiles.VAF (in MFiles.VAF.dll) Version: 24.1.706.1
C#
public class BackgroundOperation
Inheritance
Object    BackgroundOperation

Constructors

BackgroundOperation Creates a new background operation that runs the method in separate task.

Properties

Cancelled Is the operation cancelled. A cancelled operation cannot be used and is waiting to be disposed.
Interval The interval between runs, when the operation is recurring. Only available when the operation is recurring.
Name The name of the background operation.
NextRunScheduled The next run scheduled time in milliseconds. Only available in Waiting state.
PreviousRunFinished The previous run finished time in milliseconds. Only available after the first run has finished.
PreviousRunStarted The previous invocation time in milliseconds. Only available after the first run has started.
Recurring Is the operation recurring.
RunCount The number of finished runs since the creation of the background operation.
RunOnceRequestCount The amount of run once requests. The run once requests will be served immediately after the previous run finishes.
State The state of the background operation.
Status The status of the background operation.
VaultName The name of the vault where this background operation is running.

Methods

Cancel Cancels the operation. A cancelled operation cannot be used and is waiting to be disposed.
RunAtIntervals Begins running the operation at given intervals. If a run takes longer than the interval, the next run starts immediately after the previous run.
RunOnce Runs the operation at once or immediately after the current run is finished.
RunOnce(Int32) Runs the operation at once or immediately after the current run is finished.
StopRunningAtIntervals Stops running the operation at intervals.
WaitUntilIdle Waits for the the operation to stop running. Can only return, if the operation is not running at intervals.

Events

StatusChanged The event that is triggered, when the status of the background operation has changed.

See Also