A timer that fires at regular intervals, with a resolution of 1 second.
More...
#include <PulseTimer.h++>
|
| static void | exit () |
| | Exit (terminate) the calling thread. More...
|
| |
A timer that fires at regular intervals, with a resolution of 1 second.
This is an abstract class; subclasses should implement the pulse() method, which is called each time the timer fires. A PulseTimer is intended to run in its own thread.
- Author
- Mark Lindner
◆ PulseTimer()
Construct a new PulseTimer with the given interval and initial delay.
- Parameters
-
| interval | The interval, in seconds, at which the timer will fire. Must be > 0. |
| initialDelay | An initial delay, in seconds, before the timer should begin firing. |
◆ ~PulseTimer()
◆ cleanup()
Cleanup function.
This function will be executed by the thread just prior to termination. The default implementation is a no-op.
Reimplemented from Thread.
◆ currentThread()
Obtain a pointer to the Thread object for the calling thread.
If the calling thread is the main thread, or some other thread that was not created via commonc++, a NULL pointer is returned. Never delete the object returned by this method.
◆ currentThreadID()
Get the calling thread's thread ID.
◆ exit()
Exit (terminate) the calling thread.
◆ getLastPulseTime()
Get the time at which the timer last fired.
- Returns
- The time of the last pulse, where 0 indicates that the timer has not yet fired for the first time.
◆ getName()
Get the name of this thread.
◆ getPriority()
◆ getPulseCount()
| uint32_t getPulseCount |
( |
| ) |
const |
|
inline |
Get the pluse count, i.e., the number of times the timer has fired.
◆ isDetached()
| bool isDetached |
( |
| ) |
const |
|
inlineinherited |
Test if the thread is detached.
◆ isRunning()
Test if the thread is currently running.
◆ join()
Wait for the thread to terminate.
- Returns
- true if the join was successful, false otherwise. Note that threads which were created in a detached state are not joinable.
◆ pulse()
This method is called each time the timer fires.
- Parameters
-
| now | The current system time. |
◆ run()
Main function.
Thread execution begins in this function. The default implementation does nothing.
Reimplemented from Thread.
◆ setName()
| void setName |
( |
const String & |
name | ) |
|
|
inlineinherited |
Set the name of this thread.
◆ setPriority()
◆ sleep()
Suspend the calling thread for the given time interval.
- Parameters
-
| msec | The number of milliseconds to sleep. |
◆ start()
Start executing the thread.
If a Runnable object was supplied in the constructor, its run() method is invoked; otherwise the thread object's run() method is called. If the thread is already running, the call has no effect.
◆ stop()
Stop execution of the thread.
The thread is not forcibly killed; instead, an asynchronous cancellation request is posted to the thread. If the thread is not running, the call has no effect.
◆ testCancel()
Test for asynchronous cancellation requests.
- Returns
- true If a cancellation request has been posted to the calling thread.
◆ trySleep()
Suspend the thread for the given time interval, returning early if the thread was cancelled via a call to stop().
- Parameters
-
| msec | The number of milliseconds to sleep. |
- Returns
- true if the full interval elapsed, false if the thread was cancelled during the sleep.
◆ yield()
Yield the CPU to (potentially) another thread.
The documentation for this class was generated from the following files:
