Control.Concurrent.HierarchyInternal

Internal implementations of Control.Concurrent.Hierarchy

Documentation

newtype FinishMarker

FinishMarker is created as empty MVar when a thread is created. It is automatically filled by () when the thread exits.

Constructors

FinishMarker (MVar ())

Instances

Eq FinishMarker

Methods

(==) :: FinishMarker -> FinishMarker -> Bool

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

newtype ThreadMap

Mutable map containing thread ID and finish marker.

Constructors

ThreadMap (MVar (Map ThreadId FinishMarker))

newThreadMap :: MonadBase IO m => m ThreadMap

Create a new empty ThreadMap.

newChild

Arguments

:: MonadBaseControl IO m

=> ThreadMap

ThreadMap where newly created thread will be registered.

-> (ThreadMap -> m ())

Action executed within the new thread.

-> m ThreadId

newChild returns ThreadId of created thread.

Create a new thread and register it to given ThreadMap.

killThreadHierarchy

Arguments

:: MonadBase IO m

=> ThreadMap

ThreadMap containing threads to be killed

-> m ()

Kill all thread registered in given ThreadMap.

newFinishMarker :: MonadBase IO m => m FinishMarker

Create new empty finish marker. Internal use only.

markFinish :: MonadBase IO m => FinishMarker -> m ()

Filling MVar of finish marker to mark thread finished. Only used by cleanup routine internally.

waitFinish :: MonadBase IO m => FinishMarker -> m ()

Wait for finish marker marked. Only used by killThreadHierarchy routine internally.

cleanup :: MonadBase IO m => FinishMarker -> ThreadMap -> ThreadMap -> m ()

Thread clean up routine automatically installed by newChild. It first killThreadHierarchy all its child threads and unregister itself. This function is not an API function but for internal use only.