An extension to the ITaskletinterface to allow users to add logic for stopping a tasklet. It is up to each implementation as to how the stop will behave. The only guarantee provided by the framework is that a call to JobOperator.Stop(long) will attempt to call the stop method on any currently running IStoppableTasklet. The call to IStoppableTasklet.Stop() will be from a thread other than the thread executing Tasklet.Execute() so the appropriate thread safety and visibility controls should be put in place. More...
Public Member Functions | |
void | Stop () |
Used to signal that the job this Tasklet is executing within has been requested to stop. More... | |
Public Member Functions inherited from Summer.Batch.Core.Step.Tasklet.ITasklet | |
RepeatStatus | Execute (StepContribution contribution, ChunkContext chunkContext) |
Given the current context in the form of a step contribution, do whatever is necessary to process this unit inside a transaction. Implementations return RepeatStatus::Finished if finished. If not they return RepeatStatus::Continuable. On failure throws an exception. More... | |
Detailed Description
An extension to the ITaskletinterface to allow users to add logic for stopping a tasklet. It is up to each implementation as to how the stop will behave. The only guarantee provided by the framework is that a call to JobOperator.Stop(long) will attempt to call the stop method on any currently running IStoppableTasklet. The call to IStoppableTasklet.Stop() will be from a thread other than the thread executing Tasklet.Execute() so the appropriate thread safety and visibility controls should be put in place.
Member Function Documentation
void Summer.Batch.Core.Step.Tasklet.IStoppableTasklet.Stop | ( | ) |
Used to signal that the job this Tasklet is executing within has been requested to stop.
Implemented in Summer.Batch.Core.Step.Tasklet.PowerShellTasklet, and Summer.Batch.Core.Step.Tasklet.SystemCommandTasklet.
The documentation for this interface was generated from the following file:
- Summer.Batch.Core/Core/Step/Tasklet/IStoppableTasklet.cs