Files
Flash5/javadoc/2.0.0/dev/relism/flash/ext/limiter/class-use/RateLimitStrategy.html
T

139 lines
9.0 KiB
HTML

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Tue May 12 14:36:52 UTC 2026 -->
<title>Uses of Interface dev.relism.flash.ext.limiter.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="use: package: dev.relism.flash.ext.limiter, interface: RateLimitStrategy">
<meta name="generator" content="javadoc/ClassUseWriter">
<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-use-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">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</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><a href="../RateLimitStrategy.html" title="interface in dev.relism.flash.ext.limiter">Class</a></li>
<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list"></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">
<div class="header">
<h1 title="Uses of Interface dev.relism.flash.ext.limiter.RateLimitStrategy" class="title">Uses of Interface<br>dev.relism.flash.ext.limiter.RateLimitStrategy</h1>
</div>
<div class="caption"><span>Packages that use <a href="../RateLimitStrategy.html" title="interface in dev.relism.flash.ext.limiter">RateLimitStrategy</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#dev.relism.flash.ext.limiter">dev.relism.flash.ext.limiter</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#dev.relism.flash.ext.limiter.strategy">dev.relism.flash.ext.limiter.strategy</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="dev.relism.flash.ext.limiter">
<h2>Uses of <a href="../RateLimitStrategy.html" title="interface in dev.relism.flash.ext.limiter">RateLimitStrategy</a> in <a href="../package-summary.html">dev.relism.flash.ext.limiter</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">dev.relism.flash.ext.limiter</a> that return <a href="../RateLimitStrategy.html" title="interface in dev.relism.flash.ext.limiter">RateLimitStrategy</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>abstract <a href="../RateLimitStrategy.html" title="interface in dev.relism.flash.ext.limiter">RateLimitStrategy</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">LimitStrategy.</span><code><a href="../LimitStrategy.html#create()" class="member-name-link">create</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a fresh, stateless <a href="../RateLimitStrategy.html" title="interface in dev.relism.flash.ext.limiter"><code>RateLimitStrategy</code></a> instance for this algorithm.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../RateLimitStrategy.html" title="interface in dev.relism.flash.ext.limiter">RateLimitStrategy</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">LimitConfig.</span><code><a href="../LimitConfig.html#strategy()" class="member-name-link">strategy</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Returns the value of the <a href="../../../../../../dev/relism/flash/ext/limiter/LimitConfig.html#param-strategy"><code>strategy</code></a> record component.</div>
</div>
</div>
<div class="caption"><span>Constructors in <a href="../package-summary.html">dev.relism.flash.ext.limiter</a> with parameters of type <a href="../RateLimitStrategy.html" title="interface in dev.relism.flash.ext.limiter">RateLimitStrategy</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../LimitConfig.html#%3Cinit%3E(int,long,dev.relism.flash.ext.limiter.RateLimitStrategy)" class="member-name-link">LimitConfig</a><wbr>(int&nbsp;limit,
long&nbsp;windowMs,
<a href="../RateLimitStrategy.html" title="interface in dev.relism.flash.ext.limiter">RateLimitStrategy</a>&nbsp;strategy)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates an instance of a <code>LimitConfig</code> record class.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="dev.relism.flash.ext.limiter.strategy">
<h2>Uses of <a href="../RateLimitStrategy.html" title="interface in dev.relism.flash.ext.limiter">RateLimitStrategy</a> in <a href="../strategy/package-summary.html">dev.relism.flash.ext.limiter.strategy</a></h2>
<div class="caption"><span>Classes in <a href="../strategy/package-summary.html">dev.relism.flash.ext.limiter.strategy</a> that implement <a href="../RateLimitStrategy.html" title="interface in dev.relism.flash.ext.limiter">RateLimitStrategy</a></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">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>final class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../strategy/FixedWindowStrategy.html" class="type-name-link" title="class in dev.relism.flash.ext.limiter.strategy">FixedWindowStrategy</a></code></div>
<div class="col-last even-row-color">
<div class="block">Fixed-window rate limit: allows up to <a href="../LimitConfig.html#limit()"><code>LimitConfig.limit()</code></a> requests per window of
<a href="../LimitConfig.html#windowMs()"><code>LimitConfig.windowMs()</code></a> milliseconds.</div>
</div>
<div class="col-first odd-row-color"><code>final class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../strategy/SlidingWindowStrategy.html" class="type-name-link" title="class in dev.relism.flash.ext.limiter.strategy">SlidingWindowStrategy</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Sliding-window counter rate limit: approximates a true sliding window by interpolating
between the previous fixed window's count and the current window's count.</div>
</div>
<div class="col-first even-row-color"><code>final class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../strategy/TokenBucketStrategy.html" class="type-name-link" title="class in dev.relism.flash.ext.limiter.strategy">TokenBucketStrategy</a></code></div>
<div class="col-last even-row-color">
<div class="block">Token-bucket rate limit: tokens refill continuously at a rate of
<code>limit / windowMs</code> tokens per millisecond, up to a maximum of <code>limit</code> tokens.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2026. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>