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

=doc #3647 Clarify that existing FSM timer is canceled by setTimer

Browse source
This commit is contained in:
Patrik Nordwall 2014-01-22 09:55:38 +01:00
parent 1c0e799370
commit 686cfab150
3 changed files with 12 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
akka-actor/src/main/scala/akka/actor/FSM.scala
View file

@ -356,6 +356,8 @@ trait FSM[S, D] extends Actor with Listeners with ActorLogging {
/**
* Schedule named timer to deliver message after given delay, possibly repeating.
* Any existing timer with the same name will automatically be canceled before
* adding the new timer.
* @param name identifier to be used with cancelTimer()
* @param msg message to be delivered
* @param timeout delay of first message delivery and between subsequent messages

7
akka-docs/rst/java/lambda-fsm.rst
View file

@ -332,8 +332,11 @@ You may set a timer using
where :obj:`msg` is the message object which will be sent after the duration
:obj:`interval` has elapsed. If :obj:`repeat` is :obj:`true`, then the timer is
scheduled at fixed rate given by the :obj:`interval` parameter. Timers may be
canceled using
scheduled at fixed rate given by the :obj:`interval` parameter.
Any existing timer with the same name will automatically be canceled before
adding the new timer.
Timers may be canceled using
:func:`cancelTimer(name)`

7
akka-docs/rst/scala/fsm.rst
View file

@ -362,8 +362,11 @@ You may set a timer using
where :obj:`msg` is the message object which will be sent after the duration
:obj:`interval` has elapsed. If :obj:`repeat` is :obj:`true`, then the timer is
scheduled at fixed rate given by the :obj:`interval` parameter. Timers may be
canceled using
scheduled at fixed rate given by the :obj:`interval` parameter.
Any existing timer with the same name will automatically be canceled before
adding the new timer.
Timers may be canceled using
:func:`cancelTimer(name)`