cassandra-server

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <html lang="en"> <head>  <title>StreamTransferTask (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"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript>  <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/StreamTransferTask.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/StreamTask.html" title="class in org.apache.cassandra.streaming"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/streaming/StreamWriter.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/StreamTransferTask.html" target="_top">Frames</a></li> <li><a href="StreamTransferTask.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#fields_inherited_from_class_org.apache.cassandra.streaming.StreamTask">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>Field | </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>   <div class="header"> <div class="subTitle">org.apache.cassandra.streaming</div> <h2 title="Class StreamTransferTask" class="title">Class StreamTransferTask</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.StreamTransferTask</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">StreamTransferTask</span> extends <a href="../../../../org/apache/cassandra/streaming/StreamTask.html" title="class in org.apache.cassandra.streaming">StreamTask</a></pre> <div class="block">StreamTransferTask sends sections of SSTable files in certain ColumnFamily.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="field_summary">  </a> <h3>Field Summary</h3> <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>  <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/StreamTransferTask.html#StreamTransferTask(org.apache.cassandra.streaming.StreamSession,%20java.util.UUID)">StreamTransferTask</a></strong>(<a href="../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a> session, java.util.UUID cfId)</code> </td> </tr> </table> </li> </ul>  <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/StreamTransferTask.html#abort()">abort</a></strong>()</code> <div class="block">Abort the task.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamTransferTask.html#addTransferFile(org.apache.cassandra.io.sstable.SSTableReader,%20long,%20java.util.List,%20long)">addTransferFile</a></strong>(<a href="../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a> sstable, long estimatedKeys, java.util.List<<a href="../../../../org/apache/cassandra/utils/Pair.html" title="class in org.apache.cassandra.utils">Pair</a><java.lang.Long,java.lang.Long>> sections, long repairedAt)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamTransferTask.html#complete(int)">complete</a></strong>(int sequenceNumber)</code> <div class="block">Received ACK for file at <code>sequenceNumber</code>.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/streaming/messages/OutgoingFileMessage.html" title="class in org.apache.cassandra.streaming.messages">OutgoingFileMessage</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamTransferTask.html#createMessageForRetry(int)">createMessageForRetry</a></strong>(int sequenceNumber)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/messages/OutgoingFileMessage.html" title="class in org.apache.cassandra.streaming.messages">OutgoingFileMessage</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamTransferTask.html#getFileMessages()">getFileMessages</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/streaming/StreamTransferTask.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/StreamTransferTask.html#getTotalSize()">getTotalSize</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.concurrent.ScheduledFuture</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamTransferTask.html#scheduleTimeout(int,%20long,%20java.util.concurrent.TimeUnit)">scheduleTimeout</a></strong>(int sequenceNumber, long time, java.util.concurrent.TimeUnit unit)</code> <div class="block">Schedule timeout task to release reference for file sent.</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">  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="StreamTransferTask(org.apache.cassandra.streaming.StreamSession, java.util.UUID)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>StreamTransferTask</h4> <pre>public StreamTransferTask(<a href="../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a> session, java.util.UUID cfId)</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="addTransferFile(org.apache.cassandra.io.sstable.SSTableReader, long, java.util.List, long)">  </a> <ul class="blockList"> <li class="blockList"> <h4>addTransferFile</h4> <pre>public void addTransferFile(<a href="../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a> sstable, long estimatedKeys, java.util.List<<a href="../../../../org/apache/cassandra/utils/Pair.html" title="class in org.apache.cassandra.utils">Pair</a><java.lang.Long,java.lang.Long>> sections, long repairedAt)</pre> </li> </ul> <a name="complete(int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>complete</h4> <pre>public void complete(int sequenceNumber)</pre> <div class="block">Received ACK for file at <code>sequenceNumber</code>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sequenceNumber</code> - sequence number of file</dd></dl> </li> </ul> <a name="abort()">  </a> <ul class="blockList"> <li class="blockList"> <h4>abort</h4> <pre>public void abort()</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/cassandra/streaming/StreamTask.html#abort()">StreamTask</a></code></strong></div> <div class="block">Abort the task. Subclass should implement cleaning up resources.</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> <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="getFileMessages()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getFileMessages</h4> <pre>public java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/messages/OutgoingFileMessage.html" title="class in org.apache.cassandra.streaming.messages">OutgoingFileMessage</a>> getFileMessages()</pre> </li> </ul> <a name="createMessageForRetry(int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>createMessageForRetry</h4> <pre>public <a href="../../../../org/apache/cassandra/streaming/messages/OutgoingFileMessage.html" title="class in org.apache.cassandra.streaming.messages">OutgoingFileMessage</a> createMessageForRetry(int sequenceNumber)</pre> </li> </ul> <a name="scheduleTimeout(int, long, java.util.concurrent.TimeUnit)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>scheduleTimeout</h4> <pre>public java.util.concurrent.ScheduledFuture scheduleTimeout(int sequenceNumber, long time, java.util.concurrent.TimeUnit unit)</pre> <div class="block">Schedule timeout task to release reference for file sent. When not receiving ACK after sending to receiver in given time, the task will release reference.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sequenceNumber</code> - sequence number of file sent.</dd><dd><code>time</code> - time to timeout</dd><dd><code>unit</code> - unit of given time</dd> <dt><span class="strong">Returns:</span></dt><dd>scheduled future for timeout task</dd></dl> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <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/StreamTransferTask.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/StreamTask.html" title="class in org.apache.cassandra.streaming"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/streaming/StreamWriter.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/StreamTransferTask.html" target="_top">Frames</a></li> <li><a href="StreamTransferTask.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#fields_inherited_from_class_org.apache.cassandra.streaming.StreamTask">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>Field | </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>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>