+doc #15239: Stream cookbook

akka-docs-dev/rst/scala/code/docs/stream/cookbook/RecipeHold.scala

@@ -0,0 +1,120 @@
+package docs.stream.cookbook
+
+import akka.stream.scaladsl.{ Sink, Source }
+import akka.stream.testkit.StreamTestKit
+import akka.stream.testkit.StreamTestKit.{ SubscriberProbe, PublisherProbe }
+
+import scala.concurrent.duration._
+
+object HoldOps {
+  //#hold-version-1
+  import akka.stream.stage._
+  class HoldWithInitial[T](initial: T) extends DetachedStage[T, T] {
+    private var currentValue: T = initial
+
+    override def onPush(elem: T, ctx: DetachedContext[T]): UpstreamDirective = {
+      currentValue = elem
+      ctx.pull()
+    }
+
+    override def onPull(ctx: DetachedContext[T]): DownstreamDirective = {
+      ctx.push(currentValue)
+    }
+
+  }
+  //#hold-version-1
+
+  //#hold-version-2
+  import akka.stream.stage._
+  class HoldWithWait[T] extends DetachedStage[T, T] {
+    private var currentValue: T = _
+    private var waitingFirstValue = true
+
+    override def onPush(elem: T, ctx: DetachedContext[T]): UpstreamDirective = {
+      currentValue = elem
+      waitingFirstValue = false
+      if (ctx.isHolding) ctx.pushAndPull(currentValue)
+      else ctx.pull()
+    }
+
+    override def onPull(ctx: DetachedContext[T]): DownstreamDirective = {
+      if (waitingFirstValue) ctx.hold()
+      else ctx.push(currentValue)
+    }
+
+  }
+  //#hold-version-2
+}
+
+class RecipeHold extends RecipeSpec {
+  import HoldOps._
+
+  "Recipe for creating a holding element" must {
+
+    "work for version 1" in {
+
+      val pub = PublisherProbe[Int]()
+      val sub = SubscriberProbe[Int]()
+      val source = Source(pub)
+      val sink = Sink(sub)
+
+      source.transform(() => new HoldWithInitial(0)).to(sink).run()
+
+      val manualSource = new StreamTestKit.AutoPublisher(pub)
+
+      val subscription = sub.expectSubscription()
+      sub.expectNoMsg(100.millis)
+
+      subscription.request(1)
+      sub.expectNext(0)
+
+      subscription.request(1)
+      sub.expectNext(0)
+
+      manualSource.sendNext(1)
+      manualSource.sendNext(2)
+
+      subscription.request(2)
+      sub.expectNext(2)
+      sub.expectNext(2)
+
+      manualSource.sendComplete()
+      subscription.request(1)
+      sub.expectComplete()
+    }
+
+    "work for version 2" in {
+
+      val pub = PublisherProbe[Int]()
+      val sub = SubscriberProbe[Int]()
+      val source = Source(pub)
+      val sink = Sink(sub)
+
+      source.transform(() => new HoldWithWait).to(sink).run()
+
+      val manualSource = new StreamTestKit.AutoPublisher(pub)
+
+      val subscription = sub.expectSubscription()
+      sub.expectNoMsg(100.millis)
+
+      subscription.request(1)
+      sub.expectNoMsg(100.millis)
+
+      manualSource.sendNext(1)
+      sub.expectNext(1)
+
+      manualSource.sendNext(2)
+      manualSource.sendNext(3)
+
+      subscription.request(2)
+      sub.expectNext(3)
+      sub.expectNext(3)
+
+      manualSource.sendComplete()
+      subscription.request(1)
+      sub.expectComplete()
+    }
+
+  }
+
+}