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>StreamResultFuture (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/StreamResultFuture.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/StreamRequest.StreamRequestSerializer.html" title="class in org.apache.cassandra.streaming"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/streaming/StreamSession.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/StreamResultFuture.html" target="_top">Frames</a></li> <li><a href="StreamResultFuture.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="#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>   <div class="header"> <div class="subTitle">org.apache.cassandra.streaming</div> <h2 title="Class StreamResultFuture" class="title">Class StreamResultFuture</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.google.common.util.concurrent.AbstractFuture<<a href="../../../../org/apache/cassandra/streaming/StreamState.html" title="class in org.apache.cassandra.streaming">StreamState</a>></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.streaming.StreamResultFuture</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>com.google.common.util.concurrent.ListenableFuture<<a href="../../../../org/apache/cassandra/streaming/StreamState.html" title="class in org.apache.cassandra.streaming">StreamState</a>>, java.util.concurrent.Future<<a href="../../../../org/apache/cassandra/streaming/StreamState.html" title="class in org.apache.cassandra.streaming">StreamState</a>></dd> </dl> <hr> <br> <pre>public final class <span class="strong">StreamResultFuture</span> extends com.google.common.util.concurrent.AbstractFuture<<a href="../../../../org/apache/cassandra/streaming/StreamState.html" title="class in org.apache.cassandra.streaming">StreamState</a>></pre> <div class="block">A future on the result (<a href="../../../../org/apache/cassandra/streaming/StreamState.html" title="class in org.apache.cassandra.streaming"><code>StreamState</code></a>) of a streaming plan. In practice, this object also groups all the <a href="../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming"><code>StreamSession</code></a> for the streaming job involved. One StreamSession will be created for every peer involved and said session will handle every streaming (outgoing and incoming) to that peer for this job. <p> The future will return a result once every session is completed (successfully or not). If any session ended up with an error, the future will throw a StreamException. <p> You can attach <a href="../../../../org/apache/cassandra/streaming/StreamEventHandler.html" title="interface in org.apache.cassandra.streaming"><code>StreamEventHandler</code></a> to this object to listen on <a href="../../../../org/apache/cassandra/streaming/StreamEvent.html" title="class in org.apache.cassandra.streaming"><code>StreamEvent</code></a>s to track progress of the streaming.</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> <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>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamResultFuture.html#description">description</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.UUID</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamResultFuture.html#planId">planId</a></strong></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/StreamResultFuture.html#addEventListener(org.apache.cassandra.streaming.StreamEventHandler)">addEventListener</a></strong>(<a href="../../../../org/apache/cassandra/streaming/StreamEventHandler.html" title="interface in org.apache.cassandra.streaming">StreamEventHandler</a> listener)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamResultFuture.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object o)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/streaming/StreamState.html" title="class in org.apache.cassandra.streaming">StreamState</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamResultFuture.html#getCurrentState()">getCurrentState</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/StreamResultFuture.html#handleProgress(org.apache.cassandra.streaming.ProgressInfo)">handleProgress</a></strong>(<a href="../../../../org/apache/cassandra/streaming/ProgressInfo.html" title="class in org.apache.cassandra.streaming">ProgressInfo</a> progress)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamResultFuture.html#hashCode()">hashCode</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/streaming/StreamResultFuture.html" title="class in org.apache.cassandra.streaming">StreamResultFuture</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamResultFuture.html#initReceivingSide(int,%20java.util.UUID,%20java.lang.String,%20java.net.InetAddress,%20java.net.Socket,%20boolean,%20int)">initReceivingSide</a></strong>(int sessionIndex, java.util.UUID planId, java.lang.String description, java.net.InetAddress from, java.net.Socket socket, boolean isForOutgoing, int version)</code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_com.google.common.util.concurrent.AbstractFuture">  </a> <h3>Methods inherited from class com.google.common.util.concurrent.AbstractFuture</h3> <code>addListener, cancel, get, get, interruptTask, isCancelled, isDone, set, setException, wasInterrupted</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, finalize, getClass, 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="field_detail">  </a> <h3>Field Detail</h3> <a name="planId">  </a> <ul class="blockList"> <li class="blockList"> <h4>planId</h4> <pre>public final java.util.UUID planId</pre> </li> </ul> <a name="description">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>description</h4> <pre>public final java.lang.String description</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="initReceivingSide(int, java.util.UUID, java.lang.String, java.net.InetAddress, java.net.Socket, boolean, int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>initReceivingSide</h4> <pre>public static <a href="../../../../org/apache/cassandra/streaming/StreamResultFuture.html" title="class in org.apache.cassandra.streaming">StreamResultFuture</a> initReceivingSide(int sessionIndex, java.util.UUID planId, java.lang.String description, java.net.InetAddress from, java.net.Socket socket, boolean isForOutgoing, int version) throws java.io.IOException</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="addEventListener(org.apache.cassandra.streaming.StreamEventHandler)">  </a> <ul class="blockList"> <li class="blockList"> <h4>addEventListener</h4> <pre>public void addEventListener(<a href="../../../../org/apache/cassandra/streaming/StreamEventHandler.html" title="interface in org.apache.cassandra.streaming">StreamEventHandler</a> listener)</pre> </li> </ul> <a name="getCurrentState()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCurrentState</h4> <pre>public <a href="../../../../org/apache/cassandra/streaming/StreamState.html" title="class in org.apache.cassandra.streaming">StreamState</a> getCurrentState()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>Current snapshot of streaming progress.</dd></dl> </li> </ul> <a name="equals(java.lang.Object)">  </a> <ul class="blockList"> <li class="blockList"> <h4>equals</h4> <pre>public boolean equals(java.lang.Object o)</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>equals</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="hashCode()">  </a> <ul class="blockList"> <li class="blockList"> <h4>hashCode</h4> <pre>public int hashCode()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="handleProgress(org.apache.cassandra.streaming.ProgressInfo)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>handleProgress</h4> <pre>public void handleProgress(<a href="../../../../org/apache/cassandra/streaming/ProgressInfo.html" title="class in org.apache.cassandra.streaming">ProgressInfo</a> progress)</pre> </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/StreamResultFuture.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/StreamRequest.StreamRequestSerializer.html" title="class in org.apache.cassandra.streaming"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/streaming/StreamSession.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/StreamResultFuture.html" target="_top">Frames</a></li> <li><a href="StreamResultFuture.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="#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>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>