UNPKG

cassandra-server

Version:

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

289 lines (288 loc) 10.5 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:28 CEST 2014 --> <title>HintedHandOffManagerMBean (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="HintedHandOffManagerMBean (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/HintedHandOffManagerMBean.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/HintedHandOffManager.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/db/IMutation.html" title="interface in org.apache.cassandra.db"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/db/HintedHandOffManagerMBean.html" target="_top">Frames</a></li> <li><a href="HintedHandOffManagerMBean.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</div> <h2 title="Interface HintedHandOffManagerMBean" class="title">Interface HintedHandOffManagerMBean</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/HintedHandOffManager.html" title="class in org.apache.cassandra.db">HintedHandOffManager</a></dd> </dl> <hr> <br> <pre>public interface <span class="strong">HintedHandOffManagerMBean</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>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/HintedHandOffManagerMBean.html#deleteHintsForEndpoint(java.lang.String)">deleteHintsForEndpoint</a></strong>(java.lang.String&nbsp;host)</code> <div class="block">Nuke all hints from this node to `ep`.</div> </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/HintedHandOffManagerMBean.html#listEndpointsPendingHints()">listEndpointsPendingHints</a></strong>()</code> <div class="block">List all the endpoints that this node has hints for.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/HintedHandOffManagerMBean.html#pauseHintsDelivery(boolean)">pauseHintsDelivery</a></strong>(boolean&nbsp;b)</code> <div class="block">pause hints delivery process</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/HintedHandOffManagerMBean.html#scheduleHintDelivery(java.lang.String)">scheduleHintDelivery</a></strong>(java.lang.String&nbsp;host)</code> <div class="block">force hint delivery to an endpoint</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/HintedHandOffManagerMBean.html#truncateAllHints()">truncateAllHints</a></strong>()</code> <div class="block">Truncate all the hints</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="deleteHintsForEndpoint(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>deleteHintsForEndpoint</h4> <pre>void&nbsp;deleteHintsForEndpoint(java.lang.String&nbsp;host)</pre> <div class="block">Nuke all hints from this node to `ep`.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>host</code> - String rep. of endpoint address to delete hints for, either ip address ("127.0.0.1") or hostname</dd></dl> </li> </ul> <a name="truncateAllHints()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>truncateAllHints</h4> <pre>void&nbsp;truncateAllHints() throws java.util.concurrent.ExecutionException, java.lang.InterruptedException</pre> <div class="block">Truncate all the hints</div> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.util.concurrent.ExecutionException</code></dd> <dd><code>java.lang.InterruptedException</code></dd></dl> </li> </ul> <a name="listEndpointsPendingHints()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>listEndpointsPendingHints</h4> <pre>java.util.List&lt;java.lang.String&gt;&nbsp;listEndpointsPendingHints()</pre> <div class="block">List all the endpoints that this node has hints for.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>set of endpoints; as Strings</dd></dl> </li> </ul> <a name="scheduleHintDelivery(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>scheduleHintDelivery</h4> <pre>void&nbsp;scheduleHintDelivery(java.lang.String&nbsp;host) throws java.net.UnknownHostException</pre> <div class="block">force hint delivery to an endpoint</div> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.net.UnknownHostException</code></dd></dl> </li> </ul> <a name="pauseHintsDelivery(boolean)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>pauseHintsDelivery</h4> <pre>void&nbsp;pauseHintsDelivery(boolean&nbsp;b)</pre> <div class="block">pause hints delivery process</div> </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/HintedHandOffManagerMBean.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/HintedHandOffManager.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/db/IMutation.html" title="interface in org.apache.cassandra.db"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/db/HintedHandOffManagerMBean.html" target="_top">Frames</a></li> <li><a href="HintedHandOffManagerMBean.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>