krontab/kdocs/dev.inmo.krontab/do-once.html
2023-07-05 14:09:24 +00:00

73 lines
7.4 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>doOnce</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="member" id="content" pageIds="kdocs::dev.inmo.krontab//doOnce/dev.inmo.krontab.KronScheduler#kotlin.Function1[[Error type: Unresolved type for DateTime],TypeParam(bounds=[kotlin.Any?])]/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">doOnce</span></div>
<div class="cover ">
<h1 class="cover"><span>do</span><wbr></wbr><span><span>Once</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">inline suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="do-once.html">T</a><span class="token operator">&gt; </span><a href="-kron-scheduler/index.html">KronScheduler</a><span class="token punctuation">.</span><a href="do-once.html"><span class="token function">doOnce</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">block<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><span data-unresolved-link="/&amp;lt;Error class: unknown class&amp;gt;///PointingToDeclaration/">&lt;Error class: unknown class&gt;</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="do-once.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="do-once.html">T</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/krontab/blob/master//src/commonMain/kotlin/dev/inmo/krontab/Executes.kt#L17">source</a>)</span></span></div><p class="paragraph">Execute <a href="do-once.html">block</a> once at the <a href="-kron-scheduler/next.html">KronScheduler.next</a> time and return result of <a href="do-once.html">block</a> calculation.</p><p class="paragraph">WARNING!!! If you want to launch it in parallel, you must do this explicitly.</p><p class="paragraph">WARNING!!! In case if <a href="-kron-scheduler/next.html">KronScheduler.next</a> of <span data-unresolved-link="dev.inmo.krontab//&amp;lt;this&amp;gt;/#/PointingToCallableParameters(-1)/">this</span> instance will return null, <a href="do-once.html">block</a> will be called immediately</p><hr><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="do-once.html">T</a><span class="token operator">&gt; </span><a href="do-once.html"><span class="token function">doOnce</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scheduleConfig<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><span data-unresolved-link="/&amp;lt;Error class: unknown class&amp;gt;///PointingToDeclaration/">&lt;Error class: unknown class&gt;</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="do-once.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="do-once.html">T</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/krontab/blob/master//src/commonMain/kotlin/dev/inmo/krontab/Executes.kt#L54">source</a>)</span></span></div><p class="paragraph">Will <a href="build-schedule.html">buildSchedule</a> using <a href="do-once.html">scheduleConfig</a> and call <a href="do-once.html">doOnce</a> on it</p><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><a href="build-schedule.html"><span>build</span><wbr></wbr><span><span>Schedule</span></span></a></div></span></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>