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

improve documentation of Future.onComplete wrt. ordering

Browse source
This commit is contained in:
Roland 2011-09-16 21:19:41 +02:00
parent 9b21dd0af3
commit c0bc83b3ed
1 changed files with 6 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
akka-actor/src/main/scala/akka/dispatch/Future.scala
View file

@ -484,13 +484,16 @@ sealed trait Future[+T] extends japi.Future[T] {
/**
* When this Future is completed, apply the provided function to the
* Future. If the Future has already been completed, this will apply
* immediately.
* immediately. Will not be called in case of a timeout, which also holds if
* corresponding Promise is attempted to complete after expiry. Multiple
* callbacks may be registered; there is no guarantee that they will be
* executed in a particular order.
*/
def onComplete(func: Future[T] ⇒ Unit): this.type
/**
* When the future is completed with a valid result, apply the provided
* PartialFunction to the result.
* PartialFunction to the result. See `onComplete` for more details.
* <pre>
* future onResult {
* case Foo ⇒ target ! "foo"
@ -507,7 +510,7 @@ sealed trait Future[+T] extends japi.Future[T] {
/**
* When the future is completed with an exception, apply the provided
* PartialFunction to the exception.
* PartialFunction to the exception. See `onComplete` for more details.
* <pre>
* future onException {
* case NumberFormatException ⇒ target ! "wrong format"