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

Clarify what to do instead of sending a PoisonPill for ActorRef source (#27090)

Browse source 
* Clarify what to do instead of sending poison pill to actor ref source

* Fix typos in scala/java doc for Source.actorRef
This commit is contained in:
Christopher Batey 2019-06-07 08:46:34 +01:00 • committed by Arnout Engelen
parent 508aa9970f
commit 6d7ad47571
3 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

3
akka-stream/src/main/scala/akka/stream/impl/ActorRefSource.scala
View file

@ -53,7 +53,8 @@ private object ActorRefSource {
override val ref: ActorRef = getEagerStageActor(eagerMaterializer, poisonPillCompatibility = true) {
case (_, PoisonPill) =>
log.warning("for backwards compatibility: PoisonPill will not be supported in the future")
log.warning(
"PoisonPill only completes ActorRefSource for backwards compatibility and not be supported in the future. Send Status.Success(CompletionStrategy) instead")
completeStage()
case (_, m) if failureMatcher.isDefinedAt(m) =>
failStage(failureMatcher(m))

4
akka-stream/src/main/scala/akka/stream/javadsl/Source.scala
View file

@ -319,9 +319,9 @@ object Source {
* completion.
*
* The stream can be completed successfully by sending the actor reference a [[akka.actor.Status.Success]].
* If the content is [[akka.stream.CompletionStrategy.immediately]] the completion will be signaled immidiately,
* If the content is [[akka.stream.CompletionStrategy.immediately]] the completion will be signaled immediately,
* otherwise if the content is [[akka.stream.CompletionStrategy.draining]] (or anything else)
* already buffered elements will be signaled before siganling completion.
* already buffered elements will be signaled before signaling completion.
* Sending [[akka.actor.PoisonPill]] will signal completion immediately but this behavior is deprecated and scheduled to be removed.
*
* The stream can be completed with failure by sending a [[akka.actor.Status.Failure]] to the

4
akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala
View file

@ -543,9 +543,9 @@ object Source {
* this Source; as such, it is never safe to assume the downstream will always generate demand.
*
* The stream can be completed successfully by sending the actor reference a [[akka.actor.Status.Success]].
* If the content is [[akka.stream.CompletionStrategy.immediately]] the completion will be signaled immidiately,
* If the content is [[akka.stream.CompletionStrategy.immediately]] the completion will be signaled immediately,
* otherwise if the content is [[akka.stream.CompletionStrategy.draining]] (or anything else)
* already buffered elements will be signaled before siganling completion.
* already buffered elements will be signaled before signaling completion.
* Sending [[akka.actor.PoisonPill]] will signal completion immediately but this behavior is deprecated and scheduled to be removed.
*
* The stream can be completed with failure by sending a [[akka.actor.Status.Failure]] to the