From 61de190fca2e2508aec831d009f94ce437b0b488 Mon Sep 17 00:00:00 2001 From: "He-Pin(kerr)" Date: Fri, 5 Sep 2025 05:56:24 +0800 Subject: [PATCH] chore: Add doc for AsyncCallback (#2142) --- .../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 } }