| <!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>ITridentSpout.BatchCoordinator (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="ITridentSpout.BatchCoordinator (Storm 2.4.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":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/ITridentSpout.BatchCoordinator.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/trident/spout/ITridentSpout.html" title="interface in org.apache.storm.trident.spout"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html" target="_top">Frames</a></li> |
| <li><a href="ITridentSpout.BatchCoordinator.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.trident.spout</div> |
| <h2 title="Interface ITridentSpout.BatchCoordinator" class="title">Interface ITridentSpout.BatchCoordinator<X></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/trident/spout/BatchSpoutExecutor.EmptyCoordinator.html" title="class in org.apache.storm.trident.spout">BatchSpoutExecutor.EmptyCoordinator</a>, <a href="../../../../../org/apache/storm/trident/testing/FeederBatchSpout.FeederCoordinator.html" title="class in org.apache.storm.trident.testing">FeederBatchSpout.FeederCoordinator</a>, <a href="../../../../../org/apache/storm/trident/spout/OpaquePartitionedTridentSpoutExecutor.Coordinator.html" title="class in org.apache.storm.trident.spout">OpaquePartitionedTridentSpoutExecutor.Coordinator</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html" title="interface in org.apache.storm.trident.spout">ITridentSpout</a><<a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html" title="type parameter in ITridentSpout">T</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static interface <span class="typeNameLabel">ITridentSpout.BatchCoordinator<X></span></pre> |
| </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/trident/spout/ITridentSpout.BatchCoordinator.html#close--">close</a></span>()</code> |
| <div class="block">Release any resources from this coordinator.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html" title="type parameter in ITridentSpout.BatchCoordinator">X</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html#initializeTransaction-long-X-X-">initializeTransaction</a></span>(long txid, |
| <a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html" title="type parameter in ITridentSpout.BatchCoordinator">X</a> prevMetadata, |
| <a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html" title="type parameter in ITridentSpout.BatchCoordinator">X</a> currMetadata)</code> |
| <div class="block">Create metadata for this particular transaction id which has never been emitted before.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html#isReady-long-">isReady</a></span>(long txid)</code> |
| <div class="block">hint to Storm if the spout is ready for the transaction id.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html#success-long-">success</a></span>(long txid)</code> |
| <div class="block">This attempt committed successfully, so all state for this commit and before can be safely cleaned up.</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="initializeTransaction-long-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a><a name="initializeTransaction-long-X-X-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initializeTransaction</h4> |
| <pre><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html" title="type parameter in ITridentSpout.BatchCoordinator">X</a> initializeTransaction(long txid, |
| <a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html" title="type parameter in ITridentSpout.BatchCoordinator">X</a> prevMetadata, |
| <a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html" title="type parameter in ITridentSpout.BatchCoordinator">X</a> currMetadata)</pre> |
| <div class="block"><p>Create metadata for this particular transaction id which has never been emitted before. The metadata should contain whatever is necessary to be able to replay the exact batch for the transaction at a later point.</p><p><p>The metadata is stored in Zookeeper.</p><p><p>Storm uses JSON encoding to store the metadata. Only simple types such as numbers, booleans, strings, lists, and maps should be used.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>txid</code> - The id of the transaction.</dd> |
| <dd><code>prevMetadata</code> - The metadata of the previous transaction</dd> |
| <dd><code>currMetadata</code> - The metadata for this transaction the last time it was initialized. null if this is the first attempt</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the metadata for this new transaction</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="success-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>success</h4> |
| <pre>void success(long txid)</pre> |
| <div class="block"><p>This attempt committed successfully, so all state for this commit and before can be safely cleaned up.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>txid</code> - transaction id that completed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isReady-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReady</h4> |
| <pre>boolean isReady(long txid)</pre> |
| <div class="block"><p>hint to Storm if the spout is ready for the transaction id.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>txid</code> - the id of the transaction</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true, if the spout is ready for the given transaction id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <div class="block"><p>Release any resources from this coordinator.</p></div> |
| </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/ITridentSpout.BatchCoordinator.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/trident/spout/ITridentSpout.html" title="interface in org.apache.storm.trident.spout"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html" target="_top">Frames</a></li> |
| <li><a href="ITridentSpout.BatchCoordinator.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> |
