Moduletime-manager-0.2.3Haskell2010

System.ThreadManager

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

4 types
12 values

Packagetime-manager-0.2.3
Exports16
LanguageHaskell2010
LicenceMIT
SourceThreadManager.hs

datadata ThreadManager

Manager to manage the thread and the timer.

valuenewThreadManager :: Manager -> IO ThreadManager

Starting a thread manager. Its action is initially set to 'return ()' and should be set by setAction. This allows that the action can include the manager itself.

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

Stopping the manager.

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.

datadata KilledByThreadManager

An exception used internally to kill a managed thread.

Constructors

KilledByThreadManager (Maybe SomeException)

Instances2Show, Exception

Show KilledByThreadManagerDefined in time-manager-0.2.3 · System.ThreadManager
Exception KilledByThreadManagerDefined in time-manager-0.2.3 · 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 -> IO () -> IO () -> IO ()

Fork a managed thread with a cleanup function.

valueforkManagedUnmask

:: ThreadManager
-> String
-> (forall x. IO x -> IO x) -> IO ()
-> IO ()

Like forkManaged, but run action with exceptions masked

valueforkManagedTimeout :: ThreadManager -> String -> (Handle -> IO ()) -> IO ()

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

valueforkManagedTimeoutFinally

:: ThreadManager
-> String
-> Handle -> IO ()
-> IO ()
-> IO ()

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

Synchronization

1 declaration

valuewaitUntilAllGone :: ThreadManager -> IO ()

Wait until all managed thread are finished.

Re-exports

6 declarations

datadata Manager

A timeout manager

valuewithHandle

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

datadata Handle

A handle used by a timeout manager.

valuetickle :: Handle -> IO ()

Setting the state to active. Manager turns active to inactive repeatedly.

valuepause :: Handle -> IO ()

Setting the state to paused. Manager does not change the value.

valueresume :: Handle -> IO ()

Setting the paused state to active. This is an alias to tickle.