Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kTimer.h
Go to the documentation of this file.
1 
10 #ifndef K_API_TIMER_H
11 #define K_API_TIMER_H
12 
13 #include <kApi/kApiDef.h>
14 #include <kApi/Threads/kTimer.x.h>
15 
22 //typedef kObject kTimer; --forward-declared in kApiDef.x.h
23 
34 {
35  return xkTimer_FromTicks(xkTimer_Ticks());
36 }
37 
46 kFx(kStatus) kTimer_Construct(kTimer* timer, kAlloc allocator);
47 
58 kFx(kStatus) kTimer_Start(kTimer timer, k64u totalTime);
59 
72 kFx(kStatus) kTimer_Stop(kTimer timer);
73 
81 kFx(kBool) kTimer_IsStarted(kTimer timer);
82 
90 kFx(kBool) kTimer_IsExpired(kTimer timer);
91 
99 kFx(k64u) kTimer_Elapsed(kTimer timer);
100 
108 kFx(k64u) kTimer_Remaining(kTimer timer);
109 
110 #endif
kStatus kTimer_Stop(kTimer timer)
Stops the timer.
Represents a 64-bit unsigned integer.
Abstract base class for memory allocator types.
kBool kTimer_IsExpired(kTimer timer)
Reports whether a count-down timer has expired.
#define kInlineFx(TYPE)
Inline method declaration helper.
Definition: kApiDef.h:26
k64u kTimer_Elapsed(kTimer timer)
Reports the duration, in microseconds, for which the timer has been running.
Core Zen type declarations.
k64u kTimer_Now()
Provides the current time in microseconds.
Definition: kTimer.h:33
kBool kTimer_IsStarted(kTimer timer)
Reports whether a timer has been started.
k64u kTimer_Remaining(kTimer timer)
Reports the remaining time, in microseconds, for a countdown timer.
kStatus kTimer_Start(kTimer timer, k64u totalTime)
Starts the timer.
Represents an error code.
kStatus kTimer_Construct(kTimer *timer, kAlloc allocator)
Constructs a timer object.
Represents a boolean value.
Represents an interval timer.