krontab/kdocs/dev.inmo.krontab/create-simple-scheduler.html

73 lines
13 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>createSimpleScheduler</title>
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../";</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../styles/style.css" rel="Stylesheet">
<link href="../../styles/jetbrains-mono.css" rel="Stylesheet">
<link href="../../styles/main.css" rel="Stylesheet">
<link href="../../styles/prism.css" rel="Stylesheet">
<link href="../../styles/logo-styles.css" rel="Stylesheet">
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../index.html">
<span>kdocs</span>
</a>
</div>
<div>
0.8.3 </div>
<div class="pull-right d-flex">
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":dokkaHtml/commonMain">common</button>
</div>
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="kdocs::dev.inmo.krontab//createSimpleScheduler/#kotlin.String/PointingToDeclaration//788909594">
<div class="breadcrumbs"><a href="../../index.html">kdocs</a><span class="delimiter">/</span><a href="index.html">dev.inmo.krontab</a><span class="delimiter">/</span><span class="current">createSimpleScheduler</span></div>
<div class="cover ">
<h1 class="cover"><span>create</span><wbr></wbr><span>Simple</span><wbr></wbr><span><span>Scheduler</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="create-simple-scheduler.html"><span class="token function">createSimpleScheduler</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">incoming<span class="token operator">: </span><a href="index.html#-1448720714%2FClasslikes%2F788909594">KrontabTemplate</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-kron-scheduler/index.html">KronScheduler</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/krontab/blob/master//src/commonMain/kotlin/dev/inmo/krontab/StringParser.kt#L14">source</a>)</span></span></div><p class="paragraph">Parse <a href="create-simple-scheduler.html">incoming</a> string and adapt according to next format: &quot;* * * * *&quot; where order of things:</p><ul><li><p class="paragraph"><strong>seconds</strong></p></li><li><p class="paragraph"><strong>minutes</strong></p></li><li><p class="paragraph"><strong>hours</strong></p></li><li><p class="paragraph"><strong>dayOfMonth</strong></p></li><li><p class="paragraph"><strong>month</strong></p></li><li><p class="paragraph"><strong>year</strong> (optional)</p></li><li><p class="paragraph"><strong>offset</strong> (optional) (can be placed anywhere after month) (must be marked with <code class="lang-kotlin">o</code> at the end, for example: 60o == +01:00)</p></li><li><p class="paragraph"><strong>dayOfWeek</strong> (optional) (can be placed anywhere after month)</p></li><li><p class="paragraph"><strong>milliseconds</strong> (optional) (can be placed anywhere after month) (must be marked with <code class="lang-kotlin">ms</code> at the end, for example: 500ms; 100-200ms)</p></li></ul><p class="paragraph">And each one (except of offsets) have next format:</p><p class="paragraph"><code class="lang-kotlin">{number}[,{number},...]</code> or <code class="lang-kotlin">*</code></p><p class="paragraph">and {number} here is one of</p><ul><li><p class="paragraph">{int}-{int}</p></li><li><p class="paragraph">{int}/{int}</p></li><li><p class="paragraph">*/{int}</p></li><li><p class="paragraph">{int}</p></li><li><p class="paragraph">F</p></li><li><p class="paragraph">L</p></li></ul><p class="paragraph">Week days must be marked with <code class="lang-kotlin">w</code> at the end, and starts with 0 which means Sunday. For example, 0w == Sunday. With weeks you can use syntax like with any number like seconds, for example: 0-2w means Sunday-Tuesday</p><p class="paragraph">Additional info about ranges can be found in follow accordance:</p><ul><li><p class="paragraph">Seconds ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//secondsRange/#/PointingToDeclaration/">secondsRange</span></p></li><li><p class="paragraph">Minutes ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//minutesRange/#/PointingToDeclaration/">minutesRange</span></p></li><li><p class="paragraph">Hours ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//hoursRange/#/PointingToDeclaration/">hoursRange</span></p></li><li><p class="paragraph">Days of month ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//dayOfMonthRange/#/PointingToDeclaration/">dayOfMonthRange</span></p></li><li><p class="paragraph">Months ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//monthRange/#/PointingToDeclaration/">monthRange</span></p></li><li><p class="paragraph">Years ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//yearRange/#/PointingToDeclaration/">yearRange</span> (in fact - any <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>)</p></li><li><p class="paragraph">WeekDay (timezone) ranges can be found in <
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</body>
</html>