| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>IStrategy (Storm 2.6.2 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.storm.scheduler.resource.strategies.scheduling, interface: IStrategy"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.scheduler.resource.strategies.scheduling</a></div> |
| <h1 title="Interface IStrategy" class="title">Interface IStrategy</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="BaseResourceAwareStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">BaseResourceAwareStrategy</a></code>, <code><a href="ConstraintSolverStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ConstraintSolverStrategy</a></code>, <code><a href="DefaultResourceAwareStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">DefaultResourceAwareStrategy</a></code>, <code><a href="DefaultResourceAwareStrategyOld.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">DefaultResourceAwareStrategyOld</a></code>, <code><a href="GenericResourceAwareStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">GenericResourceAwareStrategy</a></code>, <code><a href="GenericResourceAwareStrategyOld.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">GenericResourceAwareStrategyOld</a></code>, <code><a href="RoundRobinResourceAwareStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">RoundRobinResourceAwareStrategy</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">IStrategy</span></div> |
| <div class="block">An interface to for implementing different scheduling strategies for the resource aware scheduling. |
| Scheduler should call <a href="#prepare(java.util.Map)"><code>prepare(Map)</code></a> followed by <a href="#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="BaseResourceAwareStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><code>BaseResourceAwareStrategy</code></a>. |
| Subclasses classes should extend <a href="BaseResourceAwareStrategy.html#%3Cinit%3E()"><code>BaseResourceAwareStrategy()</code></a> |
| in their constructors (as in <a href="GenericResourceAwareStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><code>GenericResourceAwareStrategy</code></a>, <a href="DefaultResourceAwareStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><code>DefaultResourceAwareStrategy</code></a> |
| and <a href="ConstraintSolverStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><code>ConstraintSolverStrategy</code></a>). |
| </p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#prepare(java.util.Map)" class="member-name-link">prepare</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> config)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Prepare the Strategy for scheduling.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../SchedulingResult.html" title="class in org.apache.storm.scheduler.resource">SchedulingResult</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#schedule(org.apache.storm.scheduler.Cluster,org.apache.storm.scheduler.TopologyDetails)" class="member-name-link">schedule</a><wbr>(<a href="../../../Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a> schedulingState, |
| <a href="../../../TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> td)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">This method is invoked to calculate a scheduling for topology td.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="prepare(java.util.Map)"> |
| <h3>prepare</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">prepare</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> config)</span></div> |
| <div class="block">Prepare the Strategy for scheduling.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>config</code> - the cluster configuration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="schedule(org.apache.storm.scheduler.Cluster,org.apache.storm.scheduler.TopologyDetails)"> |
| <h3>schedule</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../SchedulingResult.html" title="class in org.apache.storm.scheduler.resource">SchedulingResult</a></span> <span class="element-name">schedule</span><wbr><span class="parameters">(<a href="../../../Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a> schedulingState, |
| <a href="../../../TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> td)</span></div> |
| <div class="block">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></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>schedulingState</code> - the current state of the cluster</dd> |
| <dd><code>td</code> - the topology to schedule for</dd> |
| <dt>Returns:</dt> |
| <dd>returns a SchedulingResult object containing SchedulingStatus object to indicate whether scheduling is |
| successful.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |