raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

add example to the doc of combine operator (#30194)

Browse source
This commit is contained in:
Muskan Gupta 2021-04-29 12:07:14 +05:30 • committed by GitHub
parent 571aa85a36
commit 099e20ec6d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

19
akka-docs/src/main/paradox/stream/operators/Sink/combine.md
View file

@ -6,12 +6,29 @@ Combine several sinks into one using a user specified strategy
## Signature
@apidoc[Sink.combine](Sink$) { scala="#combine[T,U](first:akka.stream.scaladsl.Sink[U,_],second:akka.stream.scaladsl.Sink[U,_],rest:akka.stream.scaladsl.Sink[U,_]*)(strategy:Int=>akka.stream.Graph[akka.stream.UniformFanOutShape[T,U],akka.NotUsed]):akka.stream.scaladsl.Sink[T,akka.NotUsed]" java="#combine(akka.stream.javadsl.Sink,akka.stream.javadsl.Sink,java.util.List,akka.japi.function.Function)" }
@apidoc[Sink.combine](Sink$) { scala="
#combine[T,U](first:akka.stream.scaladsl.Sink[U,_],second:akka.stream.scaladsl.Sink[U,_],rest:akka.stream.scaladsl.Sink[U,_]*)(
strategy:Int=>akka.stream.Graph[akka.stream.UniformFanOutShape[T,U],akka.NotUsed]):
akka.stream.scaladsl.Sink[T,akka.NotUsed]" java="#combine(
akka.stream.javadsl.Sink,akka.stream.javadsl.Sink,java.util.List,akka.japi.function.Function)" }
## Description
Combine several sinks into one using a user specified strategy
## Example
This example shows how to combine multiple sinks with a Fan-out Junction.
Scala
:
@@snip [StreamPartialGraphDSLDocSpec.scala](/akka-docs/src/test/scala/docs/stream/StreamPartialGraphDSLDocSpec.scala) {
#sink-combine }
Java
: @@snip [StreamPartialGraphDSLDocTest.java](/akka-docs/src/test/java/jdocs/stream/StreamPartialGraphDSLDocTest.java)
{ #sink-combine }
## Reactive Streams semantics
@@@div { .callout }