203 lines
11 KiB
HTML
203 lines
11 KiB
HTML
<!DOCTYPE HTML>
|
||
<html lang="en">
|
||
<head>
|
||
<!-- Generated by javadoc (21) on Tue May 12 14:36:52 UTC 2026 -->
|
||
<title>Bucket (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, class: Bucket">
|
||
<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/Bucket.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><a href="#field-summary">Field</a></li>
|
||
<li><a href="#constructor-summary">Constr</a></li>
|
||
<li><a href="#method-summary">Method</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Detail:</p>
|
||
<ul>
|
||
<li><a href="#field-detail">Field</a></li>
|
||
<li><a href="#constructor-detail">Constr</a></li>
|
||
<li>Method</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><a href="#field-summary">Field</a> | </li>
|
||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||
<li><a href="#method-summary">Method</a></li>
|
||
</ul>
|
||
<ul class="sub-nav-list">
|
||
<li>Detail: </li>
|
||
<li><a href="#field-detail">Field</a> | </li>
|
||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||
<li>Method</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="Class Bucket" class="title">Class Bucket</h1>
|
||
</div>
|
||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||
<div class="inheritance">dev.relism.flash.ext.limiter.Bucket</div>
|
||
</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">Bucket</span>
|
||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||
<div class="block">Pre-allocated per-key rate limit state. Holds two <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> slots whose
|
||
semantics are strategy-specific:
|
||
|
||
<ul>
|
||
<li><b>FIXED_WINDOW</b>: <code>slot0</code> = packed <code>(epoch << 32 | count)</code>,
|
||
<code>slot1</code> unused.</li>
|
||
<li><b>SLIDING_WINDOW</b>: <code>slot0</code> = packed <code>(epoch << 32 | count)</code>,
|
||
<code>slot1</code> = request count from the immediately preceding epoch.</li>
|
||
<li><b>TOKEN_BUCKET</b>: <code>slot0</code> = tokens × 1000 (scaled),
|
||
<code>slot1</code> = last-refill timestamp (ms since epoch).</li>
|
||
</ul>
|
||
|
||
<p>Buckets are created once per unique key (via <a href="BucketStore.html" title="class in dev.relism.flash.ext.limiter"><code>BucketStore</code></a>) and reused
|
||
for the lifetime of the server — zero allocation on the warm path.</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>
|
||
<div class="col-first even-row-color"><code>final <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">AtomicLong</a></code></div>
|
||
<div class="col-second even-row-color"><code><a href="#slot0" class="member-name-link">slot0</a></code></div>
|
||
<div class="col-last even-row-color"> </div>
|
||
<div class="col-first odd-row-color"><code>final <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">AtomicLong</a></code></div>
|
||
<div class="col-second odd-row-color"><code><a href="#slot1" class="member-name-link">slot1</a></code></div>
|
||
<div class="col-last odd-row-color"> </div>
|
||
</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()" class="member-name-link">Bucket</a>()</code></div>
|
||
<div class="col-last even-row-color"> </div>
|
||
</div>
|
||
</section>
|
||
</li>
|
||
<!-- ========== METHOD SUMMARY =========== -->
|
||
<li>
|
||
<section class="method-summary" id="method-summary">
|
||
<h2>Method Summary</h2>
|
||
<div class="inherited-list">
|
||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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="slot0">
|
||
<h3>slot0</h3>
|
||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><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">AtomicLong</a></span> <span class="element-name">slot0</span></div>
|
||
</section>
|
||
</li>
|
||
<li>
|
||
<section class="detail" id="slot1">
|
||
<h3>slot1</h3>
|
||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><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">AtomicLong</a></span> <span class="element-name">slot1</span></div>
|
||
</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="<init>()">
|
||
<h3>Bucket</h3>
|
||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Bucket</span>()</div>
|
||
</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>
|