cardiologist/io.github.kevincianfarini.cardiologist

Package-level declarations

Types

Pulse

@ExperimentalTime

@JvmInline

value class Pulse

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

PulseBackpressureStrategy

class PulseBackpressureStrategy

PulseSchedule

class PulseSchedule(val atSeconds: Set<Int>, val atMinutes: Set<Int>, val atHours: Set<Int>, val onDaysOfMonth: Set<Int>, val inMonths: Set<Month>, val onDaysOfWeek: Set<DayOfWeek>)

A Pulse schedule that can be used with schedulePulse to define complex schedules.

PulseScheduleBuilder

class PulseScheduleBuilder

Functions

buildPulseSchedule

fun buildPulseSchedule(builder: PulseScheduleBuilder.() -> Unit): PulseSchedule

Build a complex PulseSchedule with a DSL.

executeAt

@ExperimentalTime

suspend fun <T> Clock.executeAt(instant: Instant, action: suspend () -> T): T

Execute the provided action at or after instant.

@ExperimentalTime

suspend fun <T> Clock.executeAt(dateTime: LocalDateTime, timeZone: TimeZone, action: suspend () -> T): T

Execute the provided action at or after dateTime in timeZone.

fixedPeriodPulse

@ExperimentalTime

fun Clock.fixedPeriodPulse(period: Duration): Pulse

Return a Pulse which beats every period.

@ExperimentalTime

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

Return a Pulse which beats every period in timeZone.

schedulePulse

@ExperimentalTime

fun Clock.schedulePulse(schedule: PulseSchedule, timeZone: TimeZone = TimeZone.UTC): Pulse

Schedule a Pulse whose beats occur in accordance with schedule for a specific timeZone.

@ExperimentalTime

fun Clock.schedulePulse(cronExpression: String, timeZone: TimeZone = TimeZone.UTC): Pulse

Schedule a Pulse whose beats occur in accordance with the provided cronExpression for a specific timeZone.

@ExperimentalTime

fun Clock.schedulePulse(timeZone: TimeZone = TimeZone.UTC, scheduleBuilder: PulseScheduleBuilder.() -> Unit): Pulse

Schedule a Pulse whose beats occur in accordance with the built schedule for a specific timeZone.

@ExperimentalTime

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

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