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


-- | Provides API for timer based execution of IO actions
--   
--   This is a lightweight package built on top of the async package
--   providing easy to use periodic timers. This can be used for executing
--   IO actions periodically.
@package async-timer
@version 0.2.0.0


-- | This module exports the public API for asynchronous timers.
module Control.Concurrent.Async.Timer

-- | This is the type of timer handle, which will be provided to the IO
--   action to be executed within <a>withAsyncTimer</a>. The user can use
--   <tt>timerWait</tt> on this timer to delay execution until the next
--   timer synchronization event.
data Timer

-- | Type of a timer configuration.
data TimerConf

-- | Default timer configuration specifies no initial delay and an interval
--   delay of 1s.
defaultConf :: TimerConf

-- | Set the initial delay in the provided timer configuration.
setInitDelay :: Int -> TimerConf -> TimerConf

-- | Set the interval delay in the provided timer configuration.
setInterval :: Int -> TimerConf -> TimerConf

-- | Spawn a timer thread based on the provided timer configuration and
--   then run the provided IO action, which receives the new timer as an
--   argument and call <tt>timerWait</tt> on it for synchronization. When
--   the provided IO action has terminated, the timer thread will be
--   terminated also.
withAsyncTimer :: (MonadUnliftIO m, MonadMask m) => TimerConf -> (Timer -> m b) -> m b

-- | Wait for the next synchronization event on the givem timer.
wait :: MonadUnliftIO m => Timer -> m ()

-- | Reset the provided timer.
reset :: MonadUnliftIO m => Timer -> m ()