AsyncProcessingOperationT Class

The async processing operation class is a generic class, that provides the basic events and properties that an async processing operation should have. This class provides only the properties and events, all implementing classes are required to handle the actual execution and processing, while triggering the events provided by this class as needed. - Is cancellable. - Holds a standardized processing state. ProcessingStarted, ProcessingCompleted, ProcessingFailed, CancellationRequested, - Fires events on the change of each processing state.

Definition

Namespace: MFiles.VAF.MultiserverMode
Assembly: MFiles.VAF (in MFiles.VAF.dll) Version: 24.1.706.1
C#
public abstract class AsyncProcessingOperation<T> : CancellableOperation<T>
where T : class, IDeepCloneable
Inheritance
Object    CancellableOperationT    AsyncProcessingOperationT
Derived

Type Parameters

T
Object being processed.

Constructors

AsyncProcessingOperationT Self initializing constructor.

Properties

Data Data value clone container.
(Inherited from CancellableOperationT)
FailureException Holds the failure exception, if the processing had an un-handled failure.
JobState Processing state of the async job.
LinkedTokenSource Protected linked cancellation token source. - Used to request cancellation of the process.
(Inherited from CancellableOperationT)
Task The system task that processes this operation.
(Inherited from CancellableOperationT)
Token Linked cancellation token.
(Inherited from CancellableOperationT)

Methods

Cancel Requests cancellation of the operation.
(Inherited from CancellableOperationT)
CancelAfter Requests cancellation of the operation.
(Inherited from CancellableOperationT)
OnCancellationRequested Override the cancellation requested method to ensure only items with a valid state are updated.
(Overrides CancellableOperationTOnCancellationRequested(CancellableOperationArgsT))
OnProcessingCompleted Processing completed event invocation.
OnProcessingFailed Processing failed event invoker.
OnProcessingStarted Processing started event invocation.
ResetCancellationToken Resets the cancellation token source.
(Inherited from CancellableOperationT)
ThrowIfCancellationRequested If cancellation has been requested: - The CancellationRequest event is fired. - Then the cancellation exception is thrown.
(Inherited from CancellableOperationT)
ThrowIfLessThanOne Asserts the passed value is greater than zero.
ThrowIfNull Asserts the passed object is not null.
(Inherited from CancellableOperationT)
TriggerCancellationRequested Triggers the cancellation requested event, for any registered listeners.
(Inherited from CancellableOperationT)

Events

CancellationRequested Event fired on cancellation requested.
(Inherited from CancellableOperationT)
ProcessingCompleted Event fired on processing completed without failure.
ProcessingFailed Event fired on processing failure.
ProcessingStarted Processing has started event.

See Also