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


-- | A concurrent utility inspired by Ticker in golang
--   
--   A concurrent utility inspired by Ticker in golang
@package ticker
@version 1.0.0

module Control.Concurrent.Ticker

-- | Create a new ticker.
--   
--   <pre>
--   &gt;&gt;&gt; import Control.Concurrent.Chan (getChanContents)
--   
--   &gt;&gt;&gt; import Control.Monad (forM_)
--   
--   &gt;&gt;&gt; import System.Timeout (timeout)
--   
--   &gt;&gt;&gt; (chan, cancelTicker) &lt;- newTicker $ 10^3 * 100
--   
--   &gt;&gt;&gt; chanStream &lt;- getChanContents chan
--   
--   &gt;&gt;&gt; _ &lt;- timeout (10^3 * 350) $ forM_ chanStream (\_ -&gt; putStr "Tick!")
--   Tick!Tick!Tick!
--   
--   &gt;&gt;&gt; cancelTicker
--   </pre>
newTicker :: Int -> IO (Chan (), IO ())

-- | Create a new ticker and pass a <tt>Chan ()</tt> of the ticker to the
--   supplied function. The ticker thread will be closed automatically.
--   
--   <pre>
--   &gt;&gt;&gt; import Control.Concurrent.Chan (getChanContents)
--   
--   &gt;&gt;&gt; import Control.Monad (forM_)
--   
--   &gt;&gt;&gt; import System.Timeout (timeout)
--   
--   &gt;&gt;&gt; :{
--   withTicker (10^3 * 100) $ \chan -&gt; do
--     chanStream &lt;- getChanContents chan
--     _ &lt;- timeout (10^3 * 350) $ forM_ chanStream (\_ -&gt; putStr "Tick!")
--     return ()
--   :}
--   Tick!Tick!Tick!
--   </pre>
withTicker :: Int -> (Chan () -> IO a) -> IO a

-- | A variant of the <a>newTicker</a> that uses <tt>getCPUTime</tt>
--   instead of <tt>threadDelay</tt> internally.

-- | <i>Deprecated: It doesn't work well.</i>
newCPUTimeTicker :: Int -> IO (Chan (), IO ())