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

chore: Add doc for AsyncCallback (#2142)

Browse source
This commit is contained in:
He-Pin(kerr) 2025-09-05 05:56:24 +08:00 • committed by GitHub
parent 6f2a65da4c
commit 61de190fca
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 10 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

14
stream/src/main/scala/org/apache/pekko/stream/stage/GraphStage.scala
View file

@ -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
}
}