Google Git
Sign in
apache / incubator-retired-gearpump-site / f2a69d38efa9a4415d78fca68868f176ad60dd49 / . / content / releases / latest / api / java / org / apache / gearpump / streaming / state / api / PersistentState.html
blob: 6b241fbea4f60fa7e1ad0241985685ae53283cbe [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 (1.8.0_121) on Sun Jul 09 07:41:24 CEST 2017 -->
<title>PersistentState</title>
<meta name="date" content="2017-07-09">
<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="PersistentState";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="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/gearpump/streaming/state/api/MonoidState.html" title="class in org.apache.gearpump.streaming.state.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/gearpump/streaming/state/api/PersistentTask.html" title="class in org.apache.gearpump.streaming.state.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/gearpump/streaming/state/api/PersistentState.html" target="_top">Frames</a></li>
<li><a href="PersistentState.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><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.gearpump.streaming.state.api</div>
<h2 title="Interface PersistentState" class="title">Interface PersistentState&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/gearpump/streaming/state/api/MonoidState.html" title="class in org.apache.gearpump.streaming.state.api">MonoidState</a>, <a href="../../../../../../org/apache/gearpump/streaming/state/impl/NonWindowState.html" title="class in org.apache.gearpump.streaming.state.impl">NonWindowState</a>, <a href="../../../../../../org/apache/gearpump/streaming/state/impl/WindowState.html" title="class in org.apache.gearpump.streaming.state.impl">WindowState</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">PersistentState&lt;T&gt;</span></pre>
<div class="block">PersistentState is part of the transaction API
<p>
Users could get transaction support from the framework by
conforming to PersistentState APIs and extending PersistentTask
to manage the state</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>
<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/gearpump/streaming/state/api/PersistentState.html#checkpoint--">checkpoint</a></span>()</code>
<div class="block">Gets a binary snapshot of state
usually invoked by the framework</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>scala.Option&lt;<a href="../../../../../../org/apache/gearpump/streaming/state/api/PersistentState.html" title="type parameter in PersistentState">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/gearpump/streaming/state/api/PersistentState.html#get--">get</a></span>()</code>
<div class="block">Unwraps the raw value of state</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/gearpump/streaming/state/api/PersistentState.html#recover-long-byte:A-">recover</a></span>(long&nbsp;timestamp,
byte[]&nbsp;bytes)</code>
<div class="block">Recovers state to a previous checkpoint
usually invoked by the framework</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/gearpump/streaming/state/api/PersistentState.html#setNextCheckpointTime-long-">setNextCheckpointTime</a></span>(long&nbsp;timeStamp)</code>
<div class="block">Sets next checkpoint time
should be invoked by the framework</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/gearpump/streaming/state/api/PersistentState.html#update-long-T-">update</a></span>(long&nbsp;timestamp,
<a href="../../../../../../org/apache/gearpump/streaming/state/api/PersistentState.html" title="type parameter in PersistentState">T</a>&nbsp;t)</code>
<div class="block">Updates state on a new message
this is invoked by user</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="recover-long-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recover</h4>
<pre>void&nbsp;recover(long&nbsp;timestamp,
byte[]&nbsp;bytes)</pre>
<div class="block">Recovers state to a previous checkpoint
usually invoked by the framework</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timestamp</code> - (undocumented)</dd>
<dd><code>bytes</code> - (undocumented)</dd>
</dl>
</li>
</ul>
<a name="update-long-java.lang.Object-">
<!-- -->
</a><a name="update-long-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>void&nbsp;update(long&nbsp;timestamp,
<a href="../../../../../../org/apache/gearpump/streaming/state/api/PersistentState.html" title="type parameter in PersistentState">T</a>&nbsp;t)</pre>
<div class="block">Updates state on a new message
this is invoked by user</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timestamp</code> - (undocumented)</dd>
<dd><code>t</code> - (undocumented)</dd>
</dl>
</li>
</ul>
<a name="setNextCheckpointTime-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNextCheckpointTime</h4>
<pre>void&nbsp;setNextCheckpointTime(long&nbsp;timeStamp)</pre>
<div class="block">Sets next checkpoint time
should be invoked by the framework</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeStamp</code> - (undocumented)</dd>
</dl>
</li>
</ul>
<a name="checkpoint--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkpoint</h4>
<pre>byte[]&nbsp;checkpoint()</pre>
<div class="block">Gets a binary snapshot of state
usually invoked by the framework</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="get--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>get</h4>
<pre>scala.Option&lt;<a href="../../../../../../org/apache/gearpump/streaming/state/api/PersistentState.html" title="type parameter in PersistentState">T</a>&gt;&nbsp;get()</pre>
<div class="block">Unwraps the raw value of state</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</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="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/gearpump/streaming/state/api/MonoidState.html" title="class in org.apache.gearpump.streaming.state.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/gearpump/streaming/state/api/PersistentTask.html" title="class in org.apache.gearpump.streaming.state.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/gearpump/streaming/state/api/PersistentState.html" target="_top">Frames</a></li>
<li><a href="PersistentState.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><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>