Change naming for the use case of qualified imports, added module comments

Author: mtesseract

src/Control/Concurrent/Async/Timer.hs

@@ -1,11 +1,24 @@
+{-|
+Module      : Control.Concurrent.Async.Timer
+Description : Public API for asynchronous Timers
+Copyright   : (c) Moritz Clasmeier 2016, 2018
+License     : BSD3
+Maintainer  : [email protected]
+Stability   : experimental
+Portability : POSIX
+
+This module exports the public API for asynchronous timers.
+-}
+
 module Control.Concurrent.Async.Timer
   ( Timer
-  , defaultTimerConf
-  , timerConfSetInitDelay
-  , timerConfSetInterval
+  , TimerConf
+  , defaultConf
+  , setInitDelay
+  , setInterval
   , withAsyncTimer
-  , timerWait
-  , timerReset
+  , wait
+  , reset
   ) where
 
 import           Control.Concurrent.Async.Timer.Internal

src/Control/Concurrent/Async/Timer/Internal.hs

@@ -1,3 +1,16 @@
+{-|
+Module      : Control.Concurrent.Async.Timer.Internal
+Description : Implementation of asynchronous Timers
+Copyright   : (c) Moritz Clasmeier 2016, 2018
+License     : BSD3
+Maintainer  : [email protected]
+Stability   : experimental
+Portability : POSIX
+
+This module contains the internal implementation of asynchronous
+timers.
+-}
+
 {-# LANGUAGE LambdaCase #-}
 
 module Control.Concurrent.Async.Timer.Internal where
@@ -17,6 +30,8 @@ import           UnliftIO.STM
 data Timer = Timer { timerMVar    :: MVar ()
                    , timerControl :: TBQueue TimerCommand }
 
+-- | Timer commands that can be sent over a timer control channel to
+-- an asynchronous timer.
 data TimerCommand = TimerReset deriving (Show, Eq)
 
 -- | Type of a timer configuration.
@@ -25,24 +40,29 @@ data TimerConf = TimerConf { _timerConfInitDelay :: Int
 
 -- | Sleep 'dt' milliseconds.
 millisleep :: MonadIO m => Int -> m ()
-millisleep dt = threadDelay (fromIntegral dt * 10 ^ 3)
+millisleep dt = threadDelay (dt * 10 ^ 3)
 
 -- | Default timer configuration specifies no initial delay and an
 -- interval delay of 1s.
-defaultTimerConf :: TimerConf
-defaultTimerConf = TimerConf { _timerConfInitDelay =    0
-                             , _timerConfInterval  = 1000 }
+defaultConf :: TimerConf
+defaultConf = TimerConf { _timerConfInitDelay =    0
+                        , _timerConfInterval  = 1000 }
 
 -- | Set the initial delay in the provided timer configuration.
-timerConfSetInitDelay :: Int -> TimerConf -> TimerConf
-timerConfSetInitDelay n conf = conf { _timerConfInitDelay = n }
+setInitDelay :: Int -> TimerConf -> TimerConf
+setInitDelay n conf = conf { _timerConfInitDelay = n }
 
 -- | Set the interval delay in the provided timer configuration.
-timerConfSetInterval :: Int -> TimerConf -> TimerConf
-timerConfSetInterval n conf = conf { _timerConfInterval = n }
+setInterval :: Int -> TimerConf -> TimerConf
+setInterval n conf = conf { _timerConfInterval = n }
 
 -- | Timer loop to be executed within in a timer thread.
-timerLoop :: MonadUnliftIO m => Int -> Int -> Timer -> m ()
+timerLoop
+  :: MonadUnliftIO m
+  => Int
+  -> Int
+  -> Timer
+  -> m ()
 timerLoop initDelay intervalDelay timer = go initDelay
 
   where go delay = do
@@ -59,12 +79,18 @@ timerLoop initDelay intervalDelay timer = go initDelay
         readCmd  = atomically $ readTBQueue (timerControl timer)
 
 -- | Wait for the next synchronization event on the givem timer.
-timerWait :: MonadUnliftIO m => Timer -> m ()
-timerWait = void . takeMVar . timerMVar
+wait
+  :: MonadUnliftIO m
+  => Timer
+  -> m ()
+wait = void . takeMVar . timerMVar
 
 -- | Reset the provided timer.
-timerReset :: MonadUnliftIO m => Timer -> m ()
-timerReset timer =
+reset
+  :: MonadUnliftIO m
+  => Timer
+  -> m ()
+reset timer =
   atomically $ writeTBQueue (timerControl timer) TimerReset
 
 -- | Spawn a timer thread based on the provided timer configuration

test/Spec.hs

@@ -2,7 +2,7 @@ module Main where
 
 import           Control.Concurrent
 import           Control.Concurrent.Async
-import           Control.Concurrent.Async.Timer
+import qualified Control.Concurrent.Async.Timer as Timer
 import           Control.Exception
 import           Control.Monad
 import           Criterion.Measurement
@@ -39,19 +39,20 @@ timedAssert delay before after = do
 
 testTimerReset :: IO ()
 testTimerReset = do
-  let conf = defaultTimerConf & timerConfSetInitDelay 1000
-                              & timerConfSetInterval  1000 -- ms
+  let conf = Timer.defaultConf
+             & Timer.setInitDelay 1000
+             & Timer.setInterval  1000 -- ms
       noOfTicks = 3
 
   counter <- newIORef 0
 
   _handle <- async $
-    withAsyncTimer conf $ \ timer ->
+    Timer.withAsyncTimer conf $ \ timer ->
     forM_ [1..noOfTicks] $ \ idx -> do
     when (idx == 2) $ do
       threadDelay (5 * 10^5)
-      timerReset timer
-    timerWait timer
+      Timer.reset timer
+    Timer.wait timer
     modifyIORef counter (+ 1)
 
   timedAssert (2 * 10^6 + 5 * 10^5)
@@ -60,16 +61,17 @@ testTimerReset = do
 
 testSimpleTimerTicks :: IO ()
 testSimpleTimerTicks = do
-  let conf = defaultTimerConf & timerConfSetInitDelay    0
-                              & timerConfSetInterval  1000 -- ms
+  let conf = Timer.defaultConf
+             & Timer.setInitDelay    0
+             & Timer.setInterval  1000 -- ms
       noOfTicks = 3
 
   counter <- newIORef 0
   times <- newIORef []
 
-  withAsyncTimer conf $ \ timer ->
+  Timer.withAsyncTimer conf $ \ timer ->
     forM_ [1..noOfTicks] $ \_ -> do
-      timerWait timer
+      Timer.wait timer
       void $ forkIO $ myAction counter times
 
   threadDelay (5 * 10^5)