135 lines
16 KiB
HTML
135 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>KrontabConfig</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>
|
|
2.1.2 </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" data-page-type="classlike" id="content" pageIds="kdocs::dev.inmo.krontab/KrontabConfig///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">KrontabConfig</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Krontab</span><wbr></wbr><span><span>Config</span></span></h1>
|
|
<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"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.html"><span class="token annotation builtin">JvmInline</span></a></div></div><span class="token keyword">value </span><span class="token keyword">class </span><a href="index.html">KrontabConfig</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>template<span class="token operator">: </span><a href="../index.html#-1448720714%2FClasslikes%2F788909594">KrontabTemplate</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/krontab/blob/master//src/commonMain/kotlin/dev/inmo/krontab/KrontabConfig.kt#L81">source</a>)</span></span></div><p class="paragraph">This value class contains <a href="../index.html#-1448720714%2FClasslikes%2F788909594">KrontabTemplate</a></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 secondsRange</p></li><li><p class="paragraph">Minutes ranges can be found in minutesRange</p></li><li><p class="paragraph">Hours ranges can be found in hoursRange</p></li><li><p class="paragraph">Days of month ranges can be found in dayOfMonthRange</p></li><li><p class="paragraph">Months ranges can be found in monthRange</p></li><li><p class="paragraph">Years ranges can be found in yearRange (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 dayOfWeekRange</p></li><li><p class="paragraph">Milliseconds ranges can be found in millisecondsRange</p></li></ul><p class="paragraph">Examples:</p><ul><li><p class="paragraph">"0/5 * * * *" for every five seconds triggering</p></li><li><p class="paragraph">"0/5,L * * * *" for every five seconds triggering and on 59 second</p></li><li><p class="paragraph">"0/15 30 * * *" for every 15th seconds in a half of each hour</p></li><li><p class="paragraph">"0/15 30 * * * 500ms" for every 15th seconds in a half of each hour when milliseconds equal to 500</p></li><li><p class="paragraph">"1 2 3 F,4,L 5" for triggering in near first second of second minute of third hour of first, fifth and last days of may</p></li><li><p class="paragraph">"1 2 3 F,4,L 5 60o" for triggering in near first second of second minute of third hour of first, fifth and last days of may with timezone UTC+01:00</p></li><li><p class="paragraph">"1 2 3 F,4,L 5 60o 0-2w" for triggering in near first second of second minute of third hour of first, fifth and last days of may in case if it will be in Sunday-Tuesday week days with timezone UTC+01:00</p></li><li><p class="paragraph">"1 2 3 F,4,L 5 2021" for triggering in near first second of second minute of third hour of first, fifth and last days of may of 2021st year</p></li><li><p class="paragraph">"1 2 3 F,4,L 5 2021 60o" for triggering in near first second of second minute of third hour of first, fifth and last days of may of 2021st year with timezone UTC+01:00</p></li><li><p class="paragraph">"1 2 3 F,4,L 5 2021 60o 0-2w" for triggering in near first second of second minute of third hour of first, fifth and last days of may of 2021st year if it will be in Sunday-Tuesday week days with timezone UTC+01:00</p></li><li><p class="paragraph">"1 2 3 F,4,L 5 2021 60o 0-2w 500ms" for triggering in near first second of second minute of third hour of first, fifth and last days of may of 2021st year if it will be in Sunday-Tuesday week days with timezone UTC+01:00 when milliseconds will be equal to 500</p></li></ul><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><span data-unresolved-link="dev.inmo.krontab.internal//createKronScheduler/#kotlin.Array[kotlin.Byte]?#kotlin.Array[kotlin.Byte]?#kotlin.Array[kotlin.Byte]?#kotlin.Array[kotlin.Byte]?#kotlin.Array[kotlin.Byte]?#kotlin.Array[kotlin.Int]?#kotlin.Array[kotlin.Byte]?#kotlin.Array[kotlin.Short]?/PointingToDeclaration/"><span>create</span><wbr></wbr><span>Kron</span><wbr></wbr><span><span>Scheduler</span></span></span></div></span></div><div></div></div></div></div></div></div>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
|
|
<div class="tabs-section-body">
|
|
<div data-togglable="CONSTRUCTOR">
|
|
<h2 class="">Constructors</h2>
|
|
<div class="table"><a data-name="1852627660%2FConstructors%2F788909594" anchor-label="KrontabConfig" id="1852627660%2FConstructors%2F788909594" data-filterable-set=":dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-krontab-config.html"><span>Krontab</span><wbr></wbr><span><span>Config</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1852627660%2FConstructors%2F788909594"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<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">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">template<span class="token operator">: </span><a href="../index.html#-1448720714%2FClasslikes%2F788909594">KrontabTemplate</a></span></span><span class="token punctuation">)</span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div data-togglable="PROPERTY">
|
|
<h2 class="">Properties</h2>
|
|
<div class="table"><a data-name="-770104233%2FProperties%2F788909594" anchor-label="template" id="-770104233%2FProperties%2F788909594" data-filterable-set=":dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="template.html"><span><span>template</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-770104233%2FProperties%2F788909594"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<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">val </span><a href="template.html">template</a><span class="token operator">: </span><a href="../index.html#-1448720714%2FClasslikes%2F788909594">KrontabTemplate</a></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div data-togglable="FUNCTION">
|
|
<h2 class="">Functions</h2>
|
|
<div class="table"><a data-name="-396631830%2FFunctions%2F788909594" anchor-label="scheduler" id="-396631830%2FFunctions%2F788909594" data-filterable-set=":dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="scheduler.html"><span><span>scheduler</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-396631830%2FFunctions%2F788909594"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<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="scheduler.html"><span class="token function">scheduler</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-kron-scheduler/index.html">KronScheduler</a></div><div class="brief "><p class="paragraph">Creates <strong>new</strong> <a href="../-kron-scheduler/index.html">KronScheduler</a> based on a <a href="template.html">template</a></p></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="scheduler.html"><span class="token function">scheduler</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">defaultOffset<span class="token operator">: </span><a href="../../dev.inmo.krontab.utils/index.html#1215844957%2FClasslikes%2F788909594">Minutes</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-kron-scheduler-tz/index.html">KronSchedulerTz</a></div><div class="brief "><p class="paragraph">Creates base <a href="../-kron-scheduler/index.html">KronScheduler</a> using <a href="scheduler.html">scheduler</a> function. In case when returned <a href="../-kron-scheduler/index.html">KronScheduler</a> is <a href="../-kron-scheduler-tz/index.html">KronSchedulerTz</a>, it will be returned as is. Otherwise, will be created new <span data-unresolved-link="dev.inmo.krontab.internal/CronDateTimeSchedulerTz///PointingToDeclaration/">CronDateTimeSchedulerTz</span> with <a href="scheduler.html">defaultOffset</a> as offset</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer">
|
|
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 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>
|