immortal-0.2: Spawn threads that never die (unless told to do so)

Safe HaskellNone

Control.Immortal

Description

This module is designed to be imported qualified, e.g.

import qualified Control.Immortal as Immortal

Synopsis

Documentation

data Thread Source

Immortal thread identifier (including its underlying ThreadId)

create :: MonadBaseControl IO m => (Thread -> m ()) -> m ThreadSource

Spawn a new immortal thread running the given computation.

If the computation ever finishes (either normally or due to an exception), it will be restarted (in the same thread).

The monadic «state» (captured by thMonadBaseControl instance) will be preserved if the computation terminates normally, and reset when the exception is thrown, so be cautious when m is stateful. It is completely safe, however, to instantiate m with something like ReaderT conf IO to pass configuration to the new thread.

createWithLabel :: MonadBaseControl IO m => String -> (Thread -> m ()) -> m ThreadSource

Like create, but also apply the given label to the thread (using labelThread).

mortalize :: Thread -> IO ()Source

Make a thread mortal. Next time a mortal thread attempts to finish, nothing will prevent it from doing so.

Calling this on an already mortalized thread has no effect.

immortalize :: Thread -> IO ()Source

If a thread was mortalized, this will make it immortal again. However, if it finished while being in the mortal state, it won't be resurrected.

Calling this on an immortal thread has no effect.

stop :: Thread -> IO ()Source

Stop (kill) an immortal thread.

This is equivalent to making it mortal, and then killing it with an exception.

Note that if the thread has installed its own exception handlers, it may not be killed immediately.

threadId :: Thread -> ThreadIdSource

Get the ThreadId of the immortal thread.

The ThreadId can be used to throw asynchronous exception to interrupt the computation. This won't kill the thread, however — even if the exception is not handled, the computation will be simply restarted.

onFinish :: MonadBaseControl IO m => (Either SomeException () -> m ()) -> m () -> m ()Source

Run a callback every time the action finishes. This can be used e.g. to log exceptions or attempts to exit when such attempts are not expected. Example usage:

Immortal.create $ Immortal.onFinish print myAction

This is nothing more than a simple wrapper around try.