kTimer.h

Go to the documentation of this file.

#ifndef K_API_TIMER_H
#define K_API_TIMER_H

#include <kApi/kApiDef.h>
#include <kApi/Threads/kTimer.x.h>

//typedef kObject kTimer;     --forward-declared in kApiDef.x.h 

kInlineFx(k64u) kTimer_Ticks() 
{ 
    return kApiLib_TimerQueryHandler()(); 
}

kInlineFx(k64u) kTimer_FromTicks(k64u ticks) 
{ 
    return ticks * kApiLib_TimerMultiplier() / kApiLib_TimerDivider(); 
}

kInlineFx(k64u) kTimer_ToTicks(k64u time) 
{ 
    return kApiLib_TimerDivider() * time / kApiLib_TimerMultiplier(); 
}

kInlineFx(k64u) kTimer_Now() 
{ 
    return kTimer_FromTicks(kTimer_Ticks()); 
}

kInlineFx(k64u) kTimer_Spin(k64u duration) 
{ 
    k64u startTime = kTimer_Now(); 

    while (kTimer_Now() < (startTime + duration)); 

    return kOK; 
}

kFx(kStatus) kTimer_Construct(kTimer* timer, kAlloc allocator); 

kFx(kStatus) kTimer_Start(kTimer timer, k64u totalTime); 

kFx(kStatus) kTimer_Stop(kTimer timer); 

kFx(kBool) kTimer_IsStarted(kTimer timer);

kFx(kBool) kTimer_IsExpired(kTimer timer);

kFx(k64u) kTimer_Elapsed(kTimer timer); 

kFx(k64u) kTimer_Remaining(kTimer timer); 

#endif