Safe Haskell	None
Language	Haskell2010

RON.Event

Synopsis

data CalendarTime = CalendarTime {
- months :: Word12
- days :: Word6
- hours :: Word6
- minutes :: Word6
- seconds :: Word6
- nanosecHundreds :: Word24
}
data CalendarEvent = CalendarEvent !CalendarTime !ReplicaId
data EpochEvent = EpochEvent !EpochTime !ReplicaId
type EpochTime = Word60
data Event = Event !LocalTime !ReplicaId
data LocalTime
- = TCalendar !CalendarTime
- | TLogical !Word60
- | TEpoch !EpochTime
- | TUnknown !Word60
data Naming
- = TrieForked
- | CryptoForked
- | RecordForked
- | ApplicationSpecific
class Monad m => ReplicaClock m where
- getPid :: m ReplicaId
- getEvents :: EpochTime -> m [EpochEvent]
- advance :: EpochTime -> m ()
data ReplicaId = ReplicaId !Naming !Word60
advanceToUuid :: ReplicaClock clock => UUID -> clock ()
applicationSpecific :: Word64 -> ReplicaId
decodeEvent :: UUID -> Event
encodeEvent :: Event -> UUID
fromCalendarEvent :: CalendarEvent -> Event
fromEpochEvent :: EpochEvent -> Event
getEvent :: (HasCallStack, ReplicaClock m) => m EpochEvent
getEventUuid :: ReplicaClock m => m UUID
getEventUuids :: ReplicaClock m => Word60 -> m [UUID]
mkCalendarDate :: (Word16, Word16, Word8) -> Maybe CalendarTime
mkCalendarDateTime :: (Word16, Word16, Word8) -> (Word8, Word8, Word8) -> Maybe CalendarTime
mkCalendarDateTimeNano :: (Word16, Word16, Word8) -> (Word8, Word8, Word8) -> Word32 -> Maybe CalendarTime
toEpochEvent :: Event -> Maybe EpochEvent

Documentation

data CalendarTime Source #

Calendar format. See https://github.com/gritzko/ron/issues/19. Year range is 2010—2350. Precision is 100 ns.

Constructors

CalendarTime
Fields months :: Word12 days :: Word6 hours :: Word6 minutes :: Word6 seconds :: Word6 nanosecHundreds :: Word24

Instances

Eq CalendarTime Source #
Instance details Defined in RON.Event Methods (==) :: CalendarTime -> CalendarTime -> Bool # (/=) :: CalendarTime -> CalendarTime -> Bool #
Ord CalendarTime Source #
Instance details Defined in RON.Event Methods compare :: CalendarTime -> CalendarTime -> Ordering # (<) :: CalendarTime -> CalendarTime -> Bool # (<=) :: CalendarTime -> CalendarTime -> Bool # (>) :: CalendarTime -> CalendarTime -> Bool # (>=) :: CalendarTime -> CalendarTime -> Bool # max :: CalendarTime -> CalendarTime -> CalendarTime # min :: CalendarTime -> CalendarTime -> CalendarTime #
Show CalendarTime Source #
Instance details Defined in RON.Event Methods showsPrec :: Int -> CalendarTime -> ShowS # show :: CalendarTime -> String # showList :: [CalendarTime] -> ShowS #

data CalendarEvent Source #

Calendar-based Lamport time event, specific case of Event.

Constructors

CalendarEvent !CalendarTime !ReplicaId

Instances

Eq CalendarEvent Source #
Instance details Defined in RON.Event Methods (==) :: CalendarEvent -> CalendarEvent -> Bool # (/=) :: CalendarEvent -> CalendarEvent -> Bool #
Ord CalendarEvent Source #
Instance details Defined in RON.Event Methods compare :: CalendarEvent -> CalendarEvent -> Ordering # (<) :: CalendarEvent -> CalendarEvent -> Bool # (<=) :: CalendarEvent -> CalendarEvent -> Bool # (>) :: CalendarEvent -> CalendarEvent -> Bool # (>=) :: CalendarEvent -> CalendarEvent -> Bool # max :: CalendarEvent -> CalendarEvent -> CalendarEvent # min :: CalendarEvent -> CalendarEvent -> CalendarEvent #
Show CalendarEvent Source #
Instance details Defined in RON.Event Methods showsPrec :: Int -> CalendarEvent -> ShowS # show :: CalendarEvent -> String # showList :: [CalendarEvent] -> ShowS #

data EpochEvent Source #

Epoch-based Lamport time event, specific case of Event.

Constructors

EpochEvent !EpochTime !ReplicaId

Instances

Eq EpochEvent Source #
Instance details Defined in RON.Event Methods (==) :: EpochEvent -> EpochEvent -> Bool # (/=) :: EpochEvent -> EpochEvent -> Bool #
Ord EpochEvent Source #
Instance details Defined in RON.Event Methods compare :: EpochEvent -> EpochEvent -> Ordering # (<) :: EpochEvent -> EpochEvent -> Bool # (<=) :: EpochEvent -> EpochEvent -> Bool # (>) :: EpochEvent -> EpochEvent -> Bool # (>=) :: EpochEvent -> EpochEvent -> Bool # max :: EpochEvent -> EpochEvent -> EpochEvent # min :: EpochEvent -> EpochEvent -> EpochEvent #
Show EpochEvent Source #
Instance details Defined in RON.Event Methods showsPrec :: Int -> EpochEvent -> ShowS # show :: EpochEvent -> String # showList :: [EpochEvent] -> ShowS #

type EpochTime = Word60 Source #

RFC 4122 epoch, hundreds of nanoseconds since 1582. Year range is 1582—5235.

data Event Source #

Generic Lamport time event. Cannot be Ord because we can't compare different types of clocks. If you want comparable events, use specific EpochEvent.

Constructors

Event !LocalTime !ReplicaId

Instances

Eq Event Source #
Instance details Defined in RON.Event Methods (==) :: Event -> Event -> Bool # (/=) :: Event -> Event -> Bool #
Show Event Source #
Instance details Defined in RON.Event Methods showsPrec :: Int -> Event -> ShowS # show :: Event -> String # showList :: [Event] -> ShowS #

data LocalTime Source #

Clock type is encoded in 2 higher bits of variety, value in uuidValue

Constructors

TCalendar !CalendarTime
TLogical !Word60	https://en.wikipedia.org/wiki/Logical_clock
TEpoch !EpochTime
TUnknown !Word60

Instances

Eq LocalTime Source #
Instance details Defined in RON.Event Methods (==) :: LocalTime -> LocalTime -> Bool # (/=) :: LocalTime -> LocalTime -> Bool #
Show LocalTime Source #
Instance details Defined in RON.Event Methods showsPrec :: Int -> LocalTime -> ShowS # show :: LocalTime -> String # showList :: [LocalTime] -> ShowS #

data Naming Source #

Replica id assignment style

Constructors

TrieForked
CryptoForked
RecordForked
ApplicationSpecific

Instances

Bounded Naming Source #
Instance details Defined in RON.Event Methods minBound :: Naming # maxBound :: Naming #
Enum Naming Source #
Instance details Defined in RON.Event Methods succ :: Naming -> Naming # pred :: Naming -> Naming # toEnum :: Int -> Naming # fromEnum :: Naming -> Int # enumFrom :: Naming -> [Naming] # enumFromThen :: Naming -> Naming -> [Naming] # enumFromTo :: Naming -> Naming -> [Naming] # enumFromThenTo :: Naming -> Naming -> Naming -> [Naming] #
Eq Naming Source #
Instance details Defined in RON.Event Methods (==) :: Naming -> Naming -> Bool # (/=) :: Naming -> Naming -> Bool #
Show Naming Source #
Instance details Defined in RON.Event Methods showsPrec :: Int -> Naming -> ShowS # show :: Naming -> String # showList :: [Naming] -> ShowS #
Hashable Naming Source #
Instance details Defined in RON.Event Methods hashWithSalt :: Int -> Naming -> Int # hash :: Naming -> Int #

class Monad m => ReplicaClock m where Source #

Methods

getPid :: m ReplicaId Source #

Get current replica id

getEvents Source #

Arguments

:: EpochTime	number of needed timestamps
-> m [EpochEvent]

Get sequential timestamps.

Laws:

t <- getEvents n
(t !! i) == head t + i

t1 <- getEvent
t2 <- getEvent
t2 >= t1 + 1

```
getEvents 0 == getEvents 1
```

advance :: EpochTime -> m () Source #

Make local time not less than this

Instances

ReplicaClock EpochClock Source #
Instance details Defined in RON.Epoch Methods getPid :: EpochClock ReplicaId Source # getEvents :: EpochTime -> EpochClock [EpochEvent] Source # advance :: EpochTime -> EpochClock () Source #
Monad m => ReplicaClock (ReplicaSimT m) Source #
Instance details Defined in RON.Event.Simulation Methods getPid :: ReplicaSimT m ReplicaId Source # getEvents :: EpochTime -> ReplicaSimT m [EpochEvent] Source # advance :: EpochTime -> ReplicaSimT m () Source #
ReplicaClock m => ReplicaClock (ExceptT e m) Source #
Instance details Defined in RON.Event Methods getPid :: ExceptT e m ReplicaId Source # getEvents :: EpochTime -> ExceptT e m [EpochEvent] Source # advance :: EpochTime -> ExceptT e m () Source #
ReplicaClock m => ReplicaClock (ReaderT r m) Source #
Instance details Defined in RON.Event Methods getPid :: ReaderT r m ReplicaId Source # getEvents :: EpochTime -> ReaderT r m [EpochEvent] Source # advance :: EpochTime -> ReaderT r m () Source #
ReplicaClock m => ReplicaClock (StateT s m) Source #
Instance details Defined in RON.Event Methods getPid :: StateT s m ReplicaId Source # getEvents :: EpochTime -> StateT s m [EpochEvent] Source # advance :: EpochTime -> StateT s m () Source #
ReplicaClock m => ReplicaClock (WriterT s m) Source #
Instance details Defined in RON.Event Methods getPid :: WriterT s m ReplicaId Source # getEvents :: EpochTime -> WriterT s m [EpochEvent] Source # advance :: EpochTime -> WriterT s m () Source #

data ReplicaId Source #

Replica identifier

Constructors

ReplicaId !Naming !Word60

Instances

Eq ReplicaId Source #
Instance details Defined in RON.Event Methods (==) :: ReplicaId -> ReplicaId -> Bool # (/=) :: ReplicaId -> ReplicaId -> Bool #
Show ReplicaId Source #
Instance details Defined in RON.Event Methods showsPrec :: Int -> ReplicaId -> ShowS # show :: ReplicaId -> String # showList :: [ReplicaId] -> ShowS #
Generic ReplicaId Source #
Instance details Defined in RON.Event Associated Types type Rep ReplicaId :: Type -> Type # Methods from :: ReplicaId -> Rep ReplicaId x # to :: Rep ReplicaId x -> ReplicaId #
Hashable ReplicaId Source #
Instance details Defined in RON.Event Methods hashWithSalt :: Int -> ReplicaId -> Int # hash :: ReplicaId -> Int #
type Rep ReplicaId Source #
Instance details Defined in RON.Event type Rep ReplicaId = D1 (MetaData "ReplicaId" "RON.Event" "ron-0.9-3vRSvkBw59E3vYQ9Q1curT" False) (C1 (MetaCons "ReplicaId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Naming) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Word60)))

advanceToUuid :: ReplicaClock clock => UUID -> clock () Source #

advance variant for any UUID

applicationSpecific :: Word64 -> ReplicaId Source #

Make an ApplicationSpecific replica id from arbitrary number

decodeEvent :: UUID -> Event Source #

encodeEvent :: Event -> UUID Source #

fromCalendarEvent :: CalendarEvent -> Event Source #

fromEpochEvent :: EpochEvent -> Event Source #

getEvent :: (HasCallStack, ReplicaClock m) => m EpochEvent Source #

Get a single event

getEventUuid :: ReplicaClock m => m UUID Source #

Get a single event as UUID

getEventUuids :: ReplicaClock m => Word60 -> m [UUID] Source #

Get event sequence as UUIDs

mkCalendarDate Source #

Arguments

:: (Word16, Word16, Word8)	date as (year, month [1..12], day [1..])
-> Maybe CalendarTime

Make a calendar timestamp from a date

mkCalendarDateTime Source #

Arguments

:: (Word16, Word16, Word8)	date as (year, month [1..12], day [1..])
-> (Word8, Word8, Word8)	day time as (hours, minutes, seconds)
-> Maybe CalendarTime

Make a calendar timestamp from a date and a day time

mkCalendarDateTimeNano Source #

Arguments

:: (Word16, Word16, Word8)	date as (year, month [1..12], day [1..])
-> (Word8, Word8, Word8)	day time as (hours, minutes, seconds)
-> Word32	fraction of a second in hundreds of nanosecond
-> Maybe CalendarTime

Make a calendar timestamp from a date, a day time, and a second fraction

toEpochEvent :: Event -> Maybe EpochEvent Source #