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

Clarify API-docs - desugaring of IncomingConnection.handleWith (#30025)

Browse source
This commit is contained in:
Levi Ramsey 2021-03-15 12:32:35 -04:00 • committed by GitHub
parent c24759feaa
commit f3456b382e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
akka-stream/src/main/scala/akka/stream/javadsl/Tcp.scala
View file

@ -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
*/

2
akka-stream/src/main/scala/akka/stream/scaladsl/Tcp.scala
View file

@ -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()