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

=str #17173 Clarify CompletionHandling scaladoc

Browse source
This commit is contained in:
Patrik Nordwall 2015-04-14 11:16:51 +02:00
parent 6d0ad317d0
commit 739796d81e
2 changed files with 9 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

10
akka-stream/src/main/scala/akka/stream/javadsl/FlexiRoute.scala
View file

@ -91,11 +91,13 @@ object FlexiRoute {
* How to handle completion or failure from upstream input and how to
* handle cancel from downstream output.
*
* The `onUpstreamFinish` method is called the upstream input was completed successfully.
* It returns next behavior or [[#sameState]] to keep current behavior.
* The `onUpstreamFinish` method is called when the upstream input was completed successfully.
* The completion will be propagated downstreams unless this function throws an exception, in
* which case the streams will be completed with that failure.
*
* The `onUpstreamFailure` method is called when the upstream input was completed with failure.
* It returns next behavior or [[#SameState]] to keep current behavior.
* The failure will be propagated downstreams unless this function throws an exception, in
* which case the streams will be completed with that failure instead.
*
* The `onDownstreamFinish` method is called when a downstream output cancels.
* It returns next behavior or [[#sameState]] to keep current behavior.
@ -163,7 +165,6 @@ object FlexiRoute {
/**
* When an output cancels it continues with remaining outputs.
* Failure or completion from upstream are immediately propagated.
*/
def defaultCompletionHandling: CompletionHandling[In] =
new CompletionHandling[In] {
@ -175,7 +176,6 @@ object FlexiRoute {
/**
* Completes as soon as any output cancels.
* Failure or completion from upstream are immediately propagated.
*/
def eagerClose[A]: CompletionHandling[In] =
new CompletionHandling[In] {

6
akka-stream/src/main/scala/akka/stream/scaladsl/FlexiRoute.scala
View file

@ -136,8 +136,12 @@ object FlexiRoute {
* handle cancel from downstream output.
*
* The `onUpstreamFinish` function is called the upstream input was completed successfully.
* The completion will be propagated downstreams unless this function throws an exception, in
* which case the streams will be completed with that failure.
*
* The `onUpstreamFailure` function is called when the upstream input was completed with failure.
* The failure will be propagated downstreams unless this function throws an exception, in
* which case the streams will be completed with that failure instead.
*
* The `onDownstreamFinish` function is called when a downstream output cancels.
* It returns next behavior or [[#SameState]] to keep current behavior.
@ -152,7 +156,6 @@ object FlexiRoute {
/**
* When an output cancels it continues with remaining outputs.
* Failure or completion from upstream are immediately propagated.
*/
val defaultCompletionHandling: CompletionHandling = CompletionHandling(
onUpstreamFinish = _ ⇒ (),
@ -161,7 +164,6 @@ object FlexiRoute {
/**
* Completes as soon as any output cancels.
* Failure or completion from upstream are immediately propagated.
*/
val eagerClose: CompletionHandling = CompletionHandling(
onUpstreamFinish = _ ⇒ (),