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

Merge pull request #1596 from akka/wip-3440-fsm-start-patriknw

Browse source 
DOC: FSM start state in preStart/postRestart, see #3440
This commit is contained in:
Roland Kuhn 2013-07-08 02:47:05 -07:00
commit 012e48047c
1 changed files with 8 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -184,7 +184,7 @@ object FSM {
* case Ev(SomeMsg) => ... // convenience when data not needed
* }
* when(Two, stateTimeout = 5 seconds) { ... }
* initialize
* initialize()
* }
* </pre>
*
@ -286,7 +286,9 @@ trait FSM[S, D] extends Actor with Listeners with ActorLogging {
register(stateName, stateFunction, Option(stateTimeout))
/**
* Set initial state. Call this method from the constructor before the #initialize method.
* Set initial state. Call this method from the constructor before the [[#initialize]] method.
* If different state is needed after a restart this method, followed by [[#initialize]], can
* be used in the actor life cycle hooks [[akka.actor.Actor#preStart]] and [[akka.actor.Actor#postRestart]].
*
* @param stateName initial state designator
* @param stateData initial state data
@ -447,7 +449,10 @@ trait FSM[S, D] extends Actor with Listeners with ActorLogging {
/**
* Verify existence of initial state and setup timers. This should be the
* last call within the constructor.
* last call within the constructor, or [[akka.actor.Actor#preStart]] and
* [[akka.actor.Actor#postRestart]]
*
* @see [[#startWith]]
*/
final def initialize(): Unit = makeTransition(currentState)