BlackTopp Studios inc
The interface for a WorkUnit that will keep running when the rest of the scheduler is paused. More...
#include <asynchronousworkunit.h>
Inheritance diagram for Mezzanine::Threading::iAsynchronousWorkUnit: Collaboration diagram for Mezzanine::Threading::iAsynchronousWorkUnit:Public Member Functions | |
| virtual RunningState | IsWorkDone ()=0 |
| This will atomically allow any thread to check if this WorkUnit has completed its work. More... | |
| Public Member Functions inherited from Mezzanine::Threading::DefaultWorkUnit | |
| DefaultWorkUnit () | |
| Simple constructor. | |
| virtual | ~DefaultWorkUnit () |
| Virtual destructor, doesn't actually do much. | |
| virtual void | AddDependency (iWorkUnit *NewDependency) |
| Force this WorkUnit to Start after another has completed. More... | |
| virtual void | ClearDependencies () |
| Drop any information about what work units this one depends on. | |
| virtual iWorkUnit * | GetDependency (Whole Index) const |
| This is used to iterate of all the dependencies. More... | |
| virtual Whole | GetDependencyCount () const |
| How many other WorkUnits does this one depend on? More... | |
| virtual Whole | GetDependentCount (FrameScheduler &SchedulerToCount) |
| This returns the count workunits that depend on this work unit. More... | |
| virtual Whole | GetImmediateDependencyCount () const |
| Get the amount of dependencies that directly count on this for access purposes. More... | |
| virtual Whole | GetPerformance () const |
| Get the internal rolling average for querying. More... | |
| virtual RollingAverage< Whole > & | GetPerformanceLog () |
| Get the internal rolling average for querying. More... | |
| virtual RunningState | GetRunningState () const |
| Retrieves the current RunningState of the thread. More... | |
| virtual WorkUnitKey | GetSortingKey (FrameScheduler &SchedulerToCount) |
| Get the sorting metadata. More... | |
| virtual bool | IsEveryDependencyComplete () |
| Check if this WorkUnit could concievably run right now. More... | |
| virtual void | operator() (DefaultThreadSpecificStorage::Type &CurrentThreadStorage) |
| This does everything required to track metadata and log work. More... | |
| virtual void | PrepareForNextFrame () |
| This resets the running state and takes any further action required to use the WorkUnit again. | |
| virtual void | RemoveDependency (iWorkUnit *RemoveDependency) |
| Remove a dependency. More... | |
| virtual RunningState | TakeOwnerShip () |
| Attempts to atomically start the work unit in the current thread. More... | |
| Public Member Functions inherited from Mezzanine::Threading::iWorkUnit | |
| virtual | ~iWorkUnit () |
| Virtual destructor. | |
| virtual void | DoWork (DefaultThreadSpecificStorage::Type &CurrentThreadStorage)=0 |
| WorkUnits Must implement these to do the work. | |
Additional Inherited Members | |
| Protected Attributes inherited from Mezzanine::Threading::DefaultWorkUnit | |
| Int32 | CurrentRunningState |
| This controls do work with this after it has. | |
| std::vector< iWorkUnit * > | Dependencies |
| A collection of of workunits that must be complete before this one can start. | |
| DefaultRollingAverage< Whole >::Type | PerformanceLog |
| A rolling average of execution times. | |
The interface for a WorkUnit that will keep running when the rest of the scheduler is paused.
Definition at line 59 of file asynchronousworkunit.h.
|
pure virtual |
This will atomically allow any thread to check if this WorkUnit has completed its work.
Implemented in Mezzanine::Threading::AsynchronousFileLoadWorkUnit.
1.8.9.1. Thanks to the
Open Icon Library
for help with some of the icons.
