A class to manage a loose queue of isolated tasks, which can be performed either synchronously (in the foreground thread) or asynchronously (by a background thread).
More...
|
| __init__ (str name) |
|
| add (AsyncTask task) |
| Adds the indicated task to the active queue. It is an error if the task is already added to this or any other active queue. More...
|
|
| cleanup () |
| Stops all threads and messily empties the task list. This is intended to be called on destruction only. More...
|
|
AsyncTask | findTask (str name) |
| Returns the first task found with the indicated name, or NULL if there is no task with the indicated name. More...
|
|
AsyncTaskChain | findTaskChain (str name) |
| Searches a new AsyncTaskChain of the indicated name and returns it if it exists, or NULL otherwise. More...
|
|
AsyncTaskCollection | findTasks (str name) |
| Returns the list of tasks found with the indicated name. More...
|
|
AsyncTaskCollection | findTasksMatching (const GlobPattern pattern) |
| Returns the list of tasks found whose name matches the indicated glob pattern, e.g. "my_task_*". More...
|
|
AsyncTaskCollection | getActiveTasks () |
| Returns the set of tasks that are active (and not sleeping) on the task manager, at the time of the call. More...
|
|
ClockObject | getClock () |
| Returns the clock pointer used within the AsyncTaskManager. See set_clock(). More...
|
|
double | getNextWakeTime () |
| Returns the scheduled time (on the manager's clock) of the next sleeping task, on any task chain, to awaken. Returns -1 if there are no sleeping tasks. More...
|
|
int | getNumTaskChains () |
| Returns the number of different task chains. More...
|
|
int | getNumTasks () |
| Returns the number of tasks that are currently active or sleeping within the task manager. More...
|
|
AsyncTaskCollection | getSleepingTasks () |
| Returns the set of tasks that are sleeping (and not active) on the task manager, at the time of the call. More...
|
|
AsyncTaskChain | getTaskChain (int n) |
| Returns the nth task chain. More...
|
|
list | getTaskChains () |
|
AsyncTaskCollection | getTasks () |
| Returns the set of tasks that are active or sleeping on the task manager, at the time of the call. More...
|
|
bool | hasTask (AsyncTask task) |
| Returns true if the indicated task has been added to this AsyncTaskManager, false otherwise. More...
|
|
AsyncTaskChain | makeTaskChain (str name) |
| Creates a new AsyncTaskChain of the indicated name and stores it within the AsyncTaskManager. If a task chain with this name already exists, returns it instead. More...
|
|
| output (Ostream out) |
|
| poll () |
| Runs through all the tasks in the task list, once, if the task manager is running in single-threaded mode (no threads available). This method does nothing in threaded mode, so it may safely be called in either case. More...
|
|
bool | remove (AsyncTask task) |
| Removes the indicated task from the active queue. Returns true if the task is successfully removed, or false if it wasn't there. More...
|
|
int | remove (const AsyncTaskCollection tasks) |
| Removes all of the tasks in the AsyncTaskCollection. Returns the number of tasks removed. More...
|
|
bool | removeTaskChain (str name) |
| Removes the AsyncTaskChain of the indicated name. If the chain still has tasks, this will block until all tasks are finished. More...
|
|
| setClock (ClockObject clock) |
| Replaces the clock pointer used within the AsyncTaskManager. This is used to control when tasks with a set_delay() specified will be scheduled. It can also be ticked automatically each epoch, if set_tick_clock() is true. More...
|
|
| startThreads () |
| Starts any requested threads to service the tasks on the queue. This is normally not necessary, since adding a task will start the threads automatically. More...
|
|
| stopThreads () |
| Stops any threads that are currently running. If any tasks are still pending and have not yet been picked up by a thread, they will not be serviced unless poll() or start_threads() is later called. More...
|
|
| waitForTasks () |
| Blocks until the task list is empty. More...
|
|
| write (Ostream out, int indent_level) |
|
Public Member Functions inherited from TypedObject |
TypeHandle | getType () |
| Derived classes should override this function to return get_class_type(). More...
|
|
int | getTypeIndex () |
| Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. This is equivalent to get_type().get_index(). More...
|
|
bool | isExactType (TypeHandle handle) |
| Returns true if the current object is the indicated type exactly. More...
|
|
bool | isOfType (TypeHandle handle) |
| Returns true if the current object is or derives from the indicated type. More...
|
|
Public Member Functions inherited from ReferenceCount |
int | getRefCount () |
| Returns the current reference count. More...
|
|
| ref () |
| Explicitly increments the reference count. User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. More...
|
|
bool | testRefCountIntegrity () |
| Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise. More...
|
|
bool | testRefCountNonzero () |
| Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise. More...
|
|
bool | unref () |
| Explicitly decrements the reference count. Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete(). More...
|
|
Public Member Functions inherited from Namable |
| __init__ (const Namable copy) |
|
| __init__ (str initial_name) |
|
| clearName () |
| Resets the Namable's name to empty. More...
|
|
str | getName () |
|
bool | hasName () |
| Returns true if the Namable has a nonempty name set, false if the name is empty. More...
|
|
Namable | operator= (const Namable other) |
|
| output (Ostream out) |
| Outputs the Namable. This function simply writes the name to the output stream; most Namable derivatives will probably redefine this. More...
|
|
| setName (str name) |
|
A class to manage a loose queue of isolated tasks, which can be performed either synchronously (in the foreground thread) or asynchronously (by a background thread).
The AsyncTaskManager is actually a collection of AsyncTaskChains, each of which maintains a list of tasks. Each chain can be either foreground or background (it may run only in the main thread, or it may be serviced by one or more background threads). See AsyncTaskChain for more information.
If you do not require background processing, it is perfectly acceptable to create only one AsyncTaskChain, which runs in the main thread. This is a common configuration.