[#BloombergLP-bdlt-CurrentTime]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlt.adoc[bdlt]::CurrentTime
:relfileprefix: ../../
:mrdocs:

Provide a namespace for current‐time retrieval procedures.

== Synopsis

Declared in `<bdlt_currenttime.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct CurrentTime;
----

== 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`).

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/CurrentTime/CurrentTimeCallback-02.adoc[`CurrentTimeCallback`] 
| Callback function type that returns the current time as a time interval.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/CurrentTime/asDatetimeTz.adoc[`asDatetimeTz`] 
| Return the current local date/time with its UTC offset.
| xref:BloombergLP/bdlt/CurrentTime/currentTimeCallback-0c.adoc[`currentTimeCallback`] 
| Return the installed function used to retrieve the interval between `EpochUtil::epoch()` and the current date/time.
| xref:BloombergLP/bdlt/CurrentTime/currentTimeDefault.adoc[`currentTimeDefault`] 
| Provide the default current‐time callback implementation.
| xref:BloombergLP/bdlt/CurrentTime/local.adoc[`local`] 
| Return the current date/time in the local time zone.
| xref:BloombergLP/bdlt/CurrentTime/now.adoc[`now`] 
| Return the current date/time as a time interval from the epoch.
| xref:BloombergLP/bdlt/CurrentTime/setCurrentTimeCallback.adoc[`setCurrentTimeCallback`] 
| Set the callback used to retrieve the current time.
| xref:BloombergLP/bdlt/CurrentTime/utc.adoc[`utc`] 
| Return the current date/time in Coordinated Universal Time (UTC).
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#