Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.BlockchainTime.WallClock.Types

Contents

System time
Relative time
Get current time (as RelativeTime)
Slot length
- Conversions

Synopsis

newtype SystemStart = SystemStart {
- getSystemStart :: UTCTime
}
newtype RelativeTime = RelativeTime {
- getRelativeTime :: NominalDiffTime
}
addRelTime :: NominalDiffTime -> RelativeTime -> RelativeTime
diffRelTime :: RelativeTime -> RelativeTime -> NominalDiffTime
toRelativeTime :: SystemStart -> UTCTime -> RelativeTime
fromRelativeTime :: SystemStart -> RelativeTime -> UTCTime
data SystemTime m = SystemTime {
- systemTimeCurrent :: m RelativeTime
- systemTimeWait :: m ()
}
data SlotLength
getSlotLength :: SlotLength -> NominalDiffTime
mkSlotLength :: NominalDiffTime -> SlotLength
slotLengthFromSec :: Integer -> SlotLength
slotLengthToSec :: SlotLength -> Integer
slotLengthFromMillisec :: Integer -> SlotLength
slotLengthToMillisec :: SlotLength -> Integer

System time

newtype SystemStart Source #

System start

Slots are counted from the system start.

Constructors

SystemStart
Fields getSystemStart :: UTCTime

Instances

Instances details

Eq SystemStart Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Methods (==) :: SystemStart -> SystemStart -> Bool # (/=) :: SystemStart -> SystemStart -> Bool #
Show SystemStart Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Methods showsPrec :: Int -> SystemStart -> ShowS # show :: SystemStart -> String # showList :: [SystemStart] -> ShowS #
Generic SystemStart Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Associated Types type Rep SystemStart :: Type -> Type # Methods from :: SystemStart -> Rep SystemStart x # to :: Rep SystemStart x -> SystemStart #
NoThunks SystemStart Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Methods noThunks :: Context -> SystemStart -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> SystemStart -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy SystemStart -> String Source #
type Rep SystemStart Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types type Rep SystemStart = D1 ('MetaData "SystemStart" "Ouroboros.Consensus.BlockchainTime.WallClock.Types" "ouroboros-consensus-0.1.0.0-GfJNvFcM6lj2s5utKAUPEp" 'True) (C1 ('MetaCons "SystemStart" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSystemStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

Relative time

newtype RelativeTime Source #

RelativeTime is time relative to the SystemStart

Constructors

RelativeTime
Fields getRelativeTime :: NominalDiffTime

Instances

Instances details

Eq RelativeTime Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Methods (==) :: RelativeTime -> RelativeTime -> Bool # (/=) :: RelativeTime -> RelativeTime -> Bool #
Ord RelativeTime Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Methods compare :: RelativeTime -> RelativeTime -> Ordering # (<) :: RelativeTime -> RelativeTime -> Bool # (<=) :: RelativeTime -> RelativeTime -> Bool # (>) :: RelativeTime -> RelativeTime -> Bool # (>=) :: RelativeTime -> RelativeTime -> Bool # max :: RelativeTime -> RelativeTime -> RelativeTime # min :: RelativeTime -> RelativeTime -> RelativeTime #
Show RelativeTime Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Methods showsPrec :: Int -> RelativeTime -> ShowS # show :: RelativeTime -> String # showList :: [RelativeTime] -> ShowS #
Generic RelativeTime Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Associated Types type Rep RelativeTime :: Type -> Type # Methods from :: RelativeTime -> Rep RelativeTime x # to :: Rep RelativeTime x -> RelativeTime #
NoThunks RelativeTime Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Methods noThunks :: Context -> RelativeTime -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> RelativeTime -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy RelativeTime -> String Source #
Serialise RelativeTime Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Methods encode :: RelativeTime -> Encoding Source # decode :: Decoder s RelativeTime Source # encodeList :: [RelativeTime] -> Encoding Source # decodeList :: Decoder s [RelativeTime] Source #
type Rep RelativeTime Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types type Rep RelativeTime = D1 ('MetaData "RelativeTime" "Ouroboros.Consensus.BlockchainTime.WallClock.Types" "ouroboros-consensus-0.1.0.0-GfJNvFcM6lj2s5utKAUPEp" 'True) (C1 ('MetaCons "RelativeTime" 'PrefixI 'True) (S1 ('MetaSel ('Just "getRelativeTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NominalDiffTime)))

addRelTime :: NominalDiffTime -> RelativeTime -> RelativeTime Source #

diffRelTime :: RelativeTime -> RelativeTime -> NominalDiffTime Source #

toRelativeTime :: SystemStart -> UTCTime -> RelativeTime Source #

fromRelativeTime :: SystemStart -> RelativeTime -> UTCTime Source #

Get current time (as `RelativeTime`)

data SystemTime m Source #

System time

Slots are counted from the system start.

Constructors

SystemTime

Fields

systemTimeCurrent :: m RelativeTime
Get current time (as a RelativeTime)
For real deployment, this will take the current UTCTime and then subtract the SystemStart (see defaultSystemTime). Tests don't bother with a UTCTime and just work entirely in RelativeTime.
systemTimeWait :: m ()
Wait for SystemStart
For the real deployment, this waits for the current UTCTime to reach SystemStart. In tests this does nothing.

Instances

Instances details

NoThunks (SystemTime m) Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Methods noThunks :: Context -> SystemTime m -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> SystemTime m -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy (SystemTime m) -> String Source #

Slot length

data SlotLength Source #

Slot length

Instances

Instances details

Eq SlotLength Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Methods (==) :: SlotLength -> SlotLength -> Bool # (/=) :: SlotLength -> SlotLength -> Bool #
Show SlotLength Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Methods showsPrec :: Int -> SlotLength -> ShowS # show :: SlotLength -> String # showList :: [SlotLength] -> ShowS #
Generic SlotLength Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Associated Types type Rep SlotLength :: Type -> Type # Methods from :: SlotLength -> Rep SlotLength x # to :: Rep SlotLength x -> SlotLength #
NoThunks SlotLength Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Methods noThunks :: Context -> SlotLength -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> SlotLength -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy SlotLength -> String Source #
Serialise SlotLength Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types Methods encode :: SlotLength -> Encoding Source # decode :: Decoder s SlotLength Source # encodeList :: [SlotLength] -> Encoding Source # decodeList :: Decoder s [SlotLength] Source #
type Rep SlotLength Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types type Rep SlotLength = D1 ('MetaData "SlotLength" "Ouroboros.Consensus.BlockchainTime.WallClock.Types" "ouroboros-consensus-0.1.0.0-GfJNvFcM6lj2s5utKAUPEp" 'True) (C1 ('MetaCons "SlotLength" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSlotLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NominalDiffTime)))