AuroraRuntime/Include/Aurora/Time/Clock.hpp

124 lines
3.2 KiB
C++
Raw Normal View History

2021-06-27 21:25:29 +00:00
/***
Copyright (C) 2021 J Reece Wilson (a/k/a "Reece"). All rights reserved.
File: Clock.hpp
Date: 2021-6-10
Author: Reece
***/
#pragma once
#include "ETimezoneShift.hpp"
#include "TM.hpp"
2021-06-27 21:25:29 +00:00
namespace Aurora::Time
{
/**
Converts milliseconds from the Aurora epoch to a civil timestamp structure
similar to or of std::tm
Range: 1900 -> 2001 +- 2^63-1 ms
*/
AUKN_SYM tm ToCivilTime(AuInt64 time, bool UTC = true);
2021-06-27 21:25:29 +00:00
/**
Converts civil time to milliseconds from the Aurora epoch
Range: 1900 -> 2001 +- 2^63-1 ms
*/
AUKN_SYM AuInt64 FromCivilTime(const tm &time, bool UTC = true);
2021-06-27 21:25:29 +00:00
/**
Normalizes a civil data structure with respect to UTC, given the two input parameters 'in' civil and 'shiftFrom' timezone hint
*/
AUKN_SYM tm NormalizeCivilTimezone(const tm &in, ETimezoneShift shiftFrom = ETimezoneShift::eUTC);
2021-06-27 21:25:29 +00:00
/**
Retrieves system clock in jiffies
*/
AUKN_SYM AuUInt64 CurrentClock();
/**
Retrieves system clock in milliseconds from the Aurora epoch
*/
AUKN_SYM AuUInt64 CurrentClockMS();
/**
Retrieves system clock in nanoseconds from the Aurora epoch
*/
AUKN_SYM AuUInt64 CurrentClockNS();
/**
Translates the Aurora epoch to the standard unix epoch
*/
AUKN_SYM AuInt64 ConvertAuroraToUnixMS(AuInt64 in);
/**
Translates the Aurora epoch to the standard unix epoch
*/
AUKN_SYM AuInt64 ConvertAuroraToUnixNS(AuInt64 in);
/**
Translates a standard unix epoch to the Aurora epoch
*/
AUKN_SYM AuInt64 ConvertUnixToAuroraMS(AuInt64 in);
/**
Translates a standard unix epoch to the Aurora epoch
*/
AUKN_SYM AuInt64 ConvertUnixToAuroraNS(AuInt64 in);
2021-06-27 21:25:29 +00:00
/**
Returns a high resolution count of jiffies with an undefined epoch from a
high resolution clock.
These values should not nor can be accurately converted meaningfully
*/
AUKN_SYM AuUInt64 CurrentInternalClock();
AUKN_SYM AuUInt64 CurrentInternalClockMS();
AUKN_SYM AuUInt64 CurrentInternalClockNS();
/**
Let's say you're fucked and you need a ball park figure.
Enjoy...
*/
AUKN_SYM AuUInt64 ConvertInternalToAuroraEpochMS(AuUInt64 in);
AUKN_SYM AuUInt64 ConvertInternalToAuroraEpochNS(AuUInt64 in);
2021-06-27 21:25:29 +00:00
/**
Converts seconds from the Aurora epoch to time_t
@deprecated
2021-06-27 21:25:29 +00:00
*/
AUKN_SYM time_t SToCTime(AuInt64 time);
2021-06-27 21:25:29 +00:00
/**
Converts nanoseconds from the Aurora epoch to time_t
@deprecated
2021-06-27 21:25:29 +00:00
*/
AUKN_SYM time_t NSToCTime(AuInt64 time);
2021-06-27 21:25:29 +00:00
/**
Converts milliseconds from the Aurora epoch to time_t
@deprecated
2021-06-27 21:25:29 +00:00
*/
AUKN_SYM time_t MSToCTime(AuInt64 time);
2021-06-27 21:25:29 +00:00
AUKN_SYM AuInt64 CTimeToMS(time_t time);
2021-06-27 21:25:29 +00:00
/**
Retrieves the freqency as a fraction of: jiffies per second / 1 * nanoseconds in a second
*/
AUKN_SYM double CPUFrequencyDeltaNS();
/**
Retrieves the freqency as a fraction of: jiffies per second / 1 * milliseconds in a second
*/
AUKN_SYM double CPUFrequencyDeltaMS();
/**
Retrieves the freqency of jiffies per second
*/
AUKN_SYM AuUInt64 ClockJiffies();
}