Merge pull request #19870 from akka/wip-docs-ask-cs-ktoso

+doc,java document the PatternsCS.ask
2016-02-24 18:06:06 +01:00 · 2016-02-24 18:06:06 +01:00 · 06b4d54960
commit 06b4d54960
parent 664071afb6 9deb44a3e2
1 changed files with 4 additions and 0 deletions
--- a/akka-docs/rst/java/untyped-actors.rst
+++ b/akka-docs/rst/java/untyped-actors.rst
@ -519,6 +519,10 @@ involves creating an internal actor for handling this reply, which needs to
 have a timeout after which it is destroyed in order not to leak resources; see
 more below.

+.. note::
+    A Java 8 variant of the ``ask`` pattern that returns a ``CompletionStage`` instead of a Scala ``Future``
+    is available in the ``akka.pattern.PatternsCS`` object.
+
 .. warning::

    To complete the future with an exception you need send a Failure message to the sender.