Google Git
Sign in
apache / storm-site / e499c9668e1d4e179763e1ad6192d2c93ae434b6 / . / releases / 2.2.0 / javadocs / org / apache / storm / topology / base / BaseRichSpout.html
blob: 95a43a2e41d0643728f3f2ffecd86e1212c9b3c0 [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>BaseRichSpout (Storm 2.2.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="BaseRichSpout (Storm 2.2.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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/BaseRichSpout.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/base/BaseRichBolt.html" title="class in org.apache.storm.topology.base"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/storm/topology/base/BaseStatefulBolt.html" title="class in org.apache.storm.topology.base"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/topology/base/BaseRichSpout.html" target="_top">Frames</a></li>
<li><a href="BaseRichSpout.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><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></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.base</div>
<h2 title="Class BaseRichSpout" class="title">Class BaseRichSpout</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/storm/topology/base/BaseComponent.html" title="class in org.apache.storm.topology.base">org.apache.storm.topology.base.BaseComponent</a></li>
<li>
<ul class="inheritance">
<li>org.apache.storm.topology.base.BaseRichSpout</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><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>, <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>, <a href="../../../../../org/apache/storm/topology/IRichSpout.html" title="interface in org.apache.storm.topology">IRichSpout</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</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/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/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/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/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/pmml/RawInputFromCSVSpout.html" title="class in org.apache.storm.pmml">RawInputFromCSVSpout</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/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/st/topology/window/TimeDataIncrementingSpout.html" title="class in org.apache.storm.st.topology.window">TimeDataIncrementingSpout</a>, <a href="../../../../../org/apache/storm/perf/spout/WordGenSpout.html" title="class in org.apache.storm.perf.spout">WordGenSpout</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">BaseRichSpout</span>
extends <a href="../../../../../org/apache/storm/topology/base/BaseComponent.html" title="class in org.apache.storm.topology.base">BaseComponent</a>
implements <a href="../../../../../org/apache/storm/topology/IRichSpout.html" title="interface in org.apache.storm.topology">IRichSpout</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.storm.topology.base.BaseRichSpout">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseRichSpout.html#BaseRichSpout--">BaseRichSpout</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseRichSpout.html#ack-java.lang.Object-">ack</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;msgId)</code>
<div class="block">Storm has determined that the tuple emitted by this spout with the msgId identifier has been fully processed.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseRichSpout.html#activate--">activate</a></span>()</code>
<div class="block">Called when a spout has been activated out of a deactivated mode.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseRichSpout.html#close--">close</a></span>()</code>
<div class="block">Called when an ISpout is going to be shutdown.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseRichSpout.html#deactivate--">deactivate</a></span>()</code>
<div class="block">Called when a spout has been deactivated.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseRichSpout.html#fail-java.lang.Object-">fail</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;msgId)</code>
<div class="block">The tuple emitted by this spout with the msgId identifier has failed to be fully processed.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.topology.base.BaseComponent">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.storm.topology.base.<a href="../../../../../org/apache/storm/topology/base/BaseComponent.html" title="class in org.apache.storm.topology.base">BaseComponent</a></h3>
<code><a href="../../../../../org/apache/storm/topology/base/BaseComponent.html#getComponentConfiguration--">getComponentConfiguration</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<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#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 class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="BaseRichSpout--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BaseRichSpout</h4>
<pre>public&nbsp;BaseRichSpout()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/storm/spout/ISpout.html#close--">ISpout</a></code></span></div>
<div class="block"><p>Called when an ISpout is going to be shutdown. There is no guarentee that close will be called, because the supervisor kill -9&rsquo;s worker processes on the cluster.</p><p><p>The one context where close is guaranteed to be called is a topology is killed when running Storm in local mode.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/storm/spout/ISpout.html#close--">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/storm/spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code></dd>
</dl>
</li>
</ul>
<a name="activate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>activate</h4>
<pre>public&nbsp;void&nbsp;activate()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/storm/spout/ISpout.html#activate--">ISpout</a></code></span></div>
<div class="block"><p>Called when a spout has been activated out of a deactivated mode. nextTuple will be called on this spout soon. A spout can become activated after having been deactivated when the topology is manipulated using the <code>storm</code> client.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/storm/spout/ISpout.html#activate--">activate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/storm/spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code></dd>
</dl>
</li>
</ul>
<a name="deactivate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deactivate</h4>
<pre>public&nbsp;void&nbsp;deactivate()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/storm/spout/ISpout.html#deactivate--">ISpout</a></code></span></div>
<div class="block"><p>Called when a spout has been deactivated. nextTuple will not be called while a spout is deactivated. The spout may or may not be reactivated in the future.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/storm/spout/ISpout.html#deactivate--">deactivate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/storm/spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code></dd>
</dl>
</li>
</ul>
<a name="ack-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ack</h4>
<pre>public&nbsp;void&nbsp;ack(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;msgId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/storm/spout/ISpout.html#ack-java.lang.Object-">ISpout</a></code></span></div>
<div class="block"><p>Storm has determined that the tuple emitted by this spout with the msgId identifier has been fully processed. Typically, an implementation of this method will take that message off the queue and prevent it from being replayed.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/storm/spout/ISpout.html#ack-java.lang.Object-">ack</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/storm/spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code></dd>
</dl>
</li>
</ul>
<a name="fail-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fail</h4>
<pre>public&nbsp;void&nbsp;fail(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;msgId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/storm/spout/ISpout.html#fail-java.lang.Object-">ISpout</a></code></span></div>
<div class="block"><p>The tuple emitted by this spout with the msgId identifier has failed to be fully processed. Typically, an implementation of this method will put that message back on the queue to be replayed at a later time.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/storm/spout/ISpout.html#fail-java.lang.Object-">fail</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/storm/spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code></dd>
</dl>
</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/BaseRichSpout.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/base/BaseRichBolt.html" title="class in org.apache.storm.topology.base"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/storm/topology/base/BaseStatefulBolt.html" title="class in org.apache.storm.topology.base"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/topology/base/BaseRichSpout.html" target="_top">Frames</a></li>
<li><a href="BaseRichSpout.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><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>