Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Rename FSM and TestFSMRef's timerActive_? to isTimerActive. Fixes #2766 #925

Merged
merged 1 commit into from Dec 7, 2012
Jump to file or symbol
Failed to load files and symbols.
+34 −13
Split
@@ -227,7 +227,7 @@ class FSMActorSpec extends AkkaSpec(Map("akka.actor.debug.fsm" -> true)) with Im
})
def checkTimersActive(active: Boolean) {
- for (timer timerNames) fsmref.timerActive_?(timer) must be(active)
+ for (timer timerNames) fsmref.isTimerActive(timer) must be(active)
fsmref.isStateTimerActive must be(active)
}
@@ -238,7 +238,7 @@ object FSM {
* setTimer("tock", TockMsg, 1 second, true) // repeating
* setTimer("lifetime", TerminateMsg, 1 hour, false) // single-shot
* cancelTimer("tock")
- * timerActive_? ("tock")
+ * isTimerActive("tock")
* </pre>
*/
trait FSM[S, D] extends Listeners with ActorLogging {
@@ -372,7 +372,15 @@ trait FSM[S, D] extends Listeners with ActorLogging {
* timer does not exist, has previously been canceled or if it was a
* single-shot timer whose message was already received.
*/
- final def timerActive_?(name: String) = timers contains name
+ @deprecated("Use isTimerActive(name) instead.", "2.2")
+ final def timerActive_?(name: String) = isTimerActive(name)
+
+ /**
+ * Inquire whether the named timer is still active. Returns true unless the
+ * timer does not exist, has previously been canceled or if it was a
+ * single-shot timer whose message was already received.
+ */
+ final def isTimerActive(name: String) = timers contains name
/**
* Set state timeout explicitly. This method can safely be used from within a
@@ -23,4 +23,11 @@ Search Replace with
==================================== ====================================
If you need to convert from Java to ``scala.collection.immutable.Seq`` or ``scala.collection.immutable.Iterable`` you should use ``akka.japi.Util.immutableSeq(…)``,
-and if you need to convert from Scala you can simply switch to using immutable collections yourself or use the ``to[immutable.<collection-type>]`` method.
+and if you need to convert from Scala you can simply switch to using immutable collections yourself or use the ``to[immutable.<collection-type>]`` method.
+
+API changes to FSM and TestFSMRef
+=================================
+
+The ``timerActive_?`` method has been deprecated in both the ``FSM`` trait and the ``TestFSMRef``
+class. You should now use the ``isTimerActive`` method instead. The old method will remain
+throughout 2.2.x. It will be removed in Akka 2.3.
@@ -110,11 +110,11 @@ class TestkitDocSpec extends AkkaSpec with DefaultTimeout with ImplicitSender {
fsm.setState(stateName = 1)
assert(fsm.stateName == 1)
- assert(fsm.timerActive_?("test") == false)
+ assert(fsm.isTimerActive("test") == false)
fsm.setTimer("test", 12, 10 millis, true)
- assert(fsm.timerActive_?("test") == true)
+ assert(fsm.isTimerActive("test") == true)
fsm.cancelTimer("test")
- assert(fsm.timerActive_?("test") == false)
+ assert(fsm.isTimerActive("test") == false)
//#test-fsm-ref
}
@@ -371,7 +371,7 @@ which is guaranteed to work immediately, meaning that the scheduled message
will not be processed after this call even if the timer already fired and
queued it. The status of any timer may be inquired with
- :func:`timerActive_?(name)`
+ :func:`isTimerActive(name)`
These named timers complement state timeouts because they are not affected by
intervening reception of other messages.
@@ -302,7 +302,7 @@ private[akka] class ThrottleActor(channelContext: ChannelHandlerContext)
log.debug("sending msg (Tick): {}", s.msg)
send(s)
}
- if (!timerActive_?("send"))
+ if (!isTimerActive("send"))
for (time toTick) {
log.debug("scheduling next Tick in {}", time)
setTimer("send", Tick, time, false)
@@ -78,7 +78,13 @@ class TestFSMRef[S, D, T <: Actor](
/**
* Proxy for FSM.timerActive_?.
*/
- def timerActive_?(name: String) = fsm.timerActive_?(name)
+ @deprecated("Use isTimerActive(name) instead.", "2.2")
+ def timerActive_?(name: String) = isTimerActive(name)
+
+ /**
+ * Proxy for FSM.isTimerActive.
+ */
+ def isTimerActive(name: String) = fsm.isTimerActive(name)
/**
* Proxy for FSM.timerActive_?.
@@ -51,11 +51,11 @@ class TestFSMRefSpec extends AkkaSpec {
case x stay
}
}, "test-fsm-ref-2")
- fsm.timerActive_?("test") must be(false)
+ fsm.isTimerActive("test") must be(false)
fsm.setTimer("test", 12, 10 millis, true)
- fsm.timerActive_?("test") must be(true)
+ fsm.isTimerActive("test") must be(true)
fsm.cancelTimer("test")
- fsm.timerActive_?("test") must be(false)
+ fsm.isTimerActive("test") must be(false)
}
}
}