seconds
minutes
hours
dayOfMonth
month
(optional) year
(optional) (can be placed anywhere after month) (must be marked with o at the end, for example: 60o == +01:00) offset
(optional) (can be placed anywhere after month) dayOfWeek

And each one (except of offsets) have next format:{number}[,{number},...] or *and {number} here is one of

{int}-{int}
{int}/{int}
*/{int}
{int}
F
L

Week days must be marked with w at the end, and starts with 0 which means Sunday.

fun createSimpleScheduler(incoming: KrontabTemplate, defaultOffset: Minutes): KronSchedulerTz

doInfinity

common

inline suspend fun KronScheduler.doInfinity(noinline block: suspend () -> Unit)

Will execute block without any checking of result

inline suspend fun doInfinity(scheduleConfig: String, noinline block: suspend () -> Unit)

Will buildSchedule using scheduleConfig and call doInfinity with block

doOnce

common

inline suspend fun <T> KronScheduler.doOnce(noinline block: suspend () -> T): T

Execute block once at the KronScheduler.next time and return result of block calculation.

inline suspend fun <T> doOnce(scheduleConfig: String, noinline block: suspend () -> T): T

Will buildSchedule using scheduleConfig and call doOnce on it

doWhile

common

inline suspend fun KronScheduler.doWhile(noinline block: suspend () -> Boolean)

Will execute block while it will return true as a result of its calculation

inline suspend fun doWhile(scheduleConfig: String, noinline block: suspend () -> Boolean)

Will buildSchedule using scheduleConfig and call doWhile with block

enqueueKronSchedulerWork

android

inline suspend fun <T : KronSchedulerWork> Context.enqueueKronSchedulerWork(workName: String, initialScheduler: KronScheduler, existingWorkPolicy: ExistingWorkPolicy = ExistingWorkPolicy.REPLACE, noinline setUpRequest: suspend OneTimeWorkRequest.Builder.() -> Unit = {}): Operation?

This method is shortcut for enqueueKronSchedulerWork with reified T

inline suspend fun <T : KronSchedulerWork> Context.enqueueKronSchedulerWork(workName: String, delayMillis: Long, existingWorkPolicy: ExistingWorkPolicy = ExistingWorkPolicy.REPLACE, noinline setUpRequest: suspend OneTimeWorkRequest.Builder.() -> Unit = {}): Operation

This method is shortcut for enqueueKronSchedulerWork with reified T parameter

suspend fun <T : KronSchedulerWork> Context.enqueueKronSchedulerWork(workName: String, initialScheduler: KronScheduler, workClass: Class<T>, existingWorkPolicy: ExistingWorkPolicy = ExistingWorkPolicy.REPLACE, setUpRequest: suspend OneTimeWorkRequest.Builder.() -> Unit = {}): Operation?

This method is shortcut for enqueueKronSchedulerWork with initialScheduler.

suspend fun <T : KronSchedulerWork> Context.enqueueKronSchedulerWork(workName: String, delayMillis: Long, workClass: Class<T>, existingWorkPolicy: ExistingWorkPolicy = ExistingWorkPolicy.REPLACE, setUpRequest: suspend OneTimeWorkRequest.Builder.() -> Unit = {}): Operation

This method will enqueue OneTimeWorkRequest with workName and existingWorkPolicy.

enqueueKrontabTemplateSchedulerWork

android

inline suspend fun <T : KrontabTemplateSchedulerWork> Context.enqueueKrontabTemplateSchedulerWork(workName: String, krontabTemplate: KrontabTemplate, existingWorkPolicy: ExistingWorkPolicy = ExistingWorkPolicy.REPLACE, noinline setUpRequest: suspend OneTimeWorkRequest.Builder.(data: Data) -> Unit = {}): Operation?

Will enqueueKronSchedulerWork with KronScheduler from krontabTemplate and call setUpRequest on setting up OneTimeWorkRequest.Builder with Data which will be used to OneTimeWorkRequest.Builder.setInputData after setUpRequest completed

merge

common

inline fun Iterable<KronScheduler>.merge(): CollectionKronScheduler

Create new one CollectionKronScheduler to include all KronSchedulers of this

fun Iterator<KronScheduler>.merge(): CollectionKronScheduler

Create new one CollectionKronScheduler to include all KronSchedulers of this

inline fun merge(vararg kronDateTimeSchedulers: KronScheduler): CollectionKronScheduler

common

suspend fun KronScheduler.next(relatively: DateTimeTz): DateTimeTz?

nextOrNow

common

suspend fun KronScheduler.nextOrNow(): DateTime

nextOrNowWithOffset

common

suspend fun KronSchedulerTz.nextOrNowWithOffset(): DateTimeTz

nextOrRelative

common

suspend fun KronScheduler.nextOrRelative(relatively: DateTime = DateTime.now()): DateTime

suspend fun KronSchedulerTz.nextOrRelative(relatively: DateTimeTz): DateTimeTz

nextTimeZoned

common

suspend fun KronScheduler.nextTimeZoned(): DateTimeTz?

toKronScheduler

common

fun KrontabTemplate.toKronScheduler(): KronScheduler

Shortcut for buildSchedule

fun KrontabTemplate.toKronScheduler(defaultOffset: Minutes): KronSchedulerTz

Shortcut for buildSchedule

toSchedule

common

fun KrontabTemplate.toSchedule(): KronScheduler

Shortcut for buildSchedule

fun KrontabTemplate.toSchedule(defaultOffset: Minutes): KronSchedulerTz

Shortcut for buildSchedule

wrapAsKronScheduler

common

fun KrontabTemplate.wrapAsKronScheduler(): KrontabTemplateWrapper

Will create KrontabTemplateWrapper from this

Properties

AnyTimeScheduler

common

val AnyTimeScheduler: KronScheduler

KronScheduler.next will always return com.soywiz.klock.DateTime.now

EveryDayOfMonthScheduler

common

val EveryDayOfMonthScheduler: KronScheduler

KronScheduler.next will always return com.soywiz.klock.DateTime.now + one day

EveryHourScheduler

common

val EveryHourScheduler: KronScheduler

KronScheduler.next will always return com.soywiz.klock.DateTime.now + one hour

EveryMinuteScheduler

common

val EveryMinuteScheduler: KronScheduler

KronScheduler.next will always return com.soywiz.klock.DateTime.now + one minute

EveryMonthScheduler

common

val EveryMonthScheduler: KronScheduler

KronScheduler.next will always return com.soywiz.klock.DateTime.now + one month

EverySecondScheduler

common

val EverySecondScheduler: KronScheduler

KronScheduler.next will always return com.soywiz.klock.DateTime.now + one second

EveryYearScheduler

common

val EveryYearScheduler: KronScheduler

KronScheduler.next will always return com.soywiz.klock.DateTime.now + one year

krontabTemplateWorkField

android

const val krontabTemplateWorkField: String