krontab/README.md

140 lines
3.2 KiB
Markdown
Raw Normal View History

2019-10-10 08:29:01 +00:00
# krontab
[ ![Download](https://api.bintray.com/packages/insanusmokrassar/InsanusMokrassar/krontab/images/download.svg) ](https://bintray.com/insanusmokrassar/InsanusMokrassar/krontab/_latestVersion)
2019-10-15 06:49:41 +00:00
2019-10-15 07:07:37 +00:00
Library was created to give oppotunity to launch some things from time to time according to some schedule in
runtime of applications.
| Table of content |
|---|
| [ How to use ](#how-to-use) |
| [ How to use: Including in project ](#including-in-project) |
| [ How to use: Config from string ](#config-from-string) |
| [ How to use: Config via builder (DSL preview) ](#config-via-builder) |
2019-10-15 06:49:41 +00:00
## How to use
There are several ways to configure and use this library:
* From some string
* From builder
Anyway, to start some action from time to time you will need to use one of extensions/functions:
```kotlin
val kronScheduler = /* creating of KronScheduler instance */;
kronScheuler.doWhile {
// some action
true // true - repeat on next time
}
```
2019-10-15 07:07:37 +00:00
### Including in project
Here will be presented example for including of `Krontab` as a dependency using `Gradle`. In two words,
developers must:
* Add `https://dl.bintray.com/insanusmokrassar/InsanusMokrassar/` address as source of packages
* Add `Krontab` as a dependency
In gradle script it will look like:
```groovy
repositories {
// ...
maven { url "https://dl.bintray.com/insanusmokrassar/InsanusMokrassar/" }
}
dependencies {
implementation "com.insanusmokrassar:krontab:$krontab_version"
}
```
Next version is the latest currently for the library:
[ ![Download](https://api.bintray.com/packages/insanusmokrassar/InsanusMokrassar/krontab/images/download.svg) ](https://bintray.com/insanusmokrassar/InsanusMokrassar/krontab/_latestVersion)
For old version of Gradle, instead of `implementation` word developers must use `compile`.
2019-10-15 06:49:41 +00:00
### Config from string
Developers can use more simple way to configure repeat times is string. String configuring
like a `crontab`, but with a little bit different meanings:
```
/-------- Seconds
| /------ Minutes
| | /---- Hours
| | | /-- Days of months
| | | | / Months
| | | | |
* * * * *
```
It is different with original `crontab` syntax for the reason, that expected that in practice developers
will use seconds and minutes with more probability than months (for example). In fact, developers will use something
like:
```kotlin
doWhile("/5 * * * *") {
println("Called")
true // true - repeat on next time
}
```
Or more version:
```kotlin
doInfinity("/5 * * * *") {
println("Called")
}
```
Both of examples will print `Called` message every five seconds.
### Config via builder
Also this library currently supports DSL for creating the same goals:
```kotlin
val kronScheduler = buildSchedule {
seconds {
from (0) every 5
}
}
kronScheduler.doWhile {
println("Called")
true // true - repeat on next time
}
```
Or
```kotlin
val kronScheduler = buildSchedule {
seconds {
0 every 5
}
}
kronScheduler.doWhile {
println("Called")
true // true - repeat on next time
}
```
Or
```kotlin
val kronScheduler = buildSchedule {
seconds {
0 every 5
}
}
kronScheduler.doInfinity {
println("Called")
}
```
All of these examples will do the same things: print `Called` message every five seconds.