Moduletime-manager-0.3.2Haskell2010

System.ThreadManager

A thread manager including a time manager. The manager has responsibility to kill managed threads.

Because this is based on the accompanying System.TimeManager module, the same caveats apply:

Only works for GHC.
Only works with a threaded runtime.
Users of older versions should check the current semantics.
Using 32-bit systems means the max timeout is maxBound :: Int (2147483647) microseconds, which is less than 36 minutes.
Using the same Handle in different threads might cause issues in some edge cases. (i.e. using cancel/pause in one thread, and resume in another)

4 types
14 values

Packagetime-manager-0.3.2
Exports18
LanguageHaskell2010
LicenceMIT
SourceThreadManager.hs

datadata ThreadManager

Manager to manage the thread and the timer.

valuenewThreadManager :: Manager -> IO ThreadManager

Create a thread manager.

To create a ThreadManager, you will first have to create a Manager from the System.TimeManager module.

You can use either initialize or withManager.

valuestopAfter :: ThreadManager -> IO a -> (Maybe SomeException -> IO ()) -> IO a

Stopping the manager.

stopAfter threadManager action cleanup

The action is run in the scope of an exception handler that catches all exceptions (including asynchronous ones); this allows the cleanup handler to cleanup in all circumstances. If an exception is caught, it is rethrown after the cleanup is complete.

valuestopAfterWithResult

:: ThreadManager
-> IO a
-> Either SomeException a -> IO b
-> IO b

Generalization of stopAfter where the cleanup handler is allowed to construct the final result

Unlike in stopAfter, if an exception is thrown, it is not re-thrown after the cleanup handler completes; the cleanup handler itself can decide to rethrow it or compute a result.

datadata KilledByThreadManager

An exception used internally to kill a managed thread.

Constructors

KilledByThreadManager (Maybe SomeException)

Instances2Show, Exception

Show KilledByThreadManagerDefined in time-manager-0.3.2 · System.ThreadManager
Exception KilledByThreadManagerDefined in time-manager-0.3.2 · System.ThreadManager

Fork

5 declarations

valueforkManaged

:: ThreadManager
-> String
Thread name
-> IO ()
Action
-> IO ()

Fork a managed thread.

This guarantees that the thread ID is added to the manager's queue before the thread starts, and is removed again when the thread terminates (normally or abnormally).

valueforkManagedFinally

:: ThreadManager
-> String
Thread name
-> IO ()
Action
-> IO ()
Cleanup function
-> IO ()

Fork a managed thread with a cleanup function.

valueforkManagedUnmask

:: ThreadManager
-> String
Thread name
-> ((forall x. IO x -> IO x) -> IO ())
Action with unmask argument
-> IO ()

Like forkManaged, but run action with exceptions masked

valueforkManagedTimeout

:: ThreadManager
-> String
Thread name
-> (Handle -> IO ())
Action with timeout handle
-> IO ()

Fork a managed thread with a handle created by a timeout manager.

valueforkManagedTimeoutFinally

:: ThreadManager
-> String
Thread name
-> (Handle -> IO ())
Action with timeout handle
-> IO ()
Cleanup function
-> IO ()

Fork a managed thread with a handle created by a timeout manager and with a cleanup function.

Synchronization

2 declarations

valuewaitUntilAllGone :: ThreadManager -> IO ()

Wait until all managed threads are finished.

valueisAllGone :: ThreadManager -> STM Bool

STM action that checks if all managed threads are finished.

Re-exports

6 declarations

newtypenewtype Manager

A timeout manager

valuewithHandle :: ThreadManager -> TimeoutAction -> (Handle -> IO a) -> IO a

Registering a TimeoutAction and unregister its Handle when the body action is finished.

datadata Handle

A handle used by a timeout manager.

valuetickle :: Handle -> IO ()

Extending the timeout.

Careful: this does NOT reactivate an already paused Handle!

valuepause :: Handle -> IO ()

This is identical to cancel. To resume timeout with the same Handle, resume MUST be called. Don't call tickle for resumption.

valueresume :: Handle -> IO ()

Resuming the timeout.

Works like tickle if the Handle wasn't paused or canceled.