docs

Author: hyperthunk

src/Control/Distributed/Process/FSM.hs

@@ -395,7 +395,7 @@ module Control.Distributed.Process.FSM
  , (~@)
  , (~?)
  , (^.)
-   -- * Useful / Important Types and Utilities
+   -- * Types and Utilities
  , Event
  , FSM
  , lift
@@ -426,8 +426,8 @@ import Control.Distributed.Process.FSM.Internal.Types
 import Control.Distributed.Process.Serializable (Serializable)
 import Prelude hiding ((*>))
 
--- | Fluent way to say "yield" when you're building an initial state up (e.g.
--- whilst utilising "begin").
+-- | Fluent way to say 'yield' when you're building an initial state up (e.g.
+-- whilst utilising 'begin').
 initState :: forall s d . s -> d -> Step s d
 initState = yield
 
@@ -437,13 +437,13 @@ yield :: forall s d . s -> d -> Step s d
 yield = Yield
 
 -- | Creates an @Event m@ for some "Serializable" type @m@. When passed to
--- functions that follow the combinator pattern (such as "await"), will ensure
+-- functions that follow the combinator pattern (such as 'await'), will ensure
 -- that only messages of type @m@ are processed by the handling expression.
 --
 event :: (Serializable m) => Event m
 event = Wait
 
--- | A /prioritised/ version of "event". The server will prioritise messages
+-- | A /prioritised/ version of 'event'. The server will prioritise messages
 -- matching the "Event" type @m@.
 --
 -- See "Control.Distributed.Process.ManagedProcess.Server.Priority" for more
@@ -452,8 +452,8 @@ pevent :: (Serializable m) => Int -> Event m
 pevent = WaitP . setPriority
 
 -- | Evaluates to a "Transition" that instructs the process to enter the given
--- state @s@. All expressions following evaluation of "enter" will see
--- "currentState" containing the updated value, and any future events will be
+-- state @s@. All expressions following evaluation of 'enter' will see
+-- 'currentState' containing the updated value, and any future events will be
 -- processed in the new state.
 --
 -- In addition, should any events/messages have been postponed in a previous
@@ -486,7 +486,7 @@ putBack = return PutBack
 nextEvent :: forall s d m . (Serializable m) => m -> FSM s d (Transition s d)
 nextEvent m = return $ Push (wrapMessage m)
 
--- | As "nextEvent", but places the message at the back of the queue by default.
+-- | As 'nextEvent', but places the message at the back of the queue by default.
 --
 -- Mailbox priority ordering will still take precedence over insertion order.
 --
@@ -502,7 +502,7 @@ resume = return Remain
 -- sending its event to the process.
 --
 -- The expression used to produce the reply message must reside in the "FSM" monad.
--- The reply is /not/ sent immediately upon evaluating "reply", however if the
+-- The reply is /not/ sent immediately upon evaluating 'reply', however if the
 -- sender supplied a reply channel, the reply is guaranteed to be sent prior to
 -- evaluating the next pass.
 --
@@ -532,7 +532,7 @@ stop = return . Stop
 --
 -- This expression functions as a "Transition" and is not applied immediately.
 -- To /see/ state data changes in subsequent expressions during a single pass,
--- use "yield" instead.
+-- use 'yield' instead.
 set :: forall s d . (d -> d) -> FSM s d (Transition s d)
 set f = return $ Eval (processState >>= \s -> setProcessState $ s { stData = (f $ stData s) })
 
@@ -543,12 +543,12 @@ set_ f = set f >>= addTransition
 --
 -- This expression functions as a "Transition" and is not applied immediately.
 -- To /see/ state data changes in subsequent expressions during a single pass,
--- use "yield" instead.
+-- use 'yield' instead.
 put :: forall s d . d -> FSM s d ()
 put d = addTransition $ Eval $ do
   processState >>= \s -> setProcessState $ s { stData = d }
 
--- | Synonym for "pick"
+-- | Synonym for 'pick'
 (.|) :: Step s d -> Step s d -> Step s d
 (.|) = Alternate
 infixr 9 .|
@@ -558,7 +558,7 @@ infixr 9 .|
 pick :: Step s d -> Step s d -> Step s d
 pick = Alternate
 
--- | Synonym for "begin"
+-- | Synonym for 'begin'
 (^.) :: Step s d -> Step s d -> Step s d
 (^.) = Init
 infixr 9 ^.
@@ -568,7 +568,7 @@ infixr 9 ^.
 begin :: Step s d -> Step s d -> Step s d
 begin = Init
 
--- | Synonym for "join".
+-- | Synonym for 'join'.
 (|>) :: Step s d -> Step s d -> Step s d
 (|>) = Sequence
 infixr 9 |>
@@ -582,10 +582,11 @@ join = Sequence
 (<|) = flip Sequence
 -- infixl 9 <|
 
+-- | Join from right to left.
 reverseJoin :: Step s d -> Step s d -> Step s d
 reverseJoin = flip Sequence
 
--- | Synonym for "await"
+-- | Synonym for 'await'
 (~>) :: forall s d m . (Serializable m) => Event m -> Step s d -> Step s d
 (~>) = Await
 infixr 9 ~>
@@ -595,27 +596,27 @@ infixr 9 ~>
 await :: forall s d m . (Serializable m) => Event m -> Step s d -> Step s d
 await = Await
 
--- | Synonym for "safeWait"
+-- | Synonym for 'safeWait'
 (*>) :: forall s d m . (Serializable m) => Event m -> Step s d -> Step s d
 (*>) = SafeWait
 infixr 9 *>
 
--- | A /safe/ version of "await". The FSM will place a @check $ safe@ filter
+-- | A /safe/ version of 'await'. The FSM will place a @check $ safe@ filter
 -- around all messages matching the input type @m@ of the "Event" argument.
 -- Should an exit signal interrupt the current pass, the input event will be
 -- re-tried if an exit handler can be found for the exit-reason.
 --
--- In all other respects, this API behaves exactly like "await"
+-- In all other respects, this API behaves exactly like 'await'
 safeWait :: forall s d m . (Serializable m) => Event m -> Step s d -> Step s d
 safeWait = SafeWait
 
--- | Synonym for "atState"
+-- | Synonym for 'atState'
 (~@) :: forall s d . (Eq s) => s -> FSM s d (Transition s d) -> Step s d
 (~@) = Perhaps
 infixr 9 ~@
 
 -- | Given a state @s@ and an expression that evaluates to a  "Transition",
--- proceed with evaluation only if the "currentState" is equal to @s@.
+-- proceed with evaluation only if the 'currentState' is equal to @s@.
 atState :: forall s d . (Eq s) => s -> FSM s d (Transition s d) -> Step s d
 atState = Perhaps
 
@@ -629,11 +630,11 @@ whenStateIs s = s ~@ resume
 allState :: forall s d m . (Serializable m) => (m -> FSM s d (Transition s d)) -> Step s d
 allState = Always
 
--- | Synonym for "allState".
+-- | Synonym for 'allState'.
 always :: forall s d m . (Serializable m) => (m -> FSM s d (Transition s d)) -> Step s d
 always = Always
 
--- | Synonym for "matching".
+-- | Synonym for 'matching'.
 (~?) :: forall s d m . (Serializable m) => (m -> Bool) -> (m -> FSM s d (Transition s d)) -> Step s d
 (~?) = Matching
 

src/Control/Distributed/Process/FSM/Client.hs

@@ -44,6 +44,8 @@ import Control.Distributed.Process.FSM.Internal.Types (baseErr)
 import Control.Distributed.Process.Serializable (Serializable)
 import Control.Monad.Catch (bracket)
 
+-- | Initiate a 'call' and if an exit signal arrives, return it as
+-- @Left reason@, otherwise evaluate to @Right result@.
 safeCall :: (Serializable m, Serializable r)
          => ProcessId
          -> m
@@ -57,6 +59,9 @@ safeCall pid msg = do
     weFailed a b (ExitOther _) = a == b
     weFailed _ _ _             = False
 
+-- | As 'call' but times out if the response does not arrive without the
+-- specified "TimeInterval". If the call times out, the caller's mailbox
+-- is not affected (i.e. no message will arrive at a later time).
 callTimeout :: (Serializable m, Serializable r)
             => ProcessId
             -> m
@@ -77,6 +82,11 @@ callTimeout pid msg ti = bracket (monitor pid) unmonitor $ \mRef -> do
                     Just r -> return $ Just r
                     _      -> die $ ExitOther $ baseErr ++ ".Client:InvalidResponseType"
 
+-- | Make a synchronous /call/ to the FSM process at "ProcessId". If a
+-- "Step" exists that upon receiving an event of type @m@ will eventually
+-- reply to the caller, the reply will be the result of evaluating this
+-- function. If not, or if the types do not match up, this function will
+-- block indefinitely.
 call :: (Serializable m, Serializable r) => ProcessId -> m -> Process r
 call pid msg = bracket (monitor pid) unmonitor $ \mRef -> do
   (sp, rp) <- newChan :: Process (SendPort Message, ReceivePort Message)

src/Control/Distributed/Process/FSM/Internal/Process.hs

@@ -2,7 +2,20 @@
 {-# LANGUAGE ScopedTypeVariables        #-}
 {-# LANGUAGE PatternGuards              #-}
 {-# LANGUAGE RecordWildCards            #-}
-
+-----------------------------------------------------------------------------
+-- |
+-- Module      :  Control.Distributed.Process.FSM.Internal.Process
+-- Copyright   :  (c) Tim Watson 2017
+-- License     :  BSD3 (see the file LICENSE)
+--
+-- Maintainer  :  Tim Watson <watson.timothy@gmail.com>
+-- Stability   :  experimental
+-- Portability :  non-portable (requires concurrency)
+--
+-- The /Managed Process/ implementation of an FSM process.
+--
+-- See "Control.Distributed.Process.ManagedProcess".
+-----------------------------------------------------------------------------
 module Control.Distributed.Process.FSM.Internal.Process
  ( start
  , run

src/Control/Distributed/Process/FSM/Internal/Types.hs

@@ -8,7 +8,18 @@
 {-# LANGUAGE MultiParamTypeClasses      #-}
 {-# LANGUAGE GADTs                      #-}
 {-# LANGUAGE RankNTypes                 #-}
-
+-----------------------------------------------------------------------------
+-- |
+-- Module      :  Control.Distributed.Process.FSM.Internal.Types
+-- Copyright   :  (c) Tim Watson 2017
+-- License     :  BSD3 (see the file LICENSE)
+--
+-- Maintainer  :  Tim Watson <watson.timothy@gmail.com>
+-- Stability   :  experimental
+-- Portability :  non-portable (requires concurrency)
+--
+-- Types and common functionality.
+-----------------------------------------------------------------------------
 module Control.Distributed.Process.FSM.Internal.Types
  ( apply
  , applyTransitions
@@ -219,11 +230,11 @@ stateData = ST.get >>= return . stData
 currentMessage :: forall s d . FSM s d P.Message
 currentMessage = ST.get >>= return . fromJust . stInput
 
--- | Retrieve the "currentMessage" and attempt to decode it to type @m@
+-- | Retrieve the 'currentMessage' and attempt to decode it to type @m@
 currentInput :: forall s d m . (Serializable m) => FSM s d (Maybe m)
 currentInput = currentMessage >>= \m -> lift (unwrapMessage m :: Process (Maybe m))
 
--- | A a "Transition" to be evaluated once the current pass completes.
+-- | Add a "Transition" to be evaluated once the current pass completes.
 addTransition :: Transition s d -> FSM s d ()
 addTransition t = ST.modify (\s -> fromJust $ enqueue s (Just t) )