Legacy Document

Inside Macintosh: Networking With Open Transport / Part 2 - Open Transport Reference

Chapter 23 - Programming With Open Transport Reference / Functions

Working With Deferred Tasks /

OTScheduleDeferredTask

Schedules a task for execution at deferred task time.

C INTERFACE

Boolean OTScheduleDeferredTask(long dtCookie)

C++ INTERFACE

None. C++ applications use the C interface to this function.

PARAMETERS

dtCookie

A reference that identifies the task to be scheduled. This reference is returned by the OTCreateDeferredTask function used to create the task.

function result

The result is true if the deferred task is scheduled successfully. If the result is false and the dtCookie parameter has a valid value (other than 0), then the task is already scheduled to run. If dtCookie is invalid (a value of 0), the function returns false and does nothing.

DISCUSSION

The OTScheduleDeferredTask function schedules the task (specified by the dtCookie parameter) for execution at the next deferred task time.

You can call the OTScheduleDeferredTask 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 make multiple calls to the OTScheduleDeferredTask function before the task is executed, additional tasks are not scheduled; only one instance of each unique task is scheduled at a time.

WARNING

Open Transport does not keep track of outstanding deferred task requests. It is the caller's responsibility to ensure that all outstanding deferred task requests have either executed or have been cancelled. If this is not done, and the calling process terminates before the deferred task executes, the processor will crash when it attempts to execute the task.

SPECIAL CONSIDERATIONS

You can call this Open Transport function at interrupt time, but you must precede it by calling the OTEnterInterrupt function, and you must follow it by calling the OTLeaveInterrupt function.

SEE ALSO

The OTScheduleInterruptTask function.

The OTCreateDeferredTask function.

The OTDestroyDeferredTask function.

The OTEnterInterrupt function.

The OTLeaveInterrupt function.