Control.Distributed.Process.FSM.Internal.Types

Types and common functionality.

Documentation

apply :: Show s => State s d -> Message -> Step s d -> Process (Maybe (State s d))

applyTransitions :: forall s d. Show s => State s d -> [GenProcess (State s d) ()] -> Action (State s d)

data State s d

The internal state of an FSM process.

Constructors

(Show s, Eq s) => State

Fields

• stName :: s
• stData :: d
• stProg :: Step s d
• stInput :: Maybe Message
• stReply :: Message -> Process ()
• stTrans :: Seq (Transition s d)
• stQueue :: Seq Message

Instances

Show s => Show (State s d)

Methods

showsPrec :: Int -> State s d -> ShowS

show :: State s d -> String

showList :: [State s d] -> ShowS

MonadState (State s d) (FSM s d)

Methods

get :: FSM s d (State s d)

put :: State s d -> FSM s d ()

state :: (State s d -> (a, State s d)) -> FSM s d a

data Transition s d

Represents a transition from one world state to another. Transitions can be used to alter the process state, state data, to modify and/or interact with the process mailbox, and to postpone processing of messages until state changes take place.

The fundmental state transactions are Remain, Enter newState, and Stop exitReason.

Constructors

Remain

PutBack

Push Message

Enqueue Message

Postpone

Enter s

Stop ExitReason

Eval (GenProcess (State s d) ())

Instances

Show s => Show (Transition s d)

Methods

showsPrec :: Int -> Transition s d -> ShowS

show :: Transition s d -> String

showList :: [Transition s d] -> ShowS

data Event m where

Represents an event arriving, parameterised by the type m of the event. Used in a combinatorial style to wire FSM steps, actions and transitions to specific types of input event.

Constructors

Wait :: Serializable m => Event m

WaitP :: Serializable m => Priority () -> Event m

Event :: Serializable m => m -> Event m

Instances

Typeable * m => Show (Event m)

Methods

showsPrec :: Int -> Event m -> ShowS

show :: Event m -> String

showList :: [Event m] -> ShowS

data Stopping

Event type wrapper passed to the FSM whenever we're shutting down.

Constructors

Stopping

Fields

• reason :: ExitReason

  The ExitReason

• errored :: Bool

  Was the shutdown triggered by an error

Instances

Show Stopping

Methods

showsPrec :: Int -> Stopping -> ShowS

show :: Stopping -> String

showList :: [Stopping] -> ShowS

Generic Stopping

Associated Types

type Rep Stopping :: * -> *

Methods

from :: Stopping -> Rep Stopping x

to :: Rep Stopping x -> Stopping

Binary Stopping

Methods

put :: Stopping -> Put

get :: Get Stopping

putList :: [Stopping] -> Put

type Rep Stopping

type Rep Stopping = D1 (MetaData "Stopping" "Control.Distributed.Process.FSM.Internal.Types" "distributed-process-fsm-0.0.1-CkNPRCCWUDwKnzcrQjxehF" False) (C1 (MetaCons "Stopping" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "reason") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ExitReason)) (S1 (MetaSel (Just Symbol "errored") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))

resolveEvent :: forall s d m. Serializable m => Event m -> Message -> State s d -> m -> Process (Int, Message)

Resolve an event into a priority setting, for insertion into a priority queue.

data Step s d where

Represents a step in a FSM definition

Constructors

Init :: Step s d -> Step s d -> Step s d

Yield :: s -> d -> Step s d

SafeWait :: Serializable m => Event m -> Step s d -> Step s d

Await :: Serializable m => Event m -> Step s d -> Step s d

Always :: Serializable m => (m -> FSM s d (Transition s d)) -> Step s d

Perhaps :: Eq s => s -> FSM s d (Transition s d) -> Step s d

Matching :: Serializable m => (m -> Bool) -> (m -> FSM s d (Transition s d)) -> Step s d

Sequence :: Step s d -> Step s d -> Step s d

Alternate :: Step s d -> Step s d -> Step s d

Reply :: Serializable r => FSM s d r -> Step s d

Instances

Show s => Show (Step s d)

Methods

showsPrec :: Int -> Step s d -> ShowS

show :: Step s d -> String

showList :: [Step s d] -> ShowS

newtype FSM s d o

State monad transformer.

Constructors

FSM

Fields

• unFSM :: StateT (State s d) Process o

Instances

Monad (FSM s d)

Methods

(>>=) :: FSM s d a -> (a -> FSM s d b) -> FSM s d b

(>>) :: FSM s d a -> FSM s d b -> FSM s d b

return :: a -> FSM s d a

fail :: String -> FSM s d a

Functor (FSM s d)

Methods

fmap :: (a -> b) -> FSM s d a -> FSM s d b

(<$) :: a -> FSM s d b -> FSM s d a

MonadFix (FSM s d)

Methods

mfix :: (a -> FSM s d a) -> FSM s d a

Applicative (FSM s d)

Methods

pure :: a -> FSM s d a

(<*>) :: FSM s d (a -> b) -> FSM s d a -> FSM s d b

(*>) :: FSM s d a -> FSM s d b -> FSM s d b

(<*) :: FSM s d a -> FSM s d b -> FSM s d a

MonadIO (FSM s d)

Methods

liftIO :: IO a -> FSM s d a

MonadState (State s d) (FSM s d)

Methods

get :: FSM s d (State s d)

put :: State s d -> FSM s d ()

state :: (State s d -> (a, State s d)) -> FSM s d a

runFSM :: State s d -> FSM s d o -> Process (o, State s d)

Run an action in the FSM monad.

lift :: Process a -> FSM s d a

Lift an action in the Process monad to FSM.

liftIO :: IO a -> FSM s d a

Lift an IO action directly into FSM, liftIO = lift . Process.LiftIO.

currentState :: FSM s d s

Fetch the state for the current pass.

currentInput :: forall s d m. Serializable m => FSM s d (Maybe m)

Retrieve the currentMessage and attempt to decode it to type m

currentMessage :: forall s d. FSM s d Message

Fetch the message that initiated the current pass.

stateData :: FSM s d d

Fetch the state data for the current pass.

addTransition :: Transition s d -> FSM s d ()

Add a Transition to be evaluated once the current pass completes.

baseErr :: String

Base module name for error messages.

decodeToEvent :: Serializable m => Event m -> Message -> Maybe (Event m)

Given an Event for any Serializable type m and a raw message, decode the message and map it to either Event m if the types are aligned, otherwise Nothing.