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

Merge pull request #16213 from kosii/kosii/fsm_docs_fix_#16198

Browse source 
=doc #16198 FSM extends Actor, not depends on it
This commit is contained in:
Konrad Malawski 2014-11-04 17:00:25 +01:00
commit 3c992e4756
2 changed files with 6 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

8
akka-docs/rst/scala/code/docs/actor/FSMDocSpec.scala
View file

@ -39,7 +39,7 @@ class FSMDocSpec extends MyFavoriteTestFrameWorkPlusAkkaTestKit {
final case class Todo(target: ActorRef, queue: immutable.Seq[Any]) extends Data
//#simple-state
//#simple-fsm
class Buncher extends Actor with FSM[State, Data] {
class Buncher extends FSM[State, Data] {
//#fsm-body
startWith(Idle, Uninitialized)
@ -91,7 +91,7 @@ class FSMDocSpec extends MyFavoriteTestFrameWorkPlusAkkaTestKit {
case object Idle extends StateType
case object Active extends StateType
class Dummy extends Actor with FSM[StateType, Int] {
class Dummy extends FSM[StateType, Int] {
class X
val newData = 42
object WillDo
@ -171,7 +171,7 @@ class FSMDocSpec extends MyFavoriteTestFrameWorkPlusAkkaTestKit {
//#logging-fsm
import akka.actor.LoggingFSM
class MyFSM extends Actor with LoggingFSM[StateType, Data] {
class MyFSM extends LoggingFSM[StateType, Data] {
//#body-elided
override def logDepth = 12
onTermination {
@ -191,7 +191,7 @@ class FSMDocSpec extends MyFavoriteTestFrameWorkPlusAkkaTestKit {
"simple finite state machine" must {
"demonstrate NullFunction" in {
class A extends Actor with FSM[Int, Null] {
class A extends FSM[Int, Null] {
val SomeState = 0
//#NullFunction
when(SomeState)(FSM.NullFunction)

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

@ -123,9 +123,8 @@ Reference
The FSM Trait and Object
------------------------
The :class:`FSM` trait may only be mixed into an :class:`Actor`. Instead of
extending :class:`Actor`, the self type approach was chosen in order to make it
obvious that an actor is actually created:
The :class:`FSM` trait inherits directly from :class:`Actor`, when you
extend :class:`FSM` you must be aware that an actor is actually created:
.. includecode:: code/docs/actor/FSMDocSpec.scala
:include: simple-fsm