c

org.apache.pekko.testkit

ExplicitlyTriggeredScheduler

class ExplicitlyTriggeredScheduler extends Scheduler

For testing: scheduler that does not look at the clock, but must be progressed manually by calling timePasses.

This allows for faster and less timing-sensitive specs, as jobs will be executed on the test thread instead of using the original {ExecutionContext}. This means recreating specific scenario's becomes easier, but these tests might fail to catch race conditions that only happen when tasks are scheduled in parallel in 'real time'.

Source
ExplicitlyTriggeredScheduler.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExplicitlyTriggeredScheduler
  2. Scheduler
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ExplicitlyTriggeredScheduler(config: Config, log: LoggingAdapter, tf: ThreadFactory)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ExplicitlyTriggeredScheduler toany2stringadd[ExplicitlyTriggeredScheduler] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ExplicitlyTriggeredScheduler, B)
    Implicit
    This member is added by an implicit conversion from ExplicitlyTriggeredScheduler toArrowAssoc[ExplicitlyTriggeredScheduler] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def currentTimeMs: Long

    The scheduler need to expose its internal time for testing.

  9. def ensuring(cond: (ExplicitlyTriggeredScheduler) => Boolean, msg: => Any): ExplicitlyTriggeredScheduler
    Implicit
    This member is added by an implicit conversion from ExplicitlyTriggeredScheduler toEnsuring[ExplicitlyTriggeredScheduler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (ExplicitlyTriggeredScheduler) => Boolean): ExplicitlyTriggeredScheduler
    Implicit
    This member is added by an implicit conversion from ExplicitlyTriggeredScheduler toEnsuring[ExplicitlyTriggeredScheduler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): ExplicitlyTriggeredScheduler
    Implicit
    This member is added by an implicit conversion from ExplicitlyTriggeredScheduler toEnsuring[ExplicitlyTriggeredScheduler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): ExplicitlyTriggeredScheduler
    Implicit
    This member is added by an implicit conversion from ExplicitlyTriggeredScheduler toEnsuring[ExplicitlyTriggeredScheduler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def maxFrequency: Double
    Definition Classes
    ExplicitlyTriggeredScheduler → Scheduler
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def schedule(initialDelay: FiniteDuration, interval: FiniteDuration, runnable: Runnable)(implicit executor: ExecutionContext): Cancellable
    Definition Classes
    ExplicitlyTriggeredScheduler → Scheduler
  23. final def scheduleAtFixedRate(initialDelay: Duration, interval: Duration, receiver: ActorRef, message: Any, executor: ExecutionContext, sender: ActorRef): Cancellable
    Definition Classes
    Scheduler
  24. final def scheduleAtFixedRate(initialDelay: FiniteDuration, interval: FiniteDuration, receiver: ActorRef, message: Any)(implicit executor: ExecutionContext, sender: ActorRef): Cancellable
    Definition Classes
    Scheduler
  25. final def scheduleAtFixedRate(initialDelay: Duration, interval: Duration, runnable: Runnable, executor: ExecutionContext): Cancellable
    Definition Classes
    Scheduler
  26. final def scheduleAtFixedRate(initialDelay: FiniteDuration, interval: FiniteDuration)(runnable: Runnable)(implicit executor: ExecutionContext): Cancellable
    Definition Classes
    Scheduler
  27. def scheduleOnce(delay: FiniteDuration, runnable: Runnable)(implicit executor: ExecutionContext): Cancellable
    Definition Classes
    ExplicitlyTriggeredScheduler → Scheduler
  28. def scheduleOnce(delay: Duration, runnable: Runnable)(implicit executor: ExecutionContext): Cancellable
    Definition Classes
    Scheduler
  29. final def scheduleOnce(delay: FiniteDuration)(f: => Unit)(implicit executor: ExecutionContext): Cancellable
    Definition Classes
    Scheduler
  30. final def scheduleOnce(delay: Duration, receiver: ActorRef, message: Any, executor: ExecutionContext, sender: ActorRef): Cancellable
    Definition Classes
    Scheduler
  31. final def scheduleOnce(delay: FiniteDuration, receiver: ActorRef, message: Any)(implicit executor: ExecutionContext, sender: ActorRef): Cancellable
    Definition Classes
    Scheduler
  32. final def scheduleWithFixedDelay(initialDelay: Duration, delay: Duration, receiver: ActorRef, message: Any, executor: ExecutionContext, sender: ActorRef): Cancellable
    Definition Classes
    Scheduler
  33. final def scheduleWithFixedDelay(initialDelay: FiniteDuration, delay: FiniteDuration, receiver: ActorRef, message: Any)(implicit executor: ExecutionContext, sender: ActorRef): Cancellable
    Definition Classes
    Scheduler
  34. final def scheduleWithFixedDelay(initialDelay: Duration, delay: Duration, runnable: Runnable, executor: ExecutionContext): Cancellable
    Definition Classes
    Scheduler
  35. def scheduleWithFixedDelay(initialDelay: FiniteDuration, delay: FiniteDuration)(runnable: Runnable)(implicit executor: ExecutionContext): Cancellable
    Definition Classes
    Scheduler
  36. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  37. def timePasses(amount: FiniteDuration): Unit

    Advance the clock by the specified duration, executing all outstanding jobs on the calling thread before returning.

    Advance the clock by the specified duration, executing all outstanding jobs on the calling thread before returning.

    We will not add a dilation factor to this amount, since the scheduler API also does not apply dilation. If you want the amount of time passed to be dilated, apply the dilation before passing the delay to this method.

  38. def toString(): String
    Definition Classes
    AnyRef → Any
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ExplicitlyTriggeredScheduler toStringFormat[ExplicitlyTriggeredScheduler] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def schedule(initialDelay: Duration, interval: Duration, runnable: Runnable)(implicit executor: ExecutionContext): Cancellable
    Definition Classes
    Scheduler
    Annotations
    @deprecated
    Deprecated

    (Since version Akka 2.6.0) Use scheduleWithFixedDelay or scheduleAtFixedRate instead. This has the same semantics as scheduleAtFixedRate, but scheduleWithFixedDelay is often preferred.

  4. final def schedule(initialDelay: FiniteDuration, interval: FiniteDuration)(f: => Unit)(implicit executor: ExecutionContext): Cancellable
    Definition Classes
    Scheduler
    Annotations
    @deprecated
    Deprecated

    (Since version Akka 2.6.0) Use scheduleWithFixedDelay or scheduleAtFixedRate instead. This has the same semantics as scheduleAtFixedRate, but scheduleWithFixedDelay is often preferred.

  5. final def schedule(initialDelay: Duration, interval: Duration, receiver: ActorRef, message: Any, executor: ExecutionContext, sender: ActorRef): Cancellable
    Definition Classes
    Scheduler
    Annotations
    @deprecated
    Deprecated

    (Since version Akka 2.6.0) Use scheduleWithFixedDelay or scheduleAtFixedRate instead. This has the same semantics as scheduleAtFixedRate, but scheduleWithFixedDelay is often preferred.

  6. final def schedule(initialDelay: FiniteDuration, interval: FiniteDuration, receiver: ActorRef, message: Any)(implicit executor: ExecutionContext, sender: ActorRef): Cancellable
    Definition Classes
    Scheduler
    Annotations
    @deprecated
    Deprecated

    (Since version Akka 2.6.0) Use scheduleWithFixedDelay or scheduleAtFixedRate instead. This has the same semantics as scheduleAtFixedRate, but scheduleWithFixedDelay is often preferred.

  7. def [B](y: B): (ExplicitlyTriggeredScheduler, B)
    Implicit
    This member is added by an implicit conversion from ExplicitlyTriggeredScheduler toArrowAssoc[ExplicitlyTriggeredScheduler] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Scheduler

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromExplicitlyTriggeredScheduler to any2stringadd[ExplicitlyTriggeredScheduler]

Inherited by implicit conversion StringFormat fromExplicitlyTriggeredScheduler to StringFormat[ExplicitlyTriggeredScheduler]

Inherited by implicit conversion Ensuring fromExplicitlyTriggeredScheduler to Ensuring[ExplicitlyTriggeredScheduler]

Inherited by implicit conversion ArrowAssoc fromExplicitlyTriggeredScheduler to ArrowAssoc[ExplicitlyTriggeredScheduler]

Ungrouped