Packages

c

com.twitter.util

MockTimer

class MockTimer extends Timer

Exceedingly useful for writing well-behaved tests that need control over a Timer. This is due to it playing well with the Time manipulation methods such as Time.withTimeAt, Time.withCurrentTimeFrozen, and so on.

See also

See the cookbook for examples.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MockTimer
  2. Timer
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MockTimer()

Type Members

  1. case class Task(when: Time, runner: () ⇒ Unit) extends TimerTask with Product with Serializable

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def doAt[A](time: Time)(f: ⇒ A): Future[A]

    Performs an operation at the specified time.

    Performs an operation at the specified time. Interrupting the Future will cancel the scheduled timer task, if not too late.

    Definition Classes
    Timer
    Note

    Interrupts from returned Future will be translated into a task cancellation if and only if this Timer honors cancellations in schedule(Time)(f).

  7. def doLater[A](delay: Duration)(f: ⇒ A): Future[A]

    Performs an operation after the specified delay.

    Performs an operation after the specified delay. Interrupting the Future will cancel the scheduled timer task, if not too late.

    Definition Classes
    Timer
    Note

    Interrupts from returned Future will be translated into a task cancellation if and only if this Timer honors cancellations in schedule(Time)(f).

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. var isStopped: Boolean
  15. var nCancelled: Int
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def schedule(period: Duration)(f: ⇒ Unit): TimerTask

    Run f every elapsed period, starting period from now.

    Run f every elapsed period, starting period from now.

    Definition Classes
    Timer
  20. final def schedule(when: Time, period: Duration)(f: ⇒ Unit): TimerTask

    Run f at time when; subsequently run f at every elapsed period.

    Run f at time when; subsequently run f at every elapsed period.

    Definition Classes
    Timer
    Note

    If when is negative or undefined, it will be treated as Time.epoch.

    ,

    If period is negative or undefined, the timer task will be rescheduled immediately (i.e., period will be treated as Duration.Zero).

  21. final def schedule(when: Time)(f: ⇒ Unit): TimerTask

    Run f at time when.

    Run f at time when.

    Definition Classes
    Timer
    Note

    If when is negative or undefined, it will be treated as Time.epoch.

  22. def scheduleOnce(when: Time)(f: ⇒ Unit): TimerTask
    Attributes
    protected
    Definition Classes
    MockTimerTimer
  23. def schedulePeriodically(when: Time, period: Duration)(f: ⇒ Unit): TimerTask

    Pay attention that ticking frozen time forward more than 1x duration will result in only one invocation of your task.

    Pay attention that ticking frozen time forward more than 1x duration will result in only one invocation of your task.

    Attributes
    protected
    Definition Classes
    MockTimerTimer
  24. def stop(): Unit

    Stop the timer.

    Stop the timer. Pending tasks are cancelled. The timer is unusable after being stopped.

    Definition Classes
    MockTimerTimer
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. var tasks: ArrayBuffer[Task]
  27. def tick(): Unit
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Timer

Inherited from AnyRef

Inherited from Any

Ungrouped