Derives a cats.effect.Clock
from Scheduler for any
data type that has a cats.effect.LiftIO
implementation.
Derives a cats.effect.ContextShift
from Scheduler for any
data type that has a cats.effect.Effect
implementation.
Derives a cats.effect.ContextShift
from Scheduler for any
data type that has a cats.effect.Effect
implementation.
val contextShift: ContextShift[IO] = scheduler.contextShift[IO] val executor = Executors.newCachedThreadPool() val ec = ExecutionContext.fromExecutor(executor) contextShift.evalOn(ec)(IO(println("I'm on different thread pool!")) .flatMap { _ => IO(println("I came back to default")) }
Schedules the given callback for asynchronous execution in the thread-pool.
Schedules the given callback for asynchronous execution in the thread-pool.
On Scala < 2.12 it is described as a macro, so it
has zero overhead, being perfectly equivalent with
execute(new Runnable { ... })
.
On Scala 2.12 because of the Java 8 SAM types integration,
this extension macro is replaced with a method that takes
a plain Runnable
as parameter.
the callback to execute asynchronously
Schedules the given callback for asynchronous execution in the thread-pool, but also indicates the start of a thread-local trampoline in case the scheduler is a BatchingScheduler.
Schedules the given callback for asynchronous execution in the thread-pool, but also indicates the start of a thread-local trampoline in case the scheduler is a BatchingScheduler.
This utility is provided as an optimization. If you don't understand what this does, then don't worry about it.
On Scala < 2.12 it is described as a macro, so it
has zero overhead. On Scala 2.12 because of the Java 8 SAM
types integration, this extension macro is replaced with a
method that takes a plain TrampolinedRunnable
as parameter.
the callback to execute asynchronously
Schedules the given callback for immediate execution as a TrampolinedRunnable.
Schedules the given callback for immediate execution as a TrampolinedRunnable. Depending on the execution context, it might get executed on the current thread by using an internal trampoline, so it is still safe from stack-overflow exceptions.
On Scala < 2.12 it is described as a macro, so it
has zero overhead, being perfectly equivalent with
execute(new TrampolinedRunnable { ... })
.
On Scala 2.12 because of the Java 8 SAM types integration,
this extension macro is replaced with a method that takes
a plain TrampolinedRunnable
as parameter.
the callback to execute asynchronously
Schedules a periodic task that becomes enabled first after the given initial delay, and subsequently with the given period.
Schedules a periodic task that becomes enabled first after the given
initial delay, and subsequently with the given period. Executions will
commence after initialDelay
then initialDelay + period
, then
initialDelay + 2 * period
and so on.
If any execution of the task encounters an exception, subsequent executions are suppressed. Otherwise, the task will only terminate via cancellation or termination of the scheduler. If any execution of this task takes longer than its period, then subsequent executions may start late, but will not concurrently execute.
For example the following schedules a message to be printed to standard output approximately every 10 seconds with an initial delay of 5 seconds:
val task = scheduler.scheduleAtFixedRate(5.seconds, 10.seconds) { print("Repeated message") } // later if you change your mind ... task.cancel()
is the time to wait until the first execution happens
is the time to wait between 2 successive executions of the task
is the callback to be executed
a cancelable that can be used to cancel the execution of this repeated task at any time.
Schedules a task to run in the future, after initialDelay
.
Schedules a task to run in the future, after initialDelay
.
For example the following schedules a message to be printed to standard output after 5 minutes:
val task = scheduler.scheduleOnce(5.minutes) { print("Hello, world!") } // later, if you change your mind ... task.cancel()
is the time to wait until the execution happens
is the callback to be executed
a Cancelable
that can be used to cancel the created task
before execution.
Schedules for execution a periodic task that is first executed after the given initial delay and subsequently with the given delay between the termination of one execution and the commencement of the next.
Schedules for execution a periodic task that is first executed after the given initial delay and subsequently with the given delay between the termination of one execution and the commencement of the next.
For example the following schedules a message to be printed to standard output every 10 seconds with an initial delay of 5 seconds:
val task = s.scheduleWithFixedDelay(5.seconds, 10.seconds) { print("Repeated message") } // later if you change your mind ... task.cancel()
is the time to wait until the first execution happens
is the time to wait between 2 successive executions of the task
is the callback to be executed
a cancelable that can be used to cancel the execution of this repeated task at any time.
Derives a cats.effect.Timer
from Scheduler for any
data type that has a cats.effect.Concurrent
type class
instance.
Derives a cats.effect.Timer
from Scheduler for any
data type that has a cats.effect.Concurrent
type class
instance.
implicit val timer: Timer[IO] = scheduler.timer[IO] IO.sleep(10.seconds).flatMap { _ => IO(println("Delayed hello!")) }
Derives a cats.effect.Timer
from Scheduler for any
data type that has a cats.effect.LiftIO
instance.
Derives a cats.effect.Timer
from Scheduler for any
data type that has a cats.effect.LiftIO
instance.
This is the relaxed timer method, needing only LiftIO
to work, by piggybacking on cats.effect.IO
.
implicit val timer: Timer[IO] = scheduler.timerLiftIO[IO] IO.sleep(10.seconds).flatMap { _ => IO(println("Delayed hello!")) }
DEPRECATED — use clockRealTime(MILLISECONDS).
DEPRECATED — use clockRealTime(MILLISECONDS).
(Since version 3.0.0) Use clockRealTime(MILLISECONDS)
Utilities complementing the
Scheduler
interface.