content/releases/current/javadocs/org/apache/storm/loadgen/LoadSpout.html - storm-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="de">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>LoadSpout (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.loadgen, class: LoadSpout">
 <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 evenRowColor = "even-row-color";
 var oddRowColor = "odd-row-color";
 var tableTab = "table-tab";
 var activeTableTab = "active-table-tab";
 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/LoadSpout.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><a href="#constructor-summary">Constr</a>&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><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></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.loadgen</a></div>
 <h1 title="Class LoadSpout" class="title">Class LoadSpout</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance"><a href="../topology/base/BaseComponent.html" title="class in org.apache.storm.topology.base">org.apache.storm.topology.base.BaseComponent</a>
 <div class="inheritance"><a href="../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">org.apache.storm.topology.base.BaseRichSpout</a>
 <div class="inheritance">org.apache.storm.loadgen.LoadSpout</div>
 </div>
 </div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><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>, <code><a href="../spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code>, <code><a href="../topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code>, <code><a href="../topology/IRichSpout.html" title="interface in org.apache.storm.topology">IRichSpout</a></code></dd>
 </dl>
 <dl class="notes">
 <dt>Direct Known Subclasses:</dt>
 <dd><code><a href="ThroughputVsLatency.FastRandomSentenceSpout.html" title="class in org.apache.storm.loadgen">ThroughputVsLatency.FastRandomSentenceSpout</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">LoadSpout</span>
 <span class="extends-implements">extends <a href="../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a></span></div>
 <div class="block">A spout that simulates a real world spout based off of statistics about it.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../serialized-form.html#org.apache.storm.loadgen.LoadSpout">Serialized Form</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(double)" class="member-name-link">LoadSpout</a><wbr>(double&nbsp;ratePerSecond)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Create a simple load spout with just a set rate per second on the default stream.</div>
 </div>
 <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.storm.loadgen.LoadCompConf)" class="member-name-link">LoadSpout</a><wbr>(<a href="LoadCompConf.html" title="class in org.apache.storm.loadgen">LoadCompConf</a>&nbsp;conf)</code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#ack(java.lang.Object)" class="member-name-link">ack</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;id)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Storm has determined that the tuple emitted by this spout with the msgId identifier has been fully processed.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)" class="member-name-link">declareOutputFields</a><wbr>(<a href="../topology/OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a>&nbsp;declarer)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Declare the output schema for all the streams of this topology.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fail(java.lang.Object)" class="member-name-link">fail</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;id)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">The tuple emitted by this spout with the msgId identifier has failed to be fully processed.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../tuple/Values.html" title="class in org.apache.storm.tuple">Values</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNextValues(org.apache.storm.loadgen.OutputStreamEngine)" class="member-name-link">getNextValues</a><wbr>(<a href="OutputStreamEngine.html" title="class in org.apache.storm.loadgen">OutputStreamEngine</a>&nbsp;se)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextTuple()" class="member-name-link">nextTuple</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">When this method is called, Storm is requesting that the Spout emit tuples to the output collector.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#open(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.spout.SpoutOutputCollector)" class="member-name-link">open</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;conf,
  <a href="../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a>&nbsp;context,
  <a href="../spout/SpoutOutputCollector.html" title="class in org.apache.storm.spout">SpoutOutputCollector</a>&nbsp;collector)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Called when a task for this component is initialized within a worker on the cluster.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.storm.topology.base.BaseRichSpout">Methods inherited from class&nbsp;org.apache.storm.topology.base.<a href="../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a></h3>
 <code><a href="../topology/base/BaseRichSpout.html#activate()">activate</a>, <a href="../topology/base/BaseRichSpout.html#close()">close</a>, <a href="../topology/base/BaseRichSpout.html#deactivate()">deactivate</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.storm.topology.base.BaseComponent">Methods inherited from class&nbsp;org.apache.storm.topology.base.<a href="../topology/base/BaseComponent.html" title="class in org.apache.storm.topology.base">BaseComponent</a></h3>
 <code><a href="../topology/base/BaseComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 <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="../topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></h3>
 <code><a href="../topology/IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;(double)">
 <h3>LoadSpout</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">LoadSpout</span><wbr><span class="parameters">(double&nbsp;ratePerSecond)</span></div>
 <div class="block">Create a simple load spout with just a set rate per second on the default stream.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>ratePerSecond</code> - the rate to send messages at.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(org.apache.storm.loadgen.LoadCompConf)">
 <h3>LoadSpout</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">LoadSpout</span><wbr><span class="parameters">(<a href="LoadCompConf.html" title="class in org.apache.storm.loadgen">LoadCompConf</a>&nbsp;conf)</span></div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="open(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.spout.SpoutOutputCollector)">
 <h3>open</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">open</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;conf,
  <a href="../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a>&nbsp;context,
  <a href="../spout/SpoutOutputCollector.html" title="class in org.apache.storm.spout">SpoutOutputCollector</a>&nbsp;collector)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../spout/ISpout.html#open(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.spout.SpoutOutputCollector)">ISpout</a></code></span></div>
 <div class="block">Called when a task for this component is initialized within a worker on the cluster. It provides the spout with the environment in
  which the spout executes.

  <p>This includes the:</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>conf</code> - The Storm configuration for this spout. 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 spout. Tuples can be emitted at any time, including the open and
                   close methods. The collector is thread-safe and should be saved as an instance variable of this spout object.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="nextTuple()">
 <h3>nextTuple</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">nextTuple</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../spout/ISpout.html#nextTuple()">ISpout</a></code></span></div>
 <div class="block">When this method is called, Storm is requesting that the Spout emit tuples to the output collector. This method should be
  non-blocking, so if the Spout has no tuples to emit, this method should return. nextTuple, ack, and fail are all called in a tight
  loop in a single thread in the spout task. When there are no tuples to emit, it is courteous to have nextTuple sleep for a short
  amount of time (like a single millisecond) so as not to waste too much CPU.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getNextValues(org.apache.storm.loadgen.OutputStreamEngine)">
 <h3>getNextValues</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../tuple/Values.html" title="class in org.apache.storm.tuple">Values</a></span>&nbsp;<span class="element-name">getNextValues</span><wbr><span class="parameters">(<a href="OutputStreamEngine.html" title="class in org.apache.storm.loadgen">OutputStreamEngine</a>&nbsp;se)</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">
 <h3>declareOutputFields</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">declareOutputFields</span><wbr><span class="parameters">(<a href="../topology/OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a>&nbsp;declarer)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../topology/IComponent.html#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">IComponent</a></code></span></div>
 <div class="block">Declare the output schema for all the streams of this topology.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>declarer</code> - this is used to declare output stream ids, output fields, and whether or not each output stream is a direct stream</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="ack(java.lang.Object)">
 <h3>ack</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">ack</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;id)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../spout/ISpout.html#ack(java.lang.Object)">ISpout</a></code></span></div>
 <div class="block">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.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../spout/ISpout.html#ack(java.lang.Object)">ack</a></code>&nbsp;in interface&nbsp;<code><a href="../spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code></dd>
 <dt>Overrides:</dt>
 <dd><code><a href="../topology/base/BaseRichSpout.html#ack(java.lang.Object)">ack</a></code>&nbsp;in class&nbsp;<code><a href="../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="fail(java.lang.Object)">
 <h3>fail</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">fail</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;id)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../spout/ISpout.html#fail(java.lang.Object)">ISpout</a></code></span></div>
 <div class="block">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.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../spout/ISpout.html#fail(java.lang.Object)">fail</a></code>&nbsp;in interface&nbsp;<code><a href="../spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code></dd>
 <dt>Overrides:</dt>
 <dd><code><a href="../topology/base/BaseRichSpout.html#fail(java.lang.Object)">fail</a></code>&nbsp;in class&nbsp;<code><a href="../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a></code></dd>
 </dl>
 </section>
 </li>
 </ul>
 </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>