| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>IRichSpout (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="IRichSpout (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| 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>Method</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.spout</a></div> |
| <h2 title="Interface IRichSpout" class="title">Interface IRichSpout</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></code>, <code><a href="ISpout.html" title="interface in org.apache.heron.api.spout">ISpout</a></code>, <code>java.io.Serializable</code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../../integration_test/common/spout/ABSpout.html" title="class in org.apache.heron.integration_test.common.spout">ABSpout</a></code>, <code><a href="BaseRichSpout.html" title="class in org.apache.heron.api.spout">BaseRichSpout</a></code>, <code><a href="../../streamlet/impl/sources/ComplexSource.html" title="class in org.apache.heron.streamlet.impl.sources">ComplexSource</a></code>, <code><a href="../../integration_test/topology/serialization/CustomSpout.html" title="class in org.apache.heron.integration_test.topology.serialization">CustomSpout</a></code>, <code><a href="../../integration_test/common/spout/HdfsStringSpout.html" title="class in org.apache.heron.integration_test.common.spout">HdfsStringSpout</a></code>, <code><a href="../../scheduler/yarn/HeronExecutorTaskTest.TestSpout.html" title="class in org.apache.heron.scheduler.yarn">HeronExecutorTaskTest.TestSpout</a></code>, <code><a href="../HeronSubmitterTest.TestSpout.html" title="class in org.apache.heron.api">HeronSubmitterTest.TestSpout</a></code>, <code><a href="../HeronSubmitterTest.TestSpout2.html" title="class in org.apache.heron.api">HeronSubmitterTest.TestSpout2</a></code>, <code><a href="../../integration_test/core/IntegrationTestSpout.html" title="class in org.apache.heron.integration_test.core">IntegrationTestSpout</a></code>, <code><a href="../../../../../backtype/storm/topology/IRichSpoutDelegate.html" title="class in backtype.storm.topology">IRichSpoutDelegate</a></code>, <code><a href="../../../storm/topology/IRichSpoutDelegate.html" title="class in org.apache.storm.topology">IRichSpoutDelegate</a></code>, <code><a href="../../spouts/kafka/KafkaSpout.html" title="class in org.apache.heron.spouts.kafka">KafkaSpout</a></code>, <code><a href="../../integration_test/common/spout/LocalFileSpout.html" title="class in org.apache.heron.integration_test.common.spout">LocalFileSpout</a></code>, <code><a href="../../integration_test/common/spout/PausedLocalFileSpout.html" title="class in org.apache.heron.integration_test.common.spout">PausedLocalFileSpout</a></code>, <code><a href="../../integration_topology_test/common/spout/StatefulABSpout.html" title="class in org.apache.heron.integration_topology_test.common.spout">StatefulABSpout</a></code>, <code><a href="../../integration_test/core/StatefulIntegrationTestSpout.html" title="class in org.apache.heron.integration_test.core">StatefulIntegrationTestSpout</a></code>, <code><a href="../../integration_topology_test/core/StatefulIntegrationTopologyTestSpout.html" title="class in org.apache.heron.integration_topology_test.core">StatefulIntegrationTopologyTestSpout</a></code>, <code><a href="../../examples/eco/StatefulNumberSpout.html" title="class in org.apache.heron.examples.eco">StatefulNumberSpout</a></code>, <code><a href="../../examples/eco/StatefulRandomIntSpout.html" title="class in org.apache.heron.examples.eco">StatefulRandomIntSpout</a></code>, <code><a href="../../integration_topology_test/core/StatefulSpout.html" title="class in org.apache.heron.integration_topology_test.core">StatefulSpout</a></code>, <code><a href="../../integration_test/topology/windowing/stateful/StatefulWindowingTest.RandomSentenceSpout.html" title="class in org.apache.heron.integration_test.topology.windowing.stateful">StatefulWindowingTest.RandomSentenceSpout</a></code>, <code><a href="../../streamlet/impl/sources/StreamletSource.html" title="class in org.apache.heron.streamlet.impl.sources">StreamletSource</a></code>, <code><a href="../../streamlet/impl/sources/SupplierSource.html" title="class in org.apache.heron.streamlet.impl.sources">SupplierSource</a></code>, <code><a href="../../resource/TestSpout.html" title="class in org.apache.heron.resource">TestSpout</a></code>, <code><a href="../../resource/TestStatefulSpout.html" title="class in org.apache.heron.resource">TestStatefulSpout</a></code>, <code><a href="../../resource/TestTwoPhaseStatefulSpout.html" title="class in org.apache.heron.resource">TestTwoPhaseStatefulSpout</a></code>, <code><a href="../../integration_test/topology/serialization/UnserializableCustomSpout.html" title="class in org.apache.heron.integration_test.topology.serialization">UnserializableCustomSpout</a></code>, <code><a href="../../integration_test/topology/windowing/WindowTestBase.IncrementingSpout.html" title="class in org.apache.heron.integration_test.topology.windowing">WindowTestBase.IncrementingSpout</a></code>, <code><a href="../../examples/eco/WordSpout.html" title="class in org.apache.heron.examples.eco">WordSpout</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">IRichSpout</span> |
| extends <a href="ISpout.html" title="interface in org.apache.heron.api.spout">ISpout</a>, <a href="../topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></pre> |
| <div class="block">When writing topologies using Java, <a href="../bolt/IRichBolt.html" title="interface in org.apache.heron.api.bolt"><code>IRichBolt</code></a> and |
| <a href="IRichSpout.html" title="interface in org.apache.heron.api.spout"><code>IRichSpout</code></a> are the main interfaces |
| to use to implement components of the topology.</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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.api.topology.IComponent"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.heron.api.topology.<a href="../topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></h3> |
| <code><a href="../topology/IComponent.html#declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">declareOutputFields</a>, <a href="../topology/IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.api.spout.ISpout"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.heron.api.spout.<a href="ISpout.html" title="interface in org.apache.heron.api.spout">ISpout</a></h3> |
| <code><a href="ISpout.html#ack(java.lang.Object)">ack</a>, <a href="ISpout.html#activate()">activate</a>, <a href="ISpout.html#close()">close</a>, <a href="ISpout.html#deactivate()">deactivate</a>, <a href="ISpout.html#fail(java.lang.Object)">fail</a>, <a href="ISpout.html#nextTuple()">nextTuple</a>, <a href="ISpout.html#open(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.spout.SpoutOutputCollector)">open</a></code></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>Method</li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
