Skip to content

Commit

Permalink
add example to the doc of combine operator (#30194)
Browse files Browse the repository at this point in the history
  • Loading branch information
muskan3006 committed Apr 29, 2021
1 parent 571aa85 commit 099e20e
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion akka-docs/src/main/paradox/stream/operators/Sink/combine.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 }
Expand Down

0 comments on commit 099e20e

Please sign in to comment.