types.hxx File Reference

#include <time.h>
#include <chrono>
#include <cosmos/types.hxx>

Go to the source code of this file.

Classes
class	cosmos::TimeSpec< CLOCK >
	A C++ wrapper around the POSIX struct timespec coupled to a specific CLOCK type. More...

Typedefs
using	cosmos::AtomicRealTime = TimeSpec<ClockType::ATOMIC_REALTIME>
using	cosmos::BootTime = TimeSpec<ClockType::BOOTTIME>
using	cosmos::CoarseMonotonicTime = TimeSpec<ClockType::MONOTONIC_COARSE>
using	cosmos::MonotonicTime = TimeSpec<ClockType::MONOTONIC>
using	cosmos::RawMonotonicTime = TimeSpec<ClockType::MONOTONIC_RAW>
using	cosmos::ProcessCpuTime = TimeSpec<ClockType::PROCESS_CPUTIME>
using	cosmos::CoarseRealTime = TimeSpec<ClockType::REALTIME_COARSE>
using	cosmos::RealTime = TimeSpec<ClockType::REALTIME>
using	cosmos::ThreadCpuTime = TimeSpec<ClockType::THREAD_CPUTIME>
using	cosmos::IntervalTime = TimeSpec<ClockType::INVALID>
	TimeSpec used for relative time specifications not based on absolute clock time.

Enumerations
enum class	cosmos::ClockTicks : clock_t
	Type used to express time in clock ticks unit in some APIs. More...
enum class	cosmos::ClockType : clockid_t {   REALTIME = CLOCK_REALTIME , REALTIME_COARSE = CLOCK_REALTIME_COARSE , ATOMIC_REALTIME = CLOCK_TAI , MONOTONIC = CLOCK_MONOTONIC ,   MONOTONIC_RAW = CLOCK_MONOTONIC_RAW , MONOTONIC_COARSE = CLOCK_MONOTONIC_COARSE , BOOTTIME = CLOCK_BOOTTIME , PROCESS_CPUTIME = CLOCK_PROCESS_CPUTIME_ID ,   THREAD_CPUTIME = CLOCK_THREAD_CPUTIME_ID , INVALID = clockid_t{-1} }
	Available clock types for time operations. More...

Detailed Description

Basic time related type definitions.

Definition in file types.hxx.

Typedef Documentation

AtomicRealTime

using cosmos::AtomicRealTime = TimeSpec<ClockType::ATOMIC_REALTIME>

Definition at line 187 of file types.hxx.

BootTime

using cosmos::BootTime = TimeSpec<ClockType::BOOTTIME>

Definition at line 188 of file types.hxx.

CoarseMonotonicTime

using cosmos::CoarseMonotonicTime = TimeSpec<ClockType::MONOTONIC_COARSE>

Definition at line 189 of file types.hxx.

CoarseRealTime

using cosmos::CoarseRealTime = TimeSpec<ClockType::REALTIME_COARSE>

Definition at line 193 of file types.hxx.

IntervalTime

using cosmos::IntervalTime = TimeSpec<ClockType::INVALID>

TimeSpec used for relative time specifications not based on absolute clock time.

Definition at line 197 of file types.hxx.

MonotonicTime

using cosmos::MonotonicTime = TimeSpec<ClockType::MONOTONIC>

Definition at line 190 of file types.hxx.

ProcessCpuTime

using cosmos::ProcessCpuTime = TimeSpec<ClockType::PROCESS_CPUTIME>

Definition at line 192 of file types.hxx.

RawMonotonicTime

using cosmos::RawMonotonicTime = TimeSpec<ClockType::MONOTONIC_RAW>

Definition at line 191 of file types.hxx.

RealTime

using cosmos::RealTime = TimeSpec<ClockType::REALTIME>

Definition at line 194 of file types.hxx.

ThreadCpuTime

using cosmos::ThreadCpuTime = TimeSpec<ClockType::THREAD_CPUTIME>

Definition at line 195 of file types.hxx.

Enumeration Type Documentation

ClockTicks

enum class cosmos::ClockTicks : clock_t

strong

Type used to express time in clock ticks unit in some APIs.

To convert this unit into seconds the value needs to be divied by number of clock ticks per seconds as returned by sysconf(_SC_CLK_TCK).

Definition at line 25 of file types.hxx.

                      : clock_t {
};

ClockType

enum class cosmos::ClockType : clockid_t

strong

Available clock types for time operations.

Enumerator
REALTIME	System-wide wall clock time, settable.
REALTIME_COARSE	A faster but less precise version of REALTIME, not settable.
ATOMIC_REALTIME	System-wide wall clock time based on international atomic time (TAI) - it is ignoring leap seconds.
MONOTONIC	System-wide clock representing monotonic time since some unspecified point in the past. On Linux this corresponds to the time since the system was started.
MONOTONIC_RAW	Like MONOTONIC but not affected by NTP adjustments.
MONOTONIC_COARSE	A faster but less precise version of MONOTONIC, does not count suspend time.
BOOTTIME	Like MONOTONIC but also counts suspend time.
PROCESS_CPUTIME	Counts the CPU time consumed by the calling process.
THREAD_CPUTIME	Counts the CPU time consumed by the calling thread.

Definition at line 29 of file types.hxx.

                     : clockid_t {
        REALTIME         = CLOCK_REALTIME,
        REALTIME_COARSE  = CLOCK_REALTIME_COARSE,
        ATOMIC_REALTIME  = CLOCK_TAI,
 
        MONOTONIC        = CLOCK_MONOTONIC,
        MONOTONIC_RAW    = CLOCK_MONOTONIC_RAW,
        MONOTONIC_COARSE = CLOCK_MONOTONIC_COARSE,
        BOOTTIME         = CLOCK_BOOTTIME,
        PROCESS_CPUTIME  = CLOCK_PROCESS_CPUTIME_ID,
        THREAD_CPUTIME   = CLOCK_THREAD_CPUTIME_ID,
        INVALID          = clockid_t{-1}
};