time.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-present The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef BITCOIN_UTIL_TIME_H
#define BITCOIN_UTIL_TIME_H
 
// The `util/time.h` header is designed to be a drop-in replacement for `chrono`.
#include <chrono> // IWYU pragma: export
#include <cstdint>
#include <ctime>
#include <optional>
#include <string>
#include <string_view>
 
#ifdef WIN32
#include <winsock2.h>
#else
#include <sys/time.h>
#endif
 
using namespace std::chrono_literals;
 
struct NodeClock : public std::chrono::system_clock {
    using time_point = std::chrono::time_point<NodeClock>;
    static time_point now() noexcept;
    static std::time_t to_time_t(const time_point&) = delete; // unused
    static time_point from_time_t(std::time_t) = delete;      // unused
    static constexpr time_point epoch{};
};
using NodeSeconds = std::chrono::time_point<NodeClock, std::chrono::seconds>;
 
using SteadyClock = std::chrono::steady_clock;
using SteadySeconds = std::chrono::time_point<std::chrono::steady_clock, std::chrono::seconds>;
using SteadyMilliseconds = std::chrono::time_point<std::chrono::steady_clock, std::chrono::milliseconds>;
using SteadyMicroseconds = std::chrono::time_point<std::chrono::steady_clock, std::chrono::microseconds>;
 
using SystemClock = std::chrono::system_clock;
 
struct MockableSteadyClock : public std::chrono::steady_clock {
    using time_point = std::chrono::time_point<MockableSteadyClock>;
 
    using mock_time_point = std::chrono::time_point<MockableSteadyClock, std::chrono::milliseconds>;
    static constexpr mock_time_point::duration INITIAL_MOCK_TIME{1};
 
    static time_point now() noexcept;
    static std::time_t to_time_t(const time_point&) = delete; // unused
    static time_point from_time_t(std::time_t) = delete;      // unused
 
    static void SetMockTime(mock_time_point::duration mock_time_in);
 
    static void ClearMockTime();
};
 
void UninterruptibleSleep(const std::chrono::microseconds& n);
 
template <typename Dur1, typename Dur2>
constexpr auto Ticks(Dur2 d)
{
    return std::chrono::duration_cast<Dur1>(d).count();
}
 
template <typename Duration>
constexpr int64_t TicksSeconds(Duration d)
{
    return int64_t{Ticks<std::chrono::seconds>(d)};
}
template <typename Duration, typename Timepoint>
constexpr auto TicksSinceEpoch(Timepoint t)
{
    return Ticks<Duration>(t.time_since_epoch());
}
constexpr int64_t count_seconds(std::chrono::seconds t) { return t.count(); }
constexpr int64_t count_milliseconds(std::chrono::milliseconds t) { return t.count(); }
constexpr int64_t count_microseconds(std::chrono::microseconds t) { return t.count(); }
 
using HoursDouble = std::chrono::duration<double, std::chrono::hours::period>;
using SecondsDouble = std::chrono::duration<double, std::chrono::seconds::period>;
using MillisecondsDouble = std::chrono::duration<double, std::chrono::milliseconds::period>;
 
int64_t GetTime();
 
void SetMockTime(int64_t nMockTimeIn);
 
void SetMockTime(std::chrono::seconds mock_time_in);
void SetMockTime(std::chrono::time_point<NodeClock, std::chrono::seconds> mock);
 
std::chrono::seconds GetMockTime();
 
template <typename T>
T Now()
{
    return std::chrono::time_point_cast<typename T::duration>(T::clock::now());
}
template <typename T>
T GetTime()
{
    return Now<std::chrono::time_point<NodeClock, T>>().time_since_epoch();
}
 
std::string FormatISO8601DateTime(int64_t nTime);
std::string FormatISO8601Date(int64_t nTime);
std::optional<int64_t> ParseISO8601DateTime(std::string_view str);
 
std::string FormatRFC1123DateTime(int64_t nTime);
 
struct timeval MillisToTimeval(int64_t nTimeout);
 
struct timeval MillisToTimeval(std::chrono::milliseconds ms);
 
#endif // BITCOIN_UTIL_TIME_H