Google Git
Sign in
apache / storm-site / 96a3de20b80697048cf32577d9eaa97f69519756 / . / releases / 2.4.0 / javadocs / org / apache / storm / topology / IRichSpout.html
blob: 25ca8ee18fea0d113bd8202e6de216ab849de653 [file] [log] [blame]
<!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>IRichSpout (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="IRichSpout (Storm 2.4.0 API)";
}
}
catch(err) {
}
//-->
</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/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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/storm/topology/IRichBolt.html" title="interface in org.apache.storm.topology"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/storm/topology/IRichStateSpout.html" title="interface in org.apache.storm.topology"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/topology/IRichSpout.html" target="_top">Frames</a></li>
<li><a href="IRichSpout.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</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.topology</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><a href="../../../../org/apache/storm/topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a>, <a href="../../../../org/apache/storm/spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/storm/starter/AnchoredWordCount.RandomSentenceSpout.html" title="class in org.apache.storm.starter">AnchoredWordCount.RandomSentenceSpout</a>, <a href="../../../../org/apache/storm/topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a>, <a href="../../../../org/apache/storm/starter/BlobStoreAPIWordCountTopology.RandomSentenceSpout.html" title="class in org.apache.storm.starter">BlobStoreAPIWordCountTopology.RandomSentenceSpout</a>, <a href="../../../../org/apache/storm/hive/bolt/BucketTestHiveTopology.UserDataSpout.html" title="class in org.apache.storm.hive.bolt">BucketTestHiveTopology.UserDataSpout</a>, <a href="../../../../org/apache/storm/spout/CheckpointSpout.html" title="class in org.apache.storm.spout">CheckpointSpout</a>, <a href="../../../../org/apache/storm/clojure/ClojureSpout.html" title="class in org.apache.storm.clojure">ClojureSpout</a>, <a href="../../../../org/apache/storm/perf/spout/ConstSpout.html" title="class in org.apache.storm.perf.spout">ConstSpout</a>, <a href="../../../../org/apache/storm/drpc/DRPCSpout.html" title="class in org.apache.storm.drpc">DRPCSpout</a>, <a href="../../../../org/apache/storm/elasticsearch/bolt/EsIndexTopology.UserDataSpout.html" title="class in org.apache.storm.elasticsearch.bolt">EsIndexTopology.UserDataSpout</a>, <a href="../../../../org/apache/storm/eventhubs/spout/EventHubSpout.html" title="class in org.apache.storm.eventhubs.spout">EventHubSpout</a>, <a href="../../../../org/apache/storm/ExclamationTopology.FixedOrderWordSpout.html" title="class in org.apache.storm">ExclamationTopology.FixedOrderWordSpout</a>, <a href="../../../../org/apache/storm/starter/FastWordCountTopology.FastRandomSentenceSpout.html" title="class in org.apache.storm.starter">FastWordCountTopology.FastRandomSentenceSpout</a>, <a href="../../../../org/apache/storm/testing/FeederSpout.html" title="class in org.apache.storm.testing">FeederSpout</a>, <a href="../../../../org/apache/storm/perf/spout/FileReadSpout.html" title="class in org.apache.storm.perf.spout">FileReadSpout</a>, <a href="../../../../org/apache/storm/testing/FixedTupleSpout.html" title="class in org.apache.storm.testing">FixedTupleSpout</a>, <a href="../../../../org/apache/storm/flux/wrappers/spouts/FluxShellSpout.html" title="class in org.apache.storm.flux.wrappers.spouts">FluxShellSpout</a>, <a href="../../../../org/apache/storm/hdfs/bolt/HdfsFileTopology.SentenceSpout.html" title="class in org.apache.storm.hdfs.bolt">HdfsFileTopology.SentenceSpout</a>, <a href="../../../../org/apache/storm/hdfs/spout/HdfsSpout.html" title="class in org.apache.storm.hdfs.spout">HdfsSpout</a>, <a href="../../../../org/apache/storm/hive/bolt/HiveTopology.UserDataSpout.html" title="class in org.apache.storm.hive.bolt">HiveTopology.UserDataSpout</a>, <a href="../../../../org/apache/storm/hive/bolt/HiveTopologyPartitioned.UserDataSpout.html" title="class in org.apache.storm.hive.bolt">HiveTopologyPartitioned.UserDataSpout</a>, <a href="../../../../org/apache/storm/st/topology/window/IncrementingSpout.html" title="class in org.apache.storm.st.topology.window">IncrementingSpout</a>, <a href="../../../../org/apache/storm/starter/InOrderDeliveryTest.InOrderSpout.html" title="class in org.apache.storm.starter">InOrderDeliveryTest.InOrderSpout</a>, <a href="../../../../org/apache/storm/jms/spout/JmsSpout.html" title="class in org.apache.storm.jms.spout">JmsSpout</a>, <a href="../../../../org/apache/storm/kafka/spout/KafkaSpout.html" title="class in org.apache.storm.kafka.spout">KafkaSpout</a>, <a href="../../../../org/apache/storm/kinesis/spout/KinesisSpout.html" title="class in org.apache.storm.kinesis.spout">KinesisSpout</a>, <a href="../../../../org/apache/storm/lambda/LambdaSpout.html" title="class in org.apache.storm.lambda">LambdaSpout</a>, <a href="../../../../org/apache/storm/loadgen/LoadSpout.html" title="class in org.apache.storm.loadgen">LoadSpout</a>, <a href="../../../../org/apache/storm/trident/topology/MasterBatchCoordinator.html" title="class in org.apache.storm.trident.topology">MasterBatchCoordinator</a>, <a href="../../../../org/apache/storm/opentsdb/MetricGenSpout.html" title="class in org.apache.storm.opentsdb">MetricGenSpout</a>, <a href="../../../../org/apache/storm/mqtt/spout/MqttSpout.html" title="class in org.apache.storm.mqtt.spout">MqttSpout</a>, <a href="../../../../org/apache/storm/testing/PythonShellMetricsSpout.html" title="class in org.apache.storm.testing">PythonShellMetricsSpout</a>, <a href="../../../../org/apache/storm/starter/spout/RandomIntegerSpout.html" title="class in org.apache.storm.starter.spout">RandomIntegerSpout</a>, <a href="../../../../org/apache/storm/starter/spout/RandomSentenceSpout.html" title="class in org.apache.storm.starter.spout">RandomSentenceSpout</a>, <a href="../../../../org/apache/storm/starter/spout/RandomSentenceSpout.TimeStamped.html" title="class in org.apache.storm.starter.spout">RandomSentenceSpout.TimeStamped</a>, <a href="../../../../org/apache/storm/pmml/RawInputFromCSVSpout.html" title="class in org.apache.storm.pmml">RawInputFromCSVSpout</a>, <a href="../../../../org/apache/storm/clojure/RichShellSpout.html" title="class in org.apache.storm.clojure">RichShellSpout</a>, <a href="../../../../org/apache/storm/trident/spout/RichSpoutBatchTriggerer.html" title="class in org.apache.storm.trident.spout">RichSpoutBatchTriggerer</a>, <a href="../../../../org/apache/storm/rocketmq/spout/RocketMqSpout.html" title="class in org.apache.storm.rocketmq.spout">RocketMqSpout</a>, <a href="../../../../org/apache/storm/hdfs/bolt/SequenceFileTopology.SentenceSpout.html" title="class in org.apache.storm.hdfs.bolt">SequenceFileTopology.SentenceSpout</a>, <a href="../../../../org/apache/storm/sql/runtime/datasource/socket/spout/SocketSpout.html" title="class in org.apache.storm.sql.runtime.datasource.socket.spout">SocketSpout</a>, <a href="../../../../org/apache/storm/solr/spout/SolrFieldsSpout.html" title="class in org.apache.storm.solr.spout">SolrFieldsSpout</a>, <a href="../../../../org/apache/storm/solr/spout/SolrJsonSpout.html" title="class in org.apache.storm.solr.spout">SolrJsonSpout</a>, <a href="../../../../org/apache/storm/testing/SpoutTracker.html" title="class in org.apache.storm.testing">SpoutTracker</a>, <a href="../../../../org/apache/storm/perf/spout/StringGenSpout.html" title="class in org.apache.storm.perf.spout">StringGenSpout</a>, <a href="../../../../org/apache/storm/testing/TestEventLogSpout.html" title="class in org.apache.storm.testing">TestEventLogSpout</a>, <a href="../../../../org/apache/storm/testing/TestPlannerSpout.html" title="class in org.apache.storm.testing">TestPlannerSpout</a>, <a href="../../../../org/apache/storm/testing/TestWordSpout.html" title="class in org.apache.storm.testing">TestWordSpout</a>, <a href="../../../../org/apache/storm/loadgen/ThroughputVsLatency.FastRandomSentenceSpout.html" title="class in org.apache.storm.loadgen">ThroughputVsLatency.FastRandomSentenceSpout</a>, <a href="../../../../org/apache/storm/st/topology/window/TimeDataIncrementingSpout.html" title="class in org.apache.storm.st.topology.window">TimeDataIncrementingSpout</a>, <a href="../../../../org/apache/storm/jdbc/spout/UserSpout.html" title="class in org.apache.storm.jdbc.spout">UserSpout</a>, <a href="../../../../org/apache/storm/starter/WordCountTopologyNode.RandomSentence.html" title="class in org.apache.storm.starter">WordCountTopologyNode.RandomSentence</a>, <a href="../../../../org/apache/storm/perf/spout/WordGenSpout.html" title="class in org.apache.storm.perf.spout">WordGenSpout</a>, <a href="../../../../org/apache/storm/mongodb/topology/WordSpout.html" title="class in org.apache.storm.mongodb.topology">WordSpout</a>, <a href="../../../../org/apache/storm/redis/topology/WordSpout.html" title="class in org.apache.storm.redis.topology">WordSpout</a>, <a href="../../../../org/apache/storm/hbase/topology/WordSpout.html" title="class in org.apache.storm.hbase.topology">WordSpout</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IRichSpout</span>
extends <a href="../../../../org/apache/storm/spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a>, <a href="../../../../org/apache/storm/topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></pre>
<div class="block"><p>When writing topologies using Java, <a href="../../../../org/apache/storm/topology/IRichBolt.html" title="interface in org.apache.storm.topology"><code>IRichBolt</code></a> and <a href="../../../../org/apache/storm/topology/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.</p></div>
</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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.spout.ISpout">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.storm.spout.<a href="../../../../org/apache/storm/spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></h3>
<code><a href="../../../../org/apache/storm/spout/ISpout.html#ack-java.lang.Object-">ack</a>, <a href="../../../../org/apache/storm/spout/ISpout.html#activate--">activate</a>, <a href="../../../../org/apache/storm/spout/ISpout.html#close--">close</a>, <a href="../../../../org/apache/storm/spout/ISpout.html#deactivate--">deactivate</a>, <a href="../../../../org/apache/storm/spout/ISpout.html#fail-java.lang.Object-">fail</a>, <a href="../../../../org/apache/storm/spout/ISpout.html#nextTuple--">nextTuple</a>, <a href="../../../../org/apache/storm/spout/ISpout.html#open-java.util.Map-org.apache.storm.task.TopologyContext-org.apache.storm.spout.SpoutOutputCollector-">open</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.topology.IComponent">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.storm.topology.<a href="../../../../org/apache/storm/topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></h3>
<code><a href="../../../../org/apache/storm/topology/IComponent.html#declareOutputFields-org.apache.storm.topology.OutputFieldsDeclarer-">declareOutputFields</a>, <a href="../../../../org/apache/storm/topology/IComponent.html#getComponentConfiguration--">getComponentConfiguration</a></code></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/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">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/topology/IRichBolt.html" title="interface in org.apache.storm.topology"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/storm/topology/IRichStateSpout.html" title="interface in org.apache.storm.topology"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/topology/IRichSpout.html" target="_top">Frames</a></li>
<li><a href="IRichSpout.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>