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

## Namespace: OtlTaskControl
Interface IOmniTaskControl

All Known Subinterfaces:
  IOmniTaskControlSharedInfo

All Known Implementing Classes:
  TOmniTaskControl

public interface IOmniTaskControl

Persistent
  False

Property Summary
`public OtlSync.IOmniCancellationToken` | `CancellationToken`
`public OtlComm.IOmniCommunicationEndpoint` | `Comm`
`public integer` | `ExitCode`
`public string` | `ExitMessage`
`public Exception` | `FatalException`
`public TSynchroObject` | `Lock`
`public string` | `Name`
`public OtlCommon.TOmniValueContainer` | `Param`
`public int64` | `UniqueID`
`public OtlCommon.TOmniValue` | `UserData`

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 function Exception` | `DetachException()`
`public function IOmniTaskControl` | `Enforced(forceExecution: boolean)`
`public function OtlSync.IOmniCancellationToken` | `GetCancellationToken()`
`public function OtlComm.IOmniCommunicationEndpoint` | `GetComm()`
`public function integer` | `GetExitCode()`
`public function string` | `GetExitMessage()`
`public function Exception` | `GetFatalException()`
`public function TSynchroObject` | `GetLock()`
`public function string` | `GetName()`
`public function OtlCommon.TOmniValueContainer` | `GetParam()`
`public function int64` | `GetUniqueID()`
`public function OtlCommon.TOmniValue` | `GetUserDataVal(idxData: OtlCommon.TOmniValue )`
`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(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` | `OnMessage(eventHandler: TOmniOnMessageFunction )`
`public function IOmniTaskControl` | `OnMessage(msgID: word; eventHandler: TOmniOnMessageFunction )`
`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` | `SetPriority(threadPriority: TOTLThreadPriority )`
`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` | `SetUserDataVal(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

Access
  read

### Comm

    public Comm: OtlComm.IOmniCommunicationEndpoint

Type
  IOmniCommunicationEndpoint

Access
  read

### ExitCode

    public ExitCode: integer

Type
  integer

Access
  read

### ExitMessage

    public ExitMessage: string

Type
  string

Access
  read

### FatalException

    public FatalException: Exception

Type
  Exception

Access
  read

### Lock

    public Lock: TSynchroObject

Type
  TSynchroObject

Access
  read

### Name

    public Name: string

Type
  string

Access
  read

### Param

    public Param: OtlCommon.TOmniValueContainer

Type
  TOmniValueContainer

Access
  read

### UniqueID

    public UniqueID: int64

Type
  int64

Access
  read

### UserData

    public UserData: OtlCommon.TOmniValue

Type
  TOmniValue

Access
  read/write

Method Detail

### Alertable

    public function Alertable(): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### CancelWith

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

Reintroduce
  False

Returns
  IOmniTaskControl

### ChainTo

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

Reintroduce
  False

Returns
  IOmniTaskControl

### ClearTimer

    public function ClearTimer(timerID: integer): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### DetachException

    public function DetachException(): Exception

Reintroduce
  False

Returns
  Exception

### Enforced

    public function Enforced(forceExecution: boolean): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### GetCancellationToken

    public function GetCancellationToken(): OtlSync.IOmniCancellationToken

Reintroduce
  False

Returns
  IOmniCancellationToken

### GetComm

    public function GetComm(): OtlComm.IOmniCommunicationEndpoint

Reintroduce
  False

Returns
  IOmniCommunicationEndpoint

### GetExitCode

    public function GetExitCode(): integer

Reintroduce
  False

Returns
  integer

### GetExitMessage

    public function GetExitMessage(): string

Reintroduce
  False

Returns
  string

### GetFatalException

    public function GetFatalException(): Exception

Reintroduce
  False

Returns
  Exception

### GetLock

    public function GetLock(): TSynchroObject

Reintroduce
  False

Returns
  TSynchroObject

### GetName

    public function GetName(): string

Reintroduce
  False

Returns
  string

### GetParam

    public function GetParam(): OtlCommon.TOmniValueContainer

Reintroduce
  False

Returns
  TOmniValueContainer

### GetUniqueID

    public function GetUniqueID(): int64

Reintroduce
  False

Returns
  int64

### GetUserDataVal

    public function GetUserDataVal(idxData: OtlCommon.TOmniValue ): OtlCommon.TOmniValue

Reintroduce
  False

Returns
  TOmniValue

### Invoke

    public function Invoke(msgMethod: pointer): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### Invoke

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

Reintroduce
  False

Returns
  IOmniTaskControl

### Invoke

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

Reintroduce
  False

Returns
  IOmniTaskControl

### Invoke

    public function Invoke(msgName: string): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### Invoke

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

Reintroduce
  False

Returns
  IOmniTaskControl

### Invoke

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

Reintroduce
  False

Returns
  IOmniTaskControl

### Invoke

    public function Invoke(remoteFunc: TOmniTaskControlInvokeFunction ): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### Invoke

    public function Invoke(remoteFunc: TOmniTaskControlInvokeFunctionEx ): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### Join

    public function Join(group: IOmniTaskGroup ): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### Leave

    public function Leave(group: IOmniTaskGroup ): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### MonitorWith

    public function MonitorWith(monitor: IOmniTaskControlMonitor ): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### MsgWait

    public function MsgWait(wakeMask: DWORD): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### NUMANode

    public function NUMANode(numaNodeNumber: integer): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### OnMessage

    public function OnMessage(eventDispatcher: TObject): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### OnMessage

    public function OnMessage(eventHandler: TOmniTaskMessageEvent ): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### OnMessage

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

Reintroduce
  False

Returns
  IOmniTaskControl

### OnMessage

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

Reintroduce
  False

Returns
  IOmniTaskControl

### OnMessage

    public function OnMessage(eventHandler: TOmniOnMessageFunction ): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### OnMessage

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

Reintroduce
  False

Returns
  IOmniTaskControl

### OnTerminated

    public function OnTerminated(eventHandler: TOmniOnTerminatedFunction ): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### OnTerminated

    public function OnTerminated(eventHandler: TOmniOnTerminatedFunctionSimple ): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### OnTerminated

    public function OnTerminated(eventHandler: TOmniTaskTerminatedEvent ): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### ProcessorGroup

    public function ProcessorGroup(procGroupNumber: integer): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### RemoveMonitor

    public function RemoveMonitor(): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### Run

    public function Run(): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### Run

    public function Run(msgMethod: pointer): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### Run

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

Reintroduce
  False

Returns
  IOmniTaskControl

### Run

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

Reintroduce
  False

Returns
  IOmniTaskControl

### Run

    public function Run(msgName: string): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### Run

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

Reintroduce
  False

Returns
  IOmniTaskControl

### Run

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

Reintroduce
  False

Returns
  IOmniTaskControl

### Run

    public function Run(remoteFunc: TOmniTaskControlInvokeFunction ): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### Run

    public function Run(remoteFunc: TOmniTaskControlInvokeFunctionEx ): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### Schedule

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

Reintroduce
  False

Returns
  IOmniTaskControl

### SetMonitor

    public function SetMonitor(hWindow: THandle): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### SetParameter

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

Reintroduce
  False

Returns
  IOmniTaskControl

### SetParameter

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

Reintroduce
  False

Returns
  IOmniTaskControl

### SetParameters

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

Reintroduce
  False

Returns
  IOmniTaskControl

### SetPriority

    public function SetPriority(threadPriority: TOTLThreadPriority ): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### SetQueueSize

    public function SetQueueSize(numMessages: integer): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### SetTimer

    public function SetTimer(interval_ms: cardinal): IOmniTaskControl

Reintroduce
  True

Returns
  IOmniTaskControl

### SetTimer

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

Reintroduce
  True

Returns
  IOmniTaskControl

### SetTimer

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

Reintroduce
  False

Returns
  IOmniTaskControl

### SetUserData

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

Reintroduce
  False

Returns
  IOmniTaskControl

### SetUserDataVal

    public procedure SetUserDataVal(idxData: OtlCommon.TOmniValue ; value: OtlCommon.TOmniValue )

Reintroduce
  False

### Stop

    public procedure Stop()

Reintroduce
  False

### Terminate

    public function Terminate(maxWait_ms: cardinal): boolean

Reintroduce
  False

Returns
  boolean

### TerminateWhen

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

Reintroduce
  False

Returns
  IOmniTaskControl

### TerminateWhen

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

Reintroduce
  False

Returns
  IOmniTaskControl

### Unobserved

    public function Unobserved(): IOmniTaskControl

Reintroduce
  False

Returns
  IOmniTaskControl

### WaitFor

    public function WaitFor(maxWait_ms: cardinal): boolean

Reintroduce
  False

Returns
  boolean

### WaitForInit

    public function WaitForInit(): boolean

Reintroduce
  False

Returns
  boolean

### WithCounter

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

Reintroduce
  False

Returns
  IOmniTaskControl

### WithLock

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

Reintroduce
  False

Returns
  IOmniTaskControl

### WithLock

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

Reintroduce
  False

Returns
  IOmniTaskControl

Association Link

to Interface IOmniCancellationToken

Supplier
  IOmniCancellationToken

Directed
  False

Client
  CancellationToken

Type
  association

to Interface IOmniCommunicationEndpoint

Supplier
  IOmniCommunicationEndpoint

Directed
  False

Client
  Comm

Type
  association

to Class TOmniValueContainer

Supplier
  TOmniValueContainer

Directed
  False

Client
  Param

Type
  association

to Struct TOmniValue

Supplier
  TOmniValue

Directed
  False

Client
  UserData

Type
  association

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