kdocs/dev.inmo.krontab

Package-level declarations

Types

This interface was created for abstraction of next operation. Currently, there is only dev.inmo.krontab.internal.CronDateTimeScheduler realisation of this interface inside of this library, but you it is possible to create your own realisation of this interface for scheduling, for example, depending of users activity or something like this

KronSchedulerTz

interface KronSchedulerTz : KronScheduler

This interface extending KronScheduler to use DateTimeTz with taking into account offset of incoming time for next operation.

KronSchedulerWork

abstract class KronSchedulerWork(context: Context, workerParams: WorkerParameters) : CoroutineWorker

Use this class as a super class in case you wish to implement krontab-based enqueuing of works

KrontabConfig

@JvmInline

value class KrontabConfig(val template: KrontabTemplate)

This value class contains KrontabTemplate

KrontabTemplate

typealias KrontabTemplate = String

KrontabTemplateSchedulerWork

abstract class KrontabTemplateSchedulerWork(context: Context, workerParams: WorkerParameters) : KronSchedulerWork

Extend this class in case you wish to base on KrontabTemplate. It will automatically handle request of kronScheduler and put it in setUpRequest

LambdaKronScheduler

class LambdaKronScheduler(onNext: suspend (<Error class: unknown class>) -> <Error class: unknown class>?) : KronScheduler

LambdaKronSchedulerTz

class LambdaKronSchedulerTz(onNext: suspend (<Error class: unknown class>) -> <Error class: unknown class>?) : KronSchedulerTz

Properties

annually

val KronScheduler.Companion.annually: KronScheduler

Shortcut for EveryYearScheduler

AnyTimeScheduler

val AnyTimeScheduler: KronScheduler

KronScheduler.next will always return korlibs.time.DateTime.now

daily

val KronScheduler.Companion.daily: KronScheduler

Shortcut for EveryDayOfMonthScheduler

EveryDayOfMonthScheduler

val EveryDayOfMonthScheduler: KronScheduler

KronScheduler.next will always return korlibs.time.DateTime.now + one day

EveryHourScheduler

val EveryHourScheduler: KronScheduler

KronScheduler.next will always return korlibs.time.DateTime.now + one hour

everyMillisecond

val KronScheduler.Companion.everyMillisecond: KronScheduler

Shortcut for EveryMillisecondScheduler

EveryMillisecondScheduler

val EveryMillisecondScheduler: KronScheduler

KronScheduler.next will always return korlibs.time.DateTime.now + one millisecond

everyMinute

val KronScheduler.Companion.everyMinute: KronScheduler

Shortcut for EveryMinuteScheduler

EveryMinuteScheduler

val EveryMinuteScheduler: KronScheduler

KronScheduler.next will always return korlibs.time.DateTime.now + one minute

EveryMonthScheduler

val EveryMonthScheduler: KronScheduler

KronScheduler.next will always return korlibs.time.DateTime.now + one month

everySecond

val KronScheduler.Companion.everySecond: KronScheduler

Shortcut for EverySecondScheduler

EverySecondScheduler

val EverySecondScheduler: KronScheduler

KronScheduler.next will always return korlibs.time.DateTime.now + one second

EveryYearScheduler

val EveryYearScheduler: KronScheduler

KronScheduler.next will always return korlibs.time.DateTime.now + one year

hourly

val KronScheduler.Companion.hourly: KronScheduler

Shortcut for EveryHourScheduler

krontabTemplateWorkField

const val krontabTemplateWorkField: String

monthly

val KronScheduler.Companion.monthly: KronScheduler

Shortcut for EveryMonthScheduler

Functions

buildSchedule

fun buildSchedule(incoming: KrontabTemplate): KronScheduler

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

Shortcut for createSimpleScheduler

createSimpleScheduler

fun createSimpleScheduler(incoming: KrontabTemplate): KronScheduler

Parse incoming string and adapt according to next format: "* * * * *" where order of things:

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

doInfinity

inline suspend fun doInfinity(scheduleConfig: String, noinline block: suspend (<Error class: unknown class>) -> Unit)

Will buildSchedule using scheduleConfig and call doInfinity with block

doInfinity

inline suspend fun KronScheduler.doInfinity(noinline block: suspend (<Error class: unknown class>) -> Unit)

Will execute block without any checking of result

doInfinityTz

inline suspend fun doInfinityTz(scheduleConfig: String, noinline block: suspend (<Error class: unknown class>) -> Unit)

Will buildSchedule using scheduleConfig and call doInfinity with block

doInfinityTz

inline suspend fun KronScheduler.doInfinityTz(noinline block: suspend (<Error class: unknown class>) -> Unit)

Will execute block without any checking of result

doOnce

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

Will buildSchedule using scheduleConfig and call doOnce on it

doOnce

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

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

doOnceTz

inline suspend fun <T> doOnceTz(scheduleConfig: String, noinline block: suspend (<Error class: unknown class>) -> T): T

Will buildSchedule using scheduleConfig and call doOnce on it

doOnceTz

inline suspend fun <T> KronScheduler.doOnceTz(noinline block: suspend (<Error class: unknown class>) -> T): T

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

doWhile

inline suspend fun doWhile(scheduleConfig: String, noinline block: suspend (<Error class: unknown class>) -> Boolean)

Will buildSchedule using scheduleConfig and call doWhile with block

doWhile

inline suspend fun KronScheduler.doWhile(noinline block: suspend (<Error class: unknown class>) -> Boolean)

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

doWhileTz

inline suspend fun doWhileTz(scheduleConfig: String, noinline block: suspend (<Error class: unknown class>) -> Boolean)

Will buildSchedule using scheduleConfig and call doWhile with block

doWhileTz

inline suspend fun KronScheduler.doWhileTz(noinline block: suspend (<Error class: unknown class>) -> Boolean)

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

enqueueKronSchedulerWork

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. It will try to calculate delay by itself. In case if KronScheduler.next of initialScheduler will return null, work WILL NOT be enqueued

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. Use setUpRequest callback in case you need some additional actions to do before request will be enqueued

enqueueKrontabTemplateSchedulerWork

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

KronScheduler

fun KronScheduler(onNext: suspend (<Error class: unknown class>) -> <Error class: unknown class>?): LambdaKronScheduler

KronSchedulerTz

fun KronSchedulerTz(onNext: suspend (<Error class: unknown class>) -> <Error class: unknown class>?): LambdaKronSchedulerTz

krontabConfig

inline fun KrontabTemplate.krontabConfig(): KrontabConfig

merge

inline fun merge(vararg kronDateTimeSchedulers: KronScheduler): CollectionKronScheduler

merge

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

fun Iterator<KronScheduler>.merge(): CollectionKronScheduler

Create new one CollectionKronScheduler to include all KronSchedulers of this

suspend fun KronScheduler.next(relatively: <Error class: unknown class>): <Error class: unknown class>

nextOrNow

suspend fun KronScheduler.nextOrNow(): <Error class: unknown class>

nextOrNowWithOffset

suspend fun KronSchedulerTz.nextOrNowWithOffset(): <Error class: unknown class>

nextOrRelative

suspend fun KronScheduler.nextOrRelative(relatively: <Error class: unknown class> = DateTime.now()): <Error class: unknown class>

suspend fun KronSchedulerTz.nextOrRelative(relatively: <Error class: unknown class>): <Error class: unknown class>

nextTimeZoned

suspend fun KronScheduler.nextTimeZoned(): <Error class: unknown class>?

toKronScheduler

fun KrontabTemplate.toKronScheduler(): KronScheduler

fun KrontabTemplate.toKronScheduler(defaultOffset: Minutes): KronSchedulerTz

Shortcut for buildSchedule

toSchedule

fun KrontabTemplate.toSchedule(): KronScheduler

fun KrontabTemplate.toSchedule(defaultOffset: Minutes): KronSchedulerTz

Shortcut for buildSchedule