MockableSteadyClock Struct Reference

Version of SteadyClock that is mockable in the context of tests (via SteadyClockContext, or Self::SetMockTime), otherwise the system steady clock. More...

#include <time.h>

Inheritance diagram for MockableSteadyClock:

Collaboration diagram for MockableSteadyClock:

Public Types
using	time_point = std::chrono::time_point< MockableSteadyClock >
using	mock_time_point = std::chrono::time_point< MockableSteadyClock, std::chrono::milliseconds >

Static Public Member Functions
static time_point	now () noexcept
	Return current system time or mocked time, if set. More...
static std::time_t	to_time_t (const time_point &)=delete
static time_point	from_time_t (std::time_t)=delete
static void	SetMockTime (mock_time_point::duration mock_time_in)
	Set mock time for testing. More...
static void	ClearMockTime ()
	Clear mock time, go back to system steady clock. More...

Static Public Attributes
static constexpr mock_time_point::duration	INITIAL_MOCK_TIME {1}

Detailed Description

Version of SteadyClock that is mockable in the context of tests (via SteadyClockContext, or Self::SetMockTime), otherwise the system steady clock.

Definition at line 46 of file time.h.

Member Typedef Documentation

mock_time_point

using MockableSteadyClock::mock_time_point = std::chrono::time_point<MockableSteadyClock, std::chrono::milliseconds>

Definition at line 49 of file time.h.

time_point

using MockableSteadyClock::time_point = std::chrono::time_point<MockableSteadyClock>

Definition at line 47 of file time.h.

Member Function Documentation

ClearMockTime()

void MockableSteadyClock::ClearMockTime ( )

static

Clear mock time, go back to system steady clock.

Definition at line 82 of file time.cpp.

Here is the caller graph for this function:

from_time_t()

static time_point MockableSteadyClock::from_time_t ( std::time_t  )

staticdelete

now()

MockableSteadyClock::time_point MockableSteadyClock::now ( )

staticnoexcept

Return current system time or mocked time, if set.

Definition at line 63 of file time.cpp.

Here is the caller graph for this function:

SetMockTime()

void MockableSteadyClock::SetMockTime ( mock_time_point::duration  mock_time_in )

static

Set mock time for testing.

When mocking the steady clock, start at INITIAL_MOCK_TIME and add durations to elapse time as necessary for testing. To stop mocking, call ClearMockTime().

Definition at line 76 of file time.cpp.

Here is the caller graph for this function:

to_time_t()

static std::time_t MockableSteadyClock::to_time_t ( const time_point &  )

staticdelete

Member Data Documentation

INITIAL_MOCK_TIME

constexpr mock_time_point::duration MockableSteadyClock::INITIAL_MOCK_TIME {1}

staticconstexpr

Definition at line 50 of file time.h.

---

The documentation for this struct was generated from the following files:

• src/util/time.h
• src/util/time.cpp