ripple::TimeKeeperImpl Class Reference

Inheritance diagram for ripple::TimeKeeperImpl:

Collaboration diagram for ripple::TimeKeeperImpl:

Public Types
using	rep = typename NetClock ::rep
using	period = typename NetClock ::period
using	duration = typename NetClock ::duration
using	time_point = typename NetClock ::time_point
using	clock_type = NetClock

Public Member Functions
	TimeKeeperImpl (beast::Journal j)
void	run (std::vector< std::string > const &servers) override
	Launch the internal thread. More...
time_point	now () const override
	Returns the estimate of wall time, in network time. More...
time_point	closeTime () const override
	Returns the close time, in network time. More...
void	adjustCloseTime (std::chrono::duration< std::int32_t > amount) override
	Adjust the close time. More...
std::chrono::duration< std::int32_t >	nowOffset () const override
std::chrono::duration< std::int32_t >	closeOffset () const override
virtual time_point	now () const=0
	Returns the current time. More...

Static Public Attributes
static const bool	is_steady

Static Private Member Functions
static time_point	adjust (std::chrono::system_clock::time_point when)

Private Attributes
const beast::Journal	j_
std::mutex	mutex_
std::chrono::duration< std::int32_t >	closeOffset_
std::unique_ptr< SNTPClock >	clock_

Detailed Description

Definition at line 28 of file TimeKeeper.cpp.

Member Typedef Documentation

rep

using beast::abstract_clock< NetClock >::rep = typename NetClock ::rep

inherited

Definition at line 60 of file abstract_clock.h.

period

using beast::abstract_clock< NetClock >::period = typename NetClock ::period

inherited

Definition at line 61 of file abstract_clock.h.

duration

using beast::abstract_clock< NetClock >::duration = typename NetClock ::duration

inherited

Definition at line 62 of file abstract_clock.h.

time_point

using beast::abstract_clock< NetClock >::time_point = typename NetClock ::time_point

inherited

Definition at line 63 of file abstract_clock.h.

clock_type

using beast::abstract_clock< NetClock >::clock_type = NetClock

inherited

Definition at line 64 of file abstract_clock.h.

Constructor & Destructor Documentation

TimeKeeperImpl()

ripple::TimeKeeperImpl::TimeKeeperImpl ( beast::Journal  j )

explicit

Definition at line 45 of file TimeKeeper.cpp.

Member Function Documentation

adjust()

static time_point ripple::TimeKeeperImpl::adjust ( std::chrono::system_clock::time_point  when )

staticprivate

Definition at line 38 of file TimeKeeper.cpp.

run()

void ripple::TimeKeeperImpl::run ( std::vector< std::string > const &  servers )

overridevirtual

Launch the internal thread.

The internal thread synchronizes local network time using the provided list of SNTP servers.

Implements ripple::TimeKeeper.

Definition at line 51 of file TimeKeeper.cpp.

now() [1/2]

time_point ripple::TimeKeeperImpl::now ( ) const

overridevirtual

Returns the estimate of wall time, in network time.

The network time is wall time adjusted for the Ripple epoch, the beginning of January 1st, 2000 UTC. Each server can compute a different value for network time. Other servers value for network time is not directly observable, but good guesses can be made by looking at validators' positions on close times.

Servers compute network time by adjusting a local wall clock using SNTP and then adjusting for the epoch.

Implements ripple::TimeKeeper.

Definition at line 57 of file TimeKeeper.cpp.

closeTime()

time_point ripple::TimeKeeperImpl::closeTime ( ) const

overridevirtual

Returns the close time, in network time.

Close time is the time the network would agree that a ledger closed, if a ledger closed right now.

The close time represents the notional "center" of the network. Each server assumes its clock is correct, and tries to pull the close time towards its measure of network time.

Implements ripple::TimeKeeper.

Definition at line 64 of file TimeKeeper.cpp.

adjustCloseTime()

void ripple::TimeKeeperImpl::adjustCloseTime ( std::chrono::duration< std::int32_t >  amount )

overridevirtual

Adjust the close time.

This is called in response to received validations.

Implements ripple::TimeKeeper.

Definition at line 71 of file TimeKeeper.cpp.

nowOffset()

std::chrono::duration<std::int32_t> ripple::TimeKeeperImpl::nowOffset ( ) const

overridevirtual

Implements ripple::TimeKeeper.

Definition at line 100 of file TimeKeeper.cpp.

closeOffset()

std::chrono::duration<std::int32_t> ripple::TimeKeeperImpl::closeOffset ( ) const

overridevirtual

Implements ripple::TimeKeeper.

Definition at line 109 of file TimeKeeper.cpp.

now() [2/2]

virtual time_point beast::abstract_clock< NetClock >::now ( ) const

pure virtualinherited

Returns the current time.

Member Data Documentation

j_

const beast::Journal ripple::TimeKeeperImpl::j_

private

Definition at line 31 of file TimeKeeper.cpp.

mutex_

std::mutex ripple::TimeKeeperImpl::mutex_

mutableprivate

Definition at line 32 of file TimeKeeper.cpp.

closeOffset_

std::chrono::duration<std::int32_t> ripple::TimeKeeperImpl::closeOffset_

private

Definition at line 33 of file TimeKeeper.cpp.

clock_

std::unique_ptr<SNTPClock> ripple::TimeKeeperImpl::clock_

private

Definition at line 34 of file TimeKeeper.cpp.

is_steady

const bool beast::abstract_clock< NetClock >::is_steady

staticinherited

Definition at line 66 of file abstract_clock.h.