2-- Module : Streamly.Data.Stream.Concurrent
3-- Copyright : (c) 2022 Composewell Technologies
4-- License : BSD-3-Clause
5-- Maintainer : streamly@composewell.com
9-- This module provides concurrent streaming abstractions.
13-- The names in this module do not conflict with other stream modules,
14-- therefore, you can import it in the same namespace:
16-- >>> import qualified Streamly.Data.Stream.Concurrent as Stream
18module Streamly.Data.Stream.Concurrent
43 -- *** Scheduling behavior
52 -- | Stream combinators using a concurrent channel.
55 -- | Evaluates a serial stream asynchronously using a concurency channel.
60 -- | Uses a concurrency channel to evaluate multiple actions concurrently.
66 -- | Uses a concurrency channel to evaluate multiple mapped actions
72 -- *** List of streams
73 -- | Shares a single channel across many streams.
79 -- *** Stream of streams
85 -- | Shares a single channel across many streams.
98import Streamly.Internal.Data.Stream.Concurrent
99import Prelude hiding (mapM, sequence, concat, concatMap, zipWith)
103-- == Concurrency Channels
105-- At a lower level, concurrency is implemented using channels that support
106-- concurrent evaluation of streams. We create a channel, and add one or more
107-- streams to it. The channel evaluates multiple streams concurrently and then
108-- generates a single output stream from the results. How the streams are
109-- combined depends on the configuration of the channel.
111-- == Concurrency Primitives
113-- There are only a few fundamental abstractions for concurrency, 'parEval',
114-- 'parConcatMap', and 'parConcatIterate', all concurrency combinators can be
115-- expressed in terms of these.
117-- 'parEval', evaluates a single stream asynchronously, a worker thread runs
118-- the stream and buffers the results, and the consumer of the stream runs in
119-- another thread consuming it from the buffer, thus decoupling the production
120-- and consumption of the stream. This can be used to run different stages of a
121-- pipeline concurrently.
123-- 'parConcatMap' is used to evaluate multiple streams concurrently and combine
124-- the results. A stream generator function is mapped to the input stream and
125-- all the generated streams are then evaluated concurrently, and the results
128-- 'parConcatIterate' is like 'parConcatMap' but iterates a stream generator
129-- function recursively over the stream. This can be used to traverse trees or
132-- == Concurrency Configuration
134-- Concurrent combinators take a 'Config' argument which controls the
135-- concurrent behavior. For example, maximum number of threads to be used
136-- ('maxThreads') or the maxmimum size of the buffer ('maxBuffer'), or how the
137-- streams are scheduled with respect to each other ('interleaved'), or how the
138-- results are consumed ('ordered').
140-- Configuration is specified as @Config -> Config@ modifier functions that can
141-- be composed together using function composition. For example, to specify the
142-- maximum threads we can use @parConcatMap (maxThreads 10)@ if we also want to
143-- specify the maximum buffer we can compose the two options @parConcatMap
144-- (maxThreads 10 . maxBuffer 100)@. To use default configuration use 'id' as
145-- the config modifier e.g. @parConcatMap id@.
147-- See the @Configuration@ section and individual configuration options'
148-- documentation for the default behavior and default values of configuration
151-- == Scheduling behavior
153-- The most important configuration option is to control whether the output of
154-- the concurrent execution is consumed in the same order as the corresponding
155-- actions in the input stream or as soon as they arrive. The default is the
156-- latter, however, we can enforce the original order by using the 'ordered'
159-- Another important option controls whether the number of worker threads are
160-- automatically increased and decreased based on the consumption rate or
161-- threads are started as aggresively as possible until the 'maxThreads' or
162-- 'maxBuffer' limits are hit. The default is the former. However, the 'eager'
163-- option can be enabled to use the latter behavior. When 'eager' is on, even
164-- if the stream consumer thread blocks it does not make any impact on the
165-- scheduling of the available tasks.
167-- == Concurrent Combinators
169-- Using the few fundamental concurrency primitives we can implement all the
170-- usual streaming combinators with concurrent behavior. Combinators like
171-- 'unfoldrM', 'iterateM' that are inherently serial can be evaluated
172-- concurrently with respect to the consumer pipeline using 'parEval'.
173-- Combinators like 'zipWithM', 'mergeByM' can also use 'parEval' on the input
174-- streams to evaluate them concurrently before combining.
176-- Combinators like 'repeatM', 'replicateM', 'fromListM', 'sequence', 'mapM' in
177-- which all actions are independent of each other can be made concurrent using
178-- the 'parConcatMap' operation.
180-- A concurrent 'repeatM' repeats an action using multiple concurrent
181-- executions of the action. Similarly, a concurrent 'mapM' performs the mapped
182-- action in independent threads.
184-- Some common concurrent combinators are provided in this module.
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list