From f3456b382edb699f1ed3020412a9f513b576e08f Mon Sep 17 00:00:00 2001 From: Levi Ramsey Date: Mon, 15 Mar 2021 12:32:35 -0400 Subject: [PATCH] Clarify API-docs - desugaring of IncomingConnection.handleWith (#30025) --- akka-stream/src/main/scala/akka/stream/javadsl/Tcp.scala | 4 ++-- akka-stream/src/main/scala/akka/stream/scaladsl/Tcp.scala | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/akka-stream/src/main/scala/akka/stream/javadsl/Tcp.scala b/akka-stream/src/main/scala/akka/stream/javadsl/Tcp.scala index 4223ae79e3..b43fd285a1 100644 --- a/akka-stream/src/main/scala/akka/stream/javadsl/Tcp.scala +++ b/akka-stream/src/main/scala/akka/stream/javadsl/Tcp.scala @@ -86,7 +86,7 @@ object Tcp extends ExtensionId[Tcp] with ExtensionIdProvider { * Handles the connection using the given flow, which is materialized exactly once and the respective * materialized value is returned. * - * Convenience shortcut for: `flow.join(handler).run()`. + * Convenience shortcut for: `flow.joinMat(handler, Keep.right).run(systemProvider)`. * * Note that the classic or typed `ActorSystem` can be used as the `systemProvider` parameter. */ @@ -97,7 +97,7 @@ object Tcp extends ExtensionId[Tcp] with ExtensionIdProvider { * Handles the connection using the given flow, which is materialized exactly once and the respective * materialized value is returned. * - * Convenience shortcut for: `flow.join(handler).run()`. + * Convenience shortcut for: `flow.joinMat(handler, Keep.right).run(materializer)`. * * Prefer the method taking an `ActorSystem` unless you have special requirements */ diff --git a/akka-stream/src/main/scala/akka/stream/scaladsl/Tcp.scala b/akka-stream/src/main/scala/akka/stream/scaladsl/Tcp.scala index a85beef35f..693d0620b5 100644 --- a/akka-stream/src/main/scala/akka/stream/scaladsl/Tcp.scala +++ b/akka-stream/src/main/scala/akka/stream/scaladsl/Tcp.scala @@ -67,7 +67,7 @@ object Tcp extends ExtensionId[Tcp] with ExtensionIdProvider { * Handles the connection using the given flow, which is materialized exactly once and the respective * materialized instance is returned. * - * Convenience shortcut for: `flow.join(handler).run()`. + * Convenience shortcut for: `flow.joinMat(handler)(Keep.right).run()`. */ def handleWith[Mat](handler: Flow[ByteString, ByteString, Mat])(implicit materializer: Materializer): Mat = flow.joinMat(handler)(Keep.right).run()