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>StreamManager (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/StreamManager.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/StreamLockfile.html" title="class in org.apache.cassandra.streaming"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/streaming/StreamManager.StreamRateLimiter.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/StreamManager.html" target="_top">Frames</a></li> <li><a href="StreamManager.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><a href="#nested_class_summary">Nested</a> | </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 StreamManager" class="title">Class StreamManager</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.streaming.StreamManager</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, <a href="../../../../org/apache/cassandra/streaming/StreamManagerMBean.html" title="interface in org.apache.cassandra.streaming">StreamManagerMBean</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">StreamManager</span> extends java.lang.Object implements <a href="../../../../org/apache/cassandra/streaming/StreamManagerMBean.html" title="interface in org.apache.cassandra.streaming">StreamManagerMBean</a></pre> <div class="block">StreamManager manages currently running <a href="../../../../org/apache/cassandra/streaming/StreamResultFuture.html" title="class in org.apache.cassandra.streaming"><code>StreamResultFuture</code></a>s and provides status of all operation invoked. All stream operation should be created through this class to track streaming status and progress.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="nested_class_summary">  </a> <h3>Nested Class Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Class and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static class </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamManager.StreamRateLimiter.html" title="class in org.apache.cassandra.streaming">StreamManager.StreamRateLimiter</a></strong></code> </td> </tr> </table> </li> </ul>  <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>static <a href="../../../../org/apache/cassandra/streaming/StreamManager.html" title="class in org.apache.cassandra.streaming">StreamManager</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamManager.html#instance">instance</a></strong></code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.streaming.StreamManagerMBean">  </a> <h3>Fields inherited from interface org.apache.cassandra.streaming.<a href="../../../../org/apache/cassandra/streaming/StreamManagerMBean.html" title="interface in org.apache.cassandra.streaming">StreamManagerMBean</a></h3> <code><a href="../../../../org/apache/cassandra/streaming/StreamManagerMBean.html#OBJECT_NAME">OBJECT_NAME</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/StreamManager.html#StreamManager()">StreamManager</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/StreamManager.html#addNotificationListener(javax.management.NotificationListener,%20javax.management.NotificationFilter,%20java.lang.Object)">addNotificationListener</a></strong>(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Set<javax.management.openmbean.CompositeData></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamManager.html#getCurrentStreams()">getCurrentStreams</a></strong>()</code> <div class="block">Returns the current state of all ongoing streams.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>javax.management.MBeanNotificationInfo[]</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamManager.html#getNotificationInfo()">getNotificationInfo</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/streaming/StreamManager.StreamRateLimiter.html" title="class in org.apache.cassandra.streaming">StreamManager.StreamRateLimiter</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamManager.html#getRateLimiter(java.net.InetAddress)">getRateLimiter</a></strong>(java.net.InetAddress peer)</code> <div class="block">Gets streaming rate limiter.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><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/StreamManager.html#getReceivingStream(java.util.UUID)">getReceivingStream</a></strong>(java.util.UUID planId)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamManager.html#register(org.apache.cassandra.streaming.StreamResultFuture)">register</a></strong>(<a href="../../../../org/apache/cassandra/streaming/StreamResultFuture.html" title="class in org.apache.cassandra.streaming">StreamResultFuture</a> result)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamManager.html#registerReceiving(org.apache.cassandra.streaming.StreamResultFuture)">registerReceiving</a></strong>(<a href="../../../../org/apache/cassandra/streaming/StreamResultFuture.html" title="class in org.apache.cassandra.streaming">StreamResultFuture</a> result)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamManager.html#removeNotificationListener(javax.management.NotificationListener)">removeNotificationListener</a></strong>(javax.management.NotificationListener listener)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/streaming/StreamManager.html#removeNotificationListener(javax.management.NotificationListener,%20javax.management.NotificationFilter,%20java.lang.Object)">removeNotificationListener</a></strong>(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback)</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">  <ul class="blockList"> <li class="blockList"><a name="field_detail">  </a> <h3>Field Detail</h3> <a name="instance">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>instance</h4> <pre>public static final <a href="../../../../org/apache/cassandra/streaming/StreamManager.html" title="class in org.apache.cassandra.streaming">StreamManager</a> instance</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="StreamManager()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>StreamManager</h4> <pre>public StreamManager()</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="getRateLimiter(java.net.InetAddress)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getRateLimiter</h4> <pre>public static <a href="../../../../org/apache/cassandra/streaming/StreamManager.StreamRateLimiter.html" title="class in org.apache.cassandra.streaming">StreamManager.StreamRateLimiter</a> getRateLimiter(java.net.InetAddress peer)</pre> <div class="block">Gets streaming rate limiter. When stream_throughput_outbound_megabits_per_sec is 0, this returns rate limiter with the rate of Double.MAX_VALUE bytes per second. Rate unit is bytes per sec.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>StreamRateLimiter with rate limit set based on peer location.</dd></dl> </li> </ul> <a name="getCurrentStreams()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCurrentStreams</h4> <pre>public java.util.Set<javax.management.openmbean.CompositeData> getCurrentStreams()</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/cassandra/streaming/StreamManagerMBean.html#getCurrentStreams()">StreamManagerMBean</a></code></strong></div> <div class="block">Returns the current state of all ongoing streams.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/streaming/StreamManagerMBean.html#getCurrentStreams()">getCurrentStreams</a></code> in interface <code><a href="../../../../org/apache/cassandra/streaming/StreamManagerMBean.html" title="interface in org.apache.cassandra.streaming">StreamManagerMBean</a></code></dd> </dl> </li> </ul> <a name="register(org.apache.cassandra.streaming.StreamResultFuture)">  </a> <ul class="blockList"> <li class="blockList"> <h4>register</h4> <pre>public void register(<a href="../../../../org/apache/cassandra/streaming/StreamResultFuture.html" title="class in org.apache.cassandra.streaming">StreamResultFuture</a> result)</pre> </li> </ul> <a name="registerReceiving(org.apache.cassandra.streaming.StreamResultFuture)">  </a> <ul class="blockList"> <li class="blockList"> <h4>registerReceiving</h4> <pre>public void registerReceiving(<a href="../../../../org/apache/cassandra/streaming/StreamResultFuture.html" title="class in org.apache.cassandra.streaming">StreamResultFuture</a> result)</pre> </li> </ul> <a name="getReceivingStream(java.util.UUID)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getReceivingStream</h4> <pre>public <a href="../../../../org/apache/cassandra/streaming/StreamResultFuture.html" title="class in org.apache.cassandra.streaming">StreamResultFuture</a> getReceivingStream(java.util.UUID planId)</pre> </li> </ul> <a name="addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)">  </a> <ul class="blockList"> <li class="blockList"> <h4>addNotificationListener</h4> <pre>public void addNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>addNotificationListener</code> in interface <code>javax.management.NotificationBroadcaster</code></dd> </dl> </li> </ul> <a name="removeNotificationListener(javax.management.NotificationListener)">  </a> <ul class="blockList"> <li class="blockList"> <h4>removeNotificationListener</h4> <pre>public void removeNotificationListener(javax.management.NotificationListener listener) throws javax.management.ListenerNotFoundException</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>removeNotificationListener</code> in interface <code>javax.management.NotificationBroadcaster</code></dd> <dt><span class="strong">Throws:</span></dt> <dd><code>javax.management.ListenerNotFoundException</code></dd></dl> </li> </ul> <a name="removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)">  </a> <ul class="blockList"> <li class="blockList"> <h4>removeNotificationListener</h4> <pre>public void removeNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback) throws javax.management.ListenerNotFoundException</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>removeNotificationListener</code> in interface <code>javax.management.NotificationEmitter</code></dd> <dt><span class="strong">Throws:</span></dt> <dd><code>javax.management.ListenerNotFoundException</code></dd></dl> </li> </ul> <a name="getNotificationInfo()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>getNotificationInfo</h4> <pre>public javax.management.MBeanNotificationInfo[] getNotificationInfo()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>getNotificationInfo</code> in interface <code>javax.management.NotificationBroadcaster</code></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/StreamManager.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/StreamLockfile.html" title="class in org.apache.cassandra.streaming"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/streaming/StreamManager.StreamRateLimiter.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/StreamManager.html" target="_top">Frames</a></li> <li><a href="StreamManager.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><a href="#nested_class_summary">Nested</a> | </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>