cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
409 lines (407 loc) • 17.7 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>AbstractReadExecutor (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="AbstractReadExecutor (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/AbstractReadExecutor.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>Prev Class</li>
<li><a href="../../../../org/apache/cassandra/service/AbstractRowResolver.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/AbstractReadExecutor.html" target="_top">Frames</a></li>
<li><a href="AbstractReadExecutor.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>Constr | </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>Constr | </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 AbstractReadExecutor" class="title">Class AbstractReadExecutor</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.service.AbstractReadExecutor</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="strong">AbstractReadExecutor</span>
extends java.lang.Object</pre>
<div class="block">Sends a read request to the replicas needed to satisfy a given ConsistencyLevel.
Optionally, may perform additional requests to provide redundancy against replica failure:
AlwaysSpeculatingReadExecutor will always send a request to one extra replica, while
SpeculatingReadExecutor will wait until it looks like the original request is in danger
of timing out before performing extra reads.</div>
</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 <a href="../../../../org/apache/cassandra/db/ReadCommand.html" title="class in org.apache.cassandra.db">ReadCommand</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractReadExecutor.html#command">command</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="class in org.apache.cassandra.service">ReadCallback</a><<a href="../../../../org/apache/cassandra/db/ReadResponse.html" title="class in org.apache.cassandra.db">ReadResponse</a>,<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractReadExecutor.html#handler">handler</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/cassandra/service/RowDigestResolver.html" title="class in org.apache.cassandra.service">RowDigestResolver</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractReadExecutor.html#resolver">resolver</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.List<java.net.InetAddress></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractReadExecutor.html#targetReplicas">targetReplicas</a></strong></code> </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>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractReadExecutor.html#executeAsync()">executeAsync</a></strong>()</code>
<div class="block">send the initial set of requests</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractReadExecutor.html#get()">get</a></strong>()</code>
<div class="block">wait for an answer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract java.util.Collection<java.net.InetAddress></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractReadExecutor.html#getContactedReplicas()">getContactedReplicas</a></strong>()</code>
<div class="block">Get the replicas involved in the [finished] request.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/service/AbstractReadExecutor.html" title="class in org.apache.cassandra.service">AbstractReadExecutor</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractReadExecutor.html#getReadExecutor(org.apache.cassandra.db.ReadCommand,%20org.apache.cassandra.db.ConsistencyLevel)">getReadExecutor</a></strong>(<a href="../../../../org/apache/cassandra/db/ReadCommand.html" title="class in org.apache.cassandra.db">ReadCommand</a> command,
<a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a> consistencyLevel)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractReadExecutor.html#makeDataRequests(java.lang.Iterable)">makeDataRequests</a></strong>(java.lang.Iterable<java.net.InetAddress> endpoints)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractReadExecutor.html#makeDigestRequests(java.lang.Iterable)">makeDigestRequests</a></strong>(java.lang.Iterable<java.net.InetAddress> endpoints)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/AbstractReadExecutor.html#maybeTryAdditionalReplicas()">maybeTryAdditionalReplicas</a></strong>()</code>
<div class="block">Perform additional requests if it looks like the original will time out.</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 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="command">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>command</h4>
<pre>protected final <a href="../../../../org/apache/cassandra/db/ReadCommand.html" title="class in org.apache.cassandra.db">ReadCommand</a> command</pre>
</li>
</ul>
<a name="targetReplicas">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>targetReplicas</h4>
<pre>protected final java.util.List<java.net.InetAddress> targetReplicas</pre>
</li>
</ul>
<a name="resolver">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolver</h4>
<pre>protected final <a href="../../../../org/apache/cassandra/service/RowDigestResolver.html" title="class in org.apache.cassandra.service">RowDigestResolver</a> resolver</pre>
</li>
</ul>
<a name="handler">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>handler</h4>
<pre>protected final <a href="../../../../org/apache/cassandra/service/ReadCallback.html" title="class in org.apache.cassandra.service">ReadCallback</a><<a href="../../../../org/apache/cassandra/db/ReadResponse.html" title="class in org.apache.cassandra.db">ReadResponse</a>,<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>> handler</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="makeDataRequests(java.lang.Iterable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeDataRequests</h4>
<pre>protected void makeDataRequests(java.lang.Iterable<java.net.InetAddress> endpoints)</pre>
</li>
</ul>
<a name="makeDigestRequests(java.lang.Iterable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeDigestRequests</h4>
<pre>protected void makeDigestRequests(java.lang.Iterable<java.net.InetAddress> endpoints)</pre>
</li>
</ul>
<a name="maybeTryAdditionalReplicas()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maybeTryAdditionalReplicas</h4>
<pre>public abstract void maybeTryAdditionalReplicas()</pre>
<div class="block">Perform additional requests if it looks like the original will time out. May block while it waits
to see if the original requests are answered first.</div>
</li>
</ul>
<a name="getContactedReplicas()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContactedReplicas</h4>
<pre>public abstract java.util.Collection<java.net.InetAddress> getContactedReplicas()</pre>
<div class="block">Get the replicas involved in the [finished] request.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>target replicas + the extra replica, *IF* we speculated.</dd></dl>
</li>
</ul>
<a name="executeAsync()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeAsync</h4>
<pre>public abstract void executeAsync()</pre>
<div class="block">send the initial set of requests</div>
</li>
</ul>
<a name="get()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public <a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</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>
<div class="block">wait for an answer. Blocks until success or timeout, so it is caller's
responsibility to call maybeTryAdditionalReplicas first.</div>
<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="getReadExecutor(org.apache.cassandra.db.ReadCommand, org.apache.cassandra.db.ConsistencyLevel)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getReadExecutor</h4>
<pre>public static <a href="../../../../org/apache/cassandra/service/AbstractReadExecutor.html" title="class in org.apache.cassandra.service">AbstractReadExecutor</a> getReadExecutor(<a href="../../../../org/apache/cassandra/db/ReadCommand.html" title="class in org.apache.cassandra.db">ReadCommand</a> command,
<a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a> consistencyLevel)
throws <a href="../../../../org/apache/cassandra/exceptions/UnavailableException.html" title="class in org.apache.cassandra.exceptions">UnavailableException</a></pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>an executor appropriate for the configured speculative read policy</dd>
<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>
</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/AbstractReadExecutor.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>Prev Class</li>
<li><a href="../../../../org/apache/cassandra/service/AbstractRowResolver.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/AbstractReadExecutor.html" target="_top">Frames</a></li>
<li><a href="AbstractReadExecutor.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>Constr | </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>Constr | </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>