Safe Haskell	Safe-Inferred
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 Source #

System start

Slots are counted from the system start.

Constructors

SystemStart
Fields getSystemStart ∷ UTCTime

Instances

Instances details

FromJSON SystemStart
Instance details Defined in Cardano.Slotting.Time Methods parseJSON ∷ Value → Parser SystemStart Source # parseJSONList ∷ Value → Parser [SystemStart] Source # omittedField ∷ Maybe SystemStart Source #
ToJSON SystemStart
Instance details Defined in Cardano.Slotting.Time Methods toJSON ∷ SystemStart → Value Source # toEncoding ∷ SystemStart → Encoding Source # toJSONList ∷ [SystemStart] → Value Source # toEncodingList ∷ [SystemStart] → Encoding Source # omitField ∷ SystemStart → Bool Source #
Generic SystemStart
Instance details Defined in Cardano.Slotting.Time Associated Types type Rep SystemStart ∷ Type → Type # Methods from ∷ SystemStart → Rep SystemStart x # to ∷ Rep SystemStart x → SystemStart #
Show SystemStart
Instance details Defined in Cardano.Slotting.Time Methods showsPrec ∷ Int → SystemStart → ShowS # show ∷ SystemStart → String # showList ∷ [SystemStart] → ShowS #
FromCBOR SystemStart
Instance details Defined in Cardano.Slotting.Time Methods fromCBOR ∷ Decoder s SystemStart Source # label ∷ Proxy SystemStart → Text Source #
ToCBOR SystemStart
Instance details Defined in Cardano.Slotting.Time Methods toCBOR ∷ SystemStart → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy SystemStart → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SystemStart] → Size Source #
Eq SystemStart
Instance details Defined in Cardano.Slotting.Time Methods (==) ∷ SystemStart → SystemStart → Bool # (/=) ∷ SystemStart → SystemStart → Bool #
NoThunks SystemStart
Instance details Defined in Cardano.Slotting.Time Methods noThunks ∷ Context → SystemStart → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → SystemStart → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy SystemStart → String Source #
Serialise SystemStart
Instance details Defined in Cardano.Slotting.Time Methods encode ∷ SystemStart → Encoding Source # decode ∷ Decoder s SystemStart Source # encodeList ∷ [SystemStart] → Encoding Source # decodeList ∷ Decoder s [SystemStart] Source #
type Rep SystemStart
Instance details Defined in Cardano.Slotting.Time type Rep SystemStart = D1 ('MetaData "SystemStart" "Cardano.Slotting.Time" "cardano-slotting-0.2.0.0-efb016fbe9e168c0ff2b2dc78099f0dcce58de3212bf5f1627b43e6c92636bbb" '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

Precision is in picoseconds

Constructors

RelativeTime
Fields getRelativeTime ∷ NominalDiffTime

Instances

Instances details

FromJSON RelativeTime
Instance details Defined in Cardano.Slotting.Time Methods parseJSON ∷ Value → Parser RelativeTime Source # parseJSONList ∷ Value → Parser [RelativeTime] Source # omittedField ∷ Maybe RelativeTime Source #
ToJSON RelativeTime
Instance details Defined in Cardano.Slotting.Time Methods toJSON ∷ RelativeTime → Value Source # toEncoding ∷ RelativeTime → Encoding Source # toJSONList ∷ [RelativeTime] → Value Source # toEncodingList ∷ [RelativeTime] → Encoding Source # omitField ∷ RelativeTime → Bool Source #
Generic RelativeTime
Instance details Defined in Cardano.Slotting.Time Associated Types type Rep RelativeTime ∷ Type → Type # Methods from ∷ RelativeTime → Rep RelativeTime x # to ∷ Rep RelativeTime x → RelativeTime #
Show RelativeTime
Instance details Defined in Cardano.Slotting.Time Methods showsPrec ∷ Int → RelativeTime → ShowS # show ∷ RelativeTime → String # showList ∷ [RelativeTime] → ShowS #
FromCBOR RelativeTime
Instance details Defined in Cardano.Slotting.Time Methods fromCBOR ∷ Decoder s RelativeTime Source # label ∷ Proxy RelativeTime → Text Source #
ToCBOR RelativeTime
Instance details Defined in Cardano.Slotting.Time Methods toCBOR ∷ RelativeTime → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy RelativeTime → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [RelativeTime] → Size Source #
Eq RelativeTime
Instance details Defined in Cardano.Slotting.Time Methods (==) ∷ RelativeTime → RelativeTime → Bool # (/=) ∷ RelativeTime → RelativeTime → Bool #
Ord RelativeTime
Instance details Defined in Cardano.Slotting.Time 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 #
NoThunks RelativeTime
Instance details Defined in Cardano.Slotting.Time Methods noThunks ∷ Context → RelativeTime → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → RelativeTime → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy RelativeTime → String Source #
Serialise RelativeTime
Instance details Defined in Cardano.Slotting.Time Methods encode ∷ RelativeTime → Encoding Source # decode ∷ Decoder s RelativeTime Source # encodeList ∷ [RelativeTime] → Encoding Source # decodeList ∷ Decoder s [RelativeTime] Source #
type Rep RelativeTime
Instance details Defined in Cardano.Slotting.Time type Rep RelativeTime = D1 ('MetaData "RelativeTime" "Cardano.Slotting.Time" "cardano-slotting-0.2.0.0-efb016fbe9e168c0ff2b2dc78099f0dcce58de3212bf5f1627b43e6c92636bbb" '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 Source #

toRelativeTime ∷ SystemStart → UTCTime → RelativeTime 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

getSlotLength ∷ SlotLength → NominalDiffTime Source #

mkSlotLength ∷ NominalDiffTime → SlotLength Source #

Constructor for SlotLength

Conversions

slotLengthFromMillisec ∷ Integer → SlotLength Source #

slotLengthFromSec ∷ Integer → SlotLength Source #

slotLengthToMillisec ∷ SlotLength → Integer Source #

slotLengthToSec ∷ SlotLength → Integer Source #

opaque

data SlotLength Source #

Slot length

Precision is in milliseconds

Instances

Instances details

Generic SlotLength
Instance details Defined in Cardano.Slotting.Time Associated Types type Rep SlotLength ∷ Type → Type # Methods from ∷ SlotLength → Rep SlotLength x # to ∷ Rep SlotLength x → SlotLength #
Show SlotLength
Instance details Defined in Cardano.Slotting.Time Methods showsPrec ∷ Int → SlotLength → ShowS # show ∷ SlotLength → String # showList ∷ [SlotLength] → ShowS #
FromCBOR SlotLength
Instance details Defined in Cardano.Slotting.Time Methods fromCBOR ∷ Decoder s SlotLength Source # label ∷ Proxy SlotLength → Text Source #
ToCBOR SlotLength
Instance details Defined in Cardano.Slotting.Time Methods toCBOR ∷ SlotLength → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy SlotLength → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SlotLength] → Size Source #
Eq SlotLength
Instance details Defined in Cardano.Slotting.Time Methods (==) ∷ SlotLength → SlotLength → Bool # (/=) ∷ SlotLength → SlotLength → Bool #
NoThunks SlotLength
Instance details Defined in Cardano.Slotting.Time Methods noThunks ∷ Context → SlotLength → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → SlotLength → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy SlotLength → String Source #
Serialise SlotLength
Instance details Defined in Cardano.Slotting.Time Methods encode ∷ SlotLength → Encoding Source # decode ∷ Decoder s SlotLength Source # encodeList ∷ [SlotLength] → Encoding Source # decodeList ∷ Decoder s [SlotLength] Source #
type Rep SlotLength
Instance details Defined in Cardano.Slotting.Time type Rep SlotLength = D1 ('MetaData "SlotLength" "Cardano.Slotting.Time" "cardano-slotting-0.2.0.0-efb016fbe9e168c0ff2b2dc78099f0dcce58de3212bf5f1627b43e6c92636bbb" '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`)