| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ITridentSpout.BatchCoordinator (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.trident.spout, interface: ITridentSpout, interface: BatchCoordinator"> |
| <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/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#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.trident.spout</a></div> |
| <h1 title="Interface ITridentSpout.BatchCoordinator" class="title">Interface ITridentSpout.BatchCoordinator<X></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="BatchSpoutExecutor.EmptyCoordinator.html" title="class in org.apache.storm.trident.spout">BatchSpoutExecutor.EmptyCoordinator</a></code>, <code><a href="../testing/FeederBatchSpout.FeederCoordinator.html" title="class in org.apache.storm.trident.testing">FeederBatchSpout.FeederCoordinator</a></code>, <code><a href="OpaquePartitionedTridentSpoutExecutor.Coordinator.html" title="class in org.apache.storm.trident.spout">OpaquePartitionedTridentSpoutExecutor.Coordinator</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="ITridentSpout.html" title="interface in org.apache.storm.trident.spout">ITridentSpout</a><<a href="ITridentSpout.html" title="type parameter in ITridentSpout">T</a>></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">ITridentSpout.BatchCoordinator<X></span></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="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Release any resources from this coordinator.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ITridentSpout.BatchCoordinator.html" title="type parameter in ITridentSpout.BatchCoordinator">X</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#initializeTransaction(long,X,X)" class="member-name-link">initializeTransaction</a><wbr>(long txid, |
| <a href="ITridentSpout.BatchCoordinator.html" title="type parameter in ITridentSpout.BatchCoordinator">X</a> prevMetadata, |
| <a href="ITridentSpout.BatchCoordinator.html" title="type parameter in ITridentSpout.BatchCoordinator">X</a> currMetadata)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Create metadata for this particular transaction id which has never been emitted before.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isReady(long)" class="member-name-link">isReady</a><wbr>(long txid)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">hint to Storm if the spout is ready for the transaction id.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#success(long)" class="member-name-link">success</a><wbr>(long txid)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">This attempt committed successfully, so all state for this commit and before can be safely cleaned up.</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="initializeTransaction(long,X,X)"> |
| <h3 id="initializeTransaction(long,java.lang.Object,java.lang.Object)">initializeTransaction</h3> |
| <div class="member-signature"><span class="return-type"><a href="ITridentSpout.BatchCoordinator.html" title="type parameter in ITridentSpout.BatchCoordinator">X</a></span> <span class="element-name">initializeTransaction</span><wbr><span class="parameters">(long txid, |
| <a href="ITridentSpout.BatchCoordinator.html" title="type parameter in ITridentSpout.BatchCoordinator">X</a> prevMetadata, |
| <a href="ITridentSpout.BatchCoordinator.html" title="type parameter in ITridentSpout.BatchCoordinator">X</a> currMetadata)</span></div> |
| <div class="block">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>The metadata is stored in Zookeeper. |
| |
| <p>Storm uses JSON encoding to store the metadata. Only simple types such as numbers, booleans, strings, |
| lists, and maps should be used.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>the metadata for this new transaction</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="success(long)"> |
| <h3>success</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">success</span><wbr><span class="parameters">(long txid)</span></div> |
| <div class="block">This attempt committed successfully, so all state for this commit and before can be safely cleaned up.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>txid</code> - transaction id that completed</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isReady(long)"> |
| <h3>isReady</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isReady</span><wbr><span class="parameters">(long txid)</span></div> |
| <div class="block">hint to Storm if the spout is ready for the transaction id.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>txid</code> - the id of the transaction</dd> |
| <dt>Returns:</dt> |
| <dd>true, if the spout is ready for the given transaction id</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">close</span>()</div> |
| <div class="block">Release any resources from this coordinator.</div> |
| </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> |
