You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pekko.apache.org by he...@apache.org on 2025/10/25 13:01:11 UTC

(pekko) branch 1.3.x-watchTermination created (now 1abc275b34)

This is an automated email from the ASF dual-hosted git repository.

hepin pushed a change to branch 1.3.x-watchTermination
in repository https://gitbox.apache.org/repos/asf/pekko.git


      at 1abc275b34 chore: Add missing scala doc for watchTermination operator. (#2368)

This branch includes the following new commits:

     new 1abc275b34 chore: Add missing scala doc for watchTermination operator. (#2368)

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org


(pekko) 01/01: chore: Add missing scala doc for watchTermination operator. (#2368)

Posted by he...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

hepin pushed a commit to branch 1.3.x-watchTermination
in repository https://gitbox.apache.org/repos/asf/pekko.git

commit 1abc275b344fdbe182141d8ed02187dffd707b01
Author: He-Pin(kerr) <he...@gmail.com>
AuthorDate: Sat Oct 25 20:52:13 2025 +0800

    chore: Add missing scala doc for watchTermination operator. (#2368)
    
    (cherry picked from commit 31ece7bfcc5974026b7a90026153463cba6f4623)
---
 stream/src/main/scala/org/apache/pekko/stream/javadsl/Flow.scala   | 3 +++
 stream/src/main/scala/org/apache/pekko/stream/javadsl/Source.scala | 3 +++
 2 files changed, 6 insertions(+)

diff --git a/stream/src/main/scala/org/apache/pekko/stream/javadsl/Flow.scala b/stream/src/main/scala/org/apache/pekko/stream/javadsl/Flow.scala
index fe5a1592da..c43628c667 100755
--- a/stream/src/main/scala/org/apache/pekko/stream/javadsl/Flow.scala
+++ b/stream/src/main/scala/org/apache/pekko/stream/javadsl/Flow.scala
@@ -4575,6 +4575,9 @@ final class Flow[In, Out, Mat](delegate: scaladsl.Flow[In, Out, Mat]) extends Gr
    * The future completes with success when received complete message from upstream or cancel
    * from downstream. It fails with the same error when received error message from
    * downstream.
+   *
+   * It is recommended to use the internally optimized `Keep.left` and `Keep.right` combiners
+   * where appropriate instead of manually writing functions that pass through one of the values.
    */
   def watchTermination[M](matF: function.Function2[Mat, CompletionStage[Done], M]): javadsl.Flow[In, Out, M] =
     new Flow(delegate.watchTermination()((left, right) => matF(left, right.asJava)))
diff --git a/stream/src/main/scala/org/apache/pekko/stream/javadsl/Source.scala b/stream/src/main/scala/org/apache/pekko/stream/javadsl/Source.scala
index 789eed2130..aabb24bc85 100755
--- a/stream/src/main/scala/org/apache/pekko/stream/javadsl/Source.scala
+++ b/stream/src/main/scala/org/apache/pekko/stream/javadsl/Source.scala
@@ -5166,6 +5166,9 @@ final class Source[Out, Mat](delegate: scaladsl.Source[Out, Mat]) extends Graph[
    * The Future completes with success when received complete message from upstream or cancel
    * from downstream. It fails with the same error when received error message from
    * downstream.
+   *
+   * It is recommended to use the internally optimized `Keep.left` and `Keep.right` combiners
+   * where appropriate instead of manually writing functions that pass through one of the values.
    */
   def watchTermination[M](matF: function.Function2[Mat, CompletionStage[Done], M]): javadsl.Source[Out, M] =
     new Source(delegate.watchTermination()((left, right) => matF(left, right.asJava)))


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org