CkTask Ruby Reference Documentation
CkTask
Current Version: 10.1.0
Represents a single task to be run in a background thread.
Object Creation
obj = Chilkat::CkTask.new()
Properties
DebugLogFilePath
# ckStr is a CkString
task.get_DebugLogFilePath(ckStr);
strVal = task.debugLogFilePath();
task.put_DebugLogFilePath(strVal);
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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
Finished
boolVal = task.get_Finished();
true if the task status is "canceled", "aborted", or "completed". A task 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.
topInert
boolVal = task.get_Inert();
true if the task status is "empty" or "loaded". When a task is inert, it has been loaded but is not scheduled to run yet.
topKeepProgressLog
boolVal = task.get_KeepProgressLog();
task.put_KeepProgressLog(boolVal);
Determines if the in-memory progress info event log is kept. The default value is false and therefore no log is kept. To enable progress info logging, set this property equal to true (prior to running the task).
topLastErrorHtml
# ckStr is a CkString
task.get_LastErrorHtml(ckStr);
strVal = task.lastErrorHtml();
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.
topLastErrorText
# ckStr is a CkString
task.get_LastErrorText(ckStr);
strVal = task.lastErrorText();
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.
LastErrorXml
# ckStr is a CkString
task.get_LastErrorXml(ckStr);
strVal = task.lastErrorXml();
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.
topLastMethodSuccess
boolVal = task.get_LastMethodSuccess();
task.put_LastMethodSuccess(boolVal);
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.
topLive
boolVal = task.get_Live();
true if the task status is "queued" or "running". When a task is live, it is either already running, or is on the thread pool thread's queue waiting for a thread to become available.
topPercentDone
intVal = task.get_PercentDone();
Indicates the percent completion while the task is running. The percent completed information is only available in cases where it is possible to know the percentage completed. For some methods, it is never possible to know, such as for methods that establish TCP or TLS connections. For other methods it is always possible to know -- such as for sending email (because the size of the email to be sent is already known). For some methods, it may or may not be possible to know the percent completed. For example, if an HTTP response is "chunked", there is no Content-Length header and therefore the receiver has no knowledge of the size of the forthcoming response body.
Also, the value of the PercentDoneScale property of the asynchronous method's object determines the scale, such as 0 to 100, or 0 to 1000, etc.
topProgressLogSize
intVal = task.get_ProgressLogSize();
What would normally be a ProgressInfo event callback (assuming Chilkat supports event callbacks for this language) is instead saved to an in-memory progress log that can be examined and pruned while the task is still running. This property returns the number of progress log entries that are currently available. (Note: the progress log is only kept if the KeepProgressLog property is turned on. By default, the KeepProgressLog is turned off.)
topResultErrorText
# ckStr is a CkString
task.get_ResultErrorText(ckStr);
strVal = task.resultErrorText();
The LastErrorText for the task's asynchronous method.
topResultType
Indicates the data type of the task's result. This property is only available after the task has completed. Possible values are "bool", "int", "string", "bytes", "object", and "void". For example, if the result data type is "bool", then call GetResultBool to get the boolean result of the underlying asynchronous method.
For example, if the synchronous version of the method returned a boolean, then in the asynchronous version of the method, the boolean return value is made available via the GetResultBool method.
topStatus
The current status of the task. Possible values are:
- "empty" -- The method call and arguments are not yet loaded into the task object. This can only happen if a task was explicitly created instead of being returned by a method ending in "Async".
- "loaded" -- The method call and arguments are loaded into the task object.
- "queued" -- The task is in the thread pool's queue of tasks awaiting to be run.
- "running" -- The task is currently running.
- "canceled" -- The task was canceled before it entered the "running" state.
- "aborted" -- The task was canceled while it was in the running state.
- "completed" -- The task completed. The success or failure depends on the semantics of the method call and the value of the result.
StatusInt
intVal = task.get_StatusInt();
The current status of the task as an integer value. Possible values are:
- 1 -- The method call and arguments are not yet loaded into the task object. This can only happen if a task was explicitly created instead of being returned by a method ending in "Async".
- 2 -- The method call and arguments are loaded into the task object.
- 3 -- The task is in the thread pool's queue of tasks awaiting to be run.
- 4 -- The task is currently running.
- 5 -- The task was canceled before it entered the "running" state.
- 6 -- The task was canceled while it was in the running state.
- 7 -- The task completed. The success or failure depends on the semantics of the method call and the value of the result.
TaskId
intVal = task.get_TaskId();
A unique integer ID assigned to this task. The purpose of this property is to help an application identify the task if a TaskCompleted event callback is used.
topTaskSuccess
boolVal = task.get_TaskSuccess();
This is the value of the LastMethodSuccess property of the underlying task object. This property is only valid for those methods where the LastMethodSuccess property would be valid had the method been called synchronously.
Important: This property is only meaningful for cases where the underlying method call has a non-boolean return value (such as for methods that return strings, other Chilkat objects, or integers). If the underlying method call returns a boolean, then call the GetResultBool() method instead to get the boolean return value.
topUserData
# ckStr is a CkString
task.get_UserData(ckStr);
strVal = task.userData();
task.put_UserData(strVal);
An application may use this property to attach some user-specific information with the task, which may be useful if a TaskCompleted event callback is used.
topUtf8
boolVal = task.get_Utf8();
task.put_Utf8(boolVal);
When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.
topVerboseLogging
boolVal = task.get_VerboseLogging();
task.put_VerboseLogging(boolVal);
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.
topVersion
Methods
Cancel
Marks an asynchronous task for cancellation. The expected behavior depends on the current status of the task as described here:
- "loaded" - If the task has been loaded but has not yet been queued to run in the thread pool, then there is nothing to do. (There is nothing to cancel because the task's Run method has not yet been called.) The task will remain in the "loaded" state.
- "queued" - The task is marked for cancellation, is dequeued, and will not run. The task's status changes immediately to "canceled".
- "running" - The already-running task is marked for cancellation. The task's status will eventually change to "aborted" when the asynchronous method returns. At that point in time, the ResultErrorText property will contain the "LastErrorText" of the method call. In the case where a task is marked for cancellation just at the time it's completing, the task status may instead change to "completed".
- "canceled", "aborted", "completed" - In these cases the task has already finished, and there will be no change in status.
Important: Calling the Cancel method marks a task for cancellation. It sets a flag in memory that the running task will soon notice and then abort. It is important to realize that your application is likely calling Cancel from the main UI thread, whereas the asynchronous task is running in a background thread. If the task was in the "running" state when Cancel was called, it will still be in the "running" state when Cancel returns. It will take a short amount of time until the task actually aborts. This is because operating systems schedule threads in time slices, and the thread needs one or more time slices to notice the cancellation flag and abort. After calling Cancel, your application might wish to call the Wait method to wait until the task has actually aborted, or it could periodically check the task's status and then react once the status changes to "aborted".
topClearProgressLog
Removes all entries from the progress info log.
topCopyResultBytes
Returns the binary bytes result of the task. The bytes are copied to the caller.
Returns true for success, false for failure.
topGetResultBool
Returns the boolean result of the task.
topGetResultBytes
Returns the binary bytes result of the task. The bytes are transferred to the caller, not copied. Call CopyResultBytes instead to copy the result bytes.
Returns true for success, false for failure.
topGetResultInt
Returns the integer result of the task.
topGetResultString
status = task.GetResultString(outStr);
retStr = task.getResultString();
ProgressInfoName
# outStr is a CkString (output)
status = task.ProgressInfoName(index, outStr);
retStr = task.progressInfoName(index);
Returns the name of the Nth progress info event logged. The 1st entry is at index 0.
Returns true for success, false for failure.
ProgressInfoValue
# outStr is a CkString (output)
status = task.ProgressInfoValue(index, outStr);
retStr = task.progressInfoValue(index);
Returns the value of the Nth progress info event logged. The 1st entry is at index 0.
Returns true for success, false for failure.
topRemoveProgressInfo
task.RemoveProgressInfo(index);
Removes the Nth progress info log entry.
topRun
Queues the task to run on the internal Chilkat thread pool.
Returns true for success, false for failure.
topRunSynchronously
Runs the task synchronously. Then this method returns after the task has been run.
Returns true for success, false for failure.
topSleepMs
task.SleepMs(numMs);
Convenience method to force the calling thread to sleep for a number of milliseconds. (This does not cause the task's background thread to sleep.)
topWait
status = task.Wait(maxWaitMs);
Waits for the task to complete. Returns when task has completed, or after maxWaitMs milliseconds have elapsed. (A maxWaitMs value of 0 is to wait indefinitely.) Returns (false) if the task has not yet been started by calling the Run method, or if the maxWaitMs expired. If the task completed, was already completed, was canceled or aborted, then this method returns true.
Returns true for success, false for failure.
top