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 Source #

System start

Slots are counted from the system start.

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 #
ToCBOR SystemStart
Instance details Defined in Cardano.Slotting.Time Methods toCBOR :: SystemStart -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy SystemStart -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ SystemStart ] -> Size Source #
FromCBOR SystemStart
Instance details Defined in Cardano.Slotting.Time Methods fromCBOR :: Decoder s SystemStart Source # label :: Proxy SystemStart -> Text Source #
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.1.0.2-j5NuF73p5IFfcfvmth6tS" ' 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
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 #
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.1.0.2-j5NuF73p5IFfcfvmth6tS" ' 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

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 #
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.1.0.2-j5NuF73p5IFfcfvmth6tS" ' 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` )