Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.BlockchainTime.WallClock.Types

Contents

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

Synopsis

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

System time

newtype SystemStart #

Constructors

SystemStart
Fields getSystemStart ∷ UTCTime

Instances

Instances details

Eq SystemStart
Instance details Defined in Cardano.Slotting.Time Methods (==) ∷ SystemStart → SystemStart → Bool Source # (/=) ∷ SystemStart → SystemStart → Bool Source #
Show SystemStart
Instance details Defined in Cardano.Slotting.Time Methods showsPrec ∷ Int → SystemStart → ShowS Source # show ∷ SystemStart → String Source # showList ∷ [SystemStart] → ShowS Source #
Generic SystemStart
Instance details Defined in Cardano.Slotting.Time Associated Types type Rep SystemStart ∷ Type → Type Source # Methods from ∷ SystemStart → Rep SystemStart x Source # to ∷ Rep SystemStart x → SystemStart Source #
Serialise SystemStart
Instance details Defined in Cardano.Slotting.Time Methods encode ∷ SystemStart → Encoding # decode ∷ Decoder s SystemStart # encodeList ∷ [SystemStart] → Encoding # decodeList ∷ Decoder s [SystemStart] #
NoThunks SystemStart
Instance details Defined in Cardano.Slotting.Time Methods noThunks ∷ Context → SystemStart → IO (Maybe ThunkInfo) # wNoThunks ∷ Context → SystemStart → IO (Maybe ThunkInfo) # showTypeOf ∷ Proxy SystemStart → String #
FromCBOR SystemStart
Instance details Defined in Cardano.Slotting.Time Methods fromCBOR ∷ Decoder s SystemStart label ∷ Proxy SystemStart → Text
ToCBOR SystemStart
Instance details Defined in Cardano.Slotting.Time Methods toCBOR ∷ SystemStart → Encoding encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy SystemStart → Size encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SystemStart] → Size
type Rep SystemStart
Instance details Defined in Cardano.Slotting.Time type Rep SystemStart = D1 ('MetaData "SystemStart" "Cardano.Slotting.Time" "cardano-slotting-0.1.0.0-0d44f65cb9561765b48fdba2b66a0b633a4e95aca59cab56ad2b70ffb4013db6" 'True) (C1 ('MetaCons "SystemStart" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSystemStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

Relative time

newtype RelativeTime #

Constructors

RelativeTime
Fields getRelativeTime ∷ NominalDiffTime

Instances

Instances details

Eq RelativeTime
Instance details Defined in Cardano.Slotting.Time Methods (==) ∷ RelativeTime → RelativeTime → Bool Source # (/=) ∷ RelativeTime → RelativeTime → Bool Source #
Ord RelativeTime
Instance details Defined in Cardano.Slotting.Time Methods compare ∷ RelativeTime → RelativeTime → Ordering Source # (<) ∷ RelativeTime → RelativeTime → Bool Source # (<=) ∷ RelativeTime → RelativeTime → Bool Source # (>) ∷ RelativeTime → RelativeTime → Bool Source # (>=) ∷ RelativeTime → RelativeTime → Bool Source # max ∷ RelativeTime → RelativeTime → RelativeTime Source # min ∷ RelativeTime → RelativeTime → RelativeTime Source #
Show RelativeTime
Instance details Defined in Cardano.Slotting.Time Methods showsPrec ∷ Int → RelativeTime → ShowS Source # show ∷ RelativeTime → String Source # showList ∷ [RelativeTime] → ShowS Source #
Generic RelativeTime
Instance details Defined in Cardano.Slotting.Time Associated Types type Rep RelativeTime ∷ Type → Type Source # Methods from ∷ RelativeTime → Rep RelativeTime x Source # to ∷ Rep RelativeTime x → RelativeTime Source #
Serialise RelativeTime
Instance details Defined in Cardano.Slotting.Time Methods encode ∷ RelativeTime → Encoding # decode ∷ Decoder s RelativeTime # encodeList ∷ [RelativeTime] → Encoding # decodeList ∷ Decoder s [RelativeTime] #
NoThunks RelativeTime
Instance details Defined in Cardano.Slotting.Time Methods noThunks ∷ Context → RelativeTime → IO (Maybe ThunkInfo) # wNoThunks ∷ Context → RelativeTime → IO (Maybe ThunkInfo) # showTypeOf ∷ Proxy RelativeTime → String #
type Rep RelativeTime
Instance details Defined in Cardano.Slotting.Time type Rep RelativeTime = D1 ('MetaData "RelativeTime" "Cardano.Slotting.Time" "cardano-slotting-0.1.0.0-0d44f65cb9561765b48fdba2b66a0b633a4e95aca59cab56ad2b70ffb4013db6" '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 #

fromRelativeTime ∷ SystemStart → RelativeTime → UTCTime #

toRelativeTime ∷ SystemStart → UTCTime → RelativeTime #

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) # wNoThunks ∷ Context → SystemTime m → IO (Maybe ThunkInfo) # showTypeOf ∷ Proxy (SystemTime m) → String #

Slot length

getSlotLength ∷ SlotLength → NominalDiffTime #

mkSlotLength ∷ NominalDiffTime → SlotLength #

Conversions

slotLengthFromMillisec ∷ Integer → SlotLength #

slotLengthFromSec ∷ Integer → SlotLength #

slotLengthToMillisec ∷ SlotLength → Integer #

slotLengthToSec ∷ SlotLength → Integer #

opaque

data SlotLength #

Instances

Instances details

Eq SlotLength
Instance details Defined in Cardano.Slotting.Time Methods (==) ∷ SlotLength → SlotLength → Bool Source # (/=) ∷ SlotLength → SlotLength → Bool Source #
Show SlotLength
Instance details Defined in Cardano.Slotting.Time Methods showsPrec ∷ Int → SlotLength → ShowS Source # show ∷ SlotLength → String Source # showList ∷ [SlotLength] → ShowS Source #
Generic SlotLength
Instance details Defined in Cardano.Slotting.Time Associated Types type Rep SlotLength ∷ Type → Type Source # Methods from ∷ SlotLength → Rep SlotLength x Source # to ∷ Rep SlotLength x → SlotLength Source #
Serialise SlotLength
Instance details Defined in Cardano.Slotting.Time Methods encode ∷ SlotLength → Encoding # decode ∷ Decoder s SlotLength # encodeList ∷ [SlotLength] → Encoding # decodeList ∷ Decoder s [SlotLength] #
NoThunks SlotLength
Instance details Defined in Cardano.Slotting.Time Methods noThunks ∷ Context → SlotLength → IO (Maybe ThunkInfo) # wNoThunks ∷ Context → SlotLength → IO (Maybe ThunkInfo) # showTypeOf ∷ Proxy SlotLength → String #
type Rep SlotLength
Instance details Defined in Cardano.Slotting.Time type Rep SlotLength = D1 ('MetaData "SlotLength" "Cardano.Slotting.Time" "cardano-slotting-0.1.0.0-0d44f65cb9561765b48fdba2b66a0b633a4e95aca59cab56ad2b70ffb4013db6" 'True) (C1 ('MetaCons "SlotLength" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSlotLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NominalDiffTime)))

System time

Instances

Relative time

Instances

Get current time (as RelativeTime)

Instances

Slot length

Conversions

opaque

Instances

Get current time (as `RelativeTime`)