Namespace: OtlTaskControl

Class TOmniTaskControl

System.TInterfacedObject
  |
  +-- OtlTaskControl.TOmniTaskControl

All Implemented Interfaces:

IOmniTaskControl , IOmniTaskControlSharedInfo , IOmniTaskControlInternals

public class TOmniTaskControl ( System.TInterfacedObject , IOmniTaskControl , IOmniTaskControlSharedInfo , IOmniTaskControlInternals )

Sealed

False

Abstract

False

Persistent

False

Property Summary
public  OtlSync.IOmniCancellationToken	CancellationToken
public  OtlComm.IOmniCommunicationEndpoint	Comm
public  TOmniTaskControlInternalDebugFlags	DebugFlags
public  integer	ExitCode
public  string	ExitMessage
public  Exception	FatalException
public  TSynchroObject	Lock
public  string	Name
public  TOmniTaskControlOptions	Options
public  OtlCommon.TOmniValueContainer	Param
public  TOmniSharedTaskInfo	SharedInfo
public  int64	UniqueID
public  OtlCommon.TOmniValue	UserData

 

Constructor Summary

Create(worker: OtlTask.TOmniTaskDelegate ; taskName: string)

Create(worker: IOmniWorker ; taskName: string)

Create(worker: TOmniTaskMethod ; taskName: string)

Create(worker: TOmniTaskProcedure ; taskName: string)

 

Method Summary
public function IOmniTaskControl	Alertable()
public function IOmniTaskControl	CancelWith(token: OtlSync.IOmniCancellationToken )
public function IOmniTaskControl	ChainTo(task: IOmniTaskControl ; ignoreErrors: boolean)
public function IOmniTaskControl	ClearTimer(timerID: integer)
public Sub	Destroy()
public function Exception	DetachException()
public function IOmniTaskControl	Enforced(forceExecution: boolean)
public function IOmniTaskControl	Invoke(msgMethod: pointer)
public function IOmniTaskControl	Invoke(msgMethod: pointer; msgData: array of const)
public function IOmniTaskControl	Invoke(msgMethod: pointer; msgData: OtlCommon.TOmniValue )
public function IOmniTaskControl	Invoke(msgName: string)
public function IOmniTaskControl	Invoke(msgName: string; msgData: array of const)
public function IOmniTaskControl	Invoke(msgName: string; msgData: OtlCommon.TOmniValue )
public function IOmniTaskControl	Invoke(remoteFunc: TOmniTaskControlInvokeFunction )
public function IOmniTaskControl	Invoke(remoteFunc: TOmniTaskControlInvokeFunctionEx )
public function IOmniTaskControl	Join(group: IOmniTaskGroup )
public function IOmniTaskControl	Leave(group: IOmniTaskGroup )
public function IOmniTaskControl	MonitorWith(monitor: IOmniTaskControlMonitor )
public function IOmniTaskControl	MsgWait(wakeMask: DWORD)
public function IOmniTaskControl	NUMANode(numaNodeNumber: integer)
public function IOmniTaskControl	OnMessage(eventHandler: TOmniOnMessageFunction )
public function IOmniTaskControl	OnMessage(msgID: word; eventHandler: TOmniOnMessageFunction )
public function IOmniTaskControl	OnMessage(eventDispatcher: TObject)
public function IOmniTaskControl	OnMessage(eventHandler: TOmniTaskMessageEvent )
public function IOmniTaskControl	OnMessage(msgID: word; eventHandler: TOmniTaskMessageEvent )
public function IOmniTaskControl	OnMessage(msgID: word; eventHandler: TOmniMessageExec )
public function IOmniTaskControl	OnTerminated(eventHandler: TOmniOnTerminatedFunction )
public function IOmniTaskControl	OnTerminated(eventHandler: TOmniOnTerminatedFunctionSimple )
public function IOmniTaskControl	OnTerminated(eventHandler: TOmniTaskTerminatedEvent )
public function IOmniTaskControl	ProcessorGroup(procGroupNumber: integer)
public function IOmniTaskControl	RemoveMonitor()
public function IOmniTaskControl	Run()
public function IOmniTaskControl	Run(msgMethod: pointer)
public function IOmniTaskControl	Run(msgMethod: pointer; msgData: array of const)
public function IOmniTaskControl	Run(msgMethod: pointer; msgData: OtlCommon.TOmniValue )
public function IOmniTaskControl	Run(msgName: string)
public function IOmniTaskControl	Run(msgName: string; msgData: array of const)
public function IOmniTaskControl	Run(msgName: string; msgData: OtlCommon.TOmniValue )
public function IOmniTaskControl	Run(remoteFunc: TOmniTaskControlInvokeFunction )
public function IOmniTaskControl	Run(remoteFunc: TOmniTaskControlInvokeFunctionEx )
public function IOmniTaskControl	Schedule(threadPool: OtlThreadPool.IOmniThreadPool )
public function IOmniTaskControl	SetMonitor(hWindow: THandle)
public function IOmniTaskControl	SetParameter(paramName: string; paramValue: OtlCommon.TOmniValue )
public function IOmniTaskControl	SetParameter(paramValue: OtlCommon.TOmniValue )
public function IOmniTaskControl	SetParameters(parameters: OtlCommon.TOmniValue )
public function IOmniTaskControl	SetQueueSize(numMessages: integer)
public function IOmniTaskControl	SetTimer(interval_ms: cardinal)
public function IOmniTaskControl	SetTimer(interval_ms: cardinal; timerMessage: OtlCommon.TOmniMessageID )
public function IOmniTaskControl	SetTimer(timerID: integer; interval_ms: cardinal; timerMessage: OtlCommon.TOmniMessageID )
public function IOmniTaskControl	SetUserData(idxData: OtlCommon.TOmniValue ; value: OtlCommon.TOmniValue )
public Sub	Stop()
public function boolean	Terminate(maxWait_ms: cardinal)
public function IOmniTaskControl	TerminateWhen(event: OtlSync.TOmniTransitionEvent )
public function IOmniTaskControl	TerminateWhen(token: OtlSync.IOmniCancellationToken )
public function IOmniTaskControl	Unobserved()
public function boolean	WaitFor(maxWait_ms: cardinal)
public function boolean	WaitForInit()
public function IOmniTaskControl	WithCounter(counter: OtlCommon.IOmniCounter )
public function IOmniTaskControl	WithLock(lock: TSynchroObject; autoDestroyLock: boolean)
public function IOmniTaskControl	WithLock(lock: OtlSync.IOmniCriticalSection )

 

Property Detail

CancellationToken

public CancellationToken: OtlSync.IOmniCancellationToken 

Type

IOmniCancellationToken

Class

False

Access

read

public Comm: OtlComm.IOmniCommunicationEndpoint 

Type

IOmniCommunicationEndpoint

Class

False

Access

read

public DebugFlags: TOmniTaskControlInternalDebugFlags 

Type

TOmniTaskControlInternalDebugFlags

Class

False

Access

read/write

public ExitCode: integer

Type

integer

Class

False

Access

read

public ExitMessage: string

Type

string

Class

False

Access

read

public FatalException: Exception

Type

Exception

Class

False

Access

read

public Lock: TSynchroObject

Type

TSynchroObject

Class

False

Access

read

public Name: string

Type

string

Class

False

Access

read

public Options: TOmniTaskControlOptions 

Type

TOmniTaskControlOptions

Class

False

Access

read/write

public Param: OtlCommon.TOmniValueContainer 

Type

TOmniValueContainer

Class

False

Access

read

public SharedInfo: TOmniSharedTaskInfo 

Type

TOmniSharedTaskInfo

Class

False

Access

read

public UniqueID: int64

Type

int64

Class

False

Access

read

public UserData: OtlCommon.TOmniValue 

Type

TOmniValue

Class

False

Access

read/write

public constructor Create(worker: OtlTask.TOmniTaskDelegate ; taskName: string)

Final

False

Reintroduce

False

Virtual

False

Override

False

Abstract

False

public constructor Create(worker: IOmniWorker ; taskName: string)

Final

False

Reintroduce

False

Virtual

False

Override

False

Abstract

False

public constructor Create(worker: TOmniTaskMethod ; taskName: string)

Final

False

Reintroduce

False

Virtual

False

Override

False

Abstract

False

public constructor Create(worker: TOmniTaskProcedure ; taskName: string)

Final

False

Reintroduce

False

Virtual

False

Override

False

Abstract

False

public function Alertable(): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function CancelWith(token: OtlSync.IOmniCancellationToken ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function ChainTo(task: IOmniTaskControl ; ignoreErrors: boolean): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function ClearTimer(timerID: integer): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public procedure Destroy()

Reintroduce

False

Virtual

False

Override

True

Abstract

False

Final

False

public function DetachException(): Exception

Final

False

Reintroduce

False

Abstract

False

Returns

Exception

Override

False

Virtual

False

Class

False

public function Enforced(forceExecution: boolean): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Invoke(msgMethod: pointer): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Invoke(msgMethod: pointer; msgData: array of const): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Invoke(msgMethod: pointer; msgData: OtlCommon.TOmniValue ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Invoke(msgName: string): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Invoke(msgName: string; msgData: array of const): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Invoke(msgName: string; msgData: OtlCommon.TOmniValue ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Invoke(remoteFunc: TOmniTaskControlInvokeFunction ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Invoke(remoteFunc: TOmniTaskControlInvokeFunctionEx ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Join(group: IOmniTaskGroup ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Leave(group: IOmniTaskGroup ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function MonitorWith(monitor: IOmniTaskControlMonitor ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function MsgWait(wakeMask: DWORD): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function NUMANode(numaNodeNumber: integer): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function OnMessage(eventHandler: TOmniOnMessageFunction ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function OnMessage(msgID: word; eventHandler: TOmniOnMessageFunction ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function OnMessage(eventDispatcher: TObject): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function OnMessage(eventHandler: TOmniTaskMessageEvent ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function OnMessage(msgID: word; eventHandler: TOmniTaskMessageEvent ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function OnMessage(msgID: word; eventHandler: TOmniMessageExec ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function OnTerminated(eventHandler: TOmniOnTerminatedFunction ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function OnTerminated(eventHandler: TOmniOnTerminatedFunctionSimple ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function OnTerminated(eventHandler: TOmniTaskTerminatedEvent ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function ProcessorGroup(procGroupNumber: integer): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function RemoveMonitor(): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Run(): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Run(msgMethod: pointer): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Run(msgMethod: pointer; msgData: array of const): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Run(msgMethod: pointer; msgData: OtlCommon.TOmniValue ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Run(msgName: string): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Run(msgName: string; msgData: array of const): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Run(msgName: string; msgData: OtlCommon.TOmniValue ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Run(remoteFunc: TOmniTaskControlInvokeFunction ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Run(remoteFunc: TOmniTaskControlInvokeFunctionEx ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Schedule(threadPool: OtlThreadPool.IOmniThreadPool ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function SetMonitor(hWindow: THandle): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function SetParameter(paramName: string; paramValue: OtlCommon.TOmniValue ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function SetParameter(paramValue: OtlCommon.TOmniValue ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function SetParameters(parameters: OtlCommon.TOmniValue ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function SetQueueSize(numMessages: integer): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function SetTimer(interval_ms: cardinal): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function SetTimer(interval_ms: cardinal; timerMessage: OtlCommon.TOmniMessageID ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function SetTimer(timerID: integer; interval_ms: cardinal; timerMessage: OtlCommon.TOmniMessageID ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function SetUserData(idxData: OtlCommon.TOmniValue ; value: OtlCommon.TOmniValue ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public procedure Stop()

Final

False

Reintroduce

False

Abstract

False

Override

False

Virtual

False

Class

False

public function Terminate(maxWait_ms: cardinal): boolean

Final

False

Reintroduce

False

Abstract

False

Returns

boolean

Override

False

Virtual

False

Class

False

public function TerminateWhen(event: OtlSync.TOmniTransitionEvent ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function TerminateWhen(token: OtlSync.IOmniCancellationToken ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function Unobserved(): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function WaitFor(maxWait_ms: cardinal): boolean

Final

False

Reintroduce

False

Abstract

False

Returns

boolean

Override

False

Virtual

False

Class

False

public function WaitForInit(): boolean

Final

False

Reintroduce

False

Abstract

False

Returns

boolean

Override

False

Virtual

False

Class

False

public function WithCounter(counter: OtlCommon.IOmniCounter ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function WithLock(lock: TSynchroObject; autoDestroyLock: boolean): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

public function WithLock(lock: OtlSync.IOmniCriticalSection ): IOmniTaskControl 

Final

False

Reintroduce

False

Abstract

False

Returns

IOmniTaskControl

Override

False

Virtual

False

Class

False

Implementation Link

to Interface IOmniTaskControl

Client

TOmniTaskControl

Supplier

IOmniTaskControl

Client

TOmniTaskControl

Supplier

IOmniTaskControlSharedInfo

Client

TOmniTaskControl

Supplier

IOmniTaskControlInternals

Association Link

to Delegate TOmniOnTerminatedFunctionSimple

Supplier

TOmniOnTerminatedFunctionSimple

Directed

False

Client

otcOnTerminatedSimple

Type

association

Supplier

TOmniTaskControlInternalDebugFlags

Directed

False

Client

otcDebugFlags

Type

association

Supplier

TOmniTaskExecutor

Directed

False

Client

otcExecutor

Type

association

Supplier

TOmniMessageExec

Directed

False

Client

otcOnMessageExec

Type

association

Supplier

TOmniMessageExec

Directed

False

Client

otcOnTerminatedExec

Type

association

Supplier

IOmniThreadPool

Directed

False

Client

otcOwningPool

Type

association

Supplier

TOmniValueContainer

Directed

False

Client

otcParameters

Type

association

Supplier

TOmniSharedTaskInfo

Directed

False

Client

otcSharedInfo

Type

association

Supplier

TOmniThread

Directed

False

Client

otcThread

Type

association

Supplier

TOmniValueContainer

Directed

False

Client

otcUserData

Type

association

Supplier

TOmniTaskControlInternalDebugFlags

Directed

False

Client

DebugFlags

Type

association

Supplier

IOmniCancellationToken

Directed

False

Client

CancellationToken

Type

association

Supplier

IOmniCommunicationEndpoint

Directed

False

Client

Comm

Type

association

Supplier

TOmniTaskControlOptions

Directed

False

Client

Options

Type

association

Supplier

TOmniValueContainer

Directed

False

Client

Param

Type

association

Supplier

TOmniSharedTaskInfo

Directed

False

Client

SharedInfo

Type

association

Supplier

TOmniValue

Directed

False

Client

UserData

Type

association