| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>IStrategy (Storm 2.4.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="IStrategy (Storm 2.4.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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/IStrategy.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/storm/scheduler/resource/strategies/scheduling/GenericResourceAwareStrategyOld.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/storm/scheduler/resource/strategies/scheduling/IStrategy.html" target="_top">Frames</a></li> |
| <li><a href="IStrategy.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.storm.scheduler.resource.strategies.scheduling</div> |
| <h2 title="Interface IStrategy" class="title">Interface IStrategy</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/BaseResourceAwareStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">BaseResourceAwareStrategy</a>, <a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/ConstraintSolverStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ConstraintSolverStrategy</a>, <a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/DefaultResourceAwareStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">DefaultResourceAwareStrategy</a>, <a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/DefaultResourceAwareStrategyOld.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">DefaultResourceAwareStrategyOld</a>, <a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/GenericResourceAwareStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">GenericResourceAwareStrategy</a>, <a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/GenericResourceAwareStrategyOld.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">GenericResourceAwareStrategyOld</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">IStrategy</span></pre> |
| <div class="block"><p>An interface to for implementing different scheduling strategies for the resource aware scheduling. Scheduler should call <a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/IStrategy.html#prepare-java.util.Map-"><code>prepare(Map)</code></a> followed by <a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/IStrategy.html#schedule-org.apache.storm.scheduler.Cluster-org.apache.storm.scheduler.TopologyDetails-"><code>schedule(Cluster, TopologyDetails)</code></a>. <p> A fully functioning implementation is in the abstract class <a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/BaseResourceAwareStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><code>BaseResourceAwareStrategy</code></a>. Subclasses classes should extend <a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/BaseResourceAwareStrategy.html#BaseResourceAwareStrategy--"><code>BaseResourceAwareStrategy.BaseResourceAwareStrategy()</code></a> in their constructors (as in <a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/GenericResourceAwareStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><code>GenericResourceAwareStrategy</code></a>, <a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/DefaultResourceAwareStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><code>DefaultResourceAwareStrategy</code></a> and <a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/ConstraintSolverStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><code>ConstraintSolverStrategy</code></a>). </p></p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/IStrategy.html#prepare-java.util.Map-">prepare</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> config)</code> |
| <div class="block">Prepare the Strategy for scheduling.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/storm/scheduler/resource/SchedulingResult.html" title="class in org.apache.storm.scheduler.resource">SchedulingResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/IStrategy.html#schedule-org.apache.storm.scheduler.Cluster-org.apache.storm.scheduler.TopologyDetails-">schedule</a></span>(<a href="../../../../../../../org/apache/storm/scheduler/Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a> schedulingState, |
| <a href="../../../../../../../org/apache/storm/scheduler/TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> td)</code> |
| <div class="block">This method is invoked to calculate a scheduling for topology td.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="prepare-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre>void prepare(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> config)</pre> |
| <div class="block"><p>Prepare the Strategy for scheduling.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - the cluster configuration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="schedule-org.apache.storm.scheduler.Cluster-org.apache.storm.scheduler.TopologyDetails-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>schedule</h4> |
| <pre><a href="../../../../../../../org/apache/storm/scheduler/resource/SchedulingResult.html" title="class in org.apache.storm.scheduler.resource">SchedulingResult</a> schedule(<a href="../../../../../../../org/apache/storm/scheduler/Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a> schedulingState, |
| <a href="../../../../../../../org/apache/storm/scheduler/TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> td)</pre> |
| <div class="block"><p>This method is invoked to calculate a scheduling for topology td. Cluster will reject any changes that are not for the given topology. Any changes made to the cluster will be committed if the scheduling is successful. <p> NOTE: scheduling occurs as a runnable in an interruptable thread. Scheduling should consider being interrupted if long running. </p></p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schedulingState</code> - the current state of the cluster</dd> |
| <dd><code>td</code> - the topology to schedule for</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>returns a SchedulingResult object containing SchedulingStatus object to indicate whether scheduling is successful.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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/IStrategy.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 class="aboutLanguage"><script type="text/javascript" src="../../../../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/GenericResourceAwareStrategyOld.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/storm/scheduler/resource/strategies/scheduling/ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/storm/scheduler/resource/strategies/scheduling/IStrategy.html" target="_top">Frames</a></li> |
| <li><a href="IStrategy.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
