OTScheduleDeferredTask
Schedules a task for execution at deferred task time.C INTERFACE
Boolean OTScheduleDeferredTask(long dtCookie)C++ INTERFACES
None. C++ applications use the C interface to this function.PARAMETERS
dtCookie- A reference that identifies the task to be scheduled.
DESCRIPTION
TheOTScheduleDeferredTaskfunction schedules for execution at the next deferred task time the task associated with thedtCookieparameter, which is the reference returned by theOTCreateDeferredTaskfunction.You can call this function at any time. If you have not yet destroyed a task, you can use this function to reschedule the same task more than once.
If you makes multiple calls to the
OTScheduleDeferredTaskfunction before the task is executed, additional tasks are not scheduled; only one instance of each unique task can only be scheduled at a time.This function returns
trueif it scheduled the deferred task successfully,falseif not. If it returnsfalseand thedtCookieparameter has a valid value (other than 0), then the task is already scheduled to run. IfdtCookieis invalid (a value of 0), the function returnsfalseand does nothing.If you want to call Open Transport from an interrupt, you can use this function (and the
OTCreateDeferredTaskfunction) instead of the standard Deferred Task Manager functionDTInstallto create a deferred task that permits you to call Open Transport function calls. This allows Open Transport to adapt to changes in the underlying operating system without affecting the client's code.SPECIAL CONSIDERATIONS
You can call this Open Transport function at interrupt time, but you must precede it by calling theOTEnterInterruptfunction and you must follow it by calling theOTLeaveInterruptfunction.SEE ALSO
To create a deferred task for execution at deferred task time, call theOTCreateDeferredTaskfunction (page 7-14).To destroy a task created with the
OTCreateDeferredTaskfunction, call theOTDestroyDeferredTaskfunction (page 7-18).Before making this call from within an interrupt, use the
OTEnterInterruptfunction (page 7-19).After you have made this call from within an an interrupt, use the
OTLeaveInterruptfunction (page 7-20).