cardiologist/io.github.kevincianfarini.cardiologist

Package-level declarations

Types

value class Pulse

A Pulse is a cadence which informs consumers when to execute work by calling Pulse.beat.

RecurringJobMode

enum RecurringJobMode : Enum<RecurringJobMode>

Functions

suspend fun Clock.delayFor(period: DateTimePeriod, timeZone: TimeZone)

suspend fun Clock.delayUntil(instant: Instant)

suspend fun Clock.delayUntil(dateTime: LocalDateTime, timeZone: TimeZone)

suspend fun Clock.delayUntilNext(time: LocalTime, timeZone: TimeZone)

fun Clock.intervalPulse(interval: Duration): Pulse

Return a Pulse which beats every interval. The return value will immediately beat prior to delaying.

fun Clock.intervalPulse(period: DateTimePeriod, timeZone: TimeZone): Pulse

Return a Pulse which beats every period in timeZone. The return value will immediately beat prior to delaying.

fun Clock.schedulePulse(timeZone: TimeZone = TimeZone.UTC, atSecond: Int? = null, atMinute: Int? = null, atHour: Int? = null, onDayOfMonth: Int? = null, inMonth: Month? = null): Pulse

Schedule a Pulse whose beats occur atSecond, atMinute, atHour, onDayOfMonth, and inMonth for a specific timeZone.