Safe Haskell	None
Language	Haskell2010

Core

Synopsis

data Core = Core {
- coreCurrentValue :: PersistentValue
- coreValueIsDirty :: TVar Bool
- coreQueue :: TBQueue Command
- coreUpdates :: TBQueue (Maybe Updated)
- coreClients :: MVar ServerState
- coreLogger :: Logger
- coreConfig :: Config
- coreMetrics :: Maybe IcepeakMetrics
}
data EnqueueResult
- = Enqueued
- | Dropped
data Command
- = Sync
- | Modify Modification (Maybe (MVar ()))
- | Stop
type ServerState = SubscriptionTree UUID Connection
data Updated = Updated Path Value
enqueueCommand :: Command -> Core -> IO ()
tryEnqueueCommand :: Command -> Core -> IO EnqueueResult
getCurrentValue :: Core -> Path -> IO (Maybe Value)
withCoreMetrics :: MonadIO m => Core -> (IcepeakMetrics -> IO ()) -> m ()
lookup :: Eq a => a -> [(a, b)] -> Maybe b
newCore :: Config -> Logger -> Maybe IcepeakMetrics -> IO (Either String Core)
postQuit :: Core -> IO ()
runCommandLoop :: Core -> IO ()
runSyncTimer :: Core -> IO ()

Documentation

data Core Source #

Constructors

Core
Fields coreCurrentValue :: PersistentValue coreValueIsDirty :: TVar Bool coreQueue :: TBQueue Command coreUpdates :: TBQueue (Maybe Updated) coreClients :: MVar ServerState coreLogger :: Logger coreConfig :: Config coreMetrics :: Maybe IcepeakMetrics

data EnqueueResult Source #

Constructors

Enqueued
Dropped

Instances

Bounded EnqueueResult Source #
Instance details Defined in Core Methods minBound :: EnqueueResult # maxBound :: EnqueueResult #
Enum EnqueueResult Source #
Instance details Defined in Core Methods succ :: EnqueueResult -> EnqueueResult # pred :: EnqueueResult -> EnqueueResult # toEnum :: Int -> EnqueueResult # fromEnum :: EnqueueResult -> Int # enumFrom :: EnqueueResult -> [EnqueueResult] # enumFromThen :: EnqueueResult -> EnqueueResult -> [EnqueueResult] # enumFromTo :: EnqueueResult -> EnqueueResult -> [EnqueueResult] # enumFromThenTo :: EnqueueResult -> EnqueueResult -> EnqueueResult -> [EnqueueResult] #
Eq EnqueueResult Source #
Instance details Defined in Core Methods (==) :: EnqueueResult -> EnqueueResult -> Bool # (/=) :: EnqueueResult -> EnqueueResult -> Bool #
Ord EnqueueResult Source #
Instance details Defined in Core Methods compare :: EnqueueResult -> EnqueueResult -> Ordering # (<) :: EnqueueResult -> EnqueueResult -> Bool # (<=) :: EnqueueResult -> EnqueueResult -> Bool # (>) :: EnqueueResult -> EnqueueResult -> Bool # (>=) :: EnqueueResult -> EnqueueResult -> Bool # max :: EnqueueResult -> EnqueueResult -> EnqueueResult # min :: EnqueueResult -> EnqueueResult -> EnqueueResult #
Show EnqueueResult Source #
Instance details Defined in Core Methods showsPrec :: Int -> EnqueueResult -> ShowS # show :: EnqueueResult -> String # showList :: [EnqueueResult] -> ShowS #

data Command Source #

Defines the kinds of commands that are handled by the event loop of the Core.

Constructors

Sync	The `Sync` command causes the core to write the JSON value to disk.
Modify Modification (Maybe (MVar ()))	The `Modify` command applies a modification (writing or deleting) to the JSON value. The optional MVar is used to signal that the command has been processed by the core.
Stop	The `Stop` command causes the event loop of the Core to exit.

Instances

Eq Command Source #
Instance details Defined in Core Methods (==) :: Command -> Command -> Bool # (/=) :: Command -> Command -> Bool #

type ServerState = SubscriptionTree UUID Connection Source #

data Updated Source #

Constructors

Updated Path Value

Instances

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

enqueueCommand :: Command -> Core -> IO () Source #

Enqueue a command. Blocks if the queue is full. This is used by the sync timer to make sure the sync commands are actually enqueued. In general, whenever it is critical that a command is executed eventually (when reaching the front of the queue), this function should be used.

tryEnqueueCommand :: Command -> Core -> IO EnqueueResult Source #

Try to enqueue a command. It succeeds if the queue is not full, otherwise, nothing is changed. This should be used for non-critical commands that can also be retried later.

getCurrentValue :: Core -> Path -> IO (Maybe Value) Source #

withCoreMetrics :: MonadIO m => Core -> (IcepeakMetrics -> IO ()) -> m () Source #

lookup :: Eq a => a -> [(a, b)] -> Maybe b #

lookup key assocs looks up a key in an association list.

newCore :: Config -> Logger -> Maybe IcepeakMetrics -> IO (Either String Core) Source #

Try to initialize the core. This loads the database and sets up the internal data structures.

postQuit :: Core -> IO () Source #

runCommandLoop :: Core -> IO () Source #

Drain the command queue and execute them. Changes are published to all subscribers. This function returns when executing the Stop command from the queue.

runSyncTimer :: Core -> IO () Source #

Periodically send a Sync command to the Core if enabled in the core configuration.