cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
381 lines (380 loc) • 15.4 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>StreamReceiveTask (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="StreamReceiveTask (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/StreamReceiveTask.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/streaming/StreamReader.html" title="class in org.apache.cassandra.streaming"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/streaming/StreamRequest.html" title="class in org.apache.cassandra.streaming"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/streaming/StreamReceiveTask.html" target="_top">Frames</a></li>
<li><a href="StreamReceiveTask.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.streaming</div>
<h2 title="Class StreamReceiveTask" class="title">Class StreamReceiveTask</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/cassandra/streaming/StreamTask.html" title="class in org.apache.cassandra.streaming">org.apache.cassandra.streaming.StreamTask</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.streaming.StreamReceiveTask</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">StreamReceiveTask</span>
extends <a href="../../../../org/apache/cassandra/streaming/StreamTask.html" title="class in org.apache.cassandra.streaming">StreamTask</a></pre>
<div class="block">Task that manages receiving files for the session for certain ColumnFamily.</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 java.util.Collection<<a href="../../../../org/apache/cassandra/io/sstable/SSTableWriter.html" title="class in org.apache.cassandra.io.sstable">SSTableWriter</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamReceiveTask.html#sstables">sstables</a></strong></code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.streaming.StreamTask">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.cassandra.streaming.<a href="../../../../org/apache/cassandra/streaming/StreamTask.html" title="class in org.apache.cassandra.streaming">StreamTask</a></h3>
<code><a href="../../../../org/apache/cassandra/streaming/StreamTask.html#cfId">cfId</a>, <a href="../../../../org/apache/cassandra/streaming/StreamTask.html#session">session</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/streaming/StreamReceiveTask.html#StreamReceiveTask(org.apache.cassandra.streaming.StreamSession,%20java.util.UUID,%20int,%20long)">StreamReceiveTask</a></strong>(<a href="../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a> session,
java.util.UUID cfId,
int totalFiles,
long totalSize)</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamReceiveTask.html#abort()">abort</a></strong>()</code>
<div class="block">Abort this task.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamReceiveTask.html#getTotalNumberOfFiles()">getTotalNumberOfFiles</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamReceiveTask.html#getTotalSize()">getTotalSize</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/streaming/StreamReceiveTask.html#received(org.apache.cassandra.io.sstable.SSTableWriter)">received</a></strong>(<a href="../../../../org/apache/cassandra/io/sstable/SSTableWriter.html" title="class in org.apache.cassandra.io.sstable">SSTableWriter</a> sstable)</code>
<div class="block">Process received file.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.streaming.StreamTask">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.cassandra.streaming.<a href="../../../../org/apache/cassandra/streaming/StreamTask.html" title="class in org.apache.cassandra.streaming">StreamTask</a></h3>
<code><a href="../../../../org/apache/cassandra/streaming/StreamTask.html#getSummary()">getSummary</a></code></li>
</ul>
<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="sstables">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>sstables</h4>
<pre>protected java.util.Collection<<a href="../../../../org/apache/cassandra/io/sstable/SSTableWriter.html" title="class in org.apache.cassandra.io.sstable">SSTableWriter</a>> sstables</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StreamReceiveTask(org.apache.cassandra.streaming.StreamSession, java.util.UUID, int, long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StreamReceiveTask</h4>
<pre>public StreamReceiveTask(<a href="../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a> session,
java.util.UUID cfId,
int totalFiles,
long totalSize)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="received(org.apache.cassandra.io.sstable.SSTableWriter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>received</h4>
<pre>public void received(<a href="../../../../org/apache/cassandra/io/sstable/SSTableWriter.html" title="class in org.apache.cassandra.io.sstable">SSTableWriter</a> sstable)</pre>
<div class="block">Process received file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sstable</code> - SSTable file received.</dd></dl>
</li>
</ul>
<a name="getTotalNumberOfFiles()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalNumberOfFiles</h4>
<pre>public int getTotalNumberOfFiles()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cassandra/streaming/StreamTask.html#getTotalNumberOfFiles()">getTotalNumberOfFiles</a></code> in class <code><a href="../../../../org/apache/cassandra/streaming/StreamTask.html" title="class in org.apache.cassandra.streaming">StreamTask</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>total number of files this task receives/streams.</dd></dl>
</li>
</ul>
<a name="getTotalSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalSize</h4>
<pre>public long getTotalSize()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cassandra/streaming/StreamTask.html#getTotalSize()">getTotalSize</a></code> in class <code><a href="../../../../org/apache/cassandra/streaming/StreamTask.html" title="class in org.apache.cassandra.streaming">StreamTask</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>total bytes expected to receive</dd></dl>
</li>
</ul>
<a name="abort()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>abort</h4>
<pre>public void abort()</pre>
<div class="block">Abort this task.
If the task already received all files and
<code>StreamReceiveTask.OnCompletionRunnable</code> task is submitted,
then task cannot be aborted.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cassandra/streaming/StreamTask.html#abort()">abort</a></code> in class <code><a href="../../../../org/apache/cassandra/streaming/StreamTask.html" title="class in org.apache.cassandra.streaming">StreamTask</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/StreamReceiveTask.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/streaming/StreamReader.html" title="class in org.apache.cassandra.streaming"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/streaming/StreamRequest.html" title="class in org.apache.cassandra.streaming"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/streaming/StreamReceiveTask.html" target="_top">Frames</a></li>
<li><a href="StreamReceiveTask.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>