Heartbeat

class Heartbeat(startDelay: Duration = Duration.ZERO, period: Duration, coroutineContext: CoroutineContext, task: () -> Unit)

A utility class that repeatedly executes the given task at a specified period.

startDelay

The initial delay before the first execution of the task.

period

The time interval between consecutive executions of the task.

coroutineContext

The coroutine context in which the heartbeat will run.

task

The function to be executed periodically.

Constructors

constructor(startDelay: Duration = Duration.ZERO, period: Duration, coroutineContext: CoroutineContext, task: () -> Unit)

fun start(restart: Boolean = true)

Starts the execution of this heartbeat.

fun stop()

Stops the execution of this heartbeat.