| SourceOperationsBatchTOut, TOut2, TMat Method |
Allows a faster upstream to progress independently of a slower subscriber by aggregating elements into batches
until the subscriber is ready to accept them.For example a batch step might store received elements in
an array up to the allowed max limit if the upstream publisher is faster.
This only rolls up elements if the upstream is faster, but if the downstream is faster it will not
duplicate elements.
Emits when downstream stops backpressuring and there is an aggregated element available
Backpressures when there are max batched elements and 1 pending element and downstream backpressures
Completes when upstream completes and there is no batched/pending element waiting
Cancels when downstream cancels
See also ,
Namespace:
Akka.Streams.Dsl
Assembly:
Akka.Streams (in Akka.Streams.dll) Version: 1.2.3.129 (1.2.3.129)
Syntax public static Source<TOut2, TMat> Batch<TOut, TOut2, TMat>(
this Source<TOut, TMat> flow,
long max,
Func<TOut, TOut2> seed,
Func<TOut2, TOut, TOut2> aggregate
)
[<ExtensionAttribute>]
static member Batch :
flow : Source<'TOut, 'TMat> *
max : int64 *
seed : Func<'TOut, 'TOut2> *
aggregate : Func<'TOut2, 'TOut, 'TOut2> -> Source<'TOut2, 'TMat>
Parameters
- flow
- Type: Akka.Streams.DslSourceTOut, TMat
TBD - max
- Type: SystemInt64
maximum number of elements to batch before backpressuring upstream (must be positive non-zero) - seed
- Type: SystemFuncTOut, TOut2
Provides the first state for a batched value using the first unconsumed element as a start - aggregate
- Type: SystemFuncTOut2, TOut, TOut2
Takes the currently batched value and the current pending element to produce a new aggregate
Type Parameters
- TOut
- TBD
- TOut2
- TBD
- TMat
- TBD
Return Value
Type:
SourceTOut2,
TMatTBD
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
SourceTOut,
TMat. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
See Also Reference
SourceOperationsBatchWeightedTOut, TOut2, TMat(SourceTOut, TMat, Int64, FuncTOut, Int64, FuncTOut, TOut2, FuncTOut2, TOut, TOut2)