Click or drag to resize

ApplicationTaskOperation Class

The application task operation class is used to process an individual ApplicationTask. - This class exists primarily to implement the Process() method, using the - AsyncProcessingOperationT as the base structure that provides the needed events. The class: - Is cancellable. - Exposes events [ ProcessingStarted, ProcessingCompleted, ProcessingFailed, CancellationRequested, ]. - Holds a reference to: -- The Task that will execute the application task handler. -- The ApplicationTask from the application task queue in the vault that is being processed. -- The FailureException, when processing experiences an unhandled -- exception from inside the TaskHandler. Note: The Process() method handles all errors. Unhandled exceptions inside the TaskHandler delegate are exposed via the ProcessingFailed event.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.MultiserverModeCancellableOperationApplicationTask
    MFiles.VAF.MultiserverModeAsyncProcessingOperationApplicationTask
      MFiles.VAF.MultiserverModeApplicationTaskOperation
        MFiles.VAF.MultiserverModeTaskProcessorJob

Namespace:  MFiles.VAF.MultiserverMode
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.2.0.9
Syntax
C#
public abstract class ApplicationTaskOperation : AsyncProcessingOperation<ApplicationTask>

The ApplicationTaskOperation type exposes the following members.

Constructors
  NameDescription
Protected methodApplicationTaskOperation
Self initializing constructor.
Top
Properties
  NameDescription
Public propertyData
Data value clone container.
(Inherited from CancellableOperationT.)
Public propertyFailureException
Holds the failure exception, if the processing had an un-handled failure.
(Inherited from AsyncProcessingOperationT.)
Public propertyJobState
Processing state of the async job.
(Inherited from AsyncProcessingOperationT.)
Protected propertyLinkedTokenSource
Protected linked cancellation token source. - Used to request cancellation of the process.
(Inherited from CancellableOperationT.)
Public propertyTask
The system task that processes this operation.
(Inherited from CancellableOperationT.)
Public propertyToken
Linked cancellation token.
(Inherited from CancellableOperationT.)
Top
Methods
  NameDescription
Protected methodAssignTaskForProcessing
Public methodCancel
Requests cancellation of the operation.
(Inherited from CancellableOperationT.)
Public methodCancelAfter
Requests cancellation of the operation.
(Inherited from CancellableOperationT.)
Protected methodOnCancellationRequested
Override the cancellation requested method to ensure only items with a valid state are updated.
(Inherited from AsyncProcessingOperationT.)
Public methodOnProcessingCompleted
Processing completed event invocation.
(Inherited from AsyncProcessingOperationT.)
Public methodOnProcessingFailed
Processing failed event invoker.
(Inherited from AsyncProcessingOperationT.)
Public methodOnProcessingStarted
Processing started event invocation.
(Inherited from AsyncProcessingOperationT.)
Public methodProcess
Begins the processing of the app task.
Public methodResetCancellationToken
Resets the cancellation token source.
(Inherited from CancellableOperationT.)
Public methodThrowIfCancellationRequested
If cancellation has been requested: - The CancellationRequest event is fired. - Then the cancellation exception is thrown.
(Inherited from CancellableOperationT.)
Protected methodThrowIfLessThanOne
Asserts the passed value is greater than zero.
(Inherited from AsyncProcessingOperationT.)
Protected methodThrowIfNull
Asserts the passed object is not null.
(Inherited from CancellableOperationT.)
Protected methodTriggerCancellationRequested
Triggers the cancellation requested event, for any registered listeners.
(Inherited from CancellableOperationT.)
Top
Events
See Also