This is an automated email from the ASF dual-hosted git repository.
hepin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pekko.git
The following commit(s) were added to refs/heads/main by this push:
new 61de190fca chore: Add doc for AsyncCallback (#2142)
61de190fca is described below
commit 61de190fca2e2508aec831d009f94ce437b0b488
Author: He-Pin(kerr) <[email protected]>
AuthorDate: Fri Sep 5 05:56:24 2025 +0800
chore: Add doc for AsyncCallback (#2142)
---
.../scala/org/apache/pekko/stream/stage/GraphStage.scala | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git
a/stream/src/main/scala/org/apache/pekko/stream/stage/GraphStage.scala
b/stream/src/main/scala/org/apache/pekko/stream/stage/GraphStage.scala
index 04f46f1d88..75a34504e1 100644
--- a/stream/src/main/scala/org/apache/pekko/stream/stage/GraphStage.scala
+++ b/stream/src/main/scala/org/apache/pekko/stream/stage/GraphStage.scala
@@ -1647,8 +1647,10 @@ trait AsyncCallback[T] {
*
* For cases where it is important to know if the notification was ever
processed or not
* see [[AsyncCallback#invokeWithFeedback]]
+ *
+ * @param msg the message to the GraphStage, can be null
*/
- def invoke(t: T): Unit
+ def invoke(msg: T): Unit
/**
* Dispatch an asynchronous notification. This method is thread-safe and
@@ -1661,8 +1663,10 @@ trait AsyncCallback[T] {
*
* The handling of the returned future incurs a slight overhead, so for
cases where it does not matter
* to the invoking logic see [[AsyncCallback#invoke]]
+ *
+ * @param msg the message to the GraphStage, can be null
*/
- def invokeWithFeedback(t: T): Future[Done]
+ def invokeWithFeedback(msg: T): Future[Done]
/**
* Java API
@@ -1677,11 +1681,13 @@ trait AsyncCallback[T] {
*
* The handling of the returned future incurs a slight overhead, so for
cases where it does not matter
* to the invoking logic see [[AsyncCallback#invoke]]
+ *
+ * @param msg the message to the GraphStage, can be null
* @since 1.2.0
*/
- def invokeWithFeedbackCompletionStage(t: T): CompletionStage[Done] = {
+ def invokeWithFeedbackCompletionStage(msg: T): CompletionStage[Done] = {
import pekko.util.FutureConverters._
- invokeWithFeedback(t).asJava
+ invokeWithFeedback(msg).asJava
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
