Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.Util.LogicalClock

Contents

API
Construction
Scheduling actions
Utilities

Description

Logical time (in terms of abstract " ticks ")

Intended for qualified import

import Test.Util.LogicalClock (LogicalClock)
import qualified Test.Util.LogicalClock as LogicalClock

Synopsis

data LogicalClock m = LogicalClock {
- getCurrentTick ∷ STM m Tick
- waitUntilDone ∷ m ()
- mockSystemTime ∷ SystemTime m
}
newtype NumTicks = NumTicks Word64
newtype Tick = Tick {
- tickToWord64 ∷ Word64
}
new ∷ IOLike m ⇒ ResourceRegistry m → NumTicks → m (LogicalClock m)
sufficientTimeFor ∷ HasCallStack ⇒ [Tick] → NumTicks
blockUntilTick ∷ MonadSTM m ⇒ LogicalClock m → Tick → m Bool
onTick ∷ (IOLike m, HasCallStack) ⇒ ResourceRegistry m → LogicalClock m → String → Tick → m () → m ()
tickWatcher ∷ LogicalClock m → (Tick → m ()) → Watcher m Tick Tick
tickTracer ∷ MonadSTM m ⇒ LogicalClock m → Tracer m (Tick, ev) → Tracer m ev

API

data LogicalClock m Source #

Logical clock (in terms of ticks rather than actual UTCTime)

Constructors

LogicalClock
Fields getCurrentTick ∷ STM m Tick Get the current " time " waitUntilDone ∷ m () Wait for the end of time (each clock has a maximum number of ticks) mockSystemTime ∷ SystemTime m Translate the logical clock to mock `SystemTime`

newtype NumTicks Source #

Number of ticks the test will run for

Constructors

NumTicks Word64

newtype Tick Source #

Logical time unit

Constructors

Tick
Fields tickToWord64 ∷ Word64

Instances

Instances details

Enum Tick Source #
Instance details Defined in Test.Util.LogicalClock Methods succ ∷ Tick → Tick # pred ∷ Tick → Tick # toEnum ∷ Int → Tick # fromEnum ∷ Tick → Int # enumFrom ∷ Tick → [Tick] # enumFromThen ∷ Tick → Tick → [Tick] # enumFromTo ∷ Tick → Tick → [Tick] # enumFromThenTo ∷ Tick → Tick → Tick → [Tick] #
Num Tick Source #
Instance details Defined in Test.Util.LogicalClock Methods (+) ∷ Tick → Tick → Tick # (-) ∷ Tick → Tick → Tick # (*) ∷ Tick → Tick → Tick # negate ∷ Tick → Tick # abs ∷ Tick → Tick # signum ∷ Tick → Tick # fromInteger ∷ Integer → Tick #
Show Tick Source #
Instance details Defined in Test.Util.LogicalClock Methods showsPrec ∷ Int → Tick → ShowS # show ∷ Tick → String # showList ∷ [Tick] → ShowS #
Eq Tick Source #
Instance details Defined in Test.Util.LogicalClock Methods (==) ∷ Tick → Tick → Bool # (/=) ∷ Tick → Tick → Bool #
Ord Tick Source #
Instance details Defined in Test.Util.LogicalClock Methods compare ∷ Tick → Tick → Ordering # (<) ∷ Tick → Tick → Bool # (<=) ∷ Tick → Tick → Bool # (>) ∷ Tick → Tick → Bool # (>=) ∷ Tick → Tick → Bool # max ∷ Tick → Tick → Tick # min ∷ Tick → Tick → Tick #
Random Tick Source #
Instance details Defined in Test.Util.LogicalClock Methods randomR ∷ RandomGen g ⇒ (Tick, Tick) → g → (Tick, g) Source # random ∷ RandomGen g ⇒ g → (Tick, g) Source # randomRs ∷ RandomGen g ⇒ (Tick, Tick) → g → [Tick] Source # randoms ∷ RandomGen g ⇒ g → [Tick] Source #

Construction

new ∷ IOLike m ⇒ ResourceRegistry m → NumTicks → m (LogicalClock m) Source #

sufficientTimeFor ∷ HasCallStack ⇒ [Tick] → NumTicks Source #

Set NumTicks such that we will have seen all of the specified Ticks

Scheduling actions

blockUntilTick ∷ MonadSTM m ⇒ LogicalClock m → Tick → m Bool Source #

Block until the specified tick

Returns False if the current tick is later than the requested one, or True if they were equal.

onTick ∷ (IOLike m, HasCallStack) ⇒ ResourceRegistry m → LogicalClock m → String → Tick → m () → m () Source #

Execute action once at the specified tick

tickWatcher ∷ LogicalClock m → (Tick → m ()) → Watcher m Tick Tick Source #

Execute action on every clock tick

Utilities

tickTracer ∷ MonadSTM m ⇒ LogicalClock m → Tracer m (Tick, ev) → Tracer m ev Source #