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>SessionInfo (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/SessionInfo.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/ReplicationFinishedVerbHandler.html" title="class in org.apache.cassandra.streaming"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/streaming/StreamCoordinator.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/SessionInfo.html" target="_top">Frames</a></li> <li><a href="SessionInfo.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><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>   <div class="header"> <div class="subTitle">org.apache.cassandra.streaming</div> <h2 title="Class SessionInfo" class="title">Class SessionInfo</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.streaming.SessionInfo</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.io.Serializable</dd> </dl> <hr> <br> <pre>public final class <span class="strong">SessionInfo</span> extends java.lang.Object implements java.io.Serializable</pre> <div class="block">Stream session info.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.cassandra.streaming.SessionInfo">Serialized Form</a></dd></dl> </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.net.InetAddress</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/SessionInfo.html#peer">peer</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/StreamSummary.html" title="class in org.apache.cassandra.streaming">StreamSummary</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/SessionInfo.html#receivingSummaries">receivingSummaries</a></strong></code> <div class="block">Immutable collection of receiving summaries</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/StreamSummary.html" title="class in org.apache.cassandra.streaming">StreamSummary</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/SessionInfo.html#sendingSummaries">sendingSummaries</a></strong></code> <div class="block">Immutable collection of sending summaries</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/SessionInfo.html#sessionIndex">sessionIndex</a></strong></code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/streaming/StreamSession.State.html" title="enum in org.apache.cassandra.streaming">StreamSession.State</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/SessionInfo.html#state">state</a></strong></code> <div class="block">Current session state</div> </td> </tr> </table> </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/SessionInfo.html#SessionInfo(java.net.InetAddress,%20int,%20java.util.Collection,%20java.util.Collection,%20org.apache.cassandra.streaming.StreamSession.State)">SessionInfo</a></strong>(java.net.InetAddress peer, int sessionIndex, java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/StreamSummary.html" title="class in org.apache.cassandra.streaming">StreamSummary</a>> receivingSummaries, java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/StreamSummary.html" title="class in org.apache.cassandra.streaming">StreamSummary</a>> sendingSummaries, <a href="../../../../org/apache/cassandra/streaming/StreamSession.State.html" title="enum in org.apache.cassandra.streaming">StreamSession.State</a> state)</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>java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/ProgressInfo.html" title="class in org.apache.cassandra.streaming">ProgressInfo</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/SessionInfo.html#getReceivingFiles()">getReceivingFiles</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/ProgressInfo.html" title="class in org.apache.cassandra.streaming">ProgressInfo</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/SessionInfo.html#getSendingFiles()">getSendingFiles</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/SessionInfo.html#getTotalFilesReceived()">getTotalFilesReceived</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/SessionInfo.html#getTotalFilesSent()">getTotalFilesSent</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/SessionInfo.html#getTotalFilesToReceive()">getTotalFilesToReceive</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/SessionInfo.html#getTotalFilesToSend()">getTotalFilesToSend</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/SessionInfo.html#getTotalSizeReceived()">getTotalSizeReceived</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/SessionInfo.html#getTotalSizeSent()">getTotalSizeSent</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/SessionInfo.html#getTotalSizeToReceive()">getTotalSizeToReceive</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/SessionInfo.html#getTotalSizeToSend()">getTotalSizeToSend</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/streaming/SessionInfo.html#isFailed()">isFailed</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/SessionInfo.html#updateProgress(org.apache.cassandra.streaming.ProgressInfo)">updateProgress</a></strong>(<a href="../../../../org/apache/cassandra/streaming/ProgressInfo.html" title="class in org.apache.cassandra.streaming">ProgressInfo</a> newProgress)</code> <div class="block">Update progress of receiving/sending file.</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">  <ul class="blockList"> <li class="blockList"><a name="field_detail">  </a> <h3>Field Detail</h3> <a name="peer">  </a> <ul class="blockList"> <li class="blockList"> <h4>peer</h4> <pre>public final java.net.InetAddress peer</pre> </li> </ul> <a name="sessionIndex">  </a> <ul class="blockList"> <li class="blockList"> <h4>sessionIndex</h4> <pre>public final int sessionIndex</pre> </li> </ul> <a name="receivingSummaries">  </a> <ul class="blockList"> <li class="blockList"> <h4>receivingSummaries</h4> <pre>public final java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/StreamSummary.html" title="class in org.apache.cassandra.streaming">StreamSummary</a>> receivingSummaries</pre> <div class="block">Immutable collection of receiving summaries</div> </li> </ul> <a name="sendingSummaries">  </a> <ul class="blockList"> <li class="blockList"> <h4>sendingSummaries</h4> <pre>public final java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/StreamSummary.html" title="class in org.apache.cassandra.streaming">StreamSummary</a>> sendingSummaries</pre> <div class="block">Immutable collection of sending summaries</div> </li> </ul> <a name="state">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>state</h4> <pre>public final <a href="../../../../org/apache/cassandra/streaming/StreamSession.State.html" title="enum in org.apache.cassandra.streaming">StreamSession.State</a> state</pre> <div class="block">Current session state</div> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="SessionInfo(java.net.InetAddress, int, java.util.Collection, java.util.Collection, org.apache.cassandra.streaming.StreamSession.State)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>SessionInfo</h4> <pre>public SessionInfo(java.net.InetAddress peer, int sessionIndex, java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/StreamSummary.html" title="class in org.apache.cassandra.streaming">StreamSummary</a>> receivingSummaries, java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/StreamSummary.html" title="class in org.apache.cassandra.streaming">StreamSummary</a>> sendingSummaries, <a href="../../../../org/apache/cassandra/streaming/StreamSession.State.html" title="enum in org.apache.cassandra.streaming">StreamSession.State</a> state)</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="isFailed()">  </a> <ul class="blockList"> <li class="blockList"> <h4>isFailed</h4> <pre>public boolean isFailed()</pre> </li> </ul> <a name="updateProgress(org.apache.cassandra.streaming.ProgressInfo)">  </a> <ul class="blockList"> <li class="blockList"> <h4>updateProgress</h4> <pre>public void updateProgress(<a href="../../../../org/apache/cassandra/streaming/ProgressInfo.html" title="class in org.apache.cassandra.streaming">ProgressInfo</a> newProgress)</pre> <div class="block">Update progress of receiving/sending file.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>newProgress</code> - new progress info</dd></dl> </li> </ul> <a name="getReceivingFiles()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getReceivingFiles</h4> <pre>public java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/ProgressInfo.html" title="class in org.apache.cassandra.streaming">ProgressInfo</a>> getReceivingFiles()</pre> </li> </ul> <a name="getSendingFiles()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getSendingFiles</h4> <pre>public java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/ProgressInfo.html" title="class in org.apache.cassandra.streaming">ProgressInfo</a>> getSendingFiles()</pre> </li> </ul> <a name="getTotalFilesReceived()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getTotalFilesReceived</h4> <pre>public long getTotalFilesReceived()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>total number of files already received.</dd></dl> </li> </ul> <a name="getTotalFilesSent()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getTotalFilesSent</h4> <pre>public long getTotalFilesSent()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>total number of files already sent.</dd></dl> </li> </ul> <a name="getTotalSizeReceived()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getTotalSizeReceived</h4> <pre>public long getTotalSizeReceived()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>total size(in bytes) already received.</dd></dl> </li> </ul> <a name="getTotalSizeSent()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getTotalSizeSent</h4> <pre>public long getTotalSizeSent()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>total size(in bytes) already sent.</dd></dl> </li> </ul> <a name="getTotalFilesToReceive()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getTotalFilesToReceive</h4> <pre>public long getTotalFilesToReceive()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>total number of files to receive in the session</dd></dl> </li> </ul> <a name="getTotalFilesToSend()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getTotalFilesToSend</h4> <pre>public long getTotalFilesToSend()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>total number of files to send in the session</dd></dl> </li> </ul> <a name="getTotalSizeToReceive()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getTotalSizeToReceive</h4> <pre>public long getTotalSizeToReceive()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>total size(in bytes) to receive in the session</dd></dl> </li> </ul> <a name="getTotalSizeToSend()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>getTotalSizeToSend</h4> <pre>public long getTotalSizeToSend()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>total size(in bytes) to send in the session</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/SessionInfo.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/ReplicationFinishedVerbHandler.html" title="class in org.apache.cassandra.streaming"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/streaming/StreamCoordinator.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/SessionInfo.html" target="_top">Frames</a></li> <li><a href="SessionInfo.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><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>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>