| <!DOCTYPE html > |
| <html> |
| <head> |
| <title>impl - org.apache.gearpump.streaming.state.impl</title> |
| <meta name="description" content="impl - org.apache.gearpump.streaming.state.impl" /> |
| <meta name="keywords" content="impl org.apache.gearpump.streaming.state.impl" /> |
| <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
| |
| <link href="../../../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet" /> |
| <link href="../../../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" /> |
| <script type="text/javascript" src="../../../../../../lib/jquery.js" id="jquery-js"></script> |
| <script type="text/javascript" src="../../../../../../lib/jquery-ui.js"></script> |
| <script type="text/javascript" src="../../../../../../lib/template.js"></script> |
| <script type="text/javascript" src="../../../../../../lib/tools.tooltip.js"></script> |
| |
| <script type="text/javascript"> |
| if(top === self) { |
| var url = '../../../../../../index.html'; |
| var hash = 'org.apache.gearpump.streaming.state.impl.package'; |
| var anchor = window.location.hash; |
| var anchor_opt = ''; |
| if (anchor.length >= 1) |
| anchor_opt = '@' + anchor.substring(1); |
| window.location.href = url + '#' + hash + anchor_opt; |
| } |
| </script> |
| |
| </head> |
| <body class="value"> |
| <div id="definition"> |
| <img alt="Package" src="../../../../../../lib/package_big.png" /> |
| <p id="owner"><a href="../../../../../package.html" class="extype" name="org">org</a>.<a href="../../../../package.html" class="extype" name="org.apache">apache</a>.<a href="../../../package.html" class="extype" name="org.apache.gearpump">gearpump</a>.<a href="../../package.html" class="extype" name="org.apache.gearpump.streaming">streaming</a>.<a href="../package.html" class="extype" name="org.apache.gearpump.streaming.state">state</a></p> |
| <h1>impl</h1><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.state.impl.package" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| </div> |
| |
| <h4 id="signature" class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">impl</span> |
| </span> |
| </h4> |
| |
| <div id="comment" class="fullcommenttop"></div> |
| |
| |
| <div id="mbrsel"> |
| <div id="textfilter"><span class="pre"></span><span class="input"><input id="mbrsel-input" type="text" accesskey="/" /></span><span class="post"></span></div> |
| |
| |
| <div id="visbl"> |
| <span class="filtertype">Visibility</span> |
| <ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol> |
| </div> |
| </div> |
| |
| <div id="template"> |
| <div id="allMembers"> |
| |
| |
| <div id="types" class="types members"> |
| <h3>Type Members</h3> |
| <ol><li name="org.apache.gearpump.streaming.state.impl.CheckpointManager" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="CheckpointManagerextendsAnyRef"></a> |
| <a id="CheckpointManager:CheckpointManager"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="CheckpointManager.html"><span class="name">CheckpointManager</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.state.impl.package@CheckpointManagerextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Manage physical checkpoints to persitent storage like HDFS</p> |
| </li><li name="org.apache.gearpump.streaming.state.impl.InMemoryCheckpointStore" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="InMemoryCheckpointStoreextendsCheckpointStore"></a> |
| <a id="InMemoryCheckpointStore:InMemoryCheckpointStore"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="InMemoryCheckpointStore.html"><span class="name">InMemoryCheckpointStore</span></a><span class="result"> extends <a href="../../transaction/api/CheckpointStore.html" class="extype" name="org.apache.gearpump.streaming.transaction.api.CheckpointStore">CheckpointStore</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.state.impl.package@InMemoryCheckpointStoreextendsCheckpointStore" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">an in memory store provided for test |
| should not be used in real cases |
| </p> |
| </li><li name="org.apache.gearpump.streaming.state.impl.InMemoryCheckpointStoreFactory" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="InMemoryCheckpointStoreFactoryextendsCheckpointStoreFactory"></a> |
| <a id="InMemoryCheckpointStoreFactory:InMemoryCheckpointStoreFactory"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="InMemoryCheckpointStoreFactory.html"><span class="name">InMemoryCheckpointStoreFactory</span></a><span class="result"> extends <a href="../../transaction/api/CheckpointStoreFactory.html" class="extype" name="org.apache.gearpump.streaming.transaction.api.CheckpointStoreFactory">CheckpointStoreFactory</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.state.impl.package@InMemoryCheckpointStoreFactoryextendsCheckpointStoreFactory" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.streaming.state.impl.Interval" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="IntervalextendsOrdered[org.apache.gearpump.streaming.state.impl.Interval]withProductwithSerializable"></a> |
| <a id="Interval:Interval"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Interval.html"><span class="name">Interval</span></a><span class="params">(<span name="startTime">startTime: <a href="../../../package.html#TimeStamp=Long" class="extmbr" name="org.apache.gearpump.TimeStamp">TimeStamp</a></span>, <span name="endTime">endTime: <a href="../../../package.html#TimeStamp=Long" class="extmbr" name="org.apache.gearpump.TimeStamp">TimeStamp</a></span>)</span><span class="result"> extends <span class="extype" name="scala.Ordered">Ordered</span>[<a href="Interval.html" class="extype" name="org.apache.gearpump.streaming.state.impl.Interval">Interval</a>] with <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.state.impl.package@IntervalextendsOrdered[org.apache.gearpump.streaming.state.impl.Interval]withProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">an interval is a dynamic time range that is divided by window boundary and checkpoint time |
| </p> |
| </li><li name="org.apache.gearpump.streaming.state.impl.NonWindowState" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="NonWindowState[T]extendsMonoidState[T]"></a> |
| <a id="NonWindowState[T]:NonWindowState[T]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="NonWindowState.html"><span class="name">NonWindowState</span></a><span class="tparams">[<span name="T">T</span>]</span><span class="result"> extends <a href="../api/MonoidState.html" class="extype" name="org.apache.gearpump.streaming.state.api.MonoidState">MonoidState</a>[<span class="extype" name="org.apache.gearpump.streaming.state.impl.NonWindowState.T">T</span>]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.state.impl.package@NonWindowState[T]extendsMonoidState[T]" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">a MonoidState storing non-window state |
| </p> |
| </li><li name="org.apache.gearpump.streaming.state.impl.Window" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="WindowextendsAnyRef"></a> |
| <a id="Window:Window"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Window.html"><span class="name">Window</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.state.impl.package@WindowextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Used in window applications |
| it keeps the current window and slide ahead when the window expires |
| </p> |
| </li><li name="org.apache.gearpump.streaming.state.impl.WindowConfig" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="WindowConfigextendsProductwithSerializable"></a> |
| <a id="WindowConfig:WindowConfig"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="WindowConfig.html"><span class="name">WindowConfig</span></a><span class="params">(<span name="windowSize">windowSize: <span class="extype" name="scala.Long">Long</span></span>, <span name="windowStep">windowStep: <span class="extype" name="scala.Long">Long</span></span>)</span><span class="result"> extends <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.state.impl.package@WindowConfigextendsProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.streaming.state.impl.WindowState" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="WindowState[T]extendsMonoidState[T]"></a> |
| <a id="WindowState[T]:WindowState[T]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="WindowState.html"><span class="name">WindowState</span></a><span class="tparams">[<span name="T">T</span>]</span><span class="result"> extends <a href="../api/MonoidState.html" class="extype" name="org.apache.gearpump.streaming.state.api.MonoidState">MonoidState</a>[<span class="extype" name="org.apache.gearpump.streaming.state.impl.WindowState.T">T</span>]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.state.impl.package@WindowState[T]extendsMonoidState[T]" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">this is a list of states, each of which is bounded by a time window |
| state of each window doesn't affect each other</p><div class="fullcomment"><div class="comment cmt"><p>this is a list of states, each of which is bounded by a time window |
| state of each window doesn't affect each other</p><p>WindowState requires a Algebird Group to be passed in |
| Group augments Monoid with a minus function which makes it |
| possible to undo the update by messages that have left the window |
| </p></div></div> |
| </li></ol> |
| </div> |
| |
| |
| |
| <div id="values" class="values members"> |
| <h3>Value Members</h3> |
| <ol><li name="org.apache.gearpump.streaming.state.impl.NonWindowState" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="NonWindowState"></a> |
| <a id="NonWindowState:NonWindowState"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="NonWindowState$.html"><span class="name">NonWindowState</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.state.impl.package@NonWindowState" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.streaming.state.impl.PersistentStateConfig" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="PersistentStateConfig"></a> |
| <a id="PersistentStateConfig:PersistentStateConfig"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="PersistentStateConfig$.html"><span class="name">PersistentStateConfig</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.state.impl.package@PersistentStateConfig" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.streaming.state.impl.WindowConfig" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="WindowConfig"></a> |
| <a id="WindowConfig:WindowConfig"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="WindowConfig$.html"><span class="name">WindowConfig</span></a><span class="result"> extends <span class="extype" name="scala.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.state.impl.package@WindowConfig" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.gearpump.streaming.state.impl.WindowState" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="WindowState"></a> |
| <a id="WindowState:WindowState"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="WindowState$.html"><span class="name">WindowState</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../../index.html#org.apache.gearpump.streaming.state.impl.package@WindowState" title="Permalink" target="_top"> |
| <img src="../../../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li></ol> |
| </div> |
| |
| |
| |
| |
| </div> |
| |
| <div id="inheritedMembers"> |
| |
| |
| </div> |
| |
| <div id="groupedMembers"> |
| <div class="group" name="Ungrouped"> |
| <h3>Ungrouped</h3> |
| |
| </div> |
| </div> |
| |
| </div> |
| |
| <div id="tooltip"></div> |
| |
| <div id="footer"> </div> |
| |
| |
| </body> |
| </html> |
