cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
450 lines (449 loc) • 22.8 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:32 CEST 2014 -->
<title>ReadCallback (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="ReadCallback (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/ReadCallback.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/RangeSliceVerbHandler.html" title="class in org.apache.cassandra.service"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/service/RowDataResolver.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/ReadCallback.html" target="_top">Frames</a></li>
<li><a href="ReadCallback.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: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </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 ReadCallback" class="title">Class ReadCallback<TMessage,TResolved></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.service.ReadCallback<TMessage,TResolved></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><TMessage></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ReadCallback<TMessage,TResolved></span>
extends java.lang.Object
implements <a href="../../../../org/apache/cassandra/net/IAsyncCallback.html" title="interface in org.apache.cassandra.net">IAsyncCallback</a><TMessage></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"> </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 static org.slf4j.Logger</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/ReadCallback.html#logger">logger</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/service/IResponseResolver.html" title="interface in org.apache.cassandra.service">IResponseResolver</a><<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TMessage</a>,<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TResolved</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/ReadCallback.html#resolver">resolver</a></strong></code> </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 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"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/service/ReadCallback.html#ReadCallback(org.apache.cassandra.service.IResponseResolver,%20org.apache.cassandra.db.ConsistencyLevel,%20int,%20org.apache.cassandra.service.IReadCommand,%20org.apache.cassandra.db.Keyspace,%20java.util.List)">ReadCallback</a></strong>(<a href="../../../../org/apache/cassandra/service/IResponseResolver.html" title="interface in org.apache.cassandra.service">IResponseResolver</a><<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TMessage</a>,<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TResolved</a>> resolver,
<a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a> consistencyLevel,
int blockfor,
<a href="../../../../org/apache/cassandra/service/IReadCommand.html" title="interface in org.apache.cassandra.service">IReadCommand</a> command,
<a href="../../../../org/apache/cassandra/db/Keyspace.html" title="class in org.apache.cassandra.db">Keyspace</a> keyspace,
java.util.List<java.net.InetAddress> endpoints)</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/service/ReadCallback.html#ReadCallback(org.apache.cassandra.service.IResponseResolver,%20org.apache.cassandra.db.ConsistencyLevel,%20org.apache.cassandra.service.IReadCommand,%20java.util.List)">ReadCallback</a></strong>(<a href="../../../../org/apache/cassandra/service/IResponseResolver.html" title="interface in org.apache.cassandra.service">IResponseResolver</a><<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TMessage</a>,<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TResolved</a>> resolver,
<a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a> consistencyLevel,
<a href="../../../../org/apache/cassandra/service/IReadCommand.html" title="interface in org.apache.cassandra.service">IReadCommand</a> command,
java.util.List<java.net.InetAddress> filteredEndpoints)</code>
<div class="block">Constructor when response count has to be calculated and blocked for.</div>
</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"> </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/service/ReadCallback.html#assureSufficientLiveNodes()">assureSufficientLiveNodes</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/ReadCallback.html#await(long,%20java.util.concurrent.TimeUnit)">await</a></strong>(long timePastStart,
java.util.concurrent.TimeUnit unit)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TResolved</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/ReadCallback.html#get()">get</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/ReadCallback.html#getReceivedCount()">getReceivedCount</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/ReadCallback.html#isLatencyForSnitch()">isLatencyForSnitch</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/ReadCallback.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><<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TMessage</a>> message)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/ReadCallback.html#response(TMessage)">response</a></strong>(<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TMessage</a> result)</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="logger">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logger</h4>
<pre>protected static final org.slf4j.Logger logger</pre>
</li>
</ul>
<a name="resolver">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>resolver</h4>
<pre>public final <a href="../../../../org/apache/cassandra/service/IResponseResolver.html" title="interface in org.apache.cassandra.service">IResponseResolver</a><<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TMessage</a>,<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TResolved</a>> resolver</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ReadCallback(org.apache.cassandra.service.IResponseResolver, org.apache.cassandra.db.ConsistencyLevel, org.apache.cassandra.service.IReadCommand, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ReadCallback</h4>
<pre>public ReadCallback(<a href="../../../../org/apache/cassandra/service/IResponseResolver.html" title="interface in org.apache.cassandra.service">IResponseResolver</a><<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TMessage</a>,<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TResolved</a>> resolver,
<a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a> consistencyLevel,
<a href="../../../../org/apache/cassandra/service/IReadCommand.html" title="interface in org.apache.cassandra.service">IReadCommand</a> command,
java.util.List<java.net.InetAddress> filteredEndpoints)</pre>
<div class="block">Constructor when response count has to be calculated and blocked for.</div>
</li>
</ul>
<a name="ReadCallback(org.apache.cassandra.service.IResponseResolver, org.apache.cassandra.db.ConsistencyLevel, int, org.apache.cassandra.service.IReadCommand, org.apache.cassandra.db.Keyspace, java.util.List)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ReadCallback</h4>
<pre>public ReadCallback(<a href="../../../../org/apache/cassandra/service/IResponseResolver.html" title="interface in org.apache.cassandra.service">IResponseResolver</a><<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TMessage</a>,<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TResolved</a>> resolver,
<a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a> consistencyLevel,
int blockfor,
<a href="../../../../org/apache/cassandra/service/IReadCommand.html" title="interface in org.apache.cassandra.service">IReadCommand</a> command,
<a href="../../../../org/apache/cassandra/db/Keyspace.html" title="class in org.apache.cassandra.db">Keyspace</a> keyspace,
java.util.List<java.net.InetAddress> endpoints)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="await(long, java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>await</h4>
<pre>public boolean await(long timePastStart,
java.util.concurrent.TimeUnit unit)</pre>
</li>
</ul>
<a name="get()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public <a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TResolved</a> get()
throws <a href="../../../../org/apache/cassandra/exceptions/ReadTimeoutException.html" title="class in org.apache.cassandra.exceptions">ReadTimeoutException</a>,
<a href="../../../../org/apache/cassandra/service/DigestMismatchException.html" title="class in org.apache.cassandra.service">DigestMismatchException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/cassandra/exceptions/ReadTimeoutException.html" title="class in org.apache.cassandra.exceptions">ReadTimeoutException</a></code></dd>
<dd><code><a href="../../../../org/apache/cassandra/service/DigestMismatchException.html" title="class in org.apache.cassandra.service">DigestMismatchException</a></code></dd></dl>
</li>
</ul>
<a name="response(org.apache.cassandra.net.MessageIn)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>response</h4>
<pre>public void response(<a href="../../../../org/apache/cassandra/net/MessageIn.html" title="class in org.apache.cassandra.net">MessageIn</a><<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TMessage</a>> message)</pre>
<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> in interface <code><a href="../../../../org/apache/cassandra/net/IAsyncCallback.html" title="interface in org.apache.cassandra.net">IAsyncCallback</a><<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TMessage</a>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - response received.</dd></dl>
</li>
</ul>
<a name="getReceivedCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReceivedCount</h4>
<pre>public int getReceivedCount()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current number of received responses</dd></dl>
</li>
</ul>
<a name="response(java.lang.Object)">
<!-- -->
</a><a name="response(TMessage)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>response</h4>
<pre>public void response(<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TMessage</a> result)</pre>
</li>
</ul>
<a name="assureSufficientLiveNodes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assureSufficientLiveNodes</h4>
<pre>public void 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="isLatencyForSnitch()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isLatencyForSnitch</h4>
<pre>public boolean isLatencyForSnitch()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cassandra/net/IAsyncCallback.html#isLatencyForSnitch()">isLatencyForSnitch</a></code> in interface <code><a href="../../../../org/apache/cassandra/net/IAsyncCallback.html" title="interface in org.apache.cassandra.net">IAsyncCallback</a><<a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="type parameter in ReadCallback">TMessage</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this callback is on the read path and its latency should be
given as input to the dynamic snitch.</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/ReadCallback.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/RangeSliceVerbHandler.html" title="class in org.apache.cassandra.service"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/service/RowDataResolver.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/ReadCallback.html" target="_top">Frames</a></li>
<li><a href="ReadCallback.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: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </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 © 2014 The Apache Software Foundation</small></p>
</body>
</html>