Click or drag to resize

BackgroundOperationManager Class

A manager to keep track of running background operations and their cancellation.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.CommonBackgroundOperationManager

Namespace:  MFiles.VAF.Common
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.1.0.1 (2.1.0.1)
Syntax
C#
public class BackgroundOperationManager : IDisposable

The BackgroundOperationManager type exposes the following members.

Constructors
  NameDescription
Public methodBackgroundOperationManager
Initializes new BackgroundOperationManager object.
Top
Properties
  NameDescription
Public propertyVaultName
The name of the vault in which the manager is running.
Top
Methods
  NameDescription
Public methodCancelAll
Cancels all background operations.
Public methodCancelAllAndWaitForFinish
Sends the request for cancelling the background operations and waits for them to finish.
Public methodCreateBackgroundOperation(String, Action)
Creates a new background operation. The background operations runs the given method at given intervals. Must be separately started.
Public methodCreateBackgroundOperation(String, ActionBackgroundOperation)
Creates a new background operation. The background operations runs the given method at given intervals. Must be separately started.
Public methodDispose
Force disposing.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetBackgroundOperations
Returns all created background operations, that have not been cancelled and finished.
Public methodGetCancellationTokenForUninitialization
Returns a cancellation token, that gets cancelled, when the vault goes offline.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRunOnce(String, Action)
Runs the given action in a background task.
Public methodRunOnce(String, ActionBackgroundOperation)
Runs the given action in a background task.
Public methodStartRecurringBackgroundOperation(String, TimeSpan, Action)
Creates a new background operation and starts it. The background operation runs the given method at given intervals.
Public methodStartRecurringBackgroundOperation(String, TimeSpan, ActionBackgroundOperation)
Creates a new background operation and starts it. The background operation runs the given method at given intervals.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventOperationStarting
Triggered when a background operation starts.
Public eventOperationStopping
Triggered when a background operation stops.
Top
See Also