119 lines
3.1 KiB
C++
119 lines
3.1 KiB
C++
/***
|
|
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"
|
|
|
|
namespace Aurora::Time
|
|
{
|
|
/**
|
|
Converts milliseconds from the Aurora epoch to a civil timestamp structure
|
|
similar to or of std::tm
|
|
*/
|
|
AUKN_SYM tm ToCivilTime(AuInt64 time, bool UTC = true);
|
|
|
|
/**
|
|
Converts civil time to milliseconds from the Aurora epoch
|
|
*/
|
|
AUKN_SYM AuInt64 FromCivilTime(const tm &time, bool UTC = true);
|
|
|
|
|
|
/**
|
|
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);
|
|
|
|
/**
|
|
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);
|
|
|
|
|
|
/**
|
|
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);
|
|
|
|
/**
|
|
Converts seconds from the Aurora epoch to time_t
|
|
@deprecated
|
|
*/
|
|
AUKN_SYM time_t SToCTime(AuInt64 time);
|
|
|
|
/**
|
|
Converts nanoseconds from the Aurora epoch to time_t
|
|
@deprecated
|
|
*/
|
|
AUKN_SYM time_t NSToCTime(AuInt64 time);
|
|
|
|
/**
|
|
Converts milliseconds from the Aurora epoch to time_t
|
|
@deprecated
|
|
*/
|
|
AUKN_SYM time_t MSToCTime(AuInt64 time);
|
|
|
|
AUKN_SYM AuInt64 CTimeToMS(time_t time);
|
|
|
|
/**
|
|
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();
|
|
} |