Drama.Internal

Documentation

newtype Actor msg a

The Actor monad, where you can spawn other actors, and send and receive messages.

Since: 0.1.0.0

Constructors

Actor (ReaderT (ActorEnv msg) IO a)

Instances

Monad (Actor msg)

Defined in Drama.Internal

Methods

(>>=) :: Actor msg a -> (a -> Actor msg b) -> Actor msg b

(>>) :: Actor msg a -> Actor msg b -> Actor msg b

return :: a -> Actor msg a

Functor (Actor msg)

Defined in Drama.Internal

Methods

fmap :: (a -> b) -> Actor msg a -> Actor msg b

(<$) :: a -> Actor msg b -> Actor msg a

MonadFix (Actor msg)

Defined in Drama.Internal

Methods

mfix :: (a -> Actor msg a) -> Actor msg a

MonadFail (Actor msg)

Defined in Drama.Internal

Methods

fail :: String -> Actor msg a

Applicative (Actor msg)

Defined in Drama.Internal

Methods

pure :: a -> Actor msg a

(<*>) :: Actor msg (a -> b) -> Actor msg a -> Actor msg b

liftA2 :: (a -> b -> c) -> Actor msg a -> Actor msg b -> Actor msg c

(*>) :: Actor msg a -> Actor msg b -> Actor msg b

(<*) :: Actor msg a -> Actor msg b -> Actor msg a

MonadIO (Actor msg)

Defined in Drama.Internal

Methods

liftIO :: IO a -> Actor msg a

Alternative (Actor msg)

Defined in Drama.Internal

Methods

empty :: Actor msg a

(<|>) :: Actor msg a -> Actor msg a -> Actor msg a

some :: Actor msg a -> Actor msg [a]

many :: Actor msg a -> Actor msg [a]

MonadPlus (Actor msg)

Defined in Drama.Internal

Methods

mzero :: Actor msg a

mplus :: Actor msg a -> Actor msg a -> Actor msg a

runActor :: MonadIO m => ActorEnv msg -> Actor msg a -> m a

Since: 0.1.0.0

data ActorEnv msg

Environment for the Actor monad.

Since: 0.1.0.0

Constructors

ActorEnv

Fields

• address :: Address msg
• mailbox :: Mailbox msg
• scope :: Scope

newtype Address msg

The address for an actor. Returned after spawning an actor or asking for the current actor's address with here. Used to send messages to specific actors.

Since: 0.1.0.0

Constructors

Address (InChan msg)

newtype Mailbox msg

Where messages are delivered. Implicitly provided to receive and tryReceive by the Actor monad.

Since: 0.1.0.0

Constructors

Mailbox (OutChan msg)

newtype Scope

Since: 0.1.0.0

Constructors

Scope Scope

spawn :: Actor childMsg () -> Actor msg (Address childMsg)

Spawn a new actor. Returns the spawned actor's address.

Example:

printerAddress <- spawn printer

Since: 0.1.0.0

wait :: Actor msg ()

Wait for all actors spawned by the current actor to terminate.

Example:

fooAddress <- spawn foo
barAddress <- spawn bar
wait

Since: 0.1.0.0

here :: Actor msg (Address msg)

Return the current actor's own address. Useful for sending your address to other actors, or for sending yourself a message.

Since: 0.1.0.0

send :: Address recipientMsg -> recipientMsg -> Actor msg ()

Given an actor's address, send it a message.

Example:

send printerAddress "Hello, world!"

Since: 0.1.0.0

receive :: Actor msg msg

Receive a message sent to the actor's mailbox. This function blocks until a message is received.

Example:

printer :: Actor String ()
printer = forever do
  string <- receive
  liftIO $ putStrLn string

Since: 0.1.0.0

tryReceive :: Actor msg (Maybe msg)

Receive a message sent to the actor's mailbox. This function blocks until a message is received.

Example:

printer :: Actor String ()
printer = forever do
  tryReceive >>= \case
    Just string -> liftIO $ putStrLn string
    Nothing -> ...

Since: 0.1.0.0

run :: MonadIO m => Actor msg a -> m a

Run a top-level actor. Intended to be used at the entry point of your program.

Since: 0.1.0.0

loop

Arguments

:: s

Initial state

-> (s -> Actor msg (Either s a))

Action to perform, either returning a new state to continue looping, or a final value to stop looping.

-> Actor msg a

Loop indefinitely with state. Use forever for stateless infinite loops.

Example:

counter :: Actor () Int
counter = loop 10 \count -> do
  liftIO $ print count
  if count > 0
    then continue (count - 1)
    else exit count

Since: 0.1.0.0

continue :: s -> Actor msg (Either s a)

Continue looping with state.

continue s = pure (Left s)

Since: 0.1.0.0

exit :: a -> Actor msg (Either s a)

Exit loop with value.

exit x = pure (Right x)

Since: 0.1.0.0