SimplexDevelopment/SimplexSS
1
0
Fork 0
mirror of https://github.com/SimplexDevelopment/SimplexSS.git synced 2025-07-02 23:26:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Docs

Browse Source
This commit is contained in:
Paldiu
2022-12-14 23:08:12 -06:00
parent 43070f9e2a
commit 43dee08554
85 changed files with 803 additions and 530 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
docs/io/github/simplexdevelopment/scheduler/SchedulingSystem.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
<title>SchedulingSystem</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@ -77,6 +77,10 @@ loadScripts(document, 'script');</script>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>T</code> - Your plugin class, which extends <code>JavaPlugin</code>.</dd>
</dl>
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></code></dd>
</dl>
@ -84,6 +88,24 @@ loadScripts(document, 'script');</script>
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">SchedulingSystem&lt;T extends org.bukkit.plugin.java.JavaPlugin&gt;</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="../api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></span></div>
<div class="block">This class is used to manage the scheduling of <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s,
and the creation of <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s through the <a href="ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a>.
The <a href="ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a> should be used to create new <a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s on
initialization of your plugin, and your <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s should be registered in the
<code>JavaPlugin.onEnable()</code> method. You can then use the <a href="#queue(io.github.simplexdevelopment.api.IService)"><code>queue(IService)</code></a> method
to then queue up your services, or call <a href="#queueAll()"><code>queueAll()</code></a> to queue up all services in every pool.
<a href="#forceStart(io.github.simplexdevelopment.api.IService)"><code>forceStart(IService)</code></a> and <a href="#forceStop(io.github.simplexdevelopment.api.IService)"><code>forceStop(IService)</code></a> will forcefully start and stop the services, respectively.
<a href="#getMainScheduler()"><code>getMainScheduler()</code></a> gets the main scheduler for the scheduling system, which is a <a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a> object.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a></li>
<li><a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a></li>
<li><a href="ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler"><code>ReactorBukkitScheduler</code></a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
@ -165,9 +187,12 @@ implements <a href="../api/ISchedule.html" title="interface in io.github.simplex
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Queues a service to be executed in a service pool.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono&lt;<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>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#runOnce(io.github.simplexdevelopment.api.IService)" class="member-name-link">runOnce</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Flux&lt;reactor.core.Disposable&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queueAll()" class="member-name-link">queueAll</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Mono&lt;<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>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#runOnce(io.github.simplexdevelopment.api.IService)" class="member-name-link">runOnce</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
@ -268,11 +293,17 @@ implements <a href="../api/ISchedule.html" title="interface in io.github.simplex
<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<Disposable> that can be used to cancel the service.</dd>
<dd>A Mono object that can be used to cancel the service.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="queueAll()">
<h3>queueAll</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">reactor.core.publisher.Flux&lt;reactor.core.Disposable&gt;</span>&nbsp;<span class="element-name">queueAll</span>()</div>
</section>
</li>
<li>
<section class="detail" id="runOnce(io.github.simplexdevelopment.api.IService)">
<h3>runOnce</h3>
<div class="member-signature"><span class="annotations">@NotNull
@ -283,7 +314,7 @@ implements <a href="../api/ISchedule.html" title="interface in io.github.simplex
<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>
<dd>A Mono object which can be used to run the service one time using <code>Mono.subscribe()</code>.</dd>
</dl>
</section>
</li>
@ -297,7 +328,7 @@ implements <a href="../api/ISchedule.html" title="interface in io.github.simplex
<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>
<dd>A Mono object which can be used to forcefully stop the service with <code>Mono.subscribe()</code>.</dd>
</dl>
</section>
</li>
@ -311,7 +342,7 @@ implements <a href="../api/ISchedule.html" title="interface in io.github.simplex
<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>
<dd>A Mono object which can be used to forcefully start the service with <code>Mono.subscribe()</code>.</dd>
</dl>
</section>
</li>