Overview | Namespace | Classifier | Tree | Index | Help
PREV NEXT | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | DESTR | METHOD | DETAIL: FIELD | CONSTR | DESTR | METHOD

## Namespace: OtlParallel
Class TOmniBackgroundWorker

    System.TInterfacedObject
      |
      +-- OtlParallel.TOmniBackgroundWorker

All Implemented Interfaces:
  IOmniBackgroundWorker

public class TOmniBackgroundWorker ( System.TInterfacedObject , IOmniBackgroundWorker )

Sealed
  False

Abstract
  False

Persistent
  False

Constructor Summary
`Create()`

Method Summary
`public Sub` | `CancelAll()`
`public Sub` | `CancelAll(upToUniqueID: int64)`
`public function IOmniWorkItemConfig` | `Config()`
`public function IOmniWorkItem` | `CreateWorkItem(data: OtlCommon.TOmniValue )`
`public Sub` | `Destroy()`
`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)`

Constructor Detail

### Create

    public constructor Create()

Final
  False

Reintroduce
  False

Virtual
  False

Override
  False

Abstract
  False

Method Detail

### CancelAll

    public procedure CancelAll()

Final
  False

Reintroduce
  False

Abstract
  False

Override
  False

Virtual
  False

Class
  False

### CancelAll

    public procedure CancelAll(upToUniqueID: int64)

Final
  False

Reintroduce
  False

Abstract
  False

Override
  False

Virtual
  False

Class
  False

### Config

    public function Config(): IOmniWorkItemConfig

Final
  False

Reintroduce
  False

Abstract
  False

Returns
  IOmniWorkItemConfig

Override
  False

Virtual
  False

Class
  False

### CreateWorkItem

    public function CreateWorkItem(data: OtlCommon.TOmniValue ): IOmniWorkItem

Final
  False

Reintroduce
  False

Abstract
  False

Returns
  IOmniWorkItem

Override
  False

Virtual
  False

Class
  False

### Destroy

    public procedure Destroy()

Reintroduce
  False

Virtual
  False

Override
  True

Abstract
  False

Final
  False

### Execute

    public function Execute(aTask: TOmniBackgroundWorkerDelegate ): IOmniBackgroundWorker

Final
  False

Reintroduce
  False

Abstract
  False

Returns
  IOmniBackgroundWorker

Override
  False

Virtual
  False

Class
  False

### Finalize

    public function Finalize(taskFinalizer: TOmniTaskFinalizerDelegate ): IOmniBackgroundWorker

Final
  False

Reintroduce
  False

Abstract
  False

Returns
  IOmniBackgroundWorker

Override
  False

Virtual
  False

Class
  False

### Initialize

    public function Initialize(taskInitializer: TOmniTaskInitializerDelegate ): IOmniBackgroundWorker

Final
  False

Reintroduce
  False

Abstract
  False

Returns
  IOmniBackgroundWorker

Override
  False

Virtual
  False

Class
  False

### NumTasks

    public function NumTasks(numTasks: integer): IOmniBackgroundWorker

Final
  False

Reintroduce
  False

Abstract
  False

Returns
  IOmniBackgroundWorker

Override
  False

Virtual
  False

Class
  False

### OnRequestDone

    public function OnRequestDone(aTask: TOmniWorkItemDoneDelegate ): IOmniBackgroundWorker

Final
  False

Reintroduce
  False

Abstract
  False

Returns
  IOmniBackgroundWorker

Override
  False

Virtual
  False

Class
  False

### OnRequestDone_Asy

    public function OnRequestDone_Asy(aTask: TOmniWorkItemDoneDelegate ): IOmniBackgroundWorker

Final
  False

Reintroduce
  False

Abstract
  False

Returns
  IOmniBackgroundWorker

Override
  False

Virtual
  False

Class
  False

### OnStop

    public function OnStop(stopCode: TProc): IOmniBackgroundWorker

Final
  False

Reintroduce
  False

Abstract
  False

Returns
  IOmniBackgroundWorker

Override
  False

Virtual
  False

Class
  False

### OnStop

    public function OnStop(stopCode: TOmniTaskStopDelegate ): IOmniBackgroundWorker

Final
  False

Reintroduce
  False

Abstract
  False

Returns
  IOmniBackgroundWorker

Override
  False

Virtual
  False

Class
  False

### Schedule

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

Final
  False

Reintroduce
  False

Abstract
  False

Override
  False

Virtual
  False

Class
  False

### StopOn

    public function StopOn(token: OtlSync.IOmniCancellationToken ): IOmniBackgroundWorker

Final
  False

Reintroduce
  False

Abstract
  False

Returns
  IOmniBackgroundWorker

Override
  False

Virtual
  False

Class
  False

### TaskConfig

    public function TaskConfig(config: IOmniTaskConfig ): IOmniBackgroundWorker

Final
  False

Reintroduce
  False

Abstract
  False

Returns
  IOmniBackgroundWorker

Override
  False

Virtual
  False

Class
  False

### Terminate

    public function Terminate(maxWait_ms: cardinal): boolean

Final
  False

Reintroduce
  False

Abstract
  False

Returns
  boolean

Override
  False

Virtual
  False

Class
  False

### WaitFor

    public function WaitFor(maxWait_ms: cardinal): boolean

Final
  False

Reintroduce
  False

Abstract
  False

Returns
  boolean

Override
  False

Virtual
  False

Class
  False

Implementation Link

to Interface IOmniBackgroundWorker

Client
  TOmniBackgroundWorker

Supplier
  IOmniBackgroundWorker

Association Link

to Struct TOmniAlignedInt64

Supplier
  TOmniAlignedInt64

Directed
  False

Client
  FCancelAllToID

Type
  association

to Interface IOmniWorkItemConfig

Supplier
  IOmniWorkItemConfig

Directed
  False

Client
  FDefaultConfig

Type
  association

to Interface IOmniWorkItemConfigEx

Supplier
  IOmniWorkItemConfigEx

Directed
  False

Client
  FDefaultConfigEx

Type
  association

to Class TOmniContainerObserver

Supplier
  TOmniContainerObserver

Directed
  False

Client
  FObserver

Type
  association

to Class TOmniTaskStopDelegate

Supplier
  TOmniTaskStopDelegate

Directed
  False

Client
  FOnStop

Type
  association

to Interface IOmniCancellationToken

Supplier
  IOmniCancellationToken

Directed
  False

Client
  FStopOn

Type
  association

to Interface IOmniTaskConfig

Supplier
  IOmniTaskConfig

Directed
  False

Client
  FTaskConfig

Type
  association

to Delegate TOmniTaskFinalizerDelegate

Supplier
  TOmniTaskFinalizerDelegate

Directed
  False

Client
  FTaskFinalizer

Type
  association

to Delegate TOmniTaskInitializerDelegate

Supplier
  TOmniTaskInitializerDelegate

Directed
  False

Client
  FTaskInitializer

Type
  association

to Interface IOmniCounter

Supplier
  IOmniCounter

Directed
  False

Client
  FUniqueID

Type
  association

to Interface IOmniPipeline

Supplier
  IOmniPipeline

Directed
  False

Client
  FWorker

Type
  association

Overview | Namespace | Classifier | Tree | Index | Help
PREV NEXT | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | DESTR | METHOD | DETAIL: FIELD | CONSTR | DESTR | METHOD