docs(javadoc): publish 2.0.0
This commit is contained in:
github-actions[bot]
@@ -0,0 +1,187 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (21) on Tue May 12 14:36:52 UTC 2026 -->
|
||||
<title>RateLimitStrategy (flash-parent 2.1.0-SNAPSHOT API)</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="2026-05-12">
|
||||
<meta name="description" content="declaration: package: dev.relism.flash.ext.limiter, interface: RateLimitStrategy">
|
||||
<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">
|
||||
<script type="text/javascript" src="../../../../../script.js"></script>
|
||||
<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.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 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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button>
|
||||
<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="class-use/RateLimitStrategy.html">Use</a></li>
|
||||
<li><a href="package-tree.html">Tree</a></li>
|
||||
<li><a href="../../../../../index-all.html">Index</a></li>
|
||||
<li><a href="../../../../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list-small">
|
||||
<li>
|
||||
<p>Summary:</p>
|
||||
<ul>
|
||||
<li>Nested</li>
|
||||
<li>Field</li>
|
||||
<li>Constr</li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p>Detail:</p>
|
||||
<ul>
|
||||
<li>Field</li>
|
||||
<li>Constr</li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div id="navbar-sub-list">
|
||||
<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"><a href="../../../../../search.html">SEARCH</a>
|
||||
<input type="text" id="search-input" disabled placeholder="Search">
|
||||
<input type="reset" id="reset-button" disabled value="reset">
|
||||
</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">dev.relism.flash.ext.limiter</a></div>
|
||||
<h1 title="Interface RateLimitStrategy" class="title">Interface RateLimitStrategy</h1>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Known Implementing Classes:</dt>
|
||||
<dd><code><a href="strategy/FixedWindowStrategy.html" title="class in dev.relism.flash.ext.limiter.strategy">FixedWindowStrategy</a></code>, <code><a href="strategy/SlidingWindowStrategy.html" title="class in dev.relism.flash.ext.limiter.strategy">SlidingWindowStrategy</a></code>, <code><a href="strategy/TokenBucketStrategy.html" title="class in dev.relism.flash.ext.limiter.strategy">TokenBucketStrategy</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">RateLimitStrategy</span></div>
|
||||
<div class="block">Contract for a rate-limit algorithm. Implementations must be:
|
||||
<ul>
|
||||
<li><b>Lock-free</b> — rely only on <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link"><code>AtomicLong</code></a> CAS operations.</li>
|
||||
<li><b>Stateless</b> — all mutable state lives in the <a href="Bucket.html" title="class in dev.relism.flash.ext.limiter"><code>Bucket</code></a>; the strategy itself
|
||||
holds no instance fields so the same object can be shared across threads and rules.</li>
|
||||
</ul>
|
||||
|
||||
<p>Called on every request — must not allocate on the hot path.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="tag-list">
|
||||
<li><a href="strategy/FixedWindowStrategy.html" title="class in dev.relism.flash.ext.limiter.strategy"><code>FixedWindowStrategy</code></a></li>
|
||||
<li><a href="strategy/SlidingWindowStrategy.html" title="class in dev.relism.flash.ext.limiter.strategy"><code>SlidingWindowStrategy</code></a></li>
|
||||
<li><a href="strategy/TokenBucketStrategy.html" title="class in dev.relism.flash.ext.limiter.strategy"><code>TokenBucketStrategy</code></a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</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" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="summary-table three-column-summary">
|
||||
<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>boolean</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#check(dev.relism.flash.ext.limiter.Bucket,dev.relism.flash.ext.limiter.LimitConfig,long%5B%5D)" class="member-name-link">check</a><wbr>(<a href="Bucket.html" title="class in dev.relism.flash.ext.limiter">Bucket</a> bucket,
|
||||
<a href="LimitConfig.html" title="class in dev.relism.flash.ext.limiter">LimitConfig</a> cfg,
|
||||
long[] out)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||||
<div class="block">Checks whether this request is within the limit and updates the bucket atomically.</div>
|
||||
</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="check(dev.relism.flash.ext.limiter.Bucket,dev.relism.flash.ext.limiter.LimitConfig,long[])">
|
||||
<h3>check</h3>
|
||||
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">check</span><wbr><span class="parameters">(<a href="Bucket.html" title="class in dev.relism.flash.ext.limiter">Bucket</a> bucket,
|
||||
<a href="LimitConfig.html" title="class in dev.relism.flash.ext.limiter">LimitConfig</a> cfg,
|
||||
long[] out)</span></div>
|
||||
<div class="block">Checks whether this request is within the limit and updates the bucket atomically.
|
||||
|
||||
<p>On return, <code>out</code> contains:
|
||||
<ul>
|
||||
<li><code>out[0]</code> — remaining allowed requests in the current window (≥ 0).</li>
|
||||
<li><code>out[1]</code> — Unix epoch seconds at which the quota resets (for <code>X-RateLimit-Reset</code>
|
||||
and <code>Retry-After</code> headers).</li>
|
||||
</ul></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>bucket</code> - per-key state carrier (pre-allocated, never null)</dd>
|
||||
<dd><code>cfg</code> - immutable rule configuration</dd>
|
||||
<dd><code>out</code> - caller-supplied two-element array; values are overwritten on every call</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd><code>true</code> if the request is within the limit and should proceed</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
<footer role="contentinfo">
|
||||
<hr>
|
||||
<p class="legal-copy"><small>Copyright © 2026. All rights reserved.</small></p>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user