std::timespec_get(3)

💖 std::timespec_get(3) 💖

Ok bestie, this page is from the C++ Standard Libary — yes, that’s the spelling in the header, and we’re keeping it 😭. Manual name: std::timespec_get(3). Let’s get into it. 🎀

✨ NAME ✨

std::timespec_get - std::timespec_get. Literally the name repeats, and honestly? Iconic. 💅

---

🌸 Synopsis 🌸

Defined in header <ctime> — that’s where this cutie lives.

int timespec_get( std::timespec* ts, int base ); (1) (since C++17)
#define TIME_UTC /* implementation-defined */    (2) (since C++17)

Now the deets, bestie:

1. Modifies the std::timespec object pointed to by ts to hold the current calendar time in the time base base.
2. Expands to a value suitable for use as the base argument of std::timespec_get.

Other macro constants beginning with TIME_ may be provided by the implementation to indicate additional time bases. Keep an eye out 👀

If base is TIME_UTC, then:

• ts->tv_sec is set to the number of seconds since an implementation defined epoch, truncated to a whole value,
• ts->tv_nsec member is set to the integral number of nanoseconds, rounded to the resolution of the system clock.

---

🌼 Parameters 🌼

• ts — pointer to an object of type std::timespec
• base — TIME_UTC or another nonzero integer value indicating the time base

---

💫 Return value 💫

It gives you back the value of base if successful, and zero otherwise. Simple, clean, slay. ✨

---

🦋 Notes 🦋

The POSIX function clock_gettime(CLOCK_REALTIME, ts) may also be used to populate a std::timespec with the time since the Epoch. iykyk 🫶

---

🎀 Example 🎀

// Run this code — go off, bestie:

#include <ctime>
#include <iostream>

int main()
{
    std::timespec ts;
    std::timespec_get(&ts, TIME_UTC);
    char buf[100];
    std::strftime(buf, sizeof buf, "%D %T", std::gmtime(&ts.tv_sec));
    std::cout << "Current time: " << buf << '.' << ts.tv_nsec << " UTC\n";
}

Possible output:

Current time: 06/24/16 20:07:42.949494132 UTC

---

🌈 See also 🌈

• timespec — time in seconds and nanoseconds (C++17) (struct)
• time — returns the current time of the system as time since epoch (function)
• C documentation for timespec_get

💖 That’s the whole page, bestie — source/version: http://cppreference.com; date: 2024.06.10; manual: std::timespec_get(3). Mwah! 💖