Google Git
Sign in
apache / storm-site / 553ca57e4e37c342861887cd8dd404f44d39b4f9 / . / content / releases / current / javadocs / org / apache / storm / state / package-summary.html
blob: 60bdb5ab52efff20bad9e75bdfd2d541b99454cb [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.state (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.state (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/starter/trident/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/storm/stats/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/state/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.state</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/state/IStateSpout.html" title="interface in org.apache.storm.state">IStateSpout</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/IStateSpoutOutputCollector.html" title="interface in org.apache.storm.state">IStateSpoutOutputCollector</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/ISubscribedState.html" title="interface in org.apache.storm.state">ISubscribedState</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/ISynchronizeOutputCollector.html" title="interface in org.apache.storm.state">ISynchronizeOutputCollector</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/KeyValueState.html" title="interface in org.apache.storm.state">KeyValueState</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">A state that supports key-value mappings.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Interface to be implemented for serlializing and de-serializing the state.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a></td>
<td class="colLast">
<div class="block">The state of the component that is either managed by the framework (e.g in case of <a href="../../../../org/apache/storm/topology/IStatefulBolt.html" title="interface in org.apache.storm.topology"><code>IStatefulBolt</code></a>) or managed by the the individual components themselves.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/StateEncoder.html" title="interface in org.apache.storm.state">StateEncoder</a>&lt;K,V,KENCODEDT,VENCODEDT&gt;</td>
<td class="colLast">
<div class="block">The interface of State Encoder.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/StateProvider.html" title="interface in org.apache.storm.state">StateProvider</a></td>
<td class="colLast">
<div class="block">Used by the <a href="../../../../org/apache/storm/state/StateFactory.html" title="class in org.apache.storm.state"><code>StateFactory</code></a> to create a new state instances.</div>
</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/state/BaseBinaryStateIterator.html" title="class in org.apache.storm.state">BaseBinaryStateIterator</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">Base implementation of iterator over <a href="../../../../org/apache/storm/state/KeyValueState.html" title="interface in org.apache.storm.state"><code>KeyValueState</code></a> which encoded types of key and value are both binary type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/BaseStateIterator.html" title="class in org.apache.storm.state">BaseStateIterator</a>&lt;K,V,KENCODEDT,VENCODEDT&gt;</td>
<td class="colLast">
<div class="block">Base implementation of iterator over <a href="../../../../org/apache/storm/state/KeyValueState.html" title="interface in org.apache.storm.state"><code>KeyValueState</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/DefaultStateEncoder.html" title="class in org.apache.storm.state">DefaultStateEncoder</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">Default state encoder class for encoding/decoding key values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/DefaultStateSerializer.html" title="class in org.apache.storm.state">DefaultStateSerializer</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A default implementation that uses Kryo to serialize and de-serialize the state.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/InMemoryKeyValueState.html" title="class in org.apache.storm.state">InMemoryKeyValueState</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">An in-memory implementation of the <a href="../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state"><code>State</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/InMemoryKeyValueStateProvider.html" title="class in org.apache.storm.state">InMemoryKeyValueStateProvider</a></td>
<td class="colLast">
<div class="block">Provides <a href="../../../../org/apache/storm/state/InMemoryKeyValueState.html" title="class in org.apache.storm.state"><code>InMemoryKeyValueState</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/StateFactory.html" title="class in org.apache.storm.state">StateFactory</a></td>
<td class="colLast">
<div class="block">A factory for creating <a href="../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state"><code>State</code></a> instances.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/StateSpoutOutputCollector.html" title="class in org.apache.storm.state">StateSpoutOutputCollector</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/state/SynchronizeOutputCollector.html" title="class in org.apache.storm.state">SynchronizeOutputCollector</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/starter/trident/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/storm/stats/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/state/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>