auto-update 0.1.1.5 → 0.1.2

raw patch · 3 files changed

+82/−1 lines, 3 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• Control/Debounce.hs +78/−0
• auto-update.cabal +3/−1
• changelog.md +1/−0

@@ -0,0 +1,78 @@+{-# LANGUAGE ScopedTypeVariables #-}+-- | Debounce an action, ensuring it doesn't occur more than once for a given+-- period of time.+--+-- This is useful as an optimization, for example to ensure that logs are only+-- flushed to disk at most once per second. See the fast-logger package for an+-- example usage.+--+-- Since 0.1.2+module Control.Debounce+    ( -- * Type+      DebounceSettings+    , defaultDebounceSettings+      -- * Accessors+    , debounceFreq+    , debounceAction+      -- * Creation+    , mkDebounce+    ) where++import           Control.Concurrent      (forkIO, threadDelay)+import           Control.Concurrent.MVar (newEmptyMVar, takeMVar, tryPutMVar)+import           Control.Exception       (SomeException, handle, mask_)+import           Control.Monad           (forever, void)++-- | Settings to control how debouncing should work.+--+-- This should be constructed using @defaultDebounceSettings@ and record+-- update syntax, e.g.:+--+-- @+-- let set = defaultDebounceSettings { debounceAction = flushLog }+-- @+--+-- Since 0.1.2+data DebounceSettings = DebounceSettings+    { debounceFreq   :: Int+    -- ^ Microseconds lag required between subsequence calls to the debounced+    -- action.+    --+    -- Default: 1 second (1000000)+    --+    -- Since 0.1.2+    , debounceAction :: IO ()+    -- ^ Action to be performed.+    --+    -- Note: all exceptions thrown by this action will be silently discarded.+    --+    -- Default: does nothing.+    --+    -- Since 0.1.2+    }++-- | Default value for creating a @DebounceSettings@.+--+-- Since 0.1.2+defaultDebounceSettings :: DebounceSettings+defaultDebounceSettings = DebounceSettings+    { debounceFreq = 1000000+    , debounceAction = return ()+    }++-- | Generate an action which will trigger the debounced action to be+-- performed. The action will either be performed immediately, or after the+-- current cooldown period has expired.+--+-- Since 0.1.2+mkDebounce :: DebounceSettings -> IO (IO ())+mkDebounce (DebounceSettings freq action) = do+    baton <- newEmptyMVar+    mask_ $ void $ forkIO $ forever $ do+        takeMVar baton+        ignoreExc action+        threadDelay freq+    return $ void $ tryPutMVar baton ()++ignoreExc :: IO () -> IO ()+ignoreExc = handle $ \(_ :: SomeException) -> return ()

@@ -1,5 +1,5 @@ name:                auto-update-version:             0.1.1.5+version:             0.1.2 synopsis:            Efficiently run periodic, on-demand actions description:     A common problem is the desire to have an action run at a scheduled interval, but only if it is needed. For example, instead of having every web request result in a new @getCurrentTime@ call, we'd like to have a single worker thread run every second, updating an @IORef@. However, if the request frequency is less than once per second, this is a pessimization, and worse, kills idle GC.@@ -13,11 +13,13 @@ category:            Control build-type:          Simple extra-source-files:  README.md+                     changelog.md cabal-version:       >=1.10  library   ghc-options:         -Wall   exposed-modules:     Control.AutoUpdate+                       Control.Debounce                        Control.Reaper   other-modules:       Control.AutoUpdate.Util   build-depends:       base >= 4 && < 5

@@ -0,0 +1,1 @@+__0.1.2__ Added Control.Debounce