FRP.Rhine.Clock.Realtime.Millisecond

Provides a clock that ticks at every multiple of a fixed number of milliseconds.

Documentation

newtype Millisecond (n :: Nat)

A clock ticking every n milliseconds, in real time. Since n is in the type signature, it is ensured that when composing two signals on a Millisecond clock, they will be driven at the same rate.

The tag of this clock is Bool, where True represents successful realtime, and False a lag.

Constructors

Millisecond (RescaledClockS IO (FixedStep n) UTCTime Bool)

Instances

Clock IO (Millisecond n)

Defined in FRP.Rhine.Clock.Realtime.Millisecond

Associated Types

type Time (Millisecond n) :: *

type Tag (Millisecond n) :: *

Methods

initClock :: Millisecond n -> RunningClockInit IO (Time (Millisecond n)) (Tag (Millisecond n))

type Time (Millisecond n)

Defined in FRP.Rhine.Clock.Realtime.Millisecond

type Time (Millisecond n) = UTCTime

type Tag (Millisecond n)

Defined in FRP.Rhine.Clock.Realtime.Millisecond

type Tag (Millisecond n) = Bool

waitClock :: KnownNat n => Millisecond n

This implementation measures the time after each tick, and waits for the remaining time until the next tick. If the next tick should already have occurred, the tag is set to False, representing a failed real time attempt.

downsampleMillisecond :: (KnownNat n, Monad m) => ResamplingBuffer m (Millisecond k) (Millisecond (n * k)) a (Vector n a)

scheduleMillisecond :: Schedule IO (Millisecond n1) (Millisecond n2)

Two Millisecond clocks can always be scheduled deterministically.