-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Perform finalization for threads.
--   
--   Please see the README on GitHub at
--   <a>https://github.com/iand675/thread-finalizers#readme</a>
@package thread-utils-finalizers
@version 0.1.1.0

module Control.Concurrent.Thread.Finalizers

-- | A variant of <a>mkWeakThreadId</a> that supports finalization.
--   
--   Make a weak pointer to a <a>ThreadId</a>. It can be important to do
--   this if you want to hold a reference to a <a>ThreadId</a> while still
--   allowing the thread to receive the <tt>BlockedIndefinitely</tt> family
--   of exceptions (e.g. <a>BlockedIndefinitelyOnMVar</a>). Holding a
--   normal <a>ThreadId</a> reference will prevent the delivery of
--   <tt>BlockedIndefinitely</tt> exceptions because the reference could be
--   used as the target of <a>throwTo</a> at any time, which would unblock
--   the thread.
--   
--   Holding a <tt>Weak ThreadId</tt>, on the other hand, will not prevent
--   the thread from receiving <tt>BlockedIndefinitely</tt> exceptions. It
--   is still possible to throw an exception to a <tt>Weak ThreadId</tt>,
--   but the caller must use <tt>deRefWeak</tt> first to determine whether
--   the thread still exists.
mkWeakThreadIdWithFinalizer :: ThreadId -> IO () -> IO (Weak ThreadId)

-- | A specialised version of <a>mkWeakThreadIdWithFinalizer</a>, where the
--   <a>Weak</a> object returned is simply thrown away (however the
--   finalizer will be remembered by the garbage collector, and will still
--   be run when the key becomes unreachable).
addThreadFinalizer :: ThreadId -> IO () -> IO ()

-- | Run a thread's finalizers. This is just a convenience alias for
--   <a>finalize</a>.
--   
--   The thread can still be used afterwards, it will simply not run the
--   associated finalizers again.
finalizeThread :: Weak ThreadId -> IO ()