BatchProcessorJob Class

The batch processor job class is the async processing operations specific to TaskProcessorJob's that are being processed by a IApplicationTaskProcessor. This class: - Has a guid identifier. - Holds a reference to the vault. - Contains a processing report. - Exposes events [ ChildJobCreated ]

Definition

Namespace: MFiles.VAF.MultiserverMode
Assembly: MFiles.VAF (in MFiles.VAF.dll) Version: 24.1.706.1
C#
public class BatchProcessorJob : AsyncProcessingOperation<AppTaskProcessingReport>
Inheritance
Object    CancellableOperationAppTaskProcessingReport    AsyncProcessingOperationAppTaskProcessingReport    BatchProcessorJob

Constructors

BatchProcessorJob 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.
(Inherited from AsyncProcessingOperationT)
Guid Identifier for this operation.
IsBroadcastJob  
JobState Processing state of the async job.
(Inherited from AsyncProcessingOperationT)
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)
CancelActiveJob Cancels an active job, by app task id.
CancelAfter Requests cancellation of the operation.
(Inherited from CancellableOperationT)
ContainsFailures True when the processing report contains any failed operations.
IsActive Resolves the is active flag.
OnCancellationRequested Override the cancellation requested method to ensure only items with a valid state are updated.
(Inherited from AsyncProcessingOperationT)
OnChildJobCreated Child job created event invoker.
OnProcessingCompleted Processing completed event invocation.
(Inherited from AsyncProcessingOperationT)
OnProcessingFailed Processing failed event invoker.
(Inherited from AsyncProcessingOperationT)
OnProcessingStarted Processing started event invocation.
(Inherited from AsyncProcessingOperationT)
Process Begins processing all passed operations.
ProcessChildJob Processes an individual child job.
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.
(Inherited from AsyncProcessingOperationT)
ThrowIfNull Asserts the passed object is not null.
(Inherited from CancellableOperationT)
TriggerCancellationRequested Triggers the cancellation requested event, for any registered listeners.
(Inherited from CancellableOperationT)
WaitAll Waits for all child tasks to exit.

Events

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

See Also