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

Merge pull request #1930 from akka/wip-3710-UnsubscribeTransitionCallback-patriknw

Browse source 
=act #3710 Correct doc of FSM unregistering listener
This commit is contained in:
Patrik Nordwall 2014-01-17 02:26:30 -08:00
commit a04a784121
2 changed files with 7 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -223,9 +223,10 @@ object FSM {
* the first matching one. * the first matching one.
* *
* Another feature is that other actors may subscribe for transition events by * Another feature is that other actors may subscribe for transition events by
* sending a <code>SubscribeTransitionCallback</code> message to this actor; * sending a <code>SubscribeTransitionCallback</code> message to this actor.
* use <code>UnsubscribeTransitionCallback</code> before stopping the other * Stopping a listener without unregistering will not remove the listener from the
* actor. * subscription list; use <code>UnsubscribeTransitionCallback</code> before stopping
* the listener.
* *
* State timeouts set an upper bound to the time which may pass before another * State timeouts set an upper bound to the time which may pass before another
* message is received in the current state. If no external message is * message is received in the current state. If no external message is

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

@ -330,9 +330,9 @@ and will receive :class:`Transition(actorRef, oldState, newState)` messages
whenever a new state is reached. External monitors may be unregistered by whenever a new state is reached. External monitors may be unregistered by
sending :class:`UnsubscribeTransitionCallBack(actorRef)` to the FSM actor. sending :class:`UnsubscribeTransitionCallBack(actorRef)` to the FSM actor.
Registering a not-running listener generates a warning and fails gracefully. Stopping a listener without unregistering will not remove the listener from the
Stopping a listener without unregistering will remove the listener from the subscription list; use :class:`UnsubscribeTransitionCallback` before stopping
subscription list upon the next transition. the listener.
Transforming State Transforming State
------------------ ------------------