Namespace: OtlParallel

Interface IOmniBackgroundWorker

All Known Implementing Classes:
TOmniBackgroundWorker

public interface IOmniBackgroundWorker

Persistent
False

Method Summary
  public Sub CancelAll()
 
  public Sub CancelAll(upToUniqueID: int64)
 
  public function IOmniWorkItemConfig Config()
 
  public function IOmniWorkItem CreateWorkItem(data: OtlCommon.TOmniValue )
 
  public function IOmniBackgroundWorker Execute(aTask: TOmniBackgroundWorkerDelegate )
 
  public function IOmniBackgroundWorker Finalize(taskFinalizer: TOmniTaskFinalizerDelegate )
 
  public function IOmniBackgroundWorker Initialize(taskInitializer: TOmniTaskInitializerDelegate )
 
  public function IOmniBackgroundWorker NumTasks(numTasks: integer)
 
  public function IOmniBackgroundWorker OnRequestDone(aTask: TOmniWorkItemDoneDelegate )
 
  public function IOmniBackgroundWorker OnRequestDone_Asy(aTask: TOmniWorkItemDoneDelegate )
 
  public function IOmniBackgroundWorker OnStop(stopCode: TProc)
 
  public function IOmniBackgroundWorker OnStop(stopCode: TOmniTaskStopDelegate )
 
  public Sub Schedule(workItem: IOmniWorkItem ; workItemConfig: IOmniWorkItemConfig )
 
  public function IOmniBackgroundWorker StopOn(token: OtlSync.IOmniCancellationToken )
 
  public function IOmniBackgroundWorker TaskConfig(config: IOmniTaskConfig )
 
  public function boolean Terminate(maxWait_ms: cardinal)
 
  public function boolean WaitFor(maxWait_ms: cardinal)
 
 

Method Detail

CancelAll

public procedure CancelAll()
Reintroduce
False

CancelAll

public procedure CancelAll(upToUniqueID: int64)
Reintroduce
False

Config

public function Config(): IOmniWorkItemConfig 
Reintroduce
False
Returns
IOmniWorkItemConfig

CreateWorkItem

public function CreateWorkItem(data: OtlCommon.TOmniValue ): IOmniWorkItem 
Reintroduce
False
Returns
IOmniWorkItem

Execute

public function Execute(aTask: TOmniBackgroundWorkerDelegate ): IOmniBackgroundWorker 
Reintroduce
False
Returns
IOmniBackgroundWorker

Finalize

public function Finalize(taskFinalizer: TOmniTaskFinalizerDelegate ): IOmniBackgroundWorker 
Reintroduce
False
Returns
IOmniBackgroundWorker

Initialize

public function Initialize(taskInitializer: TOmniTaskInitializerDelegate ): IOmniBackgroundWorker 
Reintroduce
False
Returns
IOmniBackgroundWorker

NumTasks

public function NumTasks(numTasks: integer): IOmniBackgroundWorker 
Reintroduce
False
Returns
IOmniBackgroundWorker

OnRequestDone

public function OnRequestDone(aTask: TOmniWorkItemDoneDelegate ): IOmniBackgroundWorker 
Reintroduce
False
Returns
IOmniBackgroundWorker

OnRequestDone_Asy

public function OnRequestDone_Asy(aTask: TOmniWorkItemDoneDelegate ): IOmniBackgroundWorker 
Reintroduce
False
Returns
IOmniBackgroundWorker

OnStop

public function OnStop(stopCode: TProc): IOmniBackgroundWorker 
Reintroduce
False
Returns
IOmniBackgroundWorker

OnStop

public function OnStop(stopCode: TOmniTaskStopDelegate ): IOmniBackgroundWorker 
Reintroduce
False
Returns
IOmniBackgroundWorker

Schedule

public procedure Schedule(workItem: IOmniWorkItem ; workItemConfig: IOmniWorkItemConfig )
Reintroduce
False

StopOn

public function StopOn(token: OtlSync.IOmniCancellationToken ): IOmniBackgroundWorker 
Reintroduce
False
Returns
IOmniBackgroundWorker

TaskConfig

public function TaskConfig(config: IOmniTaskConfig ): IOmniBackgroundWorker 
Reintroduce
False
Returns
IOmniBackgroundWorker

Terminate

public function Terminate(maxWait_ms: cardinal): boolean
Reintroduce
False
Returns
boolean

WaitFor

public function WaitFor(maxWait_ms: cardinal): boolean
Reintroduce
False
Returns
boolean