blob: ee772e630e4761be003aa29d33e3bf55353bee4b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MemStoreSizing (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MemStoreSizing (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":18,"i2":18,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":18};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MemStoreSizing.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSize.html" title="class in org.apache.hadoop.hbase.regionserver"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSnapshot.html" title="class in org.apache.hadoop.hbase.regionserver"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/regionserver/MemStoreSizing.html" target="_top">Frames</a></li>
<li><a href="MemStoreSizing.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.hbase.regionserver</div>
<h2 title="Interface MemStoreSizing" class="title">Interface MemStoreSizing</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/regionserver/CellArrayImmutableSegment.html" title="class in org.apache.hadoop.hbase.regionserver">CellArrayImmutableSegment</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/CellChunkImmutableSegment.html" title="class in org.apache.hadoop.hbase.regionserver">CellChunkImmutableSegment</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/CompositeImmutableSegment.html" title="class in org.apache.hadoop.hbase.regionserver">CompositeImmutableSegment</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/CSLMImmutableSegment.html" title="class in org.apache.hadoop.hbase.regionserver">CSLMImmutableSegment</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/ImmutableSegment.html" title="class in org.apache.hadoop.hbase.regionserver">ImmutableSegment</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/MutableSegment.html" title="class in org.apache.hadoop.hbase.regionserver">MutableSegment</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/NonThreadSafeMemStoreSizing.html" title="class in org.apache.hadoop.hbase.regionserver">NonThreadSafeMemStoreSizing</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/Segment.html" title="class in org.apache.hadoop.hbase.regionserver">Segment</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/ThreadSafeMemStoreSizing.html" title="class in org.apache.hadoop.hbase.regionserver">ThreadSafeMemStoreSizing</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Private
public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#line.55">MemStoreSizing</a></pre>
<div class="block">Accounting of current heap and data sizes.
Tracks 3 sizes:
<ol>
<li></li>data size: the aggregated size of all key-value not including meta data such as
index, time range etc.
</li>
<li>heap size: the aggregated size of all data that is allocated on-heap including all
key-values that reside on-heap and the metadata that resides on-heap
</li>
<li></li>off-heap size: the aggregated size of all data that is allocated off-heap including all
key-values that reside off-heap and the metadata that resides off-heap
</li>
</ol>
3 examples to illustrate their usage:
<p>
Consider a store with 100MB of key-values allocated on-heap and 20MB of metadata allocated
on-heap. The counters are <100MB, 120MB, 0>, respectively.
</p>
<p>Consider a store with 100MB of key-values allocated off-heap and 20MB of metadata
allocated on-heap (e.g, CAM index). The counters are <100MB, 20MB, 100MB>, respectively.
</p>
<p>
Consider a store with 100MB of key-values from which 95MB are allocated off-heap and 5MB
are allocated on-heap (e.g., due to upserts) and 20MB of metadata from which 15MB allocated
off-heap (e.g, CCM index) and 5MB allocated on-heap (e.g, CSLM index in active).
The counters are <100MB, 10MB, 110MB>, respectively.
</p>
Like <a href="../../../../../org/apache/hadoop/hbase/regionserver/TimeRangeTracker.html" title="class in org.apache.hadoop.hbase.regionserver"><code>TimeRangeTracker</code></a>, it has thread-safe and non-thread-safe implementations.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html" title="interface in org.apache.hadoop.hbase.regionserver">MemStoreSizing</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#DUD">DUD</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#compareAndSetDataSize-long-long-">compareAndSetDataSize</a></span>(long&nbsp;expected,
long&nbsp;updated)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#decMemStoreSize-long-long-long-int-">decMemStoreSize</a></span>(long&nbsp;dataSizeDelta,
long&nbsp;heapSizeDelta,
long&nbsp;offHeapSizeDelta,
int&nbsp;cellsCountDelta)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#decMemStoreSize-org.apache.hadoop.hbase.regionserver.MemStoreSize-">decMemStoreSize</a></span>(<a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSize.html" title="class in org.apache.hadoop.hbase.regionserver">MemStoreSize</a>&nbsp;delta)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#getCellsCount--">getCellsCount</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#getDataSize--">getDataSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#getHeapSize--">getHeapSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSize.html" title="class in org.apache.hadoop.hbase.regionserver">MemStoreSize</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#getMemStoreSize--">getMemStoreSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#getOffHeapSize--">getOffHeapSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#incMemStoreSize-long-long-long-int-">incMemStoreSize</a></span>(long&nbsp;dataSizeDelta,
long&nbsp;heapSizeDelta,
long&nbsp;offHeapSizeDelta,
int&nbsp;cellsCountDelta)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>default long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#incMemStoreSize-org.apache.hadoop.hbase.regionserver.MemStoreSize-">incMemStoreSize</a></span>(<a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSize.html" title="class in org.apache.hadoop.hbase.regionserver">MemStoreSize</a>&nbsp;delta)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DUD">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DUD</h4>
<pre>static final&nbsp;<a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html" title="interface in org.apache.hadoop.hbase.regionserver">MemStoreSizing</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#line.56">DUD</a></pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="incMemStoreSize-long-long-long-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incMemStoreSize</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#line.99">incMemStoreSize</a>(long&nbsp;dataSizeDelta,
long&nbsp;heapSizeDelta,
long&nbsp;offHeapSizeDelta,
int&nbsp;cellsCountDelta)</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The new dataSize ONLY as a convenience</dd>
</dl>
</li>
</ul>
<a name="incMemStoreSize-org.apache.hadoop.hbase.regionserver.MemStoreSize-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incMemStoreSize</h4>
<pre>default&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#line.102">incMemStoreSize</a>(<a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSize.html" title="class in org.apache.hadoop.hbase.regionserver">MemStoreSize</a>&nbsp;delta)</pre>
</li>
</ul>
<a name="decMemStoreSize-long-long-long-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decMemStoreSize</h4>
<pre>default&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#line.110">decMemStoreSize</a>(long&nbsp;dataSizeDelta,
long&nbsp;heapSizeDelta,
long&nbsp;offHeapSizeDelta,
int&nbsp;cellsCountDelta)</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The new dataSize ONLY as a convenience</dd>
</dl>
</li>
</ul>
<a name="decMemStoreSize-org.apache.hadoop.hbase.regionserver.MemStoreSize-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decMemStoreSize</h4>
<pre>default&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#line.115">decMemStoreSize</a>(<a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSize.html" title="class in org.apache.hadoop.hbase.regionserver">MemStoreSize</a>&nbsp;delta)</pre>
</li>
</ul>
<a name="compareAndSetDataSize-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareAndSetDataSize</h4>
<pre>boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#line.120">compareAndSetDataSize</a>(long&nbsp;expected,
long&nbsp;updated)</pre>
</li>
</ul>
<a name="getDataSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataSize</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#line.122">getDataSize</a>()</pre>
</li>
</ul>
<a name="getHeapSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeapSize</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#line.123">getHeapSize</a>()</pre>
</li>
</ul>
<a name="getOffHeapSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffHeapSize</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#line.124">getOffHeapSize</a>()</pre>
</li>
</ul>
<a name="getCellsCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCellsCount</h4>
<pre>int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#line.125">getCellsCount</a>()</pre>
</li>
</ul>
<a name="getMemStoreSize--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMemStoreSize</h4>
<pre><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSize.html" title="class in org.apache.hadoop.hbase.regionserver">MemStoreSize</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#line.131">getMemStoreSize</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Use this datastructure to return all three settings, <a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#getDataSize--"><code>getDataSize()</code></a>,
<a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#getHeapSize--"><code>getHeapSize()</code></a>, and <a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSizing.html#getOffHeapSize--"><code>getOffHeapSize()</code></a>, in the one go.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MemStoreSizing.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSize.html" title="class in org.apache.hadoop.hbase.regionserver"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/regionserver/MemStoreSnapshot.html" title="class in org.apache.hadoop.hbase.regionserver"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/regionserver/MemStoreSizing.html" target="_top">Frames</a></li>
<li><a href="MemStoreSizing.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>