VLink  2.3.0
A high-performance communication middleware
vlink::CachedTimestamp Class Referencefinal

Mutable cached generator for short formatted timestamps. More...

#include <cached_timestamp.h>

Collaboration diagram for vlink::CachedTimestamp:

Public Member Functions

 CachedTimestamp ()
 Constructs the generator with an empty internal cache. More...
 
 ~CachedTimestamp ()
 Destructor. More...
 
std::string_view get (const char *format="%02d-%02d %02d:%02d:%02d.%03d", bool use_utc=false)
 Returns a view of the current formatted timestamp. More...
 
std::string_view get_at (std::chrono::system_clock::time_point now, const char *format="%02d-%02d %02d:%02d:%02d.%03d", bool use_utc=false)
 Formats an explicit wall-clock time using the same cache and format contract as get. More...
 

Detailed Description

Mutable cached generator for short formatted timestamps.

Holds a 32-byte buffer and last-second counter protected by a mutex. With the default format, same-second calls patch only the millisecond suffix. Custom formats are rendered in full. Returned views require external synchronization when the instance is shared.

Constructor & Destructor Documentation

◆ CachedTimestamp()

vlink::CachedTimestamp::CachedTimestamp ( )

Constructs the generator with an empty internal cache.

The cache is populated lazily on the first get call.

◆ ~CachedTimestamp()

vlink::CachedTimestamp::~CachedTimestamp ( )

Destructor.

Member Function Documentation

◆ get()

std::string_view vlink::CachedTimestamp::get ( const char *  format = "%02d-%02d %02d:%02d:%02d.%03d",
bool  use_utc = false 
)

Returns a view of the current formatted timestamp.

The returned view points into the internal 32-byte buffer. It is invalidated by the next call to get or get_at on any thread sharing this instance. Copying the view while another thread updates the cache requires external synchronization. Output must fit within 31 characters. Only the default format patches its millisecond suffix; custom formats are rendered in full. Format and timezone changes take effect immediately.

Parameters
formatsnprintf format consuming six int arguments in this order: month, day, hour, minute, second, milliseconds. Default: "%02d-%02d @c %02d:%02d:%02d.%03d".
use_utctrue for UTC formatting; false for local time. Default: false.
Returns
std::string_view over the rendered timestamp.

◆ get_at()

std::string_view vlink::CachedTimestamp::get_at ( std::chrono::system_clock::time_point  now,
const char *  format = "%02d-%02d %02d:%02d:%02d.%03d",
bool  use_utc = false 
)

Formats an explicit wall-clock time using the same cache and format contract as get.

Parameters
nowWall-clock time to render.
formatFormat consuming month, day, hour, minute, second and milliseconds as integers.
use_utcWhether to use UTC instead of local time.
Returns
View valid until the next cache update; empty if conversion or formatting fails.

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