Files
Yasuhiro KIMURA 9678929700 Update to 18.1.40
2020-07-24 01:10:28 +09:00

562 lines
19 KiB
HTML

<!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 (11.0.7) on Mon Jun 01 06:40:53 PDT 2020 -->
<title>QueueStats (Oracle - Berkeley DB Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2020-06-01">
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="QueueStats (Oracle - Berkeley DB Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="fixedNav">
<!-- ========= 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="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/QueueStats.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 class="aboutLanguage"><b>Berkeley DB</b><br><font size="-1"> version 18.1.40</font></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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 ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.sleepycat.db</a></div>
<h2 title="Class QueueStats" class="title">Class QueueStats</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="DatabaseStats.html" title="class in com.sleepycat.db">com.sleepycat.db.DatabaseStats</a></li>
<li>
<ul class="inheritance">
<li>com.sleepycat.db.QueueStats</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">QueueStats</span>
extends <a href="DatabaseStats.html" title="class in com.sleepycat.db">DatabaseStats</a></pre>
<div class="block">The QueueStats object is used to return Queue database statistics.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurRecno--">getCurRecno</a></span>()</code></th>
<td class="colLast">
<div class="block">The next available record number.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtentSize--">getExtentSize</a></span>()</code></th>
<td class="colLast">
<div class="block">The underlying database extent size, in pages.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFirstRecno--">getFirstRecno</a></span>()</code></th>
<td class="colLast">
<div class="block">The first undeleted record in the database.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMagic--">getMagic</a></span>()</code></th>
<td class="colLast">
<div class="block">The magic number that identifies the file as a Queue file.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetaFlags--">getMetaFlags</a></span>()</code></th>
<td class="colLast">
<div class="block">Reports internal flags.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumData--">getNumData</a></span>()</code></th>
<td class="colLast">
<div class="block">The number of records in the database.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumKeys--">getNumKeys</a></span>()</code></th>
<td class="colLast">
<div class="block">The number of records in the database.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPages--">getPages</a></span>()</code></th>
<td class="colLast">
<div class="block">The number of pages in the database.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPagesFree--">getPagesFree</a></span>()</code></th>
<td class="colLast">
<div class="block">The number of bytes free in database pages.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPageSize--">getPageSize</a></span>()</code></th>
<td class="colLast">
<div class="block">The underlying database page size, in bytes.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReLen--">getReLen</a></span>()</code></th>
<td class="colLast">
<div class="block">The length of the records.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRePad--">getRePad</a></span>()</code></th>
<td class="colLast">
<div class="block">The padding byte value for the records.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersion--">getVersion</a></span>()</code></th>
<td class="colLast">
<div class="block">The version of the Queue database.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString--">toString</a></span>()</code></th>
<td class="colLast">
<div class="block">For convenience, the QueueStats class has a toString method
that lists all the data fields.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getMagic--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMagic</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getMagic()</pre>
<div class="block">The magic number that identifies the file as a Queue file.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the magic number that identifies the file as a Queue file</dd>
</dl>
</li>
</ul>
<a name="getVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersion</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getVersion()</pre>
<div class="block">The version of the Queue database.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the version of the Queue database</dd>
</dl>
</li>
</ul>
<a name="getMetaFlags--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetaFlags</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getMetaFlags()</pre>
<div class="block">Reports internal flags. For internal use only.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>internal flags</dd>
</dl>
</li>
</ul>
<a name="getNumKeys--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumKeys</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getNumKeys()</pre>
<div class="block">The number of records in the database.
<p>
If the <a href="Database.html#getStats-com.sleepycat.db.Transaction-com.sleepycat.db.StatsConfig-"><code>Database.getStats</code></a> call was configured by the
<a href="StatsConfig.html#setFast-boolean-"><code>StatsConfig.setFast</code></a> method, the count will be the last
saved value unless it has never been calculated, in which case it
will be 0.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of records in the database</dd>
</dl>
</li>
</ul>
<a name="getNumData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumData</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getNumData()</pre>
<div class="block">The number of records in the database.
<p>
If the <a href="Database.html#getStats-com.sleepycat.db.Transaction-com.sleepycat.db.StatsConfig-"><code>Database.getStats</code></a> call was configured by the
<a href="StatsConfig.html#setFast-boolean-"><code>StatsConfig.setFast</code></a> method, the count will be the last
saved value unless it has never been calculated, in which case it
will be 0.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of records in the database</dd>
</dl>
</li>
</ul>
<a name="getPageSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getPageSize()</pre>
<div class="block">The underlying database page size, in bytes.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the underlying database page size, in bytes</dd>
</dl>
</li>
</ul>
<a name="getExtentSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtentSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getExtentSize()</pre>
<div class="block">The underlying database extent size, in pages.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the underlying database extent size, in pages</dd>
</dl>
</li>
</ul>
<a name="getPages--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPages</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getPages()</pre>
<div class="block">The number of pages in the database.
<p>
The information is only included if the <a href="Database.html#getStats-com.sleepycat.db.Transaction-com.sleepycat.db.StatsConfig-"><code>Database.getStats</code></a> call
was not configured by the <a href="StatsConfig.html#setFast-boolean-"><code>StatsConfig.setFast</code></a> method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of pages in the database</dd>
</dl>
</li>
</ul>
<a name="getReLen--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReLen</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getReLen()</pre>
<div class="block">The length of the records.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the length of the records</dd>
</dl>
</li>
</ul>
<a name="getRePad--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRePad</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getRePad()</pre>
<div class="block">The padding byte value for the records.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the padding byte value for the records</dd>
</dl>
</li>
</ul>
<a name="getPagesFree--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPagesFree</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getPagesFree()</pre>
<div class="block">The number of bytes free in database pages.
<p>
The information is only included if the <a href="Database.html#getStats-com.sleepycat.db.Transaction-com.sleepycat.db.StatsConfig-"><code>Database.getStats</code></a> call
was not configured by the <a href="StatsConfig.html#setFast-boolean-"><code>StatsConfig.setFast</code></a> method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes free in database pages</dd>
</dl>
</li>
</ul>
<a name="getFirstRecno--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirstRecno</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getFirstRecno()</pre>
<div class="block">The first undeleted record in the database.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the first undeleted record in the database</dd>
</dl>
</li>
</ul>
<a name="getCurRecno--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurRecno</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getCurRecno()</pre>
<div class="block">The next available record number.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next available record number</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block">For convenience, the QueueStats class has a toString method
that lists all the data fields.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String that lists all the data fields</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="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/QueueStats.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 class="aboutLanguage"><b>Berkeley DB</b><br><font size="-1"> version 18.1.40</font></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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><font size=1>Copyright (c) 1996, 2020 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>