UnliftIO.Concurrent · unliftio-0.2.25.1

Concurrent Haskell

1 declaration

datadata ThreadId

A ThreadId is an abstract type representing a handle to a thread. ThreadId is an instance of Eq, Ord and Show, where the Ord instance implements an arbitrary total ordering over ThreadIds. The Show instance lets you convert an arbitrary-valued ThreadId to string form; showing a ThreadId value is occasionally useful when debugging or diagnosing the behaviour of a concurrent program.

Note: in GHC, if you have a ThreadId, you essentially have a pointer to the thread itself. This means the thread itself can't be garbage collected until you drop the ThreadId. This misfeature would be difficult to correct while continuing to support threadStatus.

Instances5Eq, Ord, Show, NFData, Hashable

Eq ThreadIdDefined in ghc-internal-9.1003.0 · GHC.Internal.Conc.Sync
Ord ThreadIdDefined in ghc-internal-9.1003.0 · GHC.Internal.Conc.Sync
Show ThreadIdDefined in ghc-internal-9.1003.0 · GHC.Internal.Conc.Sync
NFData ThreadIdDefined in deepseq-1.5.0.0 · Control.DeepSeq
Hashable ThreadIdDefined in hashable-1.4.7.0 · Data.Hashable.Class

Basic concurrency operations

7 declarations

valuemyThreadId :: MonadIO m => m ThreadId

#

Lifted version of myThreadId.

valueforkIO :: MonadUnliftIO m => m () -> m ThreadId

#

Unlifted version of forkIO.

valueforkWithUnmask

:: MonadUnliftIO m
=> (forall a. m a -> m a) -> m ()
-> m ThreadId

#

Deprecated. forkWithUnmask has been renamed to forkIOWithUnmask

Please use forkIOWithUnmask instead. This function has been deprecated in release 0.2.11 and will be removed in the next major release.

valueforkIOWithUnmask

:: MonadUnliftIO m
=> (forall a. m a -> m a) -> m ()
-> m ThreadId

#

Unlifted version of forkIOWithUnmask.

valueforkFinally

:: MonadUnliftIO m
=> m a
-> Either SomeException a -> m ()
-> m ThreadId

#

Unlifted version of forkFinally.

valuekillThread :: MonadIO m => ThreadId -> m ()

#

Lifted version of killThread.

valuethrowTo :: (Exception e, MonadIO m) => ThreadId -> e -> m ()

#

Throw an asynchronous exception to another thread.

Synchronously typed exceptions will be wrapped into an AsyncExceptionWrapper, see https://github.com/fpco/safe-exceptions#determining-sync-vs-async.

It's usually a better idea to use the UnliftIO.Async module, see https://github.com/fpco/safe-exceptions#quickstart.

Threads with affinity

valueforkOn :: MonadUnliftIO m => Int -> m () -> m ThreadId

#

Unlifted version of forkOn.

valueforkOnWithUnmask

:: MonadUnliftIO m
=> Int
-> (forall a. m a -> m a) -> m ()
-> m ThreadId

#

Unlifted version of forkOnWithUnmask.

valuegetNumCapabilities :: MonadIO m => m Int

#

Lifted version of getNumCapabilities.

valuesetNumCapabilities :: MonadIO m => Int -> m ()

#

Lifted version of setNumCapabilities.

valuethreadCapability :: MonadIO m => ThreadId -> m (Int, Bool)

#

Lifted version of threadCapability.

Scheduling

1 declaration

valueyield :: MonadIO m => m ()

#

Lifted version of yield.

Waiting

valuethreadDelay :: MonadIO m => Int -> m ()

#

Lifted version of threadDelay.

valuethreadWaitRead :: MonadIO m => Fd -> m ()

#

Lifted version of threadWaitRead.

valuethreadWaitWrite :: MonadIO m => Fd -> m ()

#

Lifted version of threadWaitWrite.

Communication abstractions

0 declarations

module UnliftIO.MVar

module UnliftIO.Chan

Bound Threads

5 declarations

valuertsSupportsBoundThreads :: Bool

#

True if bound threads are supported. If rtsSupportsBoundThreads is False, isCurrentThreadBound will always return False and both forkOS and runInBoundThread will fail.