doc Replace the word stage by operator in stream doc (#25138)
This commit is contained in:
Richard Imaoka
Arnout Engelen
parent
1919f222fa
commit
a17a61557c
142 changed files with 341 additions and 341 deletions
|
|
@ -383,9 +383,9 @@ tested it becomes an officially supported Akka feature.
|
|||
|
||||
[List of Akka features marked as may change](http://doc.akka.io/docs/akka/current/common/may-change.html)
|
||||
|
||||
## Contributing new Akka Streams stages/operators
|
||||
## Contributing new Akka Streams operators
|
||||
|
||||
Documentation of Akka Streams operators and stages is automatically enforced.
|
||||
Documentation of Akka Streams operators is automatically enforced.
|
||||
If a method exists on Source / Sink / Flow, or any other class listed in `project/StreamOperatorsIndexGenerator.scala`,
|
||||
it must also have a corresponding documentation page under `akka-docs/src/main/paradox/streams/operators/...`.
|
||||
|
||||
|
|
@ -393,11 +393,11 @@ The pages structure is well-defined, and must be the same on all documentation p
|
|||
docs pages in there to see the pattern in action. In general though the page must consist of:
|
||||
|
||||
- the title, including where the operator is defined (e.g. `ActorFlow.ask` or `Source.map`)
|
||||
- a short explanation of what this stage does, 1 sentence is optimal
|
||||
- an image explaining the stage more visually (whenever possible)
|
||||
- a link to the stages' "category" (these are listed in `akka-docs/src/main/paradox/categories`)
|
||||
- a short explanation of what this operator does, 1 sentence is optimal
|
||||
- an image explaining the operator more visually (whenever possible)
|
||||
- a link to the operators' "category" (these are listed in `akka-docs/src/main/paradox/categories`)
|
||||
- the method signature snippet (use the built in directives to generate it)
|
||||
- a longer explanation about the stage and it's exact semantics (when it pulls, cancels, signals elements)
|
||||
- a longer explanation about the operator and it's exact semantics (when it pulls, cancels, signals elements)
|
||||
- at least one usage example
|
||||
|
||||
Using this structure, the surrounding infrastructure will **generate the index pages**, so you do not need to maintain
|
||||
|
|
|
|||
1
akka-docs/src/main/categories/actor-interop-operators.md
Normal file
1
akka-docs/src/main/categories/actor-interop-operators.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
Operators meant for inter-operating between Akka Streams and Actors:
|
||||
|
|
@ -1 +0,0 @@
|
|||
Stages and operations meant for inter-operating between Akka Streams and Actors:
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
Sources and sinks for integrating with `java.io.InputStream` and `java.io.OutputStream` can be found on
|
||||
`StreamConverters`. As they are blocking APIs the implementations of these stages are run on a separate
|
||||
`StreamConverters`. As they are blocking APIs the implementations of these operators are run on a separate
|
||||
dispatcher configured through the `akka.stream.blocking-io-dispatcher`.
|
||||
|
||||
@@@ warning
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
These stages encapsulate an asynchronous computation, properly handling backpressure while taking care of the asynchronous
|
||||
These operators encapsulate an asynchronous computation, properly handling backpressure while taking care of the asynchronous
|
||||
operation at the same time (usually handling the completion of a @scala[`Future`] @java[`CompletionStage`]).
|
||||
|
|
@ -0,0 +1 @@
|
|||
These operators are aware of the backpressure provided by their downstreams and able to adapt their behavior to that signal.
|
||||
|
|
@ -1 +0,0 @@
|
|||
These stages are aware of the backpressure provided by their downstreams and able to adapt their behavior to that signal.
|
||||
2
akka-docs/src/main/categories/fan-in-operators.md
Normal file
2
akka-docs/src/main/categories/fan-in-operators.md
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
These operators take multiple streams as their input and provide a single output combining the elements from all of
|
||||
the inputs in different ways.
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
These stages take multiple streams as their input and provide a single output combining the elements from all of
|
||||
the inputs in different ways.
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
These stages either take a stream and turn it into a stream of streams (nesting) or they take a stream that contains
|
||||
These operators either take a stream and turn it into a stream of streams (nesting) or they take a stream that contains
|
||||
nested streams and turn them into a stream of elements instead (flattening).
|
||||
|
||||
See the [Substreams](stream-substream.md) page for more detail and code samples.
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
These stages can transform the rate of incoming elements since there are stages that emit multiple elements for a
|
||||
These operators can transform the rate of incoming elements since there are operators that emit multiple elements for a
|
||||
single input (e.g. `mapConcat`) or consume multiple elements before emitting one output (e.g. `filter`).
|
||||
However, these rate transformations are data-driven, i.e. it is the incoming elements that define how the
|
||||
rate is affected. This is in contrast with [detached stages](#backpressure-aware-stages) which can change their processing behavior
|
||||
rate is affected. This is in contrast with [detached operators](#backpressure-aware-operators) which can change their processing behavior
|
||||
depending on being backpressured by downstream or not.
|
||||
1
akka-docs/src/main/categories/time-aware-operators.md
Normal file
1
akka-docs/src/main/categories/time-aware-operators.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
Those operators operate taking time into consideration.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Those stages operate taking time into consideration.
|
||||
1
akka-docs/src/main/categories/timer-driven-operators.md
Normal file
1
akka-docs/src/main/categories/timer-driven-operators.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
These operators process elements using timers, delaying, dropping or grouping elements for certain time durations.
|
||||
|
|
@ -1 +0,0 @@
|
|||
These stages process elements using timers, delaying, dropping or grouping elements for certain time durations.
|
||||
|
|
@ -24,7 +24,7 @@ This means that we provide all the tools necessary to express any stream process
|
|||
|
||||
One important consequence of offering only features that can be relied upon is the restriction that Akka Streams cannot ensure that all objects sent through a processing topology will be processed. Elements can be dropped for a number of reasons:
|
||||
|
||||
* plain user code can consume one element in a *map(...)* stage and produce an entirely different one as its result
|
||||
* plain user code can consume one element in a *map(...)* operator and produce an entirely different one as its result
|
||||
* common stream operators drop elements intentionally, e.g. take/drop/filter/conflate/buffer/…
|
||||
* stream failure will tear down the stream without waiting for processing to finish, all elements that are in flight will be discarded
|
||||
* stream cancellation will propagate upstream (e.g. from a *take* operator) leading to upstream processing steps being terminated without having processed all of their inputs
|
||||
|
|
@ -90,7 +90,7 @@ Unfortunately the method name for signaling *failure* to a Subscriber is called
|
|||
|
||||
@@@
|
||||
|
||||
There is only limited support for treating `onError` in Akka Streams compared to the operators that are available for the transformation of data elements, which is intentional in the spirit of the previous paragraph. Since `onError` signals that the stream is collapsing, its ordering semantics are not the same as for stream completion: transformation stages of any kind will collapse with the stream, possibly still holding elements in implicit or explicit buffers. This means that data elements emitted before a failure can still be lost if the `onError` overtakes them.
|
||||
There is only limited support for treating `onError` in Akka Streams compared to the operators that are available for the transformation of data elements, which is intentional in the spirit of the previous paragraph. Since `onError` signals that the stream is collapsing, its ordering semantics are not the same as for stream completion: transformation operators of any kind will collapse with the stream, possibly still holding elements in implicit or explicit buffers. This means that data elements emitted before a failure can still be lost if the `onError` overtakes them.
|
||||
|
||||
The ability for failures to propagate faster than data elements is essential for tearing down streams that are back-pressured—especially since back-pressure can be the failure mode (e.g. by tripping upstream buffers which then abort because they cannot do anything else; or if a dead-lock occurred).
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Use the `AskPattern` to send each element as an `ask` to the target actor, and expect a reply back that will be sent further downstream.
|
||||
|
||||
@ref[Actor interop stages](../index.md#actor-interop-stages)
|
||||
@ref[Actor interop operators](../index.md#actor-interop-operators)
|
||||
|
||||
## Dependency
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Sends the elements of the stream to the given @java[`ActorRef<T>`]@scala[`ActorRef[T]`].
|
||||
|
||||
@ref[Actor interop stages](../index.md#actor-interop-stages)
|
||||
@ref[Actor interop operators](../index.md#actor-interop-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
@ -37,7 +37,7 @@ upstream, but there is no back-pressure signal from the destination actor,
|
|||
i.e. if the actor is not consuming the messages fast enough the mailbox
|
||||
of the actor will grow. For potentially slow consumer actors it is recommended
|
||||
to use a bounded mailbox with zero `mailbox-push-timeout-time` or use a rate
|
||||
limiting stage in front of this `Sink`.
|
||||
limiting operator in front of this `Sink`.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Creates a `Flow` from a `Sink` and a `Source` where the Flow's input will be sent to the `Sink` and the `Flow` 's output will come from the Source.
|
||||
|
||||
@ref[Flow stages composed of Sinks and Sources](../index.md#flow-stages-composed-of-sinks-and-sources)
|
||||
@ref[Flow operators composed of Sinks and Sources](../index.md#flow-operators-composed-of-sinks-and-sources)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Allows coupling termination (cancellation, completion, erroring) of Sinks and Sources while creating a Flow between them.
|
||||
|
||||
@ref[Flow stages composed of Sinks and Sources](../index.md#flow-stages-composed-of-sinks-and-sources)
|
||||
@ref[Flow operators composed of Sinks and Sources](../index.md#flow-operators-composed-of-sinks-and-sources)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
@ -15,7 +15,7 @@ Allows coupling termination (cancellation, completion, erroring) of Sinks and So
|
|||
## Description
|
||||
|
||||
Allows coupling termination (cancellation, completion, erroring) of Sinks and Sources while creating a Flow between them.
|
||||
Similar to `Flow.fromSinkAndSource` however couples the termination of these two stages.
|
||||
Similar to `Flow.fromSinkAndSource` however couples the termination of these two operators.
|
||||
|
||||
E.g. if the emitted `Flow` gets a cancellation, the `Source` is cancelled,
|
||||
however the Sink will also be completed. The table below illustrates the effects in detail:
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Send the elements from the stream to an `ActorRef`.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@ div { .group-scala }
|
||||
## Signature
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Send the elements from the stream to an `ActorRef` which must then acknowledge reception after completing a message, to provide back pressure onto the sink.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Integration with Reactive Streams, materializes into a `org.reactivestreams.Publisher`.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@ div { .group-scala }
|
||||
## Signature
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Immediately cancel the stream
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Combine several sinks into one using a user specified strategy
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Fold over emitted element with a function, where each invocation will get the new element and the result from the previous fold invocation.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
@ -19,7 +19,7 @@ previous fold invocation. The first invocation will be provided the `zero` value
|
|||
|
||||
Materializes into a @scala[`Future`] @java[`CompletionStage`] that will complete with the last state when the stream has completed.
|
||||
|
||||
This stage allows combining values into a result without a global mutable state by instead passing the state along
|
||||
This operator allows combining values into a result without a global mutable state by instead passing the state along
|
||||
between invocations.
|
||||
|
||||
@@@div { .callout }
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Invoke a given procedure for each element received.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Like `foreach` but allows up to `parallellism` procedure calls to happen in parallel.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Integration with Reactive Streams, wraps a `org.reactivestreams.Subscriber` as a sink.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Materializes into a @scala[`Future`] @java[`CompletionStage`] which completes with the first value arriving, after this the stream is canceled.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Materializes into a @scala[`Future[Option[T]]`] @java[`CompletionStage<Optional<T>>`] which completes with the first value arriving wrapped in @scala[`Some`] @java[`Optional`], or @scala[a `None`] @java[an empty Optional] if the stream completes without any elements emitted.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Consume all elements but discards them.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Materializes into a @scala[`Future`] @java[`CompletionStage`] which will complete with the last value emitted when the stream completes.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Materialize a @scala[`Future[Option[T]]`] @java[`CompletionStage<Optional<T>>`] which completes with the last value emitted wrapped in an @scala[`Some`] @java[`Optional`] when the stream completes.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Creates a real `Sink` upon receiving the first element.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Invoke a callback when the stream has completed or failed.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Materializes this Sink, immediately returning (1) its materialized value, and (2) a new Sink that can be consume elements 'into' the pre-materialized one.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Materialize a `SinkQueue` that can be pulled to trigger demand through the sink.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Apply a reduction function on the incoming elements and pass the result to the next invocation.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Collect values emitted from the stream into a collection.
|
||||
|
||||
@ref[Sink stages](../index.md#sink-stages)
|
||||
@ref[Sink operators](../index.md#sink-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Stream the values of an `immutable.Seq`.
|
||||
|
||||
@ref[Source stages](../index.md#source-stages)
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@ div { .group-scala }
|
||||
## Signature
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ If any of the asks times out it will fail the stream with a [[akka.pattern.AskTi
|
|||
The `mapTo` class parameter is used to cast the incoming responses to the expected response type.
|
||||
|
||||
Similar to the plain ask pattern, the target actor is allowed to reply with `akka.util.Status`.
|
||||
An `akka.util.Status#Failure` will cause the stage to fail with the cause carried in the `Failure` message.
|
||||
An `akka.util.Status#Failure` will cause the operator to fail with the cause carried in the `Failure` message.
|
||||
|
||||
Adheres to the [[ActorAttributes.SupervisionStrategy]] attribute.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
If the time between the emission of an element and the following downstream demand exceeds the provided timeout, the stream is failed with a `TimeoutException`.
|
||||
|
||||
@ref[Time aware stages](../index.md#time-aware-stages)
|
||||
@ref[Time aware operators](../index.md#time-aware-operators)
|
||||
|
||||
@@@ div { .group-scala }
|
||||
## Signature
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Fan-out the stream to several streams.
|
||||
|
||||
@ref[Fan-out stages](../index.md#fan-out-stages)
|
||||
@ref[Fan-out operators](../index.md#fan-out-operators)
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Allow for a slower downstream by passing incoming elements and a summary into an aggregate function as long as there is backpressure and a maximum number of batched elements is not yet reached.
|
||||
|
||||
@ref[Backpressure aware stages](../index.md#backpressure-aware-stages)
|
||||
@ref[Backpressure aware operators](../index.md#backpressure-aware-operators)
|
||||
|
||||
@@@ div { .group-scala }
|
||||
## Signature
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Allow for a slower downstream by passing incoming elements and a summary into an aggregate function as long as there is backpressure and a maximum weight batched elements is not yet reached.
|
||||
|
||||
@ref[Backpressure aware stages](../index.md#backpressure-aware-stages)
|
||||
@ref[Backpressure aware operators](../index.md#backpressure-aware-operators)
|
||||
|
||||
@@@ div { .group-scala }
|
||||
## Signature
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Emit each incoming element each of `n` outputs.
|
||||
|
||||
@ref[Fan-out stages](../index.md#fan-out-stages)
|
||||
@ref[Fan-out operators](../index.md#fan-out-operators)
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Allow for a temporarily faster upstream events by buffering `size` elements.
|
||||
|
||||
@ref[Backpressure aware stages](../index.md#backpressure-aware-stages)
|
||||
@ref[Backpressure aware operators](../index.md#backpressure-aware-operators)
|
||||
|
||||
@@@ div { .group-scala }
|
||||
## Signature
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ Apply a partial function to each incoming element, if the partial function is de
|
|||
## Description
|
||||
|
||||
Apply a partial function to each incoming element, if the partial function is defined for a value the returned
|
||||
value is passed downstream. Can often replace `filter` followed by `map` to achieve the same in one single stage.
|
||||
value is passed downstream. Can often replace `filter` followed by `map` to achieve the same in one single operators.
|
||||
|
||||
|
||||
@@@div { .callout }
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
If the completion of the stream does not happen until the provided timeout, the stream is failed with a `TimeoutException`.
|
||||
|
||||
@ref[Time aware stages](../index.md#time-aware-stages)
|
||||
@ref[Time aware operators](../index.md#time-aware-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
After completion of the original upstream the elements of the given source will be emitted.
|
||||
|
||||
@ref[Fan-in stages](../index.md#fan-in-stages)
|
||||
@ref[Fan-in operators](../index.md#fan-in-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Allow for a slower downstream by passing incoming elements and a summary into an aggregate function as long as there is backpressure.
|
||||
|
||||
@ref[Backpressure aware stages](../index.md#backpressure-aware-stages)
|
||||
@ref[Backpressure aware operators](../index.md#backpressure-aware-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Allow for a slower downstream by passing incoming elements and a summary into an aggregate function as long as there is backpressure.
|
||||
|
||||
@ref[Backpressure aware stages](../index.md#backpressure-aware-stages)
|
||||
@ref[Backpressure aware operators](../index.md#backpressure-aware-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Delay every element passed through with a specific duration.
|
||||
|
||||
@ref[Timer driven stages](../index.md#timer-driven-stages)
|
||||
@ref[Timer driven operators](../index.md#timer-driven-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ Detach upstream demand from downstream demand without detaching the stream rates
|
|||
|
||||
@@@div { .callout }
|
||||
|
||||
**emits** when the upstream stage has emitted and there is demand
|
||||
**emits** when the upstream operators has emitted and there is demand
|
||||
|
||||
**backpressures** when downstream backpressures
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Drop elements until a timeout has fired
|
||||
|
||||
@ref[Timer driven stages](../index.md#timer-driven-stages)
|
||||
@ref[Timer driven operators](../index.md#timer-driven-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Like `extrapolate`, but does not have the `initial` argument, and the `Iterator` is also used in lieu of the original element, allowing for it to be rewritten and/or filtered.
|
||||
|
||||
@ref[Backpressure aware stages](../index.md#backpressure-aware-stages)
|
||||
@ref[Backpressure aware operators](../index.md#backpressure-aware-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Allow for a faster downstream by expanding the last emitted element to an `Iterator`.
|
||||
|
||||
@ref[Backpressure aware stages](../index.md#backpressure-aware-stages)
|
||||
@ref[Backpressure aware operators](../index.md#backpressure-aware-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Transform each input element into a `Source` whose elements are then flattened into the output stream through concatenation.
|
||||
|
||||
@ref[Nesting and flattening stages](../index.md#nesting-and-flattening-stages)
|
||||
@ref[Nesting and flattening operators](../index.md#nesting-and-flattening-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Transform each input element into a `Source` whose elements are then flattened into the output stream through merging.
|
||||
|
||||
@ref[Nesting and flattening stages](../index.md#nesting-and-flattening-stages)
|
||||
@ref[Nesting and flattening operators](../index.md#nesting-and-flattening-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Demultiplex the incoming stream into separate output streams.
|
||||
|
||||
@ref[Nesting and flattening stages](../index.md#nesting-and-flattening-stages)
|
||||
@ref[Nesting and flattening operators](../index.md#nesting-and-flattening-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ of closing these elements might get lost.
|
|||
|
||||
@@@ warning
|
||||
|
||||
If `allowClosedSubstreamRecreation` is set to `false` (default behavior) the stage keeps track of all
|
||||
If `allowClosedSubstreamRecreation` is set to `false` (default behavior) the operators keeps track of all
|
||||
keys of streams that have already been closed. If you expect an infinite number of keys this can cause
|
||||
memory issues. Elements belonging to those keys are drained directly and not send to the substream.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Chunk up this stream into groups of elements received within a time window, or limited by the weight of the elements, whatever happens first.
|
||||
|
||||
@ref[Timer driven stages](../index.md#timer-driven-stages)
|
||||
@ref[Timer driven operators](../index.md#timer-driven-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Chunk up this stream into groups of elements received within a time window, or limited by the number of the elements, whatever happens first.
|
||||
|
||||
@ref[Timer driven stages](../index.md#timer-driven-stages)
|
||||
@ref[Timer driven operators](../index.md#timer-driven-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
If the time between two processed elements exceeds the provided timeout, the stream is failed with a `TimeoutException`.
|
||||
|
||||
@ref[Time aware stages](../index.md#time-aware-stages)
|
||||
@ref[Time aware operators](../index.md#time-aware-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Delays the initial element by the specified duration.
|
||||
|
||||
@ref[Timer driven stages](../index.md#timer-driven-stages)
|
||||
@ref[Timer driven operators](../index.md#timer-driven-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# initialTimeout
|
||||
|
||||
If the first element has not passed through this stage before the provided timeout, the stream is failed with a `TimeoutException`.
|
||||
If the first element has not passed through this operators before the provided timeout, the stream is failed with a `TimeoutException`.
|
||||
|
||||
@ref[Time aware stages](../index.md#time-aware-stages)
|
||||
@ref[Time aware operators](../index.md#time-aware-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
@ -14,7 +14,7 @@ If the first element has not passed through this stage before the provided timeo
|
|||
|
||||
## Description
|
||||
|
||||
If the first element has not passed through this stage before the provided timeout, the stream is failed
|
||||
If the first element has not passed through this operators before the provided timeout, the stream is failed
|
||||
with a `TimeoutException`.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Emits a specifiable number of elements from the original source, then from the provided source and repeats.
|
||||
|
||||
@ref[Fan-in stages](../index.md#fan-in-stages)
|
||||
@ref[Fan-in operators](../index.md#fan-in-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Injects additional (configured) elements if upstream does not emit for a configured amount of time.
|
||||
|
||||
@ref[Time aware stages](../index.md#time-aware-stages)
|
||||
@ref[Time aware operators](../index.md#time-aware-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# mapError
|
||||
|
||||
While similar to `recover` this stage can be used to transform an error signal to a different one *without* logging it as an error in the process.
|
||||
While similar to `recover` this operators can be used to transform an error signal to a different one *without* logging it as an error in the process.
|
||||
|
||||
@ref[Simple operators](../index.md#simple-operators)
|
||||
|
||||
|
|
@ -14,12 +14,12 @@ While similar to `recover` this stage can be used to transform an error signal t
|
|||
|
||||
## Description
|
||||
|
||||
While similar to `recover` this stage can be used to transform an error signal to a different one *without* logging
|
||||
While similar to `recover` this operators can be used to transform an error signal to a different one *without* logging
|
||||
it as an error in the process. So in that sense it is NOT exactly equivalent to `recover(t => throw t2)` since recover
|
||||
would log the `t2` error.
|
||||
|
||||
Since the underlying failure signal onError arrives out-of-band, it might jump over existing elements.
|
||||
This stage can recover the failure signal, but not the skipped elements, which will be dropped.
|
||||
This operators can recover the failure signal, but not the skipped elements, which will be dropped.
|
||||
|
||||
Similarily to `recover` throwing an exception inside `mapError` _will_ be logged on ERROR level automatically.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Merge multiple sources.
|
||||
|
||||
@ref[Fan-in stages](../index.md#fan-in-stages)
|
||||
@ref[Fan-in operators](../index.md#fan-in-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Merge multiple sources.
|
||||
|
||||
@ref[Fan-in stages](../index.md#fan-in-stages)
|
||||
@ref[Fan-in operators](../index.md#fan-in-operators)
|
||||
|
||||
## Signature
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Merge multiple sources.
|
||||
|
||||
@ref[Fan-in stages](../index.md#fan-in-stages)
|
||||
@ref[Fan-in operators](../index.md#fan-in-operators)
|
||||
|
||||
## Signature
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Merge multiple sources.
|
||||
|
||||
@ref[Fan-in stages](../index.md#fan-in-stages)
|
||||
@ref[Fan-in operators](../index.md#fan-in-operators)
|
||||
|
||||
## Signature
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Merge multiple sources.
|
||||
|
||||
@ref[Fan-in stages](../index.md#fan-in-stages)
|
||||
@ref[Fan-in operators](../index.md#fan-in-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# monitor
|
||||
|
||||
Materializes to a `FlowMonitor` that monitors messages flowing through or completion of the stage.
|
||||
Materializes to a `FlowMonitor` that monitors messages flowing through or completion of the operators.
|
||||
|
||||
@ref[Watching status stages](../index.md#watching-status-stages)
|
||||
@ref[Watching status operators](../index.md#watching-status-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
@ -14,7 +14,7 @@ Materializes to a `FlowMonitor` that monitors messages flowing through or comple
|
|||
|
||||
## Description
|
||||
|
||||
Materializes to a `FlowMonitor` that monitors messages flowing through or completion of the stage. The stage otherwise
|
||||
Materializes to a `FlowMonitor` that monitors messages flowing through or completion of the operators. The operators otherwise
|
||||
passes through elements unchanged. Note that the `FlowMonitor` inserts a memory barrier every time it processes an
|
||||
event, and may therefore affect performance.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
If the primary source completes without emitting any elements, the elements from the secondary source are emitted.
|
||||
|
||||
@ref[Fan-in stages](../index.md#fan-in-stages)
|
||||
@ref[Fan-in operators](../index.md#fan-in-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Fan-out the stream to several streams.
|
||||
|
||||
@ref[Fan-out stages](../index.md#fan-out-stages)
|
||||
@ref[Fan-out operators](../index.md#fan-out-operators)
|
||||
|
||||
## Signature
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Take up to *n* elements from the stream (less than *n* only if the upstream completes before emitting *n* elements) and returns a pair containing a strict sequence of the taken element and a stream representing the remaining elements.
|
||||
|
||||
@ref[Nesting and flattening stages](../index.md#nesting-and-flattening-stages)
|
||||
@ref[Nesting and flattening operators](../index.md#nesting-and-flattening-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Prepends the given source to the flow, consuming it until completion before the original source is consumed.
|
||||
|
||||
@ref[Fan-in stages](../index.md#fan-in-stages)
|
||||
@ref[Fan-in operators](../index.md#fan-in-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ it is fed into the *pf* and a new Source may be materialized. Note that if you p
|
|||
attempt to recover at all. A negative `attempts` number is interpreted as "infinite", which results in the exact same behavior as `recoverWith`.
|
||||
|
||||
Since the underlying failure signal onError arrives out-of-band, it might jump over existing elements.
|
||||
This stage can recover the failure signal, but not the skipped elements, which will be dropped.
|
||||
This operators can recover the failure signal, but not the skipped elements, which will be dropped.
|
||||
|
||||
|
||||
@@@div { .callout }
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
End the current substream whenever a predicate returns `true`, starting a new substream for the next element.
|
||||
|
||||
@ref[Nesting and flattening stages](../index.md#nesting-and-flattening-stages)
|
||||
@ref[Nesting and flattening operators](../index.md#nesting-and-flattening-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Split off elements into a new substream whenever a predicate function return `true`.
|
||||
|
||||
@ref[Nesting and flattening stages](../index.md#nesting-and-flattening-stages)
|
||||
@ref[Nesting and flattening operators](../index.md#nesting-and-flattening-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Pass elements downstream within a timeout and then complete.
|
||||
|
||||
@ref[Timer driven stages](../index.md#timer-driven-stages)
|
||||
@ref[Timer driven operators](../index.md#timer-driven-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Takes a stream of two element tuples and unzips the two elements ino two different downstreams.
|
||||
|
||||
@ref[Fan-out stages](../index.md#fan-out-stages)
|
||||
@ref[Fan-out operators](../index.md#fan-out-operators)
|
||||
|
||||
## Signature
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Splits each element of input into multiple downstreams using a function
|
||||
|
||||
@ref[Fan-out stages](../index.md#fan-out-stages)
|
||||
@ref[Fan-out operators](../index.md#fan-out-operators)
|
||||
|
||||
## Signature
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# watchTermination
|
||||
|
||||
Materializes to a @scala[`Future`] @java[`CompletionStage`] that will be completed with Done or failed depending whether the upstream of the stage has been completed or failed.
|
||||
Materializes to a @scala[`Future`] @java[`CompletionStage`] that will be completed with Done or failed depending whether the upstream of the operators has been completed or failed.
|
||||
|
||||
@ref[Watching status stages](../index.md#watching-status-stages)
|
||||
@ref[Watching status operators](../index.md#watching-status-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
@ -14,8 +14,8 @@ Materializes to a @scala[`Future`] @java[`CompletionStage`] that will be complet
|
|||
|
||||
## Description
|
||||
|
||||
Materializes to a @scala[`Future`] @java[`CompletionStage`] that will be completed with Done or failed depending whether the upstream of the stage has been completed or failed.
|
||||
The stage otherwise passes through elements unchanged.
|
||||
Materializes to a @scala[`Future`] @java[`CompletionStage`] that will be completed with Done or failed depending whether the upstream of the operators has been completed or failed.
|
||||
The operators otherwise passes through elements unchanged.
|
||||
|
||||
|
||||
@@@div { .callout }
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Combines elements from each of multiple sources into @scala[tuples] @java[*Pair*] and passes the @scala[tuples] @java[pairs] downstream.
|
||||
|
||||
@ref[Fan-in stages](../index.md#fan-in-stages)
|
||||
@ref[Fan-in operators](../index.md#fan-in-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Combines elements from multiple sources through a `combine` function and passes the returned value downstream.
|
||||
|
||||
@ref[Fan-in stages](../index.md#fan-in-stages)
|
||||
@ref[Fan-in operators](../index.md#fan-in-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Zips elements of current flow with its indices.
|
||||
|
||||
@ref[Fan-in stages](../index.md#fan-in-stages)
|
||||
@ref[Fan-in operators](../index.md#fan-in-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Materialize an `ActorRef`, sending messages to it will emit them on the stream.
|
||||
|
||||
@ref[Source stages](../index.md#source-stages)
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@ div { .group-scala }
|
||||
## Signature
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Integration with Reactive Streams, materializes into a `org.reactivestreams.Subscriber`.
|
||||
|
||||
@ref[Source stages](../index.md#source-stages)
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@ div { .group-scala }
|
||||
## Signature
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Combine several sources, using a given strategy such as merge or concat, into one source.
|
||||
|
||||
@ref[Source stages](../index.md#source-stages)
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Stream iterator in cycled manner.
|
||||
|
||||
@ref[Source stages](../index.md#source-stages)
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Complete right away without ever emitting any elements.
|
||||
|
||||
@ref[Source stages](../index.md#source-stages)
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Fail directly with a user specified exception.
|
||||
|
||||
@ref[Source stages](../index.md#source-stages)
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue