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

Merge pull request #1580 from drewhk/wip-3263-doc-warn-scheduler-closingover-drewhk

Browse source 
= doc: Added warning about closing over in scheduled tasks #3263
This commit is contained in:
Roland Kuhn 2013-07-04 05:07:27 -07:00
commit 0f1b7b3556
2 changed files with 18 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
akka-docs/rst/java/scheduler.rst
View file

@ -39,6 +39,15 @@ Schedule a Runnable, that sends the current time to the testActor, to be execute
.. includecode:: code/docs/actor/SchedulerDocTest.java
:include: schedule-one-off-thunk
.. warning::
If you schedule Runnable instances you should be extra careful
to not pass or close over unstable references. In practice this means that you should
not call methods on the enclosing Actor from within the Runnable.
If you need to schedule an invocation it is better to use the ``schedule()``
variant accepting a message and an ``ActorRef`` to schedule a message to self
(containing the necessary parameters) and then call the method when the message is received.
Schedule to send the "Tick"-message to the ``tickActor`` after 0ms repeating every 50ms:
.. includecode:: code/docs/actor/SchedulerDocTest.java