git.iko.soy/streamly
on master help sign in
rename yieldRate to just rate
commita74f668de7644d56b745117c073483ce5a4b6b63 authorHarendra Kumar <harendra.kumar@gmail.com> dateSun 19 Aug 2018, 06:24 (8 years ago) parent904de16
3 files changed+14−14
compare with master
unifiedsplit
src/Streamly.hs+2−2 src/Streamly/Streams/SVar.hs+6−6 test/MaxRate.hs+6−6
src/Streamly.hs+2−2
@@ -112,7 +112,7 @@ module Streamly
112112 -- $concurrency
113113 , maxThreads
114114 , maxBuffer
115− , yieldRate
115+ , rate
116116
117117 -- * Folding Containers of Streams
118118 -- $foldutils
@@ -173,7 +173,7 @@ import Streamly.Streams.Ahead
173173import Streamly.Streams.Parallel
174174import Streamly.Streams.Zip
175175import Streamly.Streams.Prelude
176−import Streamly.Streams.SVar (maxThreads, maxBuffer, yieldRate)
176+import Streamly.Streams.SVar (maxThreads, maxBuffer, rate)
177177import Streamly.SVar (MonadAsync)
178178import Data.Semigroup (Semigroup(..))
179179
src/Streamly/Streams/SVar.hs+6−6
@@ -32,7 +32,7 @@ module Streamly.Streams.SVar
3232 , maxThreads
3333 , maxBuffer
3434 , maxYields
35− , yieldRate
35+ , rate
3636 )
3737where
3838
@@ -198,13 +198,13 @@ maxBufferSerial _ = id
198198-- * The maximum rate that the stream consumer can achieve
199199--
200200-- @since 0.5.0
201−{-# INLINE_NORMAL yieldRate #-}
202−yieldRate :: IsStream t => Double -> t m a -> t m a
203−yieldRate n m = fromStream $ Stream $ \st stp sng yld -> do
201+{-# INLINE_NORMAL rate #-}
202+rate :: IsStream t => Double -> t m a -> t m a
203+rate n m = fromStream $ Stream $ \st stp sng yld -> do
204204 unStream (toStream m) (setMaxStreamRate n st) stp sng yld
205205
206206{-
207−{-# RULES "yieldRate serial" yieldRate = yieldRateSerial #-}
207+{-# RULES "rate serial" rate = yieldRateSerial #-}
208208yieldRateSerial :: Double -> SerialT m a -> SerialT m a
209209yieldRateSerial _ = id
210210-}
@@ -212,7 +212,7 @@ yieldRateSerial _ = id
212212-- | Specify the average latency, in nanoseconds, of a single threaded action
213213-- in a concurrent composition. Streamly can measure the latencies, but that is
214214-- possible only after at least one task has completed. This combinator can be
215−-- used to provide a latency hint so that rate control using 'yieldRate' can take
215+-- used to provide a latency hint so that rate control using 'rate' can take
216216-- that into account right from the beginning. When not specified then a
217217-- default behavior is chosen which could be too slow or too fast, and would be
218218-- restricted by any other control parameters configured.
test/MaxRate.hs+6−6
@@ -30,8 +30,8 @@ measureRate' :: IsStream t
3030 -> (Double, Double)
3131 -> (Double, Double)
3232 -> Spec
33−measureRate' desc t rate consumerDelay producerDelay dur = do
34− it (desc ++ " rate: " ++ show rate
33+measureRate' desc t rval consumerDelay producerDelay dur = do
34+ it (desc ++ " rate: " ++ show rval
3535 ++ ", consumer latency: " ++ show consumerDelay
3636 ++ ", producer latency: " ++ show producerDelay)
3737 $ durationShouldBe dur $ do
@@ -43,8 +43,8 @@ measureRate' desc t rate consumerDelay producerDelay dur = do
4343 $ t
4444 $ maxBuffer (-1)
4545 $ maxThreads (-1)
46− $ yieldRate rate
47− $ S.take (round $ rate * 10)
46+ $ rate rval
47+ $ S.take (round $ rval * 10)
4848 $ S.repeatM $ do
4949 let (t1, t2) = producerDelay
5050 r <- if t1 == t2
@@ -69,9 +69,9 @@ measureRate :: IsStream t
6969 -> Int
7070 -> (Double, Double)
7171 -> Spec
72−measureRate desc t rate consumerDelay producerDelay dur =
72+measureRate desc t rval consumerDelay producerDelay dur =
7373 let d = fromIntegral producerDelay
74− in measureRate' desc t rate consumerDelay (d, d) dur
74+ in measureRate' desc t rval consumerDelay (d, d) dur
7575
7676main :: IO ()
7777main = hspec $ do