LLRunner Class Reference
This class manages a set of LLRunnable objects. More...
#include <llrun.h>
Public Types | |
| enum | ERunSchedule { RUN_IN, RUN_EVERY, RUN_SCHEDULE_COUNT } |
| Enumeration which specifies when to run. More... | |
| typedef boost::shared_ptr < LLRunnable > | run_ptr_t |
| The pointer to a runnable. | |
| typedef S64 | run_handle_t |
| The handle for use in the API. | |
Public Member Functions | |
| LLRunner () | |
| Constructor. | |
| ~LLRunner () | |
| Destructor. | |
| S32 | run () |
| Run the runnables which are scheduled to run. | |
| run_handle_t | addRunnable (run_ptr_t runnable, ERunSchedule schedule, F64 seconds) |
| Add a runnable to the run list. | |
| run_ptr_t | removeRunnable (run_handle_t handle) |
| Remove the specified runnable. | |
Protected Types | |
| typedef std::vector< LLRunInfo > | run_list_t |
Protected Attributes | |
| run_list_t | mRunOnce |
| run_list_t | mRunEvery |
| run_handle_t | mNextHandle |
Classes | |
| struct | LLRunInfo |
Detailed Description
This class manages a set of LLRunnable objects.An instance of this class has a collection of LLRunnable objects which are scheduled to run on a repeating or one time basis.
- See also:
- LLRunnable
Definition at line 50 of file llrun.h.
Member Typedef Documentation
| typedef boost::shared_ptr<LLRunnable> LLRunner::run_ptr_t |
| typedef S64 LLRunner::run_handle_t |
typedef std::vector<LLRunInfo> LLRunner::run_list_t [protected] |
Member Enumeration Documentation
Constructor & Destructor Documentation
| LLRunner::~LLRunner | ( | ) |
Member Function Documentation
| S32 LLRunner::run | ( | void | ) |
Run the runnables which are scheduled to run.
- Returns:
- Returns the number of runnables run.
Definition at line 55 of file llrun.cpp.
References LLFrameTimer::getTotalSeconds(), mRunEvery, and mRunOnce.
Referenced by LLPumpIO::pump(), and LLApp::stepFrame().
| LLRunner::run_handle_t LLRunner::addRunnable | ( | run_ptr_t | runnable, | |
| ERunSchedule | schedule, | |||
| F64 | seconds | |||
| ) |
Add a runnable to the run list.
The handle of the runnable is unique to each addition. If the same runnable is added a second time with the same or different schedule, this method will return a new handle.
- Parameters:
-
runnable The runnable to run() on schedule. schedule Specifies the run schedule. seconds When to run the runnable as interpreted by schedule.
- Returns:
- Returns the handle to the runnable. handle == 0 means failure.
Definition at line 103 of file llrun.cpp.
References LLFrameTimer::getTotalSeconds(), indra::ipc::xml_rpc::handle(), INVALID_RUN_HANDLE, mNextHandle, mRunEvery, mRunOnce, RUN_EVERY, and RUN_IN.
Referenced by LLPumpIO::sleepChain().
| LLRunner::run_ptr_t LLRunner::removeRunnable | ( | LLRunner::run_handle_t | handle | ) |
Member Data Documentation
run_list_t LLRunner::mRunOnce [protected] |
Definition at line 136 of file llrun.h.
Referenced by addRunnable(), removeRunnable(), run(), and ~LLRunner().
run_list_t LLRunner::mRunEvery [protected] |
Definition at line 137 of file llrun.h.
Referenced by addRunnable(), removeRunnable(), run(), and ~LLRunner().
run_handle_t LLRunner::mNextHandle [protected] |
The documentation for this class was generated from the following files:
