UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

303 lines (302 loc) 11.3 kB
<!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 (version 1.7.0_67) on Sun Sep 07 15:29:32 CEST 2014 --> <title>CommitLogMBean (apache-cassandra API)</title> <meta name="date" content="2014-09-07"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="CommitLogMBean (apache-cassandra API)"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/CommitLogMBean.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/cassandra/db/commitlog/CommitLogDescriptor.html" title="class in org.apache.cassandra.db.commitlog"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogReplayer.html" title="class in org.apache.cassandra.db.commitlog"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/db/commitlog/CommitLogMBean.html" target="_top">Frames</a></li> <li><a href="CommitLogMBean.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../../allclasses-noframe.html">All 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>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 ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">org.apache.cassandra.db.commitlog</div> <h2 title="Interface CommitLogMBean" class="title">Interface CommitLogMBean</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/cassandra/db/commitlog/CommitLog.html" title="class in org.apache.cassandra.db.commitlog">CommitLog</a></dd> </dl> <hr> <br> <pre>public interface <span class="strong">CommitLogMBean</span></pre> </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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogMBean.html#getActiveSegmentNames()">getActiveSegmentNames</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogMBean.html#getArchivingSegmentNames()">getArchivingSegmentNames</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogMBean.html#getCompletedTasks()">getCompletedTasks</a></strong>()</code> <div class="block"><strong>Deprecated.</strong>&nbsp;</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogMBean.html#getPendingTasks()">getPendingTasks</a></strong>()</code> <div class="block"><strong>Deprecated.</strong>&nbsp;</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogMBean.html#getTotalCommitlogSize()">getTotalCommitlogSize</a></strong>()</code> <div class="block"><strong>Deprecated.</strong>&nbsp;</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogMBean.html#recover(java.lang.String)">recover</a></strong>(java.lang.String&nbsp;path)</code> <div class="block">Recover a single file.</div> </td> </tr> </table> </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="getCompletedTasks()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCompletedTasks</h4> <pre>@Deprecated long&nbsp;getCompletedTasks()</pre> <div class="block"><span class="strong">Deprecated.</span>&nbsp;</div> <div class="block">Get the number of completed tasks</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/cassandra/metrics/CommitLogMetrics.html#completedTasks"><code>CommitLogMetrics.completedTasks</code></a></dd></dl> </li> </ul> <a name="getPendingTasks()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPendingTasks</h4> <pre>@Deprecated long&nbsp;getPendingTasks()</pre> <div class="block"><span class="strong">Deprecated.</span>&nbsp;</div> <div class="block">Get the number of tasks waiting to be executed</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/cassandra/metrics/CommitLogMetrics.html#pendingTasks"><code>CommitLogMetrics.pendingTasks</code></a></dd></dl> </li> </ul> <a name="getTotalCommitlogSize()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getTotalCommitlogSize</h4> <pre>@Deprecated long&nbsp;getTotalCommitlogSize()</pre> <div class="block"><span class="strong">Deprecated.</span>&nbsp;</div> <div class="block">Get the current size used by all the commitlog segments.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/cassandra/metrics/CommitLogMetrics.html#totalCommitLogSize"><code>CommitLogMetrics.totalCommitLogSize</code></a></dd></dl> </li> </ul> <a name="recover(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>recover</h4> <pre>void&nbsp;recover(java.lang.String&nbsp;path) throws java.io.IOException</pre> <div class="block">Recover a single file.</div> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="getActiveSegmentNames()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getActiveSegmentNames</h4> <pre>java.util.List&lt;java.lang.String&gt;&nbsp;getActiveSegmentNames()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>file names (not full paths) of active commit log segments (segments containing unflushed data)</dd></dl> </li> </ul> <a name="getArchivingSegmentNames()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getArchivingSegmentNames</h4> <pre>java.util.List&lt;java.lang.String&gt;&nbsp;getArchivingSegmentNames()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>Files which are pending for archival attempt. Does NOT include failed archive attempts.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/CommitLogMBean.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/cassandra/db/commitlog/CommitLogDescriptor.html" title="class in org.apache.cassandra.db.commitlog"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogReplayer.html" title="class in org.apache.cassandra.db.commitlog"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/db/commitlog/CommitLogMBean.html" target="_top">Frames</a></li> <li><a href="CommitLogMBean.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../../allclasses-noframe.html">All 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>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>Copyright &copy; 2014 The Apache Software Foundation</small></p> </body> </html>