stm-effectful-0.1: STM effects
Safe HaskellNone
LanguageGHC2021

Effectful.Concurrent.STM.TVar.Static

Description

TVar helpers for static Concurrent effect.

Since: 0.1

Synopsis

TVar

newTVarA :: forall (es :: [Effect]) a. Concurrent :> es => a -> Eff es (TVar a) Source #

Since: 0.1

readTVarA :: forall (es :: [Effect]) a. Concurrent :> es => TVar a -> Eff es a Source #

Since: 0.1

writeTVarA :: forall (es :: [Effect]) a. Concurrent :> es => TVar a -> a -> Eff es () Source #

Since: 0.1

modifyTVarA' :: forall (es :: [Effect]) a. Concurrent :> es => TVar a -> (a -> a) -> Eff es () Source #

Since: 0.1

Re-exports

data Concurrent (a :: Type -> Type) b Source #

Provide the ability to run Eff computations concurrently in multiple threads and communicate between them.

Warning: unless you stick to high level functions from the withAsync family, the Concurrent effect makes it possible to escape the scope of any scoped effect operation. Consider the following:

>>> import Effectful.Reader.Static qualified as R
>>> printAsk msg = liftIO . putStrLn . (msg ++) . (": " ++) =<< R.ask
>>> :{
  runEff . R.runReader "GLOBAL" . runConcurrent $ do
    a <- R.local (const "LOCAL") $ do
      a <- async $ do
        printAsk "child (first)"
        threadDelay 20000
        printAsk "child (second)"
      threadDelay 10000
      printAsk "parent (inside)"
      pure a
    printAsk "parent (outside)"
    wait a
:}
child (first): LOCAL
parent (inside): LOCAL
parent (outside): GLOBAL
child (second): LOCAL

Note that the asynchronous computation doesn't respect the scope of local, i.e. the child thread still behaves like it's inside the local block, even though the parent thread already got out of it.

This is because the value provided by the Reader effect is thread local, i.e. each thread manages its own version of it. For the Reader it is the only reasonable behavior, it wouldn't be very useful if its "read only" value was affected by calls to local from its parent or child threads.

However, the cut isn't so clear if it comes to effects that provide access to a mutable state. That's why statically dispatched State and Writer effects come in two flavors, local and shared:

>>> import Effectful.State.Static.Local qualified as SL
>>> :{
  runEff . SL.execState "Hi" . runConcurrent $ do
    replicateConcurrently_ 3 $ SL.modify (++ "!")
:}
"Hi"
>>> import Effectful.State.Static.Shared qualified as SS
>>> :{
  runEff . SS.execState "Hi" . runConcurrent $ do
    replicateConcurrently_ 3 $ SS.modify (++ "!")
:}
"Hi!!!"

In the first example state updates made concurrently are not reflected in the parent thread because the value is thread local, but in the second example they are, because the value is shared.

Instances

Instances details
type DispatchOf Concurrent 
Instance details

Defined in Effectful.Concurrent.Effect

data StaticRep Concurrent 
Instance details

Defined in Effectful.Concurrent.Effect

runConcurrent :: forall (es :: [Effect]) a. (HasCallStack, IOE :> es) => Eff (Concurrent ': es) a -> Eff es a Source #

Run the Concurrent effect.

data TVar a #

Shared memory locations that support atomic memory transactions.

Instances

Instances details
Eq (TVar a)

@since base-4.8.0.0

Instance details

Defined in GHC.Internal.Conc.Sync

Methods

(==) :: TVar a -> TVar a -> Bool #

(/=) :: TVar a -> TVar a -> Bool #