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

Improve unstash / unstashAll scaladoc (#30815)

Browse source
This commit is contained in:
Paweł Kaczor 2021-11-24 17:02:02 +01:00 • committed by GitHub
parent 3a2c1a688d
commit 16943a12c6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

12
akka-actor-typed/src/main/scala/akka/actor/typed/javadsl/StashBuffer.scala
View file

@ -102,10 +102,10 @@ import java.util.function.{ Predicate, Function => JFunction }
def clear(): Unit
/**
* Process all stashed messages with the `behavior` and the returned
* [[Behavior]] from each processed message. The `StashBuffer` will be
* empty after processing all messages, unless an exception is thrown
* or messages are stashed while unstashing.
* Transition to the given `behavior` and process all stashed messages.
* Messages will be processed in the same order they arrived.
* The `StashBuffer` will be empty after processing all messages,
* unless an exception is thrown or messages are stashed while unstashing.
*
* If an exception is thrown by processing a message a proceeding messages
* and the message causing the exception have been removed from the
@ -120,8 +120,8 @@ import java.util.function.{ Predicate, Function => JFunction }
def unstashAll(behavior: Behavior[T]): Behavior[T]
/**
* Process `numberOfMessages` of the stashed messages with the `behavior`
* and the returned [[Behavior]] from each processed message.
* Transition to the given `behavior` and process `numberOfMessages` of the stashed messages.
* The messages will be processed in the same order they arrived.
*
* The purpose of this method, compared to `unstashAll`, is to unstash a limited
* number of messages and then send a message to `self` before continuing unstashing

14
akka-actor-typed/src/main/scala/akka/actor/typed/scaladsl/StashBuffer.scala
View file

@ -114,10 +114,10 @@ import akka.annotation.{ DoNotInherit, InternalApi }
def clear(): Unit
/**
* Process all stashed messages with the `behavior` and the returned
* [[Behavior]] from each processed message. The `StashBuffer` will be
* empty after processing all messages, unless an exception is thrown
* or messages are stashed while unstashing.
* Transition to the given `behavior` and process all stashed messages.
* Messages will be processed in the same order they arrived.
* The `StashBuffer` will be empty after processing all messages,
* unless an exception is thrown or messages are stashed while unstashing.
*
* If an exception is thrown by processing a message a proceeding messages
* and the message causing the exception have been removed from the
@ -127,13 +127,13 @@ import akka.annotation.{ DoNotInherit, InternalApi }
* messages will not be processed by this call and have to be unstashed
* in another call.
*
* The initial `behavior` passed to `unstashAll` must not be `unhandled`.
* The `behavior` passed to `unstashAll` must not be `unhandled`.
*/
def unstashAll(behavior: Behavior[T]): Behavior[T]
/**
* Process `numberOfMessages` of the stashed messages with the `behavior`
* and the returned [[Behavior]] from each processed message.
* Transition to the given `behavior` and process `numberOfMessages` of the stashed messages.
* The messages will be processed in the same order they arrived.
*
* The purpose of this method, compared to `unstashAll` is to unstash a limited
* number of messages and then send a message to `self` before continuing unstashing