clock-0.8.4: High-resolution clock functions: monotonic, realtime, cputime.
Safe HaskellNone
LanguageHaskell2010

System.Clock

Description

High-resolution, realtime clock and timer functions for Posix systems. This module is being developed according to IEEE Std 1003.1-2008: http://www.opengroup.org/onlinepubs/9699919799/, http://www.opengroup.org/onlinepubs/9699919799/functions/clock_getres.html#

Synopsis

Documentation

data Clock #

Clock types. A clock may be system-wide (that is, visible to all processes) or per-process (measuring time that is meaningful only within a process). All implementations shall support Realtime.

Constructors

Monotonic

The identifier for the system-wide monotonic clock, which is defined as a clock measuring real time, whose value cannot be set via clock_settime and which cannot have negative clock jumps. The maximum possible clock jump shall be implementation defined. For this clock, the value returned by getTime represents the amount of time (in seconds and nanoseconds) since an unspecified point in the past (for example, system start-up time, or the Epoch). This point does not change after system start-up time. Note that the absolute value of the monotonic clock is meaningless (because its origin is arbitrary), and thus there is no need to set it. Furthermore, realtime applications can rely on the fact that the value of this clock is never set. (Identical to Boottime since Linux 4.17, see https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d6ed449afdb38f89a7b38ec50e367559e1b8f71f) CLOCK_MONOTONIC (macOS - SYSTEM_CLOCK)

Realtime

The identifier of the system-wide clock measuring real time. For this clock, the value returned by getTime represents the amount of time (in seconds and nanoseconds) since the Epoch. CLOCK_REALTIME (macOS - CALENDAR_CLOCK, Windows - GetSystemTimeAsFileTime)

ProcessCPUTime

The identifier of the CPU-time clock associated with the calling process. For this clock, the value returned by getTime represents the amount of execution time of the current process.

ThreadCPUTime

The identifier of the CPU-time clock associated with the calling OS thread. For this clock, the value returned by getTime represents the amount of execution time of the current OS thread.

Instances

Instances details
Enum Clock # 
Instance details

Defined in System.Clock

Generic Clock # 
Instance details

Defined in System.Clock

Associated Types

type Rep Clock 
Instance details

Defined in System.Clock

type Rep Clock = D1 ('MetaData "Clock" "System.Clock" "clock-0.8.4-BoSBw0VDB82KWo50HGG2ac" 'False) ((C1 ('MetaCons "Monotonic" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Realtime" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ProcessCPUTime" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ThreadCPUTime" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: Clock -> Rep Clock x #

to :: Rep Clock x -> Clock #

Read Clock # 
Instance details

Defined in System.Clock

Show Clock # 
Instance details

Defined in System.Clock

Methods

showsPrec :: Int -> Clock -> ShowS #

show :: Clock -> String #

showList :: [Clock] -> ShowS #

Eq Clock # 
Instance details

Defined in System.Clock

Methods

(==) :: Clock -> Clock -> Bool #

(/=) :: Clock -> Clock -> Bool #

type Rep Clock # 
Instance details

Defined in System.Clock

type Rep Clock = D1 ('MetaData "Clock" "System.Clock" "clock-0.8.4-BoSBw0VDB82KWo50HGG2ac" 'False) ((C1 ('MetaCons "Monotonic" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Realtime" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ProcessCPUTime" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ThreadCPUTime" 'PrefixI 'False) (U1 :: Type -> Type)))

data TimeSpec #

TimeSpec structure

Constructors

TimeSpec 

Fields

Instances

Instances details
Bounded TimeSpec # 
Instance details

Defined in System.Clock

Enum TimeSpec # 
Instance details

Defined in System.Clock

Storable TimeSpec # 
Instance details

Defined in System.Clock

Generic TimeSpec # 
Instance details

Defined in System.Clock

Associated Types

type Rep TimeSpec 
Instance details

Defined in System.Clock

type Rep TimeSpec = D1 ('MetaData "TimeSpec" "System.Clock" "clock-0.8.4-BoSBw0VDB82KWo50HGG2ac" 'False) (C1 ('MetaCons "TimeSpec" 'PrefixI 'True) (S1 ('MetaSel ('Just "sec") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int64) :*: S1 ('MetaSel ('Just "nsec") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int64)))

Methods

from :: TimeSpec -> Rep TimeSpec x #

to :: Rep TimeSpec x -> TimeSpec #

Num TimeSpec # 
Instance details

Defined in System.Clock

Read TimeSpec # 
Instance details

Defined in System.Clock

Integral TimeSpec # 
Instance details

Defined in System.Clock

Real TimeSpec # 
Instance details

Defined in System.Clock

Show TimeSpec # 
Instance details

Defined in System.Clock

Eq TimeSpec # 
Instance details

Defined in System.Clock

Ord TimeSpec # 
Instance details

Defined in System.Clock

type Rep TimeSpec # 
Instance details

Defined in System.Clock

type Rep TimeSpec = D1 ('MetaData "TimeSpec" "System.Clock" "clock-0.8.4-BoSBw0VDB82KWo50HGG2ac" 'False) (C1 ('MetaCons "TimeSpec" 'PrefixI 'True) (S1 ('MetaSel ('Just "sec") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int64) :*: S1 ('MetaSel ('Just "nsec") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int64)))

getTime :: Clock -> IO TimeSpec #

The getTime function shall return the current value for the specified clock.

getRes :: Clock -> IO TimeSpec #

The getRes function shall return the resolution of any clock. Clock resolutions are implementation-defined and cannot be set by a process.

fromNanoSecs :: Integer -> TimeSpec #

TimeSpec from nano seconds.

toNanoSecs :: TimeSpec -> Integer #

TimeSpec to nano seconds.

diffTimeSpec :: TimeSpec -> TimeSpec -> TimeSpec #

Compute the absolute difference.

timeSpecAsNanoSecs :: TimeSpec -> Integer #

Deprecated: Use toNanoSecs instead! Replaced timeSpecAsNanoSecs with the same signature TimeSpec -> Integer

TimeSpec as nano seconds.

s2ns :: Num a => a #