Effectful.Ki

Effect

data StructuredConcurrency :: Effect

Instances

type DispatchOf StructuredConcurrency

Defined in Effectful.Ki

type DispatchOf StructuredConcurrency = 'Static 'WithSideEffects

data StaticRep StructuredConcurrency

Defined in Effectful.Ki

data StaticRep StructuredConcurrency = StructuredConcurrency

Handlers

runStructuredConcurrency :: IOE :> es => Eff (StructuredConcurrency ': es) a -> Eff es a

Run the StructuredConcurrency effect.

Core API

data Scope

A scope.

👉 Details

• A scope delimits the lifetime of all threads created within it.
• A scope is only valid during the callback provided to scoped.
• The thread that creates a scope is considered the parent of all threads created within it.
• All threads created within a scope can be awaited together (see awaitAll).
• All threads created within a scope are terminated when the scope closes.

data Thread a

A thread.

👉 Details

• A thread's lifetime is delimited by the scope in which it was created.
• The thread that creates a scope is considered the parent of all threads created within it.
• If an exception is raised in a child thread, the child either propagates the exception to its parent (see fork), or returns the exception as a value (see forkTry).
• All threads created within a scope are terminated when the scope closes.

Instances

Functor Thread

Defined in Ki.Internal.Thread

Methods

fmap :: (a -> b) -> Thread a -> Thread b

(<$) :: a -> Thread b -> Thread a

Eq (Thread a)

Defined in Ki.Internal.Thread

Methods

(==) :: Thread a -> Thread a -> Bool

(/=) :: Thread a -> Thread a -> Bool

Ord (Thread a)

Defined in Ki.Internal.Thread

Methods

compare :: Thread a -> Thread a -> Ordering

(<) :: Thread a -> Thread a -> Bool

(<=) :: Thread a -> Thread a -> Bool

(>) :: Thread a -> Thread a -> Bool

(>=) :: Thread a -> Thread a -> Bool

max :: Thread a -> Thread a -> Thread a

min :: Thread a -> Thread a -> Thread a

scoped :: StructuredConcurrency :> es => (Scope -> Eff es a) -> Eff es a

fork :: StructuredConcurrency :> es => Scope -> Eff es a -> Eff es (Thread a)

forkTry :: Exception e => StructuredConcurrency :> es => Scope -> Eff es a -> Eff es (Thread (Either e a))

await :: Thread a -> STM a

Wait for a thread to terminate.

awaitAll :: Scope -> STM ()

Wait until all threads created within a scope terminate.

Extended API

fork_ :: StructuredConcurrency :> es => Scope -> Eff es Void -> Eff es ()

forkWith :: StructuredConcurrency :> es => Scope -> ThreadOptions -> Eff es a -> Eff es (Thread a)

forkWith_ :: StructuredConcurrency :> es => Scope -> ThreadOptions -> Eff es Void -> Eff es ()

forkTryWith :: Exception e => Scope -> StructuredConcurrency :> es => ThreadOptions -> Eff es a -> Eff es (Thread (Either e a))

Thread options

data ThreadOptions

affinity

The affinity of a thread. A thread can be unbound, bound to a specific capability, or bound to a specific OS thread.

Default: Unbound

allocationLimit

The maximum number of bytes a thread may allocate before it is delivered an AllocationLimitExceeded exception. If caught, the thread is allowed to allocate an additional 100kb (tunable with +RTS -xq) to perform any necessary cleanup actions; if exceeded, the thread is delivered another.

Default: Nothing (no limit)

label

The label of a thread, visible in the event log (+RTS -l).

Default: "" (no label)

maskingState

The masking state a thread is created in. To unmask, use unsafeUnmask.

Default: Unmasked

Constructors

ThreadOptions

Fields

• affinity :: ThreadAffinity
• allocationLimit :: Maybe ByteCount
• label :: String
• maskingState :: MaskingState

Instances

Show ThreadOptions

Defined in Ki.Internal.Thread

Methods

showsPrec :: Int -> ThreadOptions -> ShowS

show :: ThreadOptions -> String

showList :: [ThreadOptions] -> ShowS

Eq ThreadOptions

Defined in Ki.Internal.Thread

Methods

(==) :: ThreadOptions -> ThreadOptions -> Bool

(/=) :: ThreadOptions -> ThreadOptions -> Bool

defaultThreadOptions :: ThreadOptions

Default thread options.

ThreadOptions
  { affinity = Unbound
  , allocationLimit = Nothing
  , label = ""
  , maskingState = Unmasked
  }

data ThreadAffinity

What, if anything, a thread is bound to.

Constructors

Unbound

Unbound.

Capability Int

Bound to a capability.

OsThread

Bound to an OS thread.

Instances

Show ThreadAffinity

Defined in Ki.Internal.Thread

Methods

showsPrec :: Int -> ThreadAffinity -> ShowS

show :: ThreadAffinity -> String

showList :: [ThreadAffinity] -> ShowS

Eq ThreadAffinity

Defined in Ki.Internal.Thread

Methods

(==) :: ThreadAffinity -> ThreadAffinity -> Bool

(/=) :: ThreadAffinity -> ThreadAffinity -> Bool

Byte count

data ByteCount

A number of bytes.

Instances

Show ByteCount

Defined in Ki.Internal.ByteCount

Methods

showsPrec :: Int -> ByteCount -> ShowS

show :: ByteCount -> String

showList :: [ByteCount] -> ShowS

Eq ByteCount

Defined in Ki.Internal.ByteCount

Methods

(==) :: ByteCount -> ByteCount -> Bool

(/=) :: ByteCount -> ByteCount -> Bool

Ord ByteCount

Defined in Ki.Internal.ByteCount

Methods

compare :: ByteCount -> ByteCount -> Ordering

(<) :: ByteCount -> ByteCount -> Bool

(<=) :: ByteCount -> ByteCount -> Bool

(>) :: ByteCount -> ByteCount -> Bool

(>=) :: ByteCount -> ByteCount -> Bool

max :: ByteCount -> ByteCount -> ByteCount

min :: ByteCount -> ByteCount -> ByteCount

kilobytes :: Natural -> ByteCount

A number of kilobytes.

megabytes :: Natural -> ByteCount

A number of megabytes.

STM re-export

atomically :: StructuredConcurrency :> es => STM a -> Eff es a

newTVarIO :: StructuredConcurrency :> es => a -> Eff es (TVar a)

newTMVarIO :: StructuredConcurrency :> es => a -> Eff es (TMVar a)

newEmptyTMVarIO :: StructuredConcurrency :> es => Eff es (TMVar a)