| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>IBolt (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="IBolt (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":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.api.bolt</a></div> |
| <h2 title="Interface IBolt" class="title">Interface IBolt</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code>java.io.Serializable</code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="IRichBolt.html" title="interface in org.apache.heron.api.bolt">IRichBolt</a></code>, <code><a href="../../streamlet/IStreamletRichOperator.html" title="interface in org.apache.heron.streamlet">IStreamletRichOperator</a><R,​T></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../../integration_test/core/AggregatorBolt.html" title="class in org.apache.heron.integration_test.core">AggregatorBolt</a></code>, <code><a href="../../integration_test/core/BaseBatchBolt.html" title="class in org.apache.heron.integration_test.core">BaseBatchBolt</a></code>, <code><a href="BaseRichBolt.html" title="class in org.apache.heron.api.bolt">BaseRichBolt</a></code>, <code><a href="BasicBoltExecutor.html" title="class in org.apache.heron.api.bolt">BasicBoltExecutor</a></code>, <code><a href="../../streamlet/impl/sinks/ComplexSink.html" title="class in org.apache.heron.streamlet.impl.sinks">ComplexSink</a></code>, <code><a href="../../streamlet/impl/sinks/ConsumerSink.html" title="class in org.apache.heron.streamlet.impl.sinks">ConsumerSink</a></code>, <code><a href="../../integration_test/common/bolt/CountAggregatorBolt.html" title="class in org.apache.heron.integration_test.common.bolt">CountAggregatorBolt</a></code>, <code><a href="../../streamlet/impl/operators/FilterOperator.html" title="class in org.apache.heron.streamlet.impl.operators">FilterOperator</a></code>, <code><a href="../../streamlet/impl/operators/FlatMapOperator.html" title="class in org.apache.heron.streamlet.impl.operators">FlatMapOperator</a></code>, <code><a href="../../streamlet/impl/operators/GeneralReduceByKeyOperator.html" title="class in org.apache.heron.streamlet.impl.operators">GeneralReduceByKeyOperator</a></code>, <code><a href="../../spouts/kafka/sample/HeronKafkaSpoutSampleTopology.LoggingBolt.html" title="class in org.apache.heron.spouts.kafka.sample">HeronKafkaSpoutSampleTopology.LoggingBolt</a></code>, <code><a href="../../integration_test/common/bolt/IncrementBolt.html" title="class in org.apache.heron.integration_test.common.bolt">IncrementBolt</a></code>, <code><a href="../../integration_test/core/IntegrationTestBolt.html" title="class in org.apache.heron.integration_test.core">IntegrationTestBolt</a></code>, <code><a href="../../../../../backtype/storm/topology/IRichBoltDelegate.html" title="class in backtype.storm.topology">IRichBoltDelegate</a></code>, <code><a href="../../../storm/topology/IRichBoltDelegate.html" title="class in org.apache.storm.topology">IRichBoltDelegate</a></code>, <code><a href="../../bolts/kafka/KafkaBolt.html" title="class in org.apache.heron.bolts.kafka">KafkaBolt</a></code>, <code><a href="../../streamlet/impl/operators/KeyByOperator.html" title="class in org.apache.heron.streamlet.impl.operators">KeyByOperator</a></code>, <code><a href="../../integration_test/core/LocalAggregatorBolt.html" title="class in org.apache.heron.integration_test.core">LocalAggregatorBolt</a></code>, <code><a href="../../streamlet/impl/sinks/LogSink.html" title="class in org.apache.heron.streamlet.impl.sinks">LogSink</a></code>, <code><a href="../../integration_test/common/bolt/MapAggregatorBolt.html" title="class in org.apache.heron.integration_test.common.bolt">MapAggregatorBolt</a></code>, <code><a href="../../streamlet/impl/operators/MapOperator.html" title="class in org.apache.heron.streamlet.impl.operators">MapOperator</a></code>, <code><a href="../../integration_test/common/bolt/PartialUniquerBolt.html" title="class in org.apache.heron.integration_test.common.bolt">PartialUniquerBolt</a></code>, <code><a href="../../streamlet/impl/operators/ReduceByKeyOperator.html" title="class in org.apache.heron.streamlet.impl.operators">ReduceByKeyOperator</a></code>, <code><a href="../../streamlet/impl/operators/SplitOperator.html" title="class in org.apache.heron.streamlet.impl.operators">SplitOperator</a></code>, <code><a href="../../integration_topology_test/core/StatefulBolt.html" title="class in org.apache.heron.integration_topology_test.core">StatefulBolt</a></code>, <code><a href="../../examples/eco/StatefulConsumerBolt.html" title="class in org.apache.heron.examples.eco">StatefulConsumerBolt</a></code>, <code><a href="../../integration_topology_test/common/bolt/StatefulIdentityBolt.html" title="class in org.apache.heron.integration_topology_test.common.bolt">StatefulIdentityBolt</a></code>, <code><a href="../../integration_test/core/StatefulIntegrationTestBolt.html" title="class in org.apache.heron.integration_test.core">StatefulIntegrationTestBolt</a></code>, <code><a href="../../integration_topology_test/core/StatefulIntegrationTopologyTestBolt.html" title="class in org.apache.heron.integration_topology_test.core">StatefulIntegrationTopologyTestBolt</a></code>, <code><a href="StatefulWindowedBoltExecutor.html" title="class in org.apache.heron.api.bolt">StatefulWindowedBoltExecutor</a></code>, <code><a href="../../streamlet/impl/operators/StreamletOperator.html" title="class in org.apache.heron.streamlet.impl.operators">StreamletOperator</a></code>, <code><a href="../../resource/TestBolt.html" title="class in org.apache.heron.resource">TestBolt</a></code>, <code><a href="../../resource/TestStatefulBolt.html" title="class in org.apache.heron.resource">TestStatefulBolt</a></code>, <code><a href="../../resource/TestTwoPhaseStatefulBolt.html" title="class in org.apache.heron.resource">TestTwoPhaseStatefulBolt</a></code>, <code><a href="../../streamlet/impl/operators/TransformOperator.html" title="class in org.apache.heron.streamlet.impl.operators">TransformOperator</a></code>, <code><a href="../../streamlet/impl/operators/UnionOperator.html" title="class in org.apache.heron.streamlet.impl.operators">UnionOperator</a></code>, <code><a href="WindowedBoltExecutor.html" title="class in org.apache.heron.api.bolt">WindowedBoltExecutor</a></code>, <code><a href="../../integration_test/common/bolt/WordCountBolt.html" title="class in org.apache.heron.integration_test.common.bolt">WordCountBolt</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">IBolt</span> |
| extends java.io.Serializable</pre> |
| <div class="block">An IBolt represents a component that takes tuples as input and produces tuples |
| as output. An IBolt can do everything from filtering to joining to functions |
| to aggregations. It does not have to process a tuple immediately and may |
| hold onto tuples to process later. |
| <p> |
| <p>A bolt's lifecycle is as follows:</p> |
| <p> |
| <p>IBolt object created on client machine. The IBolt is serialized into the topology |
| (using Java serialization) and submitted to the primary machine of the cluster (Nimbus). |
| Nimbus then launches workers which deserialize the object, call prepare on it, and then |
| start processing tuples.</p> |
| <p> |
| <p>If you want to parameterize an IBolt, you should set the parameter's through its |
| constructor and save the parameterization state as instance variables (which will |
| then get serialized and shipped to every task executing this bolt across the cluster).</p> |
| <p> |
| <p>When defining bolts in Java, you should use the IRichBolt interface which adds |
| necessary methods for using the Java TopologyBuilder API.</p></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="#cleanup()">cleanup</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Called when an IBolt is going to be shutdown.</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="#execute(org.apache.heron.api.tuple.Tuple)">execute</a></span>​(<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a> input)</code></th> |
| <td class="colLast"> |
| <div class="block">Process a single tuple of input.</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="#prepare(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.bolt.OutputCollector)">prepare</a></span>​(java.util.Map<java.lang.String,​java.lang.Object> heronConf, |
| <a href="../topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a> context, |
| <a href="OutputCollector.html" title="class in org.apache.heron.api.bolt">OutputCollector</a> collector)</code></th> |
| <td class="colLast"> |
| <div class="block">Called when a task for this component is initialized within a worker on the cluster.</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="prepare(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.bolt.OutputCollector)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre class="methodSignature">void prepare​(java.util.Map<java.lang.String,​java.lang.Object> heronConf, |
| <a href="../topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a> context, |
| <a href="OutputCollector.html" title="class in org.apache.heron.api.bolt">OutputCollector</a> collector)</pre> |
| <div class="block">Called when a task for this component is initialized within a worker on the cluster. |
| It provides the bolt with the environment in which the bolt executes. |
| <p> |
| <p>This includes the:</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>heronConf</code> - The Heron configuration for this bolt. This is the configuration provided to the topology merged in with cluster configuration on this machine.</dd> |
| <dd><code>context</code> - This object can be used to get information about this task's place within the topology, including the task id and component id of this task, input and output information, etc.</dd> |
| <dd><code>collector</code> - The collector is used to emit tuples from this bolt. Tuples can be emitted at any time, including the prepare and cleanup methods. The collector is thread-safe and should be saved as an instance variable of this bolt object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="execute(org.apache.heron.api.tuple.Tuple)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre class="methodSignature">void execute​(<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a> input)</pre> |
| <div class="block">Process a single tuple of input. The Tuple object contains metadata on it |
| about which component/stream/task it came from. The values of the Tuple can |
| be accessed using Tuple#getValue. The IBolt does not have to process the Tuple |
| immediately. It is perfectly fine to hang onto a tuple and process it later |
| (for instance, to do an aggregation or join). |
| <p> |
| <p>Tuples should be emitted using the OutputCollector provided through the prepare method. |
| It is required that all input tuples are acked or failed at some point using the OutputCollector. |
| Otherwise, Heron will be unable to determine when tuples coming off the spouts |
| have been completed.</p> |
| <p> |
| <p>For the common case of acking an input tuple at the end of the execute method, |
| see IBasicBolt which automates this.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>input</code> - The input tuple to be processed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="cleanup()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>cleanup</h4> |
| <pre class="methodSignature">void cleanup()</pre> |
| <div class="block">Called when an IBolt is going to be shutdown. There is no guarentee that cleanup |
| will be called, because the supervisor kill -9's worker processes on the cluster. |
| <p> |
| <p>The one context where cleanup is guaranteed to be called is when a topology |
| is killed when running Heron in simulator.</p></div> |
| </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> |
