TaskChain Delphi DLL Reference Documentation

TaskChain

Current Version: 9.5.0.97

Represents a chain of asynchronous tasks to be run in sequence in a background thread.

Create/Dispose

var
myObject: HCkTaskChain;

begin
myObject := CkTaskChain_Create();

// ...

CkTaskChain_Dispose(myObject);
end;
function CkTaskChain_Create: HCkTaskChain; stdcall;

Creates an instance of the HCkTaskChain object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkTaskChain_Dispose(handle: HCkTaskChain); stdcall;

Objects created by calling CkTaskChain_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

DebugLogFilePath
procedure CkTaskChain_getDebugLogFilePath(objHandle: HCkTaskChain; outPropVal: HCkString); stdcall;
procedure CkTaskChain_putDebugLogFilePath(objHandle: HCkTaskChain; newPropVal: PWideChar); stdcall;
function CkTaskChain__debugLogFilePath(objHandle: HCkTaskChain): PWideChar; stdcall;

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
Finished
function CkTaskChain_getFinished(objHandle: HCkTaskChain): wordbool; stdcall;
Introduced in version 9.5.0.52

True if the task status is "canceled", "aborted", or "completed". A task chain can only reach the "canceled" status if it was activated via the Run method, made it onto the internal thread pool thread's queue, was waiting for a pool thread to become available, and was then canceled prior to the task actually starting.

top
HeartbeatMs
function CkTaskChain_getHeartbeatMs(objHandle: HCkTaskChain): Integer; stdcall;
procedure CkTaskChain_putHeartbeatMs(objHandle: HCkTaskChain; newPropVal: Integer); stdcall;
Introduced in version 9.5.0.52

The number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort the Wait method. If HeartbeatMs is 0 (the default), no AbortCheck event callbacks will fire. Note: An asynchronous task chain running in a background thread (in one of the thread pool threads) does not fire events. The task chain's event callbacks pertain only to the Wait method.

top
Inert
function CkTaskChain_getInert(objHandle: HCkTaskChain): wordbool; stdcall;
Introduced in version 9.5.0.52

True if the task status is "empty" or "loaded". When a task chain is inert, it has been loaded but is not scheduled to run yet.

top
LastErrorHtml
procedure CkTaskChain_getLastErrorHtml(objHandle: HCkTaskChain; outPropVal: HCkString); stdcall;
function CkTaskChain__lastErrorHtml(objHandle: HCkTaskChain): PWideChar; stdcall;

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
procedure CkTaskChain_getLastErrorText(objHandle: HCkTaskChain; outPropVal: HCkString); stdcall;
function CkTaskChain__lastErrorText(objHandle: HCkTaskChain): PWideChar; stdcall;

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
procedure CkTaskChain_getLastErrorXml(objHandle: HCkTaskChain; outPropVal: HCkString); stdcall;
function CkTaskChain__lastErrorXml(objHandle: HCkTaskChain): PWideChar; stdcall;

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
function CkTaskChain_getLastMethodSuccess(objHandle: HCkTaskChain): wordbool; stdcall;
procedure CkTaskChain_putLastMethodSuccess(objHandle: HCkTaskChain; newPropVal: wordbool); stdcall;

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = True and failure = False.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Live
function CkTaskChain_getLive(objHandle: HCkTaskChain): wordbool; stdcall;
Introduced in version 9.5.0.52

True if the task status is "queued" or "running". When a task chain is live, it is either already running, or is on the thread pool thread's queue waiting for a thread to become available.

top
NumTasks
function CkTaskChain_getNumTasks(objHandle: HCkTaskChain): Integer; stdcall;
Introduced in version 9.5.0.52

The number of tasks contained within the task chain.

top
Status
procedure CkTaskChain_getStatus(objHandle: HCkTaskChain; outPropVal: HCkString); stdcall;
function CkTaskChain__status(objHandle: HCkTaskChain): PWideChar; stdcall;
Introduced in version 9.5.0.52

The current status of the task chain. Possible values are:

  • "empty" -- No tasks have yet been appended to the task chain.
  • "loaded" -- The task chain has been loaded (appended) with one or more task objects.
  • "queued" -- The task chain is in the thread pool's queue of tasks awaiting to be run.
  • "running" -- The task chain is currently running.
  • "canceled" -- The task chain was canceled before it entered the "running" state.
  • "aborted" -- The task chain was canceled while it was in the running state.
  • "completed" -- The task chain completed.

top
StatusInt
function CkTaskChain_getStatusInt(objHandle: HCkTaskChain): Integer; stdcall;
Introduced in version 9.5.0.52

The current status of the task as an integer value. Possible values are:

  • 1 -- "empty" -- No tasks have yet been appended to the task chain.
  • 2 -- "loaded" -- The task chain has been loaded (appended) with one or more task objects.
  • 3 -- "queued" -- The task chain is in the thread pool's queue of tasks awaiting to be run.
  • 4 -- "running" -- The task chain is currently running.
  • 5 -- "canceled" -- The task chain was canceled before it entered the "running" state.
  • 6 -- "aborted" -- The task chain was canceled while it was in the running state.
  • 7 -- "completed" -- The task chain completed.

top
StopOnFailedTask
function CkTaskChain_getStopOnFailedTask(objHandle: HCkTaskChain): wordbool; stdcall;
procedure CkTaskChain_putStopOnFailedTask(objHandle: HCkTaskChain; newPropVal: wordbool); stdcall;
Introduced in version 9.5.0.52

If True then stops execution of the task chain if any individual task fails. Task failure is defined by the standard LastMethodSuccess property. If False, then all of the tasks in the chain will be run even if some fail. The default value of this property is True.

More Information and Examples
top
VerboseLogging
function CkTaskChain_getVerboseLogging(objHandle: HCkTaskChain): wordbool; stdcall;
procedure CkTaskChain_putVerboseLogging(objHandle: HCkTaskChain; newPropVal: wordbool); stdcall;

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
procedure CkTaskChain_getVersion(objHandle: HCkTaskChain; outPropVal: HCkString); stdcall;
function CkTaskChain__version(objHandle: HCkTaskChain): PWideChar; stdcall;

Version of the component/library, such as "9.5.0.94"

More Information and Examples
top

Methods

Append
function CkTaskChain_Append(objHandle: HCkTaskChain;
    task: HCkTask): wordbool; stdcall;
Introduced in version 9.5.0.52

Appends a task to the task chain. Can fail if the task is already part of another chain. (A task can only be part of a single chain.)

Returns True for success, False for failure.

More Information and Examples
top
Cancel
function CkTaskChain_Cancel(objHandle: HCkTaskChain): wordbool; stdcall;
Introduced in version 9.5.0.52

Cancels execution of the asynchronous task chain.

Returns True for success, False for failure.

top
GetTask
function CkTaskChain_GetTask(objHandle: HCkTaskChain;
    index: Integer): HCkTask; stdcall;
Introduced in version 9.5.0.52

Returns the Nth task in the chain. The 1st task is at index 0.

Returns nil on failure

More Information and Examples
top
Run
function CkTaskChain_Run(objHandle: HCkTaskChain): wordbool; stdcall;
Introduced in version 9.5.0.52

Queues the task chain to run on the internal Chilkat thread pool. Each task in the chain will run, one after the other.

Returns True for success, False for failure.

top
RunSynchronously
function CkTaskChain_RunSynchronously(objHandle: HCkTaskChain): wordbool; stdcall;
Introduced in version 9.5.0.52

Runs the task chain synchronously. Then this method returns after all the tasks in the chain have been run.

Returns True for success, False for failure.

top
SleepMs
procedure CkTaskChain_SleepMs(objHandle: HCkTaskChain;
    numMs: Integer) stdcall;
Introduced in version 9.5.0.52

Convenience method to force the calling thread to sleep for a number of milliseconds.

top
Wait
function CkTaskChain_Wait(objHandle: HCkTaskChain;
    maxWaitMs: Integer): wordbool; stdcall;
Introduced in version 9.5.0.52

Waits for the task chain to complete. Returns when all of the tasks in the chain have completed, or after maxWaitMs milliseconds have elapsed. (A maxWaitMs value of 0 is to wait indefinitely.) Returns (False) if the task chain has not yet been started by calling the Run method, or if the maxWaitMs expired. If the task chain completed, was already completed, was canceled, or aborted, then this method returns True.

Returns True for success, False for failure.

top

Events

Chilkat supports event callbacks for the Delphi DLL starting in version 9.5.0.82.

AbortCheck
function MyAbortCheck(): Integer; cdecl;
Introduced in version 9.5.0.82

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200. Return True to abort; return False to continue (not abort)

More Information and Examples
top
PercentDone
function MyPercentDone(pctDone: Integer): Integer; cdecl;
Introduced in version 9.5.0.82

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

Return True to abort; return False to continue (not abort)

More Information and Examples
top
ProgressInfo
procedure MyProgressInfo(name: PWideChar; value: PWideChar) cdecl;
Introduced in version 9.5.0.82

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

More Information and Examples
top
TaskCompleted
procedure MyTaskCompleted(task: HCkTask) cdecl;
Introduced in version 9.5.0.82

Called in the background thread when an asynchronous task completes.

top