Safe Haskell	None
Language	Haskell2010

Devops.Graph

Contents

Asynchronous Operations
Synchronous Operations

Synopsis

data WantedDirection
- = TurnedUp
- | TurnedDown
data Stability
- = Stable
- | Transient
type OpGraph = GraphData PreOp OpUniqueId
data OpStatus
opCheckResult :: Lens' OpStatus CheckResult
type OpStatusesMap = Map OpUniqueId (TVar OpStatus)
data OpIntent
intentPreOp :: Lens' OpIntent PreOp
intentDirection :: Lens' OpIntent WantedDirection
type Intents = Map OpUniqueId OpHistory
emptyIntents :: Intents
type Broadcast = (OpUniqueId, CheckResult, Stability, WantedDirection) -> IO ()
noBroadcast :: Broadcast
snapshot :: WantedDirection -> OpGraph -> Intents -> Intents
makeStatusesMap :: Intents -> STM OpStatusesMap
asyncTurnupGraph :: Broadcast -> OpStatusesMap -> Intents -> OpGraph -> IO ()
asyncTurndownGraph :: Broadcast -> OpStatusesMap -> Intents -> OpGraph -> IO ()
checkWholeGraph :: Broadcast -> OpStatusesMap -> Intents -> OpGraph -> IO [Async (OpUniqueId, CheckResult, Stability, WantedDirection)]
upkeepGraph :: Broadcast -> OpStatusesMap -> Intents -> OpGraph -> UpkeepFSM -> DownkeepFSM -> IO ()
defaultUpKeepFSM :: UpkeepFSM
defaultDownKeepFSM :: DownkeepFSM
waitStability :: WantedDirection -> Stability -> [TVar OpStatus] -> STM ()
syncTurnupGraph :: Broadcast -> OpGraph -> IO ()
syncTurnDownGraph :: Broadcast -> OpGraph -> IO ()

Documentation

data WantedDirection Source #

The intended direction of an operation.

Constructors

TurnedUp
TurnedDown

Instances

Eq WantedDirection Source #
Instance details Defined in Devops.Graph Methods (==) :: WantedDirection -> WantedDirection -> Bool # (/=) :: WantedDirection -> WantedDirection -> Bool #
Ord WantedDirection Source #
Instance details Defined in Devops.Graph Methods compare :: WantedDirection -> WantedDirection -> Ordering # (<) :: WantedDirection -> WantedDirection -> Bool # (<=) :: WantedDirection -> WantedDirection -> Bool # (>) :: WantedDirection -> WantedDirection -> Bool # (>=) :: WantedDirection -> WantedDirection -> Bool # max :: WantedDirection -> WantedDirection -> WantedDirection # min :: WantedDirection -> WantedDirection -> WantedDirection #
Show WantedDirection Source #
Instance details Defined in Devops.Graph Methods showsPrec :: Int -> WantedDirection -> ShowS # show :: WantedDirection -> String # showList :: [WantedDirection] -> ShowS #
Generic WantedDirection Source #
Instance details Defined in Devops.Graph Associated Types type Rep WantedDirection :: * -> * # Methods from :: WantedDirection -> Rep WantedDirection x # to :: Rep WantedDirection x -> WantedDirection #
type Rep WantedDirection Source #
Instance details Defined in Devops.Graph type Rep WantedDirection = D1 (MetaData "WantedDirection" "Devops.Graph" "deptrack-devops-0.1.0.0-1BQsWDMcJxoKhJobugMn50" False) (C1 (MetaCons "TurnedUp" PrefixI False) (U1 :: * -> ) :+: C1 (MetaCons "TurnedDown" PrefixI False) (U1 :: -> *))

data Stability Source #

The stability an operation reached.

Constructors

Stable
Transient

Instances

Eq Stability Source #
Instance details Defined in Devops.Graph Methods (==) :: Stability -> Stability -> Bool # (/=) :: Stability -> Stability -> Bool #
Ord Stability Source #
Instance details Defined in Devops.Graph Methods compare :: Stability -> Stability -> Ordering # (<) :: Stability -> Stability -> Bool # (<=) :: Stability -> Stability -> Bool # (>) :: Stability -> Stability -> Bool # (>=) :: Stability -> Stability -> Bool # max :: Stability -> Stability -> Stability # min :: Stability -> Stability -> Stability #
Show Stability Source #
Instance details Defined in Devops.Graph Methods showsPrec :: Int -> Stability -> ShowS # show :: Stability -> String # showList :: [Stability] -> ShowS #
Generic Stability Source #
Instance details Defined in Devops.Graph Associated Types type Rep Stability :: * -> * # Methods from :: Stability -> Rep Stability x # to :: Rep Stability x -> Stability #
type Rep Stability Source #
Instance details Defined in Devops.Graph type Rep Stability = D1 (MetaData "Stability" "Devops.Graph" "deptrack-devops-0.1.0.0-1BQsWDMcJxoKhJobugMn50" False) (C1 (MetaCons "Stable" PrefixI False) (U1 :: * -> ) :+: C1 (MetaCons "Transient" PrefixI False) (U1 :: -> *))

type OpGraph = GraphData PreOp OpUniqueId Source #

An OpGraph is a Graph containing PreOp.

data OpStatus Source #

The observed status for an operation.

Instances

Show OpStatus Source #
Instance details Defined in Devops.Graph Methods showsPrec :: Int -> OpStatus -> ShowS # show :: OpStatus -> String # showList :: [OpStatus] -> ShowS #

opCheckResult :: Lens' OpStatus CheckResult Source #

type OpStatusesMap = Map OpUniqueId (TVar OpStatus) Source #

A map representing the mutable status for a set of operations.

data OpIntent Source #

A snapshot representing the intent for a single operation at a given time.

intentPreOp :: Lens' OpIntent PreOp Source #

intentDirection :: Lens' OpIntent WantedDirection Source #

type Intents = Map OpUniqueId OpHistory Source #

A map representing the collection of histories for a set of operations.

emptyIntents :: Intents Source #

type Broadcast = (OpUniqueId, CheckResult, Stability, WantedDirection) -> IO () Source #

noBroadcast :: Broadcast Source #

Asynchronous Operations

snapshot :: WantedDirection -> OpGraph -> Intents -> Intents Source #

Computes a snapshot of an OpGraph.

makeStatusesMap :: Intents -> STM OpStatusesMap Source #

Returns an operation to atomically build a status map from a graph snapshot.

asyncTurnupGraph :: Broadcast -> OpStatusesMap -> Intents -> OpGraph -> IO () Source #

asyncTurndownGraph :: Broadcast -> OpStatusesMap -> Intents -> OpGraph -> IO () Source #

TODO: no longer transpose graph at the calling sites

checkWholeGraph :: Broadcast -> OpStatusesMap -> Intents -> OpGraph -> IO [Async (OpUniqueId, CheckResult, Stability, WantedDirection)] Source #

upkeepGraph Source #

Arguments

:: Broadcast	function delivering node change updates
-> OpStatusesMap	instantaneous statuses
-> Intents	historical intents
-> OpGraph	graph containing adjacencies
-> UpkeepFSM	FSM to apply to nodes that must be up
-> DownkeepFSM	FSM to apply to nodes that must be down
-> IO ()

Turns a graph up and keep it up.

defaultUpKeepFSM :: UpkeepFSM Source #

defaultDownKeepFSM :: DownkeepFSM Source #

waitStability :: WantedDirection -> Stability -> [TVar OpStatus] -> STM () Source #

Atomically wait until all statuses are stable after reaching a given direction.

Synchronous Operations

syncTurnupGraph :: Broadcast -> OpGraph -> IO () Source #

Turn-up a graph sequentially

Topologically sorts the graph then invokes TurnUp action synchronously through each node. Note the order of execution is deterministic.

syncTurnDownGraph :: Broadcast -> OpGraph -> IO () Source #

Turn-down a graph sequentially

Topologically sorts the graph then invokes TurnDown action synchronously through each node. Note the order of execution is deterministic.