blob: 20ad4ce5413f250ff7531cc383d694990e6d5ca3 [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>org.apache.storm.trident.spout (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="org.apache.storm.trident.spout (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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/trident/planner/processor/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/storm/trident/state/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/trident/spout/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.storm.trident.spout</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/IBatchID.html" title="interface in org.apache.storm.trident.spout">IBatchID</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/IBatchSpout.html" title="interface in org.apache.storm.trident.spout">IBatchSpout</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/ICommitterTridentSpout.html" title="interface in org.apache.storm.trident.spout">ICommitterTridentSpout</a>&lt;X&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/ICommitterTridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout">ICommitterTridentSpout.Emitter</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/IOpaquePartitionedTridentSpout.html" title="interface in org.apache.storm.trident.spout">IOpaquePartitionedTridentSpout</a>&lt;PartitionsT,PartitionT extends <a href="../../../../../org/apache/storm/trident/spout/ISpoutPartition.html" title="interface in org.apache.storm.trident.spout">ISpoutPartition</a>,M&gt;</td>
<td class="colLast">
<div class="block">This defines a transactional spout which does <em>not</em> necessarily replay the same batch every time it emits a batch for a transaction id.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/IOpaquePartitionedTridentSpout.Coordinator.html" title="interface in org.apache.storm.trident.spout">IOpaquePartitionedTridentSpout.Coordinator</a>&lt;PartitionsT&gt;</td>
<td class="colLast">
<div class="block">Coordinator for batches.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/IOpaquePartitionedTridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout">IOpaquePartitionedTridentSpout.Emitter</a>&lt;PartitionsT,PartitionT extends <a href="../../../../../org/apache/storm/trident/spout/ISpoutPartition.html" title="interface in org.apache.storm.trident.spout">ISpoutPartition</a>,M&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.html" title="interface in org.apache.storm.trident.spout">IPartitionedTridentSpout</a>&lt;PartitionsT,PartitionT extends <a href="../../../../../org/apache/storm/trident/spout/ISpoutPartition.html" title="interface in org.apache.storm.trident.spout">ISpoutPartition</a>,T&gt;</td>
<td class="colLast">
<div class="block">This interface defines a transactional spout that reads its tuples from a partitioned set of brokers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.Coordinator.html" title="interface in org.apache.storm.trident.spout">IPartitionedTridentSpout.Coordinator</a>&lt;PartitionsT&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/IPartitionedTridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout">IPartitionedTridentSpout.Emitter</a>&lt;PartitionsT,PartitionT extends <a href="../../../../../org/apache/storm/trident/spout/ISpoutPartition.html" title="interface in org.apache.storm.trident.spout">ISpoutPartition</a>,X&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/ISpoutPartition.html" title="interface in org.apache.storm.trident.spout">ISpoutPartition</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/ITridentDataSource.html" title="interface in org.apache.storm.trident.spout">ITridentDataSource</a></td>
<td class="colLast">
<div class="block">ITridentDataSource marks all spouts that provide data into Trident.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.html" title="interface in org.apache.storm.trident.spout">ITridentSpout</a>&lt;T&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.BatchCoordinator.html" title="interface in org.apache.storm.trident.spout">ITridentSpout.BatchCoordinator</a>&lt;X&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/ITridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout">ITridentSpout.Emitter</a>&lt;X&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/BatchSpoutExecutor.html" title="class in org.apache.storm.trident.spout">BatchSpoutExecutor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/BatchSpoutExecutor.EmptyCoordinator.html" title="class in org.apache.storm.trident.spout">BatchSpoutExecutor.EmptyCoordinator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/OpaquePartitionedTridentSpoutExecutor.html" title="class in org.apache.storm.trident.spout">OpaquePartitionedTridentSpoutExecutor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/PartitionedTridentSpoutExecutor.html" title="class in org.apache.storm.trident.spout">PartitionedTridentSpoutExecutor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/RichSpoutBatchExecutor.html" title="class in org.apache.storm.trident.spout">RichSpoutBatchExecutor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/RichSpoutBatchId.html" title="class in org.apache.storm.trident.spout">RichSpoutBatchId</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/RichSpoutBatchIdSerializer.html" title="class in org.apache.storm.trident.spout">RichSpoutBatchIdSerializer</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/RichSpoutBatchTriggerer.html" title="class in org.apache.storm.trident.spout">RichSpoutBatchTriggerer</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/TridentSpoutCoordinator.html" title="class in org.apache.storm.trident.spout">TridentSpoutCoordinator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/storm/trident/spout/TridentSpoutExecutor.html" title="class in org.apache.storm.trident.spout">TridentSpoutExecutor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/trident/planner/processor/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/storm/trident/state/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/trident/spout/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>