bdlt::CurrentTime Struct Reference

#include <bdlt_currenttime.h>

Detailed Description

This struct provides a namespace for current-time-retrieval procedures including a configurable global callback mechanism. The use of a subset of these procedures is thread-safe (see Thread Safety).

See bdlt_currenttime

Public Types
typedef bsls::TimeInterval(*	CurrentTimeCallback) ()

Static Public Member Functions
static Datetime	local ()
static bsls::TimeInterval	now ()
static Datetime	utc ()
static DatetimeTz	asDatetimeTz ()
static CurrentTimeCallback	currentTimeCallback ()
static CurrentTimeCallback	setCurrentTimeCallback (CurrentTimeCallback callback)
static bsls::TimeInterval	currentTimeDefault ()

Member Typedef Documentation

CurrentTimeCallback

typedef bsls::TimeInterval(* bdlt::CurrentTime::CurrentTimeCallback) ()

CurrentTimeCallback is a callback function pointer for a callback function that returns a bsls::TimeInterval object. This function must be thread-safe in multi-threaded builds.

Member Function Documentation

asDatetimeTz()

static DatetimeTz bdlt::CurrentTime::asDatetimeTz ( )

static

Return the DatetimeTz value representing the current date/time in the local time zone, and the local time zone's offset from UTC, as provided by the installed callback function and the facilities of LocalTimeOffset.

currentTimeCallback()

CurrentTime::CurrentTimeCallback bdlt::CurrentTime::currentTimeCallback ( )

inlinestatic

Return the installed function used to retrieve the interval between EpochUtil::epoch() and the current date/time,

currentTimeDefault()

static bsls::TimeInterval bdlt::CurrentTime::currentTimeDefault ( )

static

Return the TimeInterval value between EpochUtil::epoch() and the current date/time. This is the default current-time callback implementation for current time retrieval. The obtained time is expressed as a time interval from 00:00 UTC, January 1, 1970. The resolution is:

• Unix DG-Unix: microsecond resolution
• Linux: nanosecond resolution
• Solaris: 5 nanosecond resolution
• Windows 11: 1-5 millisecond resolution

local()

Datetime bdlt::CurrentTime::local ( )

inlinestatic

Return the Datetime value representing the current date/time in the local time zone, as provided by the installed callback function and the facilities of LocalTimeOffset.

now()

bsls::TimeInterval bdlt::CurrentTime::now ( )

inlinestatic

Return the TimeInterval value between EpochUtil::epoch() and the current date/time as provided by the installed callback function.

Note

Note that this value is independent of time zone.

setCurrentTimeCallback()

CurrentTime::CurrentTimeCallback bdlt::CurrentTime::setCurrentTimeCallback ( CurrentTimeCallback  callback )

inlinestatic

Set the specified callback as the function to be used to retrieve the interval between EpochUtil::epoch() and the current date/time, and return the previously set function.

utc()

Datetime bdlt::CurrentTime::utc ( )

inlinestatic

Return the Datetime value representing the current date/time in Coordinated Universal Time (UTC) as provided by the installed callback function.

---

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

• bdlt_currenttime.h