diff --git a/akka-actor/src/main/resources/reference.conf b/akka-actor/src/main/resources/reference.conf index 6e747f8121..3f38cfeca0 100644 --- a/akka-actor/src/main/resources/reference.conf +++ b/akka-actor/src/main/resources/reference.conf @@ -295,7 +295,7 @@ akka { # Used to set the behavior of the scheduler. # Changing the default values may change the system behavior drastically so make sure - # you know what you're doing! + # you know what you're doing! See the Scheduler section of the Akka documentation for more details. scheduler { # The HashedWheelTimer (HWT) implementation from Netty is used as the default scheduler # in the system. diff --git a/akka-docs/java/scheduler.rst b/akka-docs/java/scheduler.rst index 3dde1345a6..faff8d9fe0 100644 --- a/akka-docs/java/scheduler.rst +++ b/akka-docs/java/scheduler.rst @@ -15,6 +15,13 @@ You can schedule sending of messages to actors and execution of tasks (functions You will get a ``Cancellable`` back that you can call :meth:`cancel` on to cancel the execution of the scheduled operation. +.. warning:: + + The default implementation of ``Scheduler`` used by Akka is based on the Netty ``HashedWheelTimer``. + It does not execute tasks at the exact time, but on every tick, it will run everything that is overdue. + The accuracy of the default Scheduler can be modified by the "ticks-per-wheel" and "tick-duration" configuration + properties. For more information, see: `HashedWheelTimers `_. + Some examples ------------- diff --git a/akka-docs/scala/scheduler.rst b/akka-docs/scala/scheduler.rst index 6089630625..a98f0f563c 100644 --- a/akka-docs/scala/scheduler.rst +++ b/akka-docs/scala/scheduler.rst @@ -15,6 +15,13 @@ You can schedule sending of messages to actors and execution of tasks (functions You will get a ``Cancellable`` back that you can call :meth:`cancel` on to cancel the execution of the scheduled operation. +.. warning:: + + The default implementation of ``Scheduler`` used by Akka is based on the Netty ``HashedWheelTimer``. + It does not execute tasks at the exact time, but on every tick, it will run everything that is overdue. + The accuracy of the default Scheduler can be modified by the "ticks-per-wheel" and "tick-duration" configuration + properties. For more information, see: `HashedWheelTimers `_. + Some examples -------------