SimplexDevelopment/SimplexSS
1
0
Fork 0
mirror of https://github.com/SimplexDevelopment/SimplexSS.git synced 2024-11-15 06:03:32 +00:00
Code Issues Packages Projects Releases Wiki Activity
25ea207677
SimplexSS/docs/io/github/simplex/simplexss/ServicePool.html

410 lines
30 KiB
HTML
Raw Normal View History

Docs
2022-12-13 02:41:22 +00:00
<!DOCTYPE HTML>
<html lang="en">
<head>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<!-- Generated by javadoc (17) on Tue Dec 13 17:23:54 CST 2022 -->
Docs
2022-12-13 02:41:22 +00:00
<title>ServicePool</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<meta name="dc.created" content="2022-12-13">
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<meta name="description" content="declaration: package: io.github.simplexdevelopment.scheduler, class: ServicePool">
Docs
2022-12-13 02:41:22 +00:00
<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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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">
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">io.github.simplexdevelopment.scheduler</a></div>
Docs
2022-12-13 02:41:22 +00:00
<h1 title="Class ServicePool" class="title">Class ServicePool</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="inheritance">io.github.simplexdevelopment.scheduler.ServicePool</div>
Docs
2022-12-13 02:41:22 +00:00
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ServicePool</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></span></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="col-first even-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&gt;</code></div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-second even-row-color"><code><a href="#associatedServices" class="member-name-link">associatedServices</a></code></div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="col-last even-row-color">
<div class="block">A collection of services related to this service pool.</div>
</div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-first odd-row-color"><code>private static final org.bukkit.NamespacedKey</code></div>
<div class="col-second odd-row-color"><code><a href="#DEFAULT" class="member-name-link">DEFAULT</a></code></div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="col-last odd-row-color">
<div class="block">The default <code>NamespacedKey</code> used to identify unmarked services.</div>
</div>
Docs
2022-12-13 02:41:22 +00:00
<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="#name" class="member-name-link">name</a></code></div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="col-last even-row-color">
<div class="block">The key used to identify this service pool.</div>
</div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-first odd-row-color"><code>private final reactor.core.scheduler.Scheduler</code></div>
<div class="col-second odd-row-color"><code><a href="#scheduler" class="member-name-link">scheduler</a></code></div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="col-last odd-row-color">
<div class="block">The scheduler used to run the services in this pool.</div>
</div>
Docs
2022-12-13 02:41:22 +00:00
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<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,boolean)" class="member-name-link">ServicePool</a><wbr>(org.bukkit.NamespacedKey&nbsp;name,
boolean&nbsp;multithreaded)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== 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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code>(package private) void</code></div>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addService(io.github.simplexdevelopment.api.IService)" class="member-name-link">addService</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</code></div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&gt;</code></div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAssociatedServices()" class="member-name-link">getAssociatedServices</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static org.bukkit.NamespacedKey</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDefaultNamespacedKey()" class="member-name-link">getDefaultNamespacedKey</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 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>reactor.core.scheduler.Scheduler</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScheduler()" class="member-name-link">getScheduler</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<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="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&gt;</code></div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getService(org.bukkit.NamespacedKey)" class="member-name-link">getService</a><wbr>(org.bukkit.NamespacedKey&nbsp;service_name)</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>(package private) boolean</code></div>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isValidService(io.github.simplexdevelopment.api.IService)" class="member-name-link">isValidService</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</code></div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<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;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="#queueService(org.bukkit.NamespacedKey)" class="member-name-link">queueService</a><wbr>(org.bukkit.NamespacedKey&nbsp;service_name)</code></div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<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="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</code></div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#recycle()" class="member-name-link">recycle</a>()</code></div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeService(io.github.simplexdevelopment.api.IService)" class="member-name-link">removeService</a><wbr>(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</code></div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull reactor.core.publisher.Flux&lt;reactor.core.Disposable&gt;</code></div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startServices()" class="member-name-link">startServices</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<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="#stopService(org.bukkit.NamespacedKey,reactor.core.publisher.Mono)" class="member-name-link">stopService</a><wbr>(@NotNull org.bukkit.NamespacedKey&nbsp;service_name,
@Nullable reactor.core.publisher.Mono&lt;reactor.core.Disposable&gt;&nbsp;disposable)</code></div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<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="#stopServices(reactor.core.publisher.Flux)" class="member-name-link">stopServices</a><wbr>(@NotNull reactor.core.publisher.Flux&lt;reactor.core.Disposable&gt;&nbsp;disposableThread)</code></div>
Docs
2022-12-13 02:41:22 +00:00
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<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></h3>
<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>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="associatedServices">
<h3>associatedServices</h3>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&gt;</span>&nbsp;<span class="element-name">associatedServices</span></div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="block">A collection of services related to this service pool.</div>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
<li>
<section class="detail" id="scheduler">
<h3>scheduler</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">reactor.core.scheduler.Scheduler</span>&nbsp;<span class="element-name">scheduler</span></div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="block">The scheduler used to run the services in this pool.</div>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
<li>
<section class="detail" id="name">
<h3>name</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">org.bukkit.NamespacedKey</span>&nbsp;<span class="element-name">name</span></div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="block">The key used to identify this service pool.</div>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
<li>
<section class="detail" id="DEFAULT">
<h3>DEFAULT</h3>
<div class="member-signature"><span class="modifiers">private static final</span>&nbsp;<span class="return-type">org.bukkit.NamespacedKey</span>&nbsp;<span class="element-name">DEFAULT</span></div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="block">The default <code>NamespacedKey</code> used to identify unmarked services. This will cause errors if left unchecked.</div>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.bukkit.NamespacedKey,boolean)">
<h3>ServicePool</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ServicePool</span><wbr><span class="parameters">(org.bukkit.NamespacedKey&nbsp;name,
boolean&nbsp;multithreaded)</span></div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The name of this service pool.</dd>
<dd><code>multithreaded</code> - Whether this service pool should be multithreaded, or operate upon a single thread.</dd>
</dl>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getDefaultNamespacedKey()">
<h3>getDefaultNamespacedKey</h3>
<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type">org.bukkit.NamespacedKey</span>&nbsp;<span class="element-name">getDefaultNamespacedKey</span>()</div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<dl class="notes">
<dt>Returns:</dt>
<dd>The default namespaced key to use if one is not assigned.</dd>
</dl>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
<li>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<section class="detail" id="addService(io.github.simplexdevelopment.api.IService)">
Docs
2022-12-13 02:41:22 +00:00
<h3>addService</h3>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">addService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</span></div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service</code> - Add a service to the pool's service collection.</dd>
</dl>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
<li>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<section class="detail" id="isValidService(io.github.simplexdevelopment.api.IService)">
Docs
2022-12-13 02:41:22 +00:00
<h3>isValidService</h3>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isValidService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</span></div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service</code> - The service to check against this pool.</dd>
<dt>Returns:</dt>
<dd>Whether the service is registered with this pool.</dd>
</dl>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
<li>
<section class="detail" id="getAssociatedServices()">
<h3>getAssociatedServices</h3>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="member-signature"><span class="annotations">@Contract(pure=true)
@NotNull
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&gt;</span>&nbsp;<span class="element-name">getAssociatedServices</span>()</div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<dl class="notes">
<dt>Returns:</dt>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<dd>A <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link"><code>Set</code></a> of <a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a> objects which are registered with this pool.</dd>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
</dl>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
<li>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<section class="detail" id="queueService(org.bukkit.NamespacedKey)">
<h3>queueService</h3>
<div class="member-signature"><span class="annotations">@NotNull
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@NotNull reactor.core.publisher.Mono&lt;reactor.core.Disposable&gt;</span>&nbsp;<span class="element-name">queueService</span><wbr><span class="parameters">(org.bukkit.NamespacedKey&nbsp;service_name)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service_name</code> - The name of the service to queue. This should be a service that is located within this service pool.
If you name a service that is stored within another service pool,
this method will throw an error.</dd>
<dt>Returns:</dt>
<dd>A <code>Mono</code> object which contains a <code>Disposable</code> element which can be used to destroy the registered service.</dd>
</dl>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
<li>
<section class="detail" id="startServices()">
<h3>startServices</h3>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="member-signature"><span class="annotations">@NotNull
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@NotNull reactor.core.publisher.Flux&lt;reactor.core.Disposable&gt;</span>&nbsp;<span class="element-name">startServices</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>A <code>Flux</code> object which contains a collection of <code>Disposable</code> elements,
which can be used to destroy the registered services using <a href="#stopServices(reactor.core.publisher.Flux)"><code>stopServices(Flux&lt;Disposable&gt;)</code></a>.</dd>
</dl>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
<li>
<section class="detail" id="stopServices(reactor.core.publisher.Flux)">
<h3>stopServices</h3>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="member-signature"><span class="annotations">@NotNull
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@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;</span>&nbsp;<span class="element-name">stopServices</span><wbr><span class="parameters">(@NotNull
@NotNull reactor.core.publisher.Flux&lt;reactor.core.Disposable&gt;&nbsp;disposableThread)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>disposableThread</code> - A <code>reactor.core.publisher.Flux&lt;reactor.core.Disposable&gt;</code> which contains all the services that should be disposed..</dd>
<dt>Returns:</dt>
<dd>A <code>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> object which can be used to stop the services.</dd>
</dl>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
<li>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<section class="detail" id="stopService(org.bukkit.NamespacedKey,reactor.core.publisher.Mono)">
Docs
2022-12-13 02:41:22 +00:00
<h3>stopService</h3>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="member-signature"><span class="annotations">@NotNull
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@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;</span>&nbsp;<span class="element-name">stopService</span><wbr><span class="parameters">(@NotNull
@NotNull org.bukkit.NamespacedKey&nbsp;service_name,
@Nullable
@Nullable reactor.core.publisher.Mono&lt;reactor.core.Disposable&gt;&nbsp;disposable)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service_name</code> - The name of the service to stop.</dd>
<dd><code>disposable</code> - A <code>Disposable</code> object which contains the service that should be disposed.</dd>
<dt>Returns:</dt>
<dd>A <code>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> object which can be used to stop the service.</dd>
</dl>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
<li>
<section class="detail" id="getService(org.bukkit.NamespacedKey)">
<h3>getService</h3>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="member-signature"><span class="annotations">@NotNull
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@NotNull reactor.core.publisher.Mono&lt;<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&gt;</span>&nbsp;<span class="element-name">getService</span><wbr><span class="parameters">(org.bukkit.NamespacedKey&nbsp;service_name)</span></div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service_name</code> - The name of the service to get.</dd>
<dt>Returns:</dt>
<dd>A <code>Mono</code> object which contains the service.</dd>
</dl>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
<li>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<section class="detail" id="removeService(io.github.simplexdevelopment.api.IService)">
Docs
2022-12-13 02:41:22 +00:00
<h3>removeService</h3>
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">removeService</span><wbr><span class="parameters">(<a href="../api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a>&nbsp;service)</span></div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service</code> - The service to remove from the pool's service collection.</dd>
</dl>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
<li>
<section class="detail" id="recycle()">
<h3>recycle</h3>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="member-signature"><span class="annotations">@NotNull
Added Bukkit communication with BukkitScheduler
2022-12-14 17:15:42 +00:00
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@NotNull reactor.core.publisher.Mono&lt;<a href="ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a>&gt;</span>&nbsp;<span class="element-name">recycle</span>()</div>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<dl class="notes">
<dt>Returns:</dt>
<dd>This service pool after being cleared of all services.
You will need to register services with this pool again before using it.</dd>
</dl>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
<li>
<section class="detail" id="getScheduler()">
<h3>getScheduler</h3>
Doccing and Bugfixing
2022-12-13 23:25:58 +00:00
<div class="member-signature"><span class="annotations">@Contract(pure=true)
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">reactor.core.scheduler.Scheduler</span>&nbsp;<span class="element-name">getScheduler</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The <code>Scheduler</code> which hosts the threads for the service pool.</dd>
</dl>
Docs
2022-12-13 02:41:22 +00:00
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink