blob: b29454470665350166ee0252a6122c30e5363517 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>IRichSpout (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.topology, interface: IRichSpout">
<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 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/IRichSpout.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</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>&nbsp;<a href="package-summary.html">org.apache.storm.topology</a></div>
<h1 title="Interface IRichSpout" class="title">Interface IRichSpout</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code>, <code><a href="../spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../starter/AnchoredWordCount.RandomSentenceSpout.html" title="class in org.apache.storm.starter">AnchoredWordCount.RandomSentenceSpout</a></code>, <code><a href="base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a></code>, <code><a href="../starter/BlobStoreAPIWordCountTopology.RandomSentenceSpout.html" title="class in org.apache.storm.starter">BlobStoreAPIWordCountTopology.RandomSentenceSpout</a></code>, <code><a href="../hive/bolt/BucketTestHiveTopology.UserDataSpout.html" title="class in org.apache.storm.hive.bolt">BucketTestHiveTopology.UserDataSpout</a></code>, <code><a href="../spout/CheckpointSpout.html" title="class in org.apache.storm.spout">CheckpointSpout</a></code>, <code><a href="../clojure/ClojureSpout.html" title="class in org.apache.storm.clojure">ClojureSpout</a></code>, <code><a href="../perf/spout/ConstSpout.html" title="class in org.apache.storm.perf.spout">ConstSpout</a></code>, <code><a href="../drpc/DRPCSpout.html" title="class in org.apache.storm.drpc">DRPCSpout</a></code>, <code><a href="../elasticsearch/bolt/EsIndexTopology.UserDataSpout.html" title="class in org.apache.storm.elasticsearch.bolt">EsIndexTopology.UserDataSpout</a></code>, <code><a href="../ExclamationTopology.FixedOrderWordSpout.html" title="class in org.apache.storm">ExclamationTopology.FixedOrderWordSpout</a></code>, <code><a href="../starter/FastWordCountTopology.FastRandomSentenceSpout.html" title="class in org.apache.storm.starter">FastWordCountTopology.FastRandomSentenceSpout</a></code>, <code><a href="../testing/FeederSpout.html" title="class in org.apache.storm.testing">FeederSpout</a></code>, <code><a href="../perf/spout/FileReadSpout.html" title="class in org.apache.storm.perf.spout">FileReadSpout</a></code>, <code><a href="../testing/FixedTupleSpout.html" title="class in org.apache.storm.testing">FixedTupleSpout</a></code>, <code><a href="../flux/wrappers/spouts/FluxShellSpout.html" title="class in org.apache.storm.flux.wrappers.spouts">FluxShellSpout</a></code>, <code><a href="../hdfs/bolt/HdfsFileTopology.SentenceSpout.html" title="class in org.apache.storm.hdfs.bolt">HdfsFileTopology.SentenceSpout</a></code>, <code><a href="../hdfs/spout/HdfsSpout.html" title="class in org.apache.storm.hdfs.spout">HdfsSpout</a></code>, <code><a href="../hive/bolt/HiveTopology.UserDataSpout.html" title="class in org.apache.storm.hive.bolt">HiveTopology.UserDataSpout</a></code>, <code><a href="../hive/bolt/HiveTopologyPartitioned.UserDataSpout.html" title="class in org.apache.storm.hive.bolt">HiveTopologyPartitioned.UserDataSpout</a></code>, <code><a href="../st/topology/window/IncrementingSpout.html" title="class in org.apache.storm.st.topology.window">IncrementingSpout</a></code>, <code><a href="../starter/InOrderDeliveryTest.InOrderSpout.html" title="class in org.apache.storm.starter">InOrderDeliveryTest.InOrderSpout</a></code>, <code><a href="../jms/spout/JmsSpout.html" title="class in org.apache.storm.jms.spout">JmsSpout</a></code>, <code><a href="../kafka/spout/KafkaSpout.html" title="class in org.apache.storm.kafka.spout">KafkaSpout</a></code>, <code><a href="../lambda/LambdaSpout.html" title="class in org.apache.storm.lambda">LambdaSpout</a></code>, <code><a href="../loadgen/LoadSpout.html" title="class in org.apache.storm.loadgen">LoadSpout</a></code>, <code><a href="../trident/topology/MasterBatchCoordinator.html" title="class in org.apache.storm.trident.topology">MasterBatchCoordinator</a></code>, <code><a href="../testing/PythonShellMetricsSpout.html" title="class in org.apache.storm.testing">PythonShellMetricsSpout</a></code>, <code><a href="../starter/spout/RandomIntegerSpout.html" title="class in org.apache.storm.starter.spout">RandomIntegerSpout</a></code>, <code><a href="../starter/spout/RandomSentenceSpout.html" title="class in org.apache.storm.starter.spout">RandomSentenceSpout</a></code>, <code><a href="../starter/spout/RandomSentenceSpout.TimeStamped.html" title="class in org.apache.storm.starter.spout">RandomSentenceSpout.TimeStamped</a></code>, <code><a href="../clojure/RichShellSpout.html" title="class in org.apache.storm.clojure">RichShellSpout</a></code>, <code><a href="../trident/spout/RichSpoutBatchTriggerer.html" title="class in org.apache.storm.trident.spout">RichSpoutBatchTriggerer</a></code>, <code><a href="../hdfs/bolt/SequenceFileTopology.SentenceSpout.html" title="class in org.apache.storm.hdfs.bolt">SequenceFileTopology.SentenceSpout</a></code>, <code><a href="../sql/runtime/datasource/socket/spout/SocketSpout.html" title="class in org.apache.storm.sql.runtime.datasource.socket.spout">SocketSpout</a></code>, <code><a href="../testing/SpoutTracker.html" title="class in org.apache.storm.testing">SpoutTracker</a></code>, <code><a href="../perf/spout/StringGenSpout.html" title="class in org.apache.storm.perf.spout">StringGenSpout</a></code>, <code><a href="../testing/TestEventLogSpout.html" title="class in org.apache.storm.testing">TestEventLogSpout</a></code>, <code><a href="../testing/TestPlannerSpout.html" title="class in org.apache.storm.testing">TestPlannerSpout</a></code>, <code><a href="../testing/TestWordSpout.html" title="class in org.apache.storm.testing">TestWordSpout</a></code>, <code><a href="../loadgen/ThroughputVsLatency.FastRandomSentenceSpout.html" title="class in org.apache.storm.loadgen">ThroughputVsLatency.FastRandomSentenceSpout</a></code>, <code><a href="../st/topology/window/TimeDataIncrementingSpout.html" title="class in org.apache.storm.st.topology.window">TimeDataIncrementingSpout</a></code>, <code><a href="../jdbc/spout/UserSpout.html" title="class in org.apache.storm.jdbc.spout">UserSpout</a></code>, <code><a href="../starter/WordCountTopologyNode.RandomSentence.html" title="class in org.apache.storm.starter">WordCountTopologyNode.RandomSentence</a></code>, <code><a href="../perf/spout/WordGenSpout.html" title="class in org.apache.storm.perf.spout">WordGenSpout</a></code>, <code><a href="../redis/topology/WordSpout.html" title="class in org.apache.storm.redis.topology">WordSpout</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">IRichSpout</span><span class="extends-implements">
extends <a href="../spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a>, <a href="IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></span></div>
<div class="block">When writing topologies using Java, <a href="IRichBolt.html" title="interface in org.apache.storm.topology"><code>IRichBolt</code></a> and <a href="IRichSpout.html" title="interface in org.apache.storm.topology"><code>IRichSpout</code></a> are the main interfaces to use to implement components of
the topology.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.storm.topology.IComponent">Methods inherited from interface&nbsp;org.apache.storm.topology.<a href="IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></h3>
<code><a href="IComponent.html#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">declareOutputFields</a>, <a href="IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.storm.spout.ISpout">Methods inherited from interface&nbsp;org.apache.storm.spout.<a href="../spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></h3>
<code><a href="../spout/ISpout.html#ack(java.lang.Object)">ack</a>, <a href="../spout/ISpout.html#activate()">activate</a>, <a href="../spout/ISpout.html#close()">close</a>, <a href="../spout/ISpout.html#deactivate()">deactivate</a>, <a href="../spout/ISpout.html#fail(java.lang.Object)">fail</a>, <a href="../spout/ISpout.html#nextTuple()">nextTuple</a>, <a href="../spout/ISpout.html#open(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.spout.SpoutOutputCollector)">open</a></code></div>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>