Click or drag to resize

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 ]
Inheritance Hierarchy
SystemObject
  MFiles.VAF.MultiserverModeCancellableOperationAppTaskProcessingReport
    MFiles.VAF.MultiserverModeAsyncProcessingOperationAppTaskProcessingReport
      MFiles.VAF.MultiserverModeBatchProcessorJob

Namespace:  MFiles.VAF.MultiserverMode
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.3.623.2
Syntax
Copy
public class BatchProcessorJob : AsyncProcessingOperation<AppTaskProcessingReport>

The BatchProcessorJob type exposes the following members.

Constructors
  NameDescription
Public methodBatchProcessorJob
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 propertyGuid
Identifier for this operation.
Public propertyIsBroadcastJob
True when the job is used for broadcast messages. - This job type is not validated against MAX batches.
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
Public methodCancel
Requests cancellation of the operation.
(Inherited from CancellableOperationT.)
Public methodCancelActiveJob
Cancels an active job, by app task id.
Public methodCancelAfter
Requests cancellation of the operation.
(Inherited from CancellableOperationT.)
Public methodContainsFailures
True when the processing report contains any failed operations.
Public methodIsActive
Resolves the is active flag.
Protected methodOnCancellationRequested
Override the cancellation requested method to ensure only items with a valid state are updated.
(Inherited from AsyncProcessingOperationT.)
Public methodOnChildJobCreated
Child job created event invoker.
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 processing all passed operations.
Public methodProcessChildJob
Processes an individual child job.
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.)
Public methodWaitAll
Waits for all child tasks to exit.
Top
Events
See Also