cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
398 lines (396 loc) • 16.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>StreamCoordinator (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="StreamCoordinator (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/StreamCoordinator.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/SessionInfo.html" title="class in org.apache.cassandra.streaming"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/streaming/StreamEvent.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/StreamCoordinator.html" target="_top">Frames</a></li>
<li><a href="StreamCoordinator.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>Field | </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>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cassandra.streaming</div>
<h2 title="Class StreamCoordinator" class="title">Class StreamCoordinator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.streaming.StreamCoordinator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">StreamCoordinator</span>
extends java.lang.Object</pre>
<div class="block"><a href="../../../../org/apache/cassandra/streaming/StreamCoordinator.html" title="class in org.apache.cassandra.streaming"><code>StreamCoordinator</code></a> is a helper class that abstracts away maintaining multiple
StreamSession and ProgressInfo instances per peer.
This class coordinates multiple SessionStreams per peer in both the outgoing StreamPlan context and on the
inbound StreamResultFuture context.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/StreamCoordinator.html#StreamCoordinator(int)">StreamCoordinator</a></strong>(int connectionsPerHost)</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/StreamCoordinator.html#addSessionInfo(org.apache.cassandra.streaming.SessionInfo)">addSessionInfo</a></strong>(<a href="../../../../org/apache/cassandra/streaming/SessionInfo.html" title="class in org.apache.cassandra.streaming">SessionInfo</a> session)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamCoordinator.html#connectAllStreamSessions()">connectAllStreamSessions</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set<<a href="../../../../org/apache/cassandra/streaming/SessionInfo.html" title="class in org.apache.cassandra.streaming">SessionInfo</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamCoordinator.html#getAllSessionInfo()">getAllSessionInfo</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamCoordinator.html#getAllStreamSessions()">getAllStreamSessions</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamCoordinator.html#getOrCreateNextSession(java.net.InetAddress)">getOrCreateNextSession</a></strong>(java.net.InetAddress peer)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamCoordinator.html#getOrCreateSessionById(java.net.InetAddress,%20int)">getOrCreateSessionById</a></strong>(java.net.InetAddress peer,
int id)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set<java.net.InetAddress></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamCoordinator.html#getPeers()">getPeers</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamCoordinator.html#hasActiveSessions()">hasActiveSessions</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/StreamCoordinator.html#isReceiving()">isReceiving</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/StreamCoordinator.html#transferFiles(java.net.InetAddress,%20java.util.Collection)">transferFiles</a></strong>(java.net.InetAddress to,
java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/StreamSession.SSTableStreamingSections.html" title="class in org.apache.cassandra.streaming">StreamSession.SSTableStreamingSections</a>> sstableDetails)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamCoordinator.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> info)</code> </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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StreamCoordinator(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StreamCoordinator</h4>
<pre>public StreamCoordinator(int connectionsPerHost)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="hasActiveSessions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasActiveSessions</h4>
<pre>public boolean hasActiveSessions()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if any stream session is active</dd></dl>
</li>
</ul>
<a name="getAllStreamSessions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllStreamSessions</h4>
<pre>public java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a>> getAllStreamSessions()</pre>
</li>
</ul>
<a name="isReceiving()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReceiving</h4>
<pre>public boolean isReceiving()</pre>
</li>
</ul>
<a name="connectAllStreamSessions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectAllStreamSessions</h4>
<pre>public void connectAllStreamSessions()</pre>
</li>
</ul>
<a name="getPeers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPeers</h4>
<pre>public java.util.Set<java.net.InetAddress> getPeers()</pre>
</li>
</ul>
<a name="getOrCreateNextSession(java.net.InetAddress)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrCreateNextSession</h4>
<pre>public <a href="../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a> getOrCreateNextSession(java.net.InetAddress peer)</pre>
</li>
</ul>
<a name="getOrCreateSessionById(java.net.InetAddress, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrCreateSessionById</h4>
<pre>public <a href="../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a> getOrCreateSessionById(java.net.InetAddress peer,
int id)</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> info)</pre>
</li>
</ul>
<a name="addSessionInfo(org.apache.cassandra.streaming.SessionInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSessionInfo</h4>
<pre>public void addSessionInfo(<a href="../../../../org/apache/cassandra/streaming/SessionInfo.html" title="class in org.apache.cassandra.streaming">SessionInfo</a> session)</pre>
</li>
</ul>
<a name="getAllSessionInfo()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllSessionInfo</h4>
<pre>public java.util.Set<<a href="../../../../org/apache/cassandra/streaming/SessionInfo.html" title="class in org.apache.cassandra.streaming">SessionInfo</a>> getAllSessionInfo()</pre>
</li>
</ul>
<a name="transferFiles(java.net.InetAddress, java.util.Collection)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>transferFiles</h4>
<pre>public void transferFiles(java.net.InetAddress to,
java.util.Collection<<a href="../../../../org/apache/cassandra/streaming/StreamSession.SSTableStreamingSections.html" title="class in org.apache.cassandra.streaming">StreamSession.SSTableStreamingSections</a>> sstableDetails)</pre>
</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/StreamCoordinator.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/SessionInfo.html" title="class in org.apache.cassandra.streaming"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/streaming/StreamEvent.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/StreamCoordinator.html" target="_top">Frames</a></li>
<li><a href="StreamCoordinator.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>Field | </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>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p>
</body>
</html>