<!DOCTYPE HTML> <html lang="en"> <head> <!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 --> <title>ISchedule</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="dc.created" content="2022-12-13"> <meta name="description" content="declaration: package: io.github.simplexdevelopment.api, interface: ISchedule"> <meta name="generator" content="javadoc/ClassWriterImpl"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> <script type="text/javascript" src="../../../../script.js"></script> <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> </head> <body class="class-declaration-page"> <script type="text/javascript">var evenRowColor = "even-row-color"; var oddRowColor = "odd-row-color"; var tableTab = "table-tab"; var activeTableTab = "active-table-tab"; var pathtoroot = "../../../../"; loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <div class="flex-box"> <header role="banner" class="flex-header"> <nav role="navigation"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="top-nav" id="navbar-top"> <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> <li><a href="../../../../index.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="nav-bar-cell1-rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../index-files/index-1.html">Index</a></li> <li><a href="../../../../help-doc.html#class">Help</a></li> </ul> </div> <div class="sub-nav"> <div> <ul class="sub-nav-list"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method-summary">Method</a></li> </ul> <ul class="sub-nav-list"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method-detail">Method</a></li> </ul> </div> <div class="nav-list-search"><label for="search-input">SEARCH:</label> <input type="text" id="search-input" value="search" disabled="disabled"> <input type="reset" id="reset-button" value="reset" disabled="disabled"> </div> </div> <!-- ========= END OF TOP NAVBAR ========= --> <span class="skip-nav" id="skip-navbar-top"></span></nav> </header> <div class="flex-content"> <main role="main"> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">io.github.simplexdevelopment.api</a></div> <h1 title="Interface ISchedule" class="title">Interface ISchedule</h1> </div> <section class="class-description" id="class-description"> <dl class="notes"> <dt>All Known Implementing Classes:</dt> <dd><code><a href="../simplexss/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a></code></dd> </dl> <hr> <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ISchedule</span></div> </section> <section class="summary"> <ul class="summary-list"> <!-- ========== METHOD SUMMARY =========== --> <li> <section class="method-summary" id="method-summary"> <h2>Method Summary</h2> <div id="method-summary-table"> <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> <div id="method-summary-table.tabpanel" role="tabpanel"> <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> <div class="table-header col-first">Modifier and Type</div> <div class="table-header col-second">Method</div> <div class="table-header col-last">Description</div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#forceStart(io.github.simplexdevelopment.api.IService)" class="member-name-link">forceStart</a><wbr>(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#forceStop(io.github.simplexdevelopment.api.IService)" class="member-name-link">forceStop</a><wbr>(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono<<a href="../simplexss/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a>></code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getServiceManager()" class="member-name-link">getServiceManager</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono<<a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#queue(io.github.simplexdevelopment.api.IService)" class="member-name-link">queue</a><wbr>(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#runOnce(io.github.simplexdevelopment.api.IService)" class="member-name-link">runOnce</a><wbr>(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> </div> </div> </div> </section> </li> </ul> </section> <section class="details"> <ul class="details-list"> <!-- ============ METHOD DETAIL ========== --> <li> <section class="method-details" id="method-detail"> <h2>Method Details</h2> <ul class="member-list"> <li> <section class="detail" id="getServiceManager()"> <h3>getServiceManager</h3> <div class="member-signature"><span class="return-type">reactor.core.publisher.Mono<<a href="../simplexss/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a>></span> <span class="element-name">getServiceManager</span>()</div> <dl class="notes"> <dt>Returns:</dt> <dd>The service manager which exerts control over the service pools and their associated services.</dd> </dl> </section> </li> <li> <section class="detail" id="queue(io.github.simplexdevelopment.api.IService)"> <h3>queue</h3> <div class="member-signature"><span class="return-type">reactor.core.publisher.Mono<<a href="../simplexss/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>></span> <span class="element-name">queue</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>service</code> - The service to use to locate the associated service pool and queue the service for execution.</dd> <dt>Returns:</dt> <dd>A Mono<ServicePool> that can be used to prepare the service for execution within it's associated service pool. If the service has no associated pool, a new pool will be created.</dd> </dl> </section> </li> <li> <section class="detail" id="runOnce(io.github.simplexdevelopment.api.IService)"> <h3>runOnce</h3> <div class="member-signature"><span class="return-type">reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">runOnce</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>service</code> - The service to run once.</dd> <dt>Returns:</dt> <dd>A Mono<Void> object which can be used to run the service one time using <code>Mono.subscribe()</code>.</dd> </dl> </section> </li> <li> <section class="detail" id="forceStop(io.github.simplexdevelopment.api.IService)"> <h3>forceStop</h3> <div class="member-signature"><span class="return-type">reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">forceStop</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>service</code> - The service to forcefully stop.</dd> <dt>Returns:</dt> <dd>A Mono<Void> object which can be used to forcefully stop the service with <code>Mono.subscribe()</code>.</dd> </dl> </section> </li> <li> <section class="detail" id="forceStart(io.github.simplexdevelopment.api.IService)"> <h3>forceStart</h3> <div class="member-signature"><span class="return-type">reactor.core.publisher.Mono<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">forceStart</span><wbr><span class="parameters">(<a href="IService.html" title="interface in io.github.simplexdevelopment.api">IService</a> service)</span></div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>service</code> - The service to forcefully start.</dd> <dt>Returns:</dt> <dd>A Mono<Void> object which can be used to forcefully start the service with <code>Mono.subscribe()</code>.</dd> </dl> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>