| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>IInstance (Heron Java API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-03-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/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="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="IInstance (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":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"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.heron.instance</a></div> |
| <h2 title="Interface IInstance" class="title">Interface IInstance</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="bolt/BoltInstance.html" title="class in org.apache.heron.instance.bolt">BoltInstance</a></code>, <code><a href="../simulator/instance/BoltInstance.html" title="class in org.apache.heron.simulator.instance">BoltInstance</a></code>, <code><a href="spout/SpoutInstance.html" title="class in org.apache.heron.instance.spout">SpoutInstance</a></code>, <code><a href="../simulator/instance/SpoutInstance.html" title="class in org.apache.heron.simulator.instance">SpoutInstance</a></code></dd> |
| </dl> |
| <hr> |
| <pre><a href="../classification/InterfaceAudience.Private.html" title="annotation in org.apache.heron.classification">@Private</a> |
| <a href="../classification/InterfaceStability.Evolving.html" title="annotation in org.apache.heron.classification">@Evolving</a> |
| public interface <span class="typeNameLabel">IInstance</span></pre> |
| <div class="block">Implementing this interface allows an object to be target of HeronInstance</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#activate()">activate</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Activate the instance</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clean()">clean</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Clean the instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deactivate()">deactivate</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Deactivate the instance</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#init(org.apache.heron.api.state.State)">init</a></span>​(<a href="../api/state/State.html" title="interface in org.apache.heron.api.state">State</a><java.io.Serializable,​java.io.Serializable> state)</code></th> |
| <td class="colLast"> |
| <div class="block">Initialize the instance.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onCheckpointSaved(java.lang.String)">onCheckpointSaved</a></span>​(java.lang.String checkpointId)</code></th> |
| <td class="colLast"> |
| <div class="block">Inform the Instance that a particular checkpoint has become globally consistent</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#persistState(java.lang.String)">persistState</a></span>​(java.lang.String checkpointId)</code></th> |
| <td class="colLast"> |
| <div class="block">Save the state and send it out for persistence</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#preRestore(java.lang.String)">preRestore</a></span>​(java.lang.String checkpointId)</code></th> |
| <td class="colLast"> |
| <div class="block">Inform the Instance that the framework will clean, stop, and delete the instance |
| in order to restore its state to a previously-saved checkpoint.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readTuplesAndExecute(org.apache.heron.common.basics.Communicator)">readTuplesAndExecute</a></span>​(<a href="../common/basics/Communicator.html" title="class in org.apache.heron.common.basics">Communicator</a><com.google.protobuf.Message> inQueue)</code></th> |
| <td class="colLast"> |
| <div class="block">Read tuples from a queue and process the tuples</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shutdown()">shutdown</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Destroy the whole IInstance.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#start()">start</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Start the execution of the IInstance</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#update(org.apache.heron.common.utils.misc.PhysicalPlanHelper)">update</a></span>​(<a href="../common/utils/misc/PhysicalPlanHelper.html" title="class in org.apache.heron.common.utils.misc">PhysicalPlanHelper</a> physicalPlanHelper)</code></th> |
| <td class="colLast"> |
| <div class="block">Update the instance.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="init(org.apache.heron.api.state.State)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre class="methodSignature">void init​(<a href="../api/state/State.html" title="interface in org.apache.heron.api.state">State</a><java.io.Serializable,​java.io.Serializable> state)</pre> |
| <div class="block">Initialize the instance. If it's a stateful topology, |
| the provided state will be used for initialization. |
| For non-stateful topology, the state will be ignored.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>state</code> - used for stateful topology to initialize the instance state</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="start()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre class="methodSignature">void start()</pre> |
| <div class="block">Start the execution of the IInstance</div> |
| </li> |
| </ul> |
| <a id="clean()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clean</h4> |
| <pre class="methodSignature">void clean()</pre> |
| <div class="block">Clean the instance. After it's called, the IInstance |
| will be still alive but with an empty state. Before |
| starting the IInstance again, an `init()` call is needed |
| to initialize the instance properly.</div> |
| </li> |
| </ul> |
| <a id="preRestore(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>preRestore</h4> |
| <pre class="methodSignature">void preRestore​(java.lang.String checkpointId)</pre> |
| <div class="block">Inform the Instance that the framework will clean, stop, and delete the instance |
| in order to restore its state to a previously-saved checkpoint.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>checkpointId</code> - the ID of the checkpoint the instance will be restoring to</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onCheckpointSaved(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onCheckpointSaved</h4> |
| <pre class="methodSignature">void onCheckpointSaved​(java.lang.String checkpointId)</pre> |
| <div class="block">Inform the Instance that a particular checkpoint has become globally consistent</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>checkpointId</code> - the ID of the checkpoint that became globally consistent</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="shutdown()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shutdown</h4> |
| <pre class="methodSignature">void shutdown()</pre> |
| <div class="block">Destroy the whole IInstance. |
| Notice: It should only be called when the whole program is |
| exiting. And in fact, this method should never be called.</div> |
| </li> |
| </ul> |
| <a id="readTuplesAndExecute(org.apache.heron.common.basics.Communicator)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readTuplesAndExecute</h4> |
| <pre class="methodSignature">void readTuplesAndExecute​(<a href="../common/basics/Communicator.html" title="class in org.apache.heron.common.basics">Communicator</a><com.google.protobuf.Message> inQueue)</pre> |
| <div class="block">Read tuples from a queue and process the tuples</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>inQueue</code> - the queue to read tuples from</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="activate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>activate</h4> |
| <pre class="methodSignature">void activate()</pre> |
| <div class="block">Activate the instance</div> |
| </li> |
| </ul> |
| <a id="deactivate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deactivate</h4> |
| <pre class="methodSignature">void deactivate()</pre> |
| <div class="block">Deactivate the instance</div> |
| </li> |
| </ul> |
| <a id="update(org.apache.heron.common.utils.misc.PhysicalPlanHelper)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre class="methodSignature">void update​(<a href="../common/utils/misc/PhysicalPlanHelper.html" title="class in org.apache.heron.common.utils.misc">PhysicalPlanHelper</a> physicalPlanHelper)</pre> |
| <div class="block">Update the instance. This happens when the physical plan changes (e.g., during a scaling event)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>physicalPlanHelper</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="persistState(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>persistState</h4> |
| <pre class="methodSignature">void persistState​(java.lang.String checkpointId)</pre> |
| <div class="block">Save the state and send it out for persistence</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>checkpointId</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |