Polysemy.Conc.Sync

Documentation

whileEmpty :: forall a r. Member (Sync a) r => Sem r () -> Sem r ()

Run an action repeatedly until the Sync variable is available.

whileEmptyInterval :: forall a u t d r. TimeUnit u => Members [Time t d, Sync a] r => u -> Sem r () -> Sem r ()

Run an action repeatedly until the Sync variable is available, waiting for the specified time between executions.

withSync :: forall d res r. Member (ScopedSync res d) r => InterpreterFor (Sync d) r

Run an action with a locally scoped Sync variable. This avoids a dependency on Embed IO in application logic while still allowing the variable to be scoped.

lock :: forall l r a. Members [Sync l, Resource] r => l -> Sem r a -> Sem r a

Run the action ma with an exclusive lock (mutex). When multiple threads call the action concurrently, only one is allowed to execute it at a time. The value l is used to disambiguate the Sync from other uses of the combinator. You can pass in something like Proxy "db-write"@.

Note: The Sync must be interpreted with an initially full MVar, e.g. using interpretSyncAs.

clear :: forall a r. Member (Sync a) r => Sem r ()

Remove the content of the Sync variable if it is present.

modify :: forall a b res r. Members [Sync a, Mask res, Resource] r => (a -> Sem r (a, b)) -> Sem r b

Modify a Sync variable with async exceptions masked for the Sync operations, but not the action. Allows a value to be returned. Equivalent to modifyMVar.

modify_ :: forall a res r. Members [Sync a, Mask res, Resource] r => (a -> Sem r a) -> Sem r ()

Modify a Sync variable with async exceptions masked for the Sync operations, but not the action. Does not allow a value to be returned. Equivalent to modifyMVar_.

modifyMasked :: forall a b res r. Members [Sync a, Mask res, Resource] r => (a -> Sem r (a, b)) -> Sem r b

Modify a Sync variable with async exceptions masked for the entire procedure. Allows a value to be returned. Equivalent to modifyMVarMasked.

modifyMasked_ :: forall a res r. Members [Sync a, Mask res, Resource] r => (a -> Sem r a) -> Sem r ()

Modify a Sync variable with async exceptions masked for the entire procedure. Does not allow a value to be returned. Equivalent to modifyMVarMasked_.

use :: forall a b res r. Members [Sync a, Mask res, Resource] r => (a -> Sem r b) -> Sem r b

Run an action with the current value of the Sync variable with async exceptions masked for the Sync operations, but not the action. Equivalent to withMVar.

useMasked :: forall a b res r. Members [Sync a, Mask res, Resource] r => (a -> Sem r b) -> Sem r b

Run an action with the current value of the Sync variable with async exceptions masked for the entire procedure. Equivalent to withMVarMasked.

data Sync d :: Effect

Abstracts an MVar.

For documentation on the constructors, see the module Polysemy.Conc.Effect.Sync.

import Polysemy.Conc (Sync)
import qualified Polysemy.Conc.Effect.Sync as Sync

prog :: Member (Sync Int) r => Sem r Int
prog = do
  Sync.putTry 5
  Sync.takeBlock

Instances

type DefiningModule Sync

Defined in Polysemy.Conc.Effect.Sync

type DefiningModule Sync = "Polysemy.Conc.Effect.Sync"

type ScopedSync res a = Scoped (SyncResources res) (Sync a)

Convenience alias.