UNPKG

cassandra-server

Version:

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

473 lines (472 loc) 20.4 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>AbstractWriteResponseHandler (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="AbstractWriteResponseHandler (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/AbstractWriteResponseHandler.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/service/AbstractRowResolver.html" title="class in org.apache.cassandra.service"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/service/ActiveRepairService.html" title="class in org.apache.cassandra.service"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/service/AbstractWriteResponseHandler.html" target="_top">Frames</a></li> <li><a href="AbstractWriteResponseHandler.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><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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.service</div> <h2 title="Class AbstractWriteResponseHandler" class="title">Class AbstractWriteResponseHandler</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.service.AbstractWriteResponseHandler</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="../../../../org/apache/cassandra/net/IAsyncCallback.html" title="interface in org.apache.cassandra.net">IAsyncCallback</a></dd> </dl> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../../org/apache/cassandra/service/DatacenterSyncWriteResponseHandler.html" title="class in org.apache.cassandra.service">DatacenterSyncWriteResponseHandler</a>, <a href="../../../../org/apache/cassandra/service/WriteResponseHandler.html" title="class in org.apache.cassandra.service">WriteResponseHandler</a></dd> </dl> <hr> <br> <pre>public abstract class <span class="strong">AbstractWriteResponseHandler</span> extends java.lang.Object implements <a href="../../../../org/apache/cassandra/net/IAsyncCallback.html" title="interface in org.apache.cassandra.net">IAsyncCallback</a></pre> </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="overviewSummary" 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>protected java.lang.Runnable</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractWriteResponseHandler.html#callback">callback</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractWriteResponseHandler.html#consistencyLevel">consistencyLevel</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected <a href="../../../../org/apache/cassandra/db/Keyspace.html" title="class in org.apache.cassandra.db">Keyspace</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractWriteResponseHandler.html#keyspace">keyspace</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected java.util.Collection&lt;java.net.InetAddress&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractWriteResponseHandler.html#naturalEndpoints">naturalEndpoints</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected java.util.Collection&lt;java.net.InetAddress&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractWriteResponseHandler.html#pendingEndpoints">pendingEndpoints</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractWriteResponseHandler.html#start">start</a></strong></code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.net.IAsyncCallback"> <!-- --> </a> <h3>Fields inherited from interface&nbsp;org.apache.cassandra.net.<a href="../../../../org/apache/cassandra/net/IAsyncCallback.html" title="interface in org.apache.cassandra.net">IAsyncCallback</a></h3> <code><a href="../../../../org/apache/cassandra/net/IAsyncCallback.html#isAlive">isAlive</a></code></li> </ul> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier</th> <th class="colLast" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractWriteResponseHandler.html#AbstractWriteResponseHandler(org.apache.cassandra.db.Keyspace,%20java.util.Collection,%20java.util.Collection,%20org.apache.cassandra.db.ConsistencyLevel,%20java.lang.Runnable,%20org.apache.cassandra.db.WriteType)">AbstractWriteResponseHandler</a></strong>(<a href="../../../../org/apache/cassandra/db/Keyspace.html" title="class in org.apache.cassandra.db">Keyspace</a>&nbsp;keyspace, java.util.Collection&lt;java.net.InetAddress&gt;&nbsp;naturalEndpoints, java.util.Collection&lt;java.net.InetAddress&gt;&nbsp;pendingEndpoints, <a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a>&nbsp;consistencyLevel, java.lang.Runnable&nbsp;callback, <a href="../../../../org/apache/cassandra/db/WriteType.html" title="enum in org.apache.cassandra.db">WriteType</a>&nbsp;writeType)</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="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>protected abstract int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractWriteResponseHandler.html#ackCount()">ackCount</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractWriteResponseHandler.html#assureSufficientLiveNodes()">assureSufficientLiveNodes</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractWriteResponseHandler.html#get()">get</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractWriteResponseHandler.html#response(org.apache.cassandra.net.MessageIn)">response</a></strong>(<a href="../../../../org/apache/cassandra/net/MessageIn.html" title="class in org.apache.cassandra.net">MessageIn</a>&nbsp;msg)</code> <div class="block">null message means "response from local write"</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractWriteResponseHandler.html#signal()">signal</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractWriteResponseHandler.html#totalBlockFor()">totalBlockFor</a></strong>()</code>&nbsp;</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, toString, wait, wait, wait</code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.net.IAsyncCallback"> <!-- --> </a> <h3>Methods inherited from interface&nbsp;org.apache.cassandra.net.<a href="../../../../org/apache/cassandra/net/IAsyncCallback.html" title="interface in org.apache.cassandra.net">IAsyncCallback</a></h3> <code><a href="../../../../org/apache/cassandra/net/IAsyncCallback.html#isLatencyForSnitch()">isLatencyForSnitch</a></code></li> </ul> </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="keyspace"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>keyspace</h4> <pre>protected final&nbsp;<a href="../../../../org/apache/cassandra/db/Keyspace.html" title="class in org.apache.cassandra.db">Keyspace</a> keyspace</pre> </li> </ul> <a name="start"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>start</h4> <pre>protected final&nbsp;long start</pre> </li> </ul> <a name="naturalEndpoints"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>naturalEndpoints</h4> <pre>protected final&nbsp;java.util.Collection&lt;java.net.InetAddress&gt; naturalEndpoints</pre> </li> </ul> <a name="consistencyLevel"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>consistencyLevel</h4> <pre>public final&nbsp;<a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a> consistencyLevel</pre> </li> </ul> <a name="callback"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>callback</h4> <pre>protected final&nbsp;java.lang.Runnable callback</pre> </li> </ul> <a name="pendingEndpoints"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>pendingEndpoints</h4> <pre>protected final&nbsp;java.util.Collection&lt;java.net.InetAddress&gt; pendingEndpoints</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="AbstractWriteResponseHandler(org.apache.cassandra.db.Keyspace, java.util.Collection, java.util.Collection, org.apache.cassandra.db.ConsistencyLevel, java.lang.Runnable, org.apache.cassandra.db.WriteType)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>AbstractWriteResponseHandler</h4> <pre>protected&nbsp;AbstractWriteResponseHandler(<a href="../../../../org/apache/cassandra/db/Keyspace.html" title="class in org.apache.cassandra.db">Keyspace</a>&nbsp;keyspace, java.util.Collection&lt;java.net.InetAddress&gt;&nbsp;naturalEndpoints, java.util.Collection&lt;java.net.InetAddress&gt;&nbsp;pendingEndpoints, <a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a>&nbsp;consistencyLevel, java.lang.Runnable&nbsp;callback, <a href="../../../../org/apache/cassandra/db/WriteType.html" title="enum in org.apache.cassandra.db">WriteType</a>&nbsp;writeType)</pre> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>callback</code> - A callback to be called when the write is successful.</dd></dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="get()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>get</h4> <pre>public&nbsp;void&nbsp;get() throws <a href="../../../../org/apache/cassandra/exceptions/WriteTimeoutException.html" title="class in org.apache.cassandra.exceptions">WriteTimeoutException</a></pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../org/apache/cassandra/exceptions/WriteTimeoutException.html" title="class in org.apache.cassandra.exceptions">WriteTimeoutException</a></code></dd></dl> </li> </ul> <a name="totalBlockFor()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>totalBlockFor</h4> <pre>protected&nbsp;int&nbsp;totalBlockFor()</pre> </li> </ul> <a name="ackCount()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>ackCount</h4> <pre>protected abstract&nbsp;int&nbsp;ackCount()</pre> </li> </ul> <a name="response(org.apache.cassandra.net.MessageIn)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>response</h4> <pre>public abstract&nbsp;void&nbsp;response(<a href="../../../../org/apache/cassandra/net/MessageIn.html" title="class in org.apache.cassandra.net">MessageIn</a>&nbsp;msg)</pre> <div class="block">null message means "response from local write"</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/net/IAsyncCallback.html#response(org.apache.cassandra.net.MessageIn)">response</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/net/IAsyncCallback.html" title="interface in org.apache.cassandra.net">IAsyncCallback</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>msg</code> - response received.</dd></dl> </li> </ul> <a name="assureSufficientLiveNodes()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>assureSufficientLiveNodes</h4> <pre>public&nbsp;void&nbsp;assureSufficientLiveNodes() throws <a href="../../../../org/apache/cassandra/exceptions/UnavailableException.html" title="class in org.apache.cassandra.exceptions">UnavailableException</a></pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../org/apache/cassandra/exceptions/UnavailableException.html" title="class in org.apache.cassandra.exceptions">UnavailableException</a></code></dd></dl> </li> </ul> <a name="signal()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>signal</h4> <pre>protected&nbsp;void&nbsp;signal()</pre> </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/AbstractWriteResponseHandler.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/service/AbstractRowResolver.html" title="class in org.apache.cassandra.service"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/service/ActiveRepairService.html" title="class in org.apache.cassandra.service"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/service/AbstractWriteResponseHandler.html" target="_top">Frames</a></li> <li><a href="AbstractWriteResponseHandler.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><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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>