ExplicitlyTriggeredScheduler

org.apache.pekko.testkit.ExplicitlyTriggeredScheduler
class ExplicitlyTriggeredScheduler(config: Config, log: LoggingAdapter, tf: ThreadFactory) 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'.

Attributes

Source
ExplicitlyTriggeredScheduler.scala
Graph
Supertypes
trait Scheduler
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

The scheduler need to expose its internal time for testing.

The scheduler need to expose its internal time for testing.

Attributes

Source
ExplicitlyTriggeredScheduler.scala
override def maxFrequency: Double

The maximum supported task frequency of this scheduler, i.e. the inverse of the minimum time interval between executions of a recurring task, in Hz.

The maximum supported task frequency of this scheduler, i.e. the inverse of the minimum time interval between executions of a recurring task, in Hz.

Attributes

Definition Classes
Source
ExplicitlyTriggeredScheduler.scala
override def schedule(initialDelay: FiniteDuration, interval: FiniteDuration, runnable: Runnable)(implicit executor: ExecutionContext): Cancellable

Deprecated API: See Scheduler#scheduleWithFixedDelay or Scheduler#scheduleAtFixedRate.

Deprecated API: See Scheduler#scheduleWithFixedDelay or Scheduler#scheduleAtFixedRate.

Attributes

Definition Classes
Source
ExplicitlyTriggeredScheduler.scala
override def scheduleOnce(delay: FiniteDuration, runnable: Runnable)(implicit executor: ExecutionContext): Cancellable

Scala API: Schedules a Runnable to be run once with a delay, i.e. a time period that has to pass before the runnable is executed.

Scala API: Schedules a Runnable to be run once with a delay, i.e. a time period that has to pass before the runnable is executed.

Attributes

Throws
IllegalArgumentException

if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors with Timers should be preferred.

Definition Classes
Source
ExplicitlyTriggeredScheduler.scala

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.

Attributes

Source
ExplicitlyTriggeredScheduler.scala

Inherited methods

Java API: Schedules a message to be sent repeatedly with an initial delay and frequency. E.g. if you would like a message to be sent immediately and thereafter every 500ms you would set delay=Duration.ZERO and interval=Duration.ofMillis(500)

Java API: Schedules a message to be sent repeatedly with an initial delay and frequency. E.g. if you would like a message to be sent immediately and thereafter every 500ms you would set delay=Duration.ZERO and interval=Duration.ofMillis(500)

It will compensate the delay for a subsequent message if the sending of previous message was delayed more than specified. In such cases, the actual message interval will differ from the interval passed to the method.

If the execution is delayed longer than the interval, the subsequent message will be sent immediately after the prior one. This also has the consequence that after long garbage collection pauses or other reasons when the JVM was suspended all "missed" messages will be sent when the process wakes up again.

In the long run, the frequency of messages will be exactly the reciprocal of the specified interval.

Warning: scheduleAtFixedRate can result in bursts of scheduled messages after long garbage collection pauses, which may in worst case cause undesired load on the system. Therefore scheduleWithFixedDelay is often preferred.

Note: For scheduling within actors AbstractActorWithTimers should be preferred.

Attributes

Inherited from:
Scheduler
Source
Scheduler.scala

Scala API: Schedules a message to be sent repeatedly with an initial delay and frequency. E.g. if you would like a message to be sent immediately and thereafter every 500ms you would set delay=Duration.Zero and interval=Duration(500, TimeUnit.MILLISECONDS)

Scala API: Schedules a message to be sent repeatedly with an initial delay and frequency. E.g. if you would like a message to be sent immediately and thereafter every 500ms you would set delay=Duration.Zero and interval=Duration(500, TimeUnit.MILLISECONDS)

It will compensate the delay for a subsequent message if the sending of previous message was delayed more than specified. In such cases, the actual message interval will differ from the interval passed to the method.

If the execution is delayed longer than the interval, the subsequent message will be sent immediately after the prior one. This also has the consequence that after long garbage collection pauses or other reasons when the JVM was suspended all "missed" messages will be sent when the process wakes up again.

In the long run, the frequency of messages will be exactly the reciprocal of the specified interval.

Warning: scheduleAtFixedRate can result in bursts of scheduled messages after long garbage collection pauses, which may in worst case cause undesired load on the system. Therefore scheduleWithFixedDelay is often preferred.

Note: For scheduling within actors with Timers should be preferred.

Attributes

Inherited from:
Scheduler
Source
Scheduler.scala

Java API: Schedules a Runnable to be run repeatedly with an initial delay and a frequency. E.g. if you would like the function to be run after 2 seconds and thereafter every 100ms you would set delay to Duration.ofSeconds(2), and interval to Duration.ofMillis(100).

Java API: Schedules a Runnable to be run repeatedly with an initial delay and a frequency. E.g. if you would like the function to be run after 2 seconds and thereafter every 100ms you would set delay to Duration.ofSeconds(2), and interval to Duration.ofMillis(100).

It will compensate the delay for a subsequent task if the previous tasks took too long to execute. In such cases, the actual execution interval will differ from the interval passed to the method.

If the execution of the tasks takes longer than the interval, the subsequent execution will start immediately after the prior one completes (there will be no overlap of executions). This also has the consequence that after long garbage collection pauses or other reasons when the JVM was suspended all "missed" tasks will execute when the process wakes up again.

In the long run, the frequency of execution will be exactly the reciprocal of the specified interval.

Warning: scheduleAtFixedRate can result in bursts of scheduled tasks after long garbage collection pauses, which may in worst case cause undesired load on the system. Therefore scheduleWithFixedDelay is often preferred.

If the Runnable throws an exception the repeated scheduling is aborted, i.e. the function will not be invoked any more.

Attributes

Throws
IllegalArgumentException

if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors AbstractActorWithTimers should be preferred.

Inherited from:
Scheduler
Source
Scheduler.scala

Scala API: Schedules a Runnable to be run repeatedly with an initial delay and a frequency. E.g. if you would like the function to be run after 2 seconds and thereafter every 100ms you would set delay=Duration(2, TimeUnit.SECONDS) and interval=Duration(100, TimeUnit.MILLISECONDS).

Scala API: Schedules a Runnable to be run repeatedly with an initial delay and a frequency. E.g. if you would like the function to be run after 2 seconds and thereafter every 100ms you would set delay=Duration(2, TimeUnit.SECONDS) and interval=Duration(100, TimeUnit.MILLISECONDS).

It will compensate the delay for a subsequent task if the previous tasks took too long to execute. In such cases, the actual execution interval will differ from the interval passed to the method.

If the execution of the tasks takes longer than the interval, the subsequent execution will start immediately after the prior one completes (there will be no overlap of executions). This also has the consequence that after long garbage collection pauses or other reasons when the JVM was suspended all "missed" tasks will execute when the process wakes up again.

In the long run, the frequency of execution will be exactly the reciprocal of the specified interval.

Warning: scheduleAtFixedRate can result in bursts of scheduled tasks after long garbage collection pauses, which may in worst case cause undesired load on the system. Therefore scheduleWithFixedDelay is often preferred.

If the Runnable throws an exception the repeated scheduling is aborted, i.e. the function will not be invoked any more.

Attributes

Throws
IllegalArgumentException

if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors with Timers should be preferred.

Inherited from:
Scheduler
Source
Scheduler.scala
def scheduleOnce(delay: Duration, runnable: Runnable)(implicit executor: ExecutionContext): Cancellable

Java API: Schedules a Runnable to be run once with a delay, i.e. a time period that has to pass before the runnable is executed.

Java API: Schedules a Runnable to be run once with a delay, i.e. a time period that has to pass before the runnable is executed.

Attributes

Throws
IllegalArgumentException

if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors AbstractActorWithTimers should be preferred.

Inherited from:
Scheduler
Source
Scheduler.scala

Scala API: Schedules a function to be run once with a delay, i.e. a time period that has to pass before the function is run.

Scala API: Schedules a function to be run once with a delay, i.e. a time period that has to pass before the function is run.

Attributes

Throws
IllegalArgumentException

if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors with Timers should be preferred.

Inherited from:
Scheduler
Source
Scheduler.scala

Java API: Schedules a message to be sent once with a delay, i.e. a time period that has to pass before the message is sent.

Java API: Schedules a message to be sent once with a delay, i.e. a time period that has to pass before the message is sent.

Attributes

Throws
IllegalArgumentException

if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors AbstractActorWithTimers should be preferred.

Inherited from:
Scheduler
Source
Scheduler.scala

Scala API: Schedules a message to be sent once with a delay, i.e. a time period that has to pass before the message is sent.

Scala API: Schedules a message to be sent once with a delay, i.e. a time period that has to pass before the message is sent.

Attributes

Throws
IllegalArgumentException

if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors with Timers should be preferred.

Inherited from:
Scheduler
Source
Scheduler.scala

Java API: Schedules a message to be sent repeatedly with an initial delay and a fixed delay between messages. E.g. if you would like a message to be sent immediately and thereafter every 500ms you would set delay=Duration.ZERO and interval=Duration.ofMillis(500).

Java API: Schedules a message to be sent repeatedly with an initial delay and a fixed delay between messages. E.g. if you would like a message to be sent immediately and thereafter every 500ms you would set delay=Duration.ZERO and interval=Duration.ofMillis(500).

It will not compensate the delay between messages if scheduling is delayed longer than specified for some reason. The delay between sending of subsequent messages will always be (at least) the given delay.

In the long run, the frequency of messages will generally be slightly lower than the reciprocal of the specified delay.

Note: For scheduling within actors AbstractActorWithTimers should be preferred.

Attributes

Inherited from:
Scheduler
Source
Scheduler.scala

Scala API: Schedules a message to be sent repeatedly with an initial delay and a fixed delay between messages. E.g. if you would like a message to be sent immediately and thereafter every 500ms you would set delay=Duration.Zero and interval=Duration(500, TimeUnit.MILLISECONDS).

Scala API: Schedules a message to be sent repeatedly with an initial delay and a fixed delay between messages. E.g. if you would like a message to be sent immediately and thereafter every 500ms you would set delay=Duration.Zero and interval=Duration(500, TimeUnit.MILLISECONDS).

It will not compensate the delay between messages if scheduling is delayed longer than specified for some reason. The delay between sending of subsequent messages will always be (at least) the given delay.

In the long run, the frequency of messages will generally be slightly lower than the reciprocal of the specified delay.

Note: For scheduling within actors with Timers should be preferred.

Attributes

Inherited from:
Scheduler
Source
Scheduler.scala

Java API: Schedules a Runnable to be run repeatedly with an initial delay and a fixed delay between subsequent executions. E.g. if you would like the function to be run after 2 seconds and thereafter every 100ms you would set delay to Duration.ofSeconds(2), and interval to Duration.ofMillis(100).

Java API: Schedules a Runnable to be run repeatedly with an initial delay and a fixed delay between subsequent executions. E.g. if you would like the function to be run after 2 seconds and thereafter every 100ms you would set delay to Duration.ofSeconds(2), and interval to Duration.ofMillis(100).

It will not compensate the delay between tasks if the execution takes a long time or if scheduling is delayed longer than specified for some reason. The delay between subsequent execution will always be (at least) the given delay.

In the long run, the frequency of tasks will generally be slightly lower than the reciprocal of the specified delay.

If the Runnable throws an exception the repeated scheduling is aborted, i.e. the function will not be invoked any more.

Attributes

Throws
IllegalArgumentException

if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors AbstractActorWithTimers should be preferred.

Inherited from:
Scheduler
Source
Scheduler.scala

Scala API: Schedules a Runnable to be run repeatedly with an initial delay and a fixed delay between subsequent executions. E.g. if you would like the function to be run after 2 seconds and thereafter every 100ms you would set delay=Duration(2, TimeUnit.SECONDS) and interval=Duration(100, TimeUnit.MILLISECONDS).

Scala API: Schedules a Runnable to be run repeatedly with an initial delay and a fixed delay between subsequent executions. E.g. if you would like the function to be run after 2 seconds and thereafter every 100ms you would set delay=Duration(2, TimeUnit.SECONDS) and interval=Duration(100, TimeUnit.MILLISECONDS).

It will not compensate the delay between tasks if the execution takes a long time or if scheduling is delayed longer than specified for some reason. The delay between subsequent execution will always be (at least) the given delay. In the long run, the frequency of execution will generally be slightly lower than the reciprocal of the specified delay.

If the Runnable throws an exception the repeated scheduling is aborted, i.e. the function will not be invoked any more.

Attributes

Throws
IllegalArgumentException

if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors with Timers should be preferred.

Inherited from:
Scheduler
Source
Scheduler.scala

Deprecated and Inherited methods

def schedule(initialDelay: Duration, interval: Duration, runnable: Runnable)(implicit executor: ExecutionContext): Cancellable

Attributes

Deprecated
[Since version Akka 2.6.0]
Inherited from:
Scheduler
Source
Scheduler.scala

Attributes

Deprecated
[Since version Akka 2.6.0]
Inherited from:
Scheduler
Source
Scheduler.scala

Attributes

Deprecated
[Since version Akka 2.6.0]
Inherited from:
Scheduler
Source
Scheduler.scala