|
|
|
|
@ -1,11 +1,11 @@
|
|
|
|
|
<!DOCTYPE HTML>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<!-- Generated by javadoc (17) on Mon Dec 12 20:32:47 CST 2022 -->
|
|
|
|
|
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
|
|
|
|
|
<title>ExecutableService</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-12">
|
|
|
|
|
<meta name="dc.created" content="2022-12-13">
|
|
|
|
|
<meta name="description" content="declaration: package: io.github.simplex.api, class: ExecutableService">
|
|
|
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
|
|
|
@ -108,15 +108,18 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
|
|
|
|
<div class="col-first even-row-color"><code>private final boolean</code></div>
|
|
|
|
|
<div class="col-second even-row-color"><code><a href="#mayInterruptWhenRunning" class="member-name-link">mayInterruptWhenRunning</a></code></div>
|
|
|
|
|
<div class="col-last even-row-color"> </div>
|
|
|
|
|
<div class="col-first odd-row-color"><code>private final long</code></div>
|
|
|
|
|
<div class="col-second odd-row-color"><code><a href="#period" class="member-name-link">period</a></code></div>
|
|
|
|
|
<div class="col-first odd-row-color"><code>private <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a></code></div>
|
|
|
|
|
<div class="col-second odd-row-color"><code><a href="#parentPool" class="member-name-link">parentPool</a></code></div>
|
|
|
|
|
<div class="col-last odd-row-color"> </div>
|
|
|
|
|
<div class="col-first even-row-color"><code>private final boolean</code></div>
|
|
|
|
|
<div class="col-second even-row-color"><code><a href="#repeating" class="member-name-link">repeating</a></code></div>
|
|
|
|
|
<div class="col-first even-row-color"><code>private final long</code></div>
|
|
|
|
|
<div class="col-second even-row-color"><code><a href="#period" class="member-name-link">period</a></code></div>
|
|
|
|
|
<div class="col-last even-row-color"> </div>
|
|
|
|
|
<div class="col-first odd-row-color"><code>private final org.bukkit.NamespacedKey</code></div>
|
|
|
|
|
<div class="col-second odd-row-color"><code><a href="#service_name" class="member-name-link">service_name</a></code></div>
|
|
|
|
|
<div class="col-first odd-row-color"><code>private final boolean</code></div>
|
|
|
|
|
<div class="col-second odd-row-color"><code><a href="#repeating" class="member-name-link">repeating</a></code></div>
|
|
|
|
|
<div class="col-last odd-row-color"> </div>
|
|
|
|
|
<div class="col-first even-row-color"><code>private final org.bukkit.NamespacedKey</code></div>
|
|
|
|
|
<div class="col-second even-row-color"><code><a href="#service_name" class="member-name-link">service_name</a></code></div>
|
|
|
|
|
<div class="col-last even-row-color"> </div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
@ -128,7 +131,31 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
|
|
|
|
<div class="summary-table two-column-summary">
|
|
|
|
|
<div class="table-header col-first">Constructor</div>
|
|
|
|
|
<div class="table-header col-last">Description</div>
|
|
|
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.bukkit.NamespacedKey,java.lang.Long,java.lang.Long,java.lang.Boolean,java.lang.Boolean)" class="member-name-link">ExecutableService</a><wbr>(@NotNull org.bukkit.NamespacedKey service_name,
|
|
|
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.bukkit.NamespacedKey)" class="member-name-link">ExecutableService</a><wbr>(@NotNull org.bukkit.NamespacedKey service_name)</code></div>
|
|
|
|
|
<div class="col-last even-row-color">
|
|
|
|
|
<div class="block">Creates a new instance of an executable service.</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey)" class="member-name-link">ExecutableService</a><wbr>(@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
|
|
|
|
@NotNull org.bukkit.NamespacedKey service_name)</code></div>
|
|
|
|
|
<div class="col-last odd-row-color">
|
|
|
|
|
<div class="block">Creates a new instance of an executable service.</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey,java.lang.Long,java.lang.Long,java.lang.Boolean)" class="member-name-link">ExecutableService</a><wbr>(@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
|
|
|
|
@NotNull org.bukkit.NamespacedKey service_name,
|
|
|
|
|
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay,
|
|
|
|
|
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> period,
|
|
|
|
|
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> repeating)</code></div>
|
|
|
|
|
<div class="col-last even-row-color">
|
|
|
|
|
<div class="block">Creates a new instance of an executable service.</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey,java.lang.Long)" class="member-name-link">ExecutableService</a><wbr>(@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
|
|
|
|
@NotNull org.bukkit.NamespacedKey service_name,
|
|
|
|
|
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay)</code></div>
|
|
|
|
|
<div class="col-last odd-row-color">
|
|
|
|
|
<div class="block">Creates a new instance of an executable service.</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey,java.lang.Long,java.lang.Long,java.lang.Boolean,java.lang.Boolean)" class="member-name-link">ExecutableService</a><wbr>(@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
|
|
|
|
@NotNull org.bukkit.NamespacedKey service_name,
|
|
|
|
|
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay,
|
|
|
|
|
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> period,
|
|
|
|
|
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> repeating,
|
|
|
|
|
@ -161,20 +188,23 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
|
|
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.bukkit.NamespacedKey</code></div>
|
|
|
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNamespacedKey()" class="member-name-link">getNamespacedKey</a>()</code></div>
|
|
|
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
|
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
|
|
|
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPeriod()" class="member-name-link">getPeriod</a>()</code></div>
|
|
|
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>reactor.core.publisher.Mono<<a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a>></code></div>
|
|
|
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParentPool()" class="member-name-link">getParentPool</a>()</code></div>
|
|
|
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
|
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
|
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCancelled()" class="member-name-link">isCancelled</a>()</code></div>
|
|
|
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
|
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
|
|
|
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPeriod()" class="member-name-link">getPeriod</a>()</code></div>
|
|
|
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
|
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
|
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCancelled()" class="member-name-link">isCancelled</a>()</code></div>
|
|
|
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
|
|
|
<div class="block">Cancels the execution of this service.</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
|
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isPeriodic()" class="member-name-link">isPeriodic</a>()</code></div>
|
|
|
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
|
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4"><code><a href="#setCancelled(boolean)" class="member-name-link">setCancelled</a><wbr>(boolean cancel)</code></div>
|
|
|
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
|
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
|
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isPeriodic()" class="member-name-link">isPeriodic</a>()</code></div>
|
|
|
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
|
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4"><code><a href="#setCancelled(boolean)" class="member-name-link">setCancelled</a><wbr>(boolean cancel)</code></div>
|
|
|
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
|
|
|
<div class="block">Cancels the execution of this service.</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
@ -185,7 +215,7 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
|
|
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
|
|
|
<div class="inherited-list">
|
|
|
|
|
<h3 id="methods-inherited-from-class-io.github.simplex.api.IService">Methods inherited from interface io.github.simplex.api.<a href="IService.html" title="interface in io.github.simplex.api">IService</a></h3>
|
|
|
|
|
<code><a href="IService.html#getParentPool()">getParentPool</a>, <a href="IService.html#getPlugin()">getPlugin</a>, <a href="IService.html#run()">run</a>, <a href="IService.html#start()">start</a>, <a href="IService.html#stop()">stop</a></code></div>
|
|
|
|
|
<code><a href="IService.html#getPlugin()">getPlugin</a>, <a href="IService.html#run()">run</a>, <a href="IService.html#start()">start</a>, <a href="IService.html#stop()">stop</a></code></div>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
@ -233,6 +263,12 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
|
|
|
|
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">cancelled</span></div>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<section class="detail" id="parentPool">
|
|
|
|
|
<h3>parentPool</h3>
|
|
|
|
|
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a></span> <span class="element-name">parentPool</span></div>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
@ -242,9 +278,94 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
|
|
|
|
<h2>Constructor Details</h2>
|
|
|
|
|
<ul class="member-list">
|
|
|
|
|
<li>
|
|
|
|
|
<section class="detail" id="<init>(org.bukkit.NamespacedKey,java.lang.Long,java.lang.Long,java.lang.Boolean,java.lang.Boolean)">
|
|
|
|
|
<section class="detail" id="<init>(org.bukkit.NamespacedKey)">
|
|
|
|
|
<h3>ExecutableService</h3>
|
|
|
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@NotNull
|
|
|
|
|
@NotNull org.bukkit.NamespacedKey service_name)</span></div>
|
|
|
|
|
<div class="block">Creates a new instance of an executable service.
|
|
|
|
|
Each service is registered with a <code>NamespacedKey</code>,
|
|
|
|
|
to allow for easy identification within the associated <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a>.</div>
|
|
|
|
|
<dl class="notes">
|
|
|
|
|
<dt>Parameters:</dt>
|
|
|
|
|
<dd><code>service_name</code> - A namespaced key which can be used to identify the service.</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<section class="detail" id="<init>(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey)">
|
|
|
|
|
<h3>ExecutableService</h3>
|
|
|
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@Nullable
|
|
|
|
|
@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
|
|
|
|
@NotNull
|
|
|
|
|
@NotNull org.bukkit.NamespacedKey service_name)</span></div>
|
|
|
|
|
<div class="block">Creates a new instance of an executable service.
|
|
|
|
|
Each service is registered with a <code>NamespacedKey</code>,
|
|
|
|
|
to allow for easy identification within the associated <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a>.</div>
|
|
|
|
|
<dl class="notes">
|
|
|
|
|
<dt>Parameters:</dt>
|
|
|
|
|
<dd><code>parentPool</code> - The <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a> which this service is executing on.</dd>
|
|
|
|
|
<dd><code>service_name</code> - A namespaced key which can be used to identify the service.</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<section class="detail" id="<init>(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey,java.lang.Long)">
|
|
|
|
|
<h3>ExecutableService</h3>
|
|
|
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@Nullable
|
|
|
|
|
@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
|
|
|
|
@NotNull
|
|
|
|
|
@NotNull org.bukkit.NamespacedKey service_name,
|
|
|
|
|
@Nullable
|
|
|
|
|
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay)</span></div>
|
|
|
|
|
<div class="block">Creates a new instance of an executable service.
|
|
|
|
|
The timings are measured in ticks (20 ticks per second).
|
|
|
|
|
You do not need to explicitly define a delay.
|
|
|
|
|
Each service is registered with a <code>NamespacedKey</code>,
|
|
|
|
|
to allow for easy identification within the associated <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a>.</div>
|
|
|
|
|
<dl class="notes">
|
|
|
|
|
<dt>Parameters:</dt>
|
|
|
|
|
<dd><code>parentPool</code> - The <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a> which this service is executing on.</dd>
|
|
|
|
|
<dd><code>service_name</code> - A namespaced key which can be used to identify the service.</dd>
|
|
|
|
|
<dd><code>delay</code> - A specified amount of time (in ticks) to wait before the service runs.</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<section class="detail" id="<init>(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey,java.lang.Long,java.lang.Long,java.lang.Boolean)">
|
|
|
|
|
<h3>ExecutableService</h3>
|
|
|
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@Nullable
|
|
|
|
|
@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
|
|
|
|
@NotNull
|
|
|
|
|
@NotNull org.bukkit.NamespacedKey service_name,
|
|
|
|
|
@NotNull
|
|
|
|
|
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay,
|
|
|
|
|
@NotNull
|
|
|
|
|
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> period,
|
|
|
|
|
@NotNull
|
|
|
|
|
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a> repeating)</span></div>
|
|
|
|
|
<div class="block">Creates a new instance of an executable service.
|
|
|
|
|
The timings are measured in ticks (20 ticks per second).
|
|
|
|
|
You do not need to explicitly define a delay or a period,
|
|
|
|
|
however if you have flagged <a href="#repeating"><code>repeating</code></a> as true, and the period is null,
|
|
|
|
|
then the period will automatically be set to 20 minutes.
|
|
|
|
|
Each service is registered with a <code>NamespacedKey</code>,
|
|
|
|
|
to allow for easy identification within the associated <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a>.</div>
|
|
|
|
|
<dl class="notes">
|
|
|
|
|
<dt>Parameters:</dt>
|
|
|
|
|
<dd><code>parentPool</code> - The <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a> which this service is executing on.</dd>
|
|
|
|
|
<dd><code>service_name</code> - A namespaced key which can be used to identify the service.</dd>
|
|
|
|
|
<dd><code>delay</code> - A specified amount of time (in ticks) to wait before the service runs.</dd>
|
|
|
|
|
<dd><code>period</code> - How long the service should wait between service executions (in ticks).</dd>
|
|
|
|
|
<dd><code>repeating</code> - If the service should be scheduled for repeated executions or not.</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<section class="detail" id="<init>(io.github.simplex.simplexss.ServicePool,org.bukkit.NamespacedKey,java.lang.Long,java.lang.Long,java.lang.Boolean,java.lang.Boolean)">
|
|
|
|
|
<h3>ExecutableService</h3>
|
|
|
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ExecutableService</span><wbr><span class="parameters">(@Nullable
|
|
|
|
|
@Nullable <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a> parentPool,
|
|
|
|
|
@NotNull
|
|
|
|
|
@NotNull org.bukkit.NamespacedKey service_name,
|
|
|
|
|
@Nullable
|
|
|
|
|
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> delay,
|
|
|
|
|
@ -263,6 +384,7 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
|
|
|
|
to allow for easy identification within the associated <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a>.</div>
|
|
|
|
|
<dl class="notes">
|
|
|
|
|
<dt>Parameters:</dt>
|
|
|
|
|
<dd><code>parentPool</code> - The <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a> which this service is executing on.</dd>
|
|
|
|
|
<dd><code>service_name</code> - A namespaced key which can be used to identify the service.</dd>
|
|
|
|
|
<dd><code>delay</code> - A specified amount of time (in ticks) to wait before the service runs.</dd>
|
|
|
|
|
<dd><code>period</code> - How long the service should wait between service executions (in ticks).</dd>
|
|
|
|
|
@ -357,6 +479,18 @@ implements <a href="IService.html" title="interface in io.github.simplex.api">IS
|
|
|
|
|
<div class="block">Actual stop call, to ensure that the service actually #isCancelled().</div>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<section class="detail" id="getParentPool()">
|
|
|
|
|
<h3>getParentPool</h3>
|
|
|
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">reactor.core.publisher.Mono<<a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss">ServicePool</a>></span> <span class="element-name">getParentPool</span>()</div>
|
|
|
|
|
<dl class="notes">
|
|
|
|
|
<dt>Specified by:</dt>
|
|
|
|
|
<dd><code><a href="IService.html#getParentPool()">getParentPool</a></code> in interface <code><a href="IService.html" title="interface in io.github.simplex.api">IService</a></code></dd>
|
|
|
|
|
<dt>Returns:</dt>
|
|
|
|
|
<dd>The <a href="../simplexss/ServicePool.html" title="class in io.github.simplex.simplexss"><code>ServicePool</code></a> which this service is executing on.</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
|
Paldiu