Polysemy.Conc.Effect.Sync

Documentation

data Sync d :: Effect where

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

Constructors

Block :: Sync d m d

Read the variable, waiting until a value is available.

Wait :: TimeUnit u => u -> Sync d m (Maybe d)

Read the variable, waiting until a value is available or the timeout has expired.

Try :: Sync d m (Maybe d)

Read the variable, returning Nothing immmediately if no value was available.

TakeBlock :: Sync d m d

Take the variable, waiting until a value is available.

TakeWait :: TimeUnit u => u -> Sync d m (Maybe d)

Take the variable, waiting until a value is available or the timeout has expired.

TakeTry :: Sync d m (Maybe d)

Take the variable, returning Nothing immmediately if no value was available.

PutBlock :: d -> Sync d m ()

Write the variable, waiting until it is writable.

PutWait :: TimeUnit u => u -> d -> Sync d m Bool

Write the variable, waiting until it is writable or the timeout has expired.

PutTry :: d -> Sync d m Bool

Write the variable, returning False immmediately if a value was available.

Empty :: Sync d m Bool

Indicate whether the variable is empty.

empty :: forall d r. Member (Sync d) r => Sem r Bool

Indicate whether the variable is empty.

putTry :: forall d r. Member (Sync d) r => d -> Sem r Bool

Write the variable, returning False immmediately if a value was available.

putWait :: forall d r u. (Member (Sync d) r, TimeUnit u) => u -> d -> Sem r Bool

Write the variable, waiting until it is writable or the timeout has expired.

putBlock :: forall d r. Member (Sync d) r => d -> Sem r ()

Write the variable, waiting until it is writable.

takeTry :: forall d r. Member (Sync d) r => Sem r (Maybe d)

Take the variable, returning Nothing immmediately if no value was available.

takeWait :: forall d r u. (Member (Sync d) r, TimeUnit u) => u -> Sem r (Maybe d)

Take the variable, waiting until a value is available or the timeout has expired.

takeBlock :: forall d r. Member (Sync d) r => Sem r d

Take the variable, waiting until a value is available.

try :: forall d r. Member (Sync d) r => Sem r (Maybe d)

Read the variable, returning Nothing immmediately if no value was available.

wait :: forall d r u. (Member (Sync d) r, TimeUnit u) => u -> Sem r (Maybe d)

Read the variable, waiting until a value is available or the timeout has expired.

block :: forall d r. Member (Sync d) r => Sem r d

Read the variable, waiting until a value is available.

type ScopedSync a = Scoped_ (Sync a)

Convenience alias.