Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

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

Merged
merged 1 commit into from

4 participants

@richdougherty

(Oops, accidentally closed 921 when updating the branch.)

This pull request is the same but also renames some of the new code that came in pull request 915.

@patriknw
Owner

LGTM

@akka-ci
Owner

Started jenkins job akka-pr-validator at https://jenkins.akka.io/job/akka-pr-validator/173/

@akka-ci
Owner

jenkins job akka-pr-validator: Success - https://jenkins.akka.io/job/akka-pr-validator/173/

akka-actor/src/main/scala/akka/actor/FSM.scala
@@ -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() instead.", "2.2")
@rkuhn Owner
rkuhn added a note

I’d include the arguments to show the right arity of the method: isTimerActive(name)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@rkuhn
Owner

apart from the nitpick: LGTM

could you do the same for ThreadPoolBuilder.conf_? and TypedActor.MethodCall.returns<*>_? ?

@akka-ci
Owner

Started jenkins job akka-pr-validator at https://jenkins.akka.io/job/akka-pr-validator/179/

@akka-ci
Owner

jenkins job akka-pr-validator: Success - https://jenkins.akka.io/job/akka-pr-validator/179/

@rkuhn rkuhn merged commit d642fab into from
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.
View
2  akka-actor-tests/src/test/scala/akka/actor/FSMActorSpec.scala
@@ -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)
}
View
12 akka-actor/src/main/scala/akka/actor/FSM.scala
@@ -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
View
9 akka-docs/rst/project/migration-guide-2.1.x-2.2.x.rst
@@ -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.
View
6 akka-docs/rst/scala/code/docs/testkit/TestkitDocSpec.scala
@@ -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
}
View
2  akka-docs/rst/scala/fsm.rst
@@ -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.
View
2  akka-remote-tests/src/main/scala/akka/remote/testconductor/NetworkFailureInjector.scala
@@ -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)
View
8 akka-testkit/src/main/scala/akka/testkit/TestFSMRef.scala
@@ -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_?.
View
6 akka-testkit/src/test/scala/akka/testkit/TestFSMRefSpec.scala
@@ -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)
}
}
}
Something went wrong with that request. Please try again.