| <!DOCTYPE html > |
| <html> |
| <head> |
| <title>PersistentTask - io.gearpump.streaming.state.api.PersistentTask</title> |
| <meta name="description" content="PersistentTask - io.gearpump.streaming.state.api.PersistentTask" /> |
| <meta name="keywords" content="PersistentTask io.gearpump.streaming.state.api.PersistentTask" /> |
| <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 = 'io.gearpump.streaming.state.api.PersistentTask'; |
| 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="type"> |
| <div id="definition"> |
| <img src="../../../../../lib/class_big.png" /> |
| <p id="owner"><a href="../../../../package.html" class="extype" name="io">io</a>.<a href="../../../package.html" class="extype" name="io.gearpump">gearpump</a>.<a href="../../package.html" class="extype" name="io.gearpump.streaming">streaming</a>.<a href="../package.html" class="extype" name="io.gearpump.streaming.state">state</a>.<a href="package.html" class="extype" name="io.gearpump.streaming.state.api">api</a></p> |
| <h1>PersistentTask</h1><h3><span class="morelinks"><div>Related Doc: |
| <a href="package.html" class="extype" name="io.gearpump.streaming.state.api">package api</a> |
| </div></span></h3><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| </div> |
| |
| <h4 id="signature" class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">PersistentTask</span><span class="tparams">[<span name="T">T</span>]</span><span class="result"> extends <a href="../../task/Task.html" class="extype" name="io.gearpump.streaming.task.Task">Task</a></span> |
| </span> |
| </h4> |
| |
| <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>PersistentTask is part of the transaction API</p><p>Users should extend this task if they want to get transaction support |
| from the framework |
| </p></div><div class="toggleContainer block"> |
| <span class="toggle">Linear Supertypes</span> |
| <div class="superTypes hiddenContent"><a href="../../task/Task.html" class="extype" name="io.gearpump.streaming.task.Task">Task</a>, <a href="../../task/TaskInterface.html" class="extype" name="io.gearpump.streaming.task.TaskInterface">TaskInterface</a>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> |
| </div></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="order"> |
| <span class="filtertype">Ordering</span> |
| <ol> |
| |
| <li class="alpha in"><span>Alphabetic</span></li> |
| <li class="inherit out"><span>By inheritance</span></li> |
| </ol> |
| </div> |
| <div id="ancestors"> |
| <span class="filtertype">Inherited<br /> |
| </span> |
| <ol id="linearization"> |
| <li class="in" name="io.gearpump.streaming.state.api.PersistentTask"><span>PersistentTask</span></li><li class="in" name="io.gearpump.streaming.task.Task"><span>Task</span></li><li class="in" name="io.gearpump.streaming.task.TaskInterface"><span>TaskInterface</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li> |
| </ol> |
| </div><div id="ancestors"> |
| <span class="filtertype"></span> |
| <ol> |
| <li class="hideall out"><span>Hide All</span></li> |
| <li class="showall in"><span>Show all</span></li> |
| </ol> |
| <a href="http://docs.scala-lang.org/overviews/scaladoc/usage.html#members" target="_blank">Learn more about member selection</a> |
| </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="constructors" class="members"> |
| <h3>Instance Constructors</h3> |
| <ol><li name="io.gearpump.streaming.state.api.PersistentTask#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="<init>(taskContext:io.gearpump.streaming.task.TaskContext,conf:io.gearpump.cluster.UserConfig):io.gearpump.streaming.state.api.PersistentTask[T]"></a> |
| <a id="<init>:PersistentTask[T]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">new</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">PersistentTask</span><span class="params">(<span name="taskContext">taskContext: <a href="../../task/TaskContext.html" class="extype" name="io.gearpump.streaming.task.TaskContext">TaskContext</a></span>, <span name="conf">conf: <a href="../../../cluster/UserConfig.html" class="extype" name="io.gearpump.cluster.UserConfig">UserConfig</a></span>)</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@<init>(taskContext:io.gearpump.streaming.task.TaskContext,conf:io.gearpump.cluster.UserConfig):io.gearpump.streaming.state.api.PersistentTask[T]" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| |
| </li></ol> |
| </div> |
| |
| |
| |
| <div id="values" class="values members"> |
| <h3>Abstract Value Members</h3> |
| <ol><li name="io.gearpump.streaming.state.api.PersistentTask#persistentState" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped"> |
| <a id="persistentState:io.gearpump.streaming.state.api.PersistentState[T]"></a> |
| <a id="persistentState:PersistentState[T]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">persistentState</span><span class="result">: <a href="PersistentState.html" class="extype" name="io.gearpump.streaming.state.api.PersistentState">PersistentState</a>[<span class="extype" name="io.gearpump.streaming.state.api.PersistentTask.T">T</span>]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@persistentState:io.gearpump.streaming.state.api.PersistentState[T]" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">subclass should override this method to pass in |
| a PersistentState</p><div class="fullcomment"><div class="comment cmt"><p>subclass should override this method to pass in |
| a PersistentState</p><p>the framework has already offered two states</p><ul><li>NonWindowState |
| state with no time or other boundary</li><li>WindowState |
| each state is bounded by a time window |
| </li></ul></div></div> |
| </li><li name="io.gearpump.streaming.state.api.PersistentTask#processMessage" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="processMessage(state:io.gearpump.streaming.state.api.PersistentState[T],message:io.gearpump.Message):Unit"></a> |
| <a id="processMessage(PersistentState[T],Message):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">processMessage</span><span class="params">(<span name="state">state: <a href="PersistentState.html" class="extype" name="io.gearpump.streaming.state.api.PersistentState">PersistentState</a>[<span class="extype" name="io.gearpump.streaming.state.api.PersistentTask.T">T</span>]</span>, <span name="message">message: <a href="../../../Message.html" class="extype" name="io.gearpump.Message">Message</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@processMessage(state:io.gearpump.streaming.state.api.PersistentState[T],message:io.gearpump.Message):Unit" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">subclass should override this method to specify how a |
| new message should update state |
| </p> |
| </li></ol> |
| </div> |
| |
| <div id="values" class="values members"> |
| <h3>Concrete Value Members</h3> |
| <ol><li name="scala.AnyRef#!=" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="!=(x$1:Any):Boolean"></a> |
| <a id="!=(Any):Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span title="gt4s: $bang$eq" class="name">!=</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@!=(x$1:Any):Boolean" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.AnyRef###" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="##():Int"></a> |
| <a id="##():Int"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span title="gt4s: $hash$hash" class="name">##</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@##():Int" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.AnyRef#==" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="==(x$1:Any):Boolean"></a> |
| <a id="==(Any):Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span title="gt4s: $eq$eq" class="name">==</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@==(x$1:Any):Boolean" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="io.gearpump.streaming.task.Task#LOG" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="LOG:org.slf4j.Logger"></a> |
| <a id="LOG:Logger"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">LOG</span><span class="result">: <span class="extype" name="org.slf4j.Logger">Logger</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@LOG:org.slf4j.Logger" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../../task/Task.html" class="extype" name="io.gearpump.streaming.task.Task">Task</a></dd></dl></div> |
| </li><li name="scala.Any#asInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="asInstanceOf[T0]:T0"></a> |
| <a id="asInstanceOf[T0]:T0"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Any.asInstanceOf.T0">T0</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@asInstanceOf[T0]:T0" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div> |
| </li><li name="io.gearpump.streaming.state.api.PersistentTask#checkpointInterval" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="checkpointInterval:Long"></a> |
| <a id="checkpointInterval:Long"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">checkpointInterval</span><span class="result">: <span class="extype" name="scala.Long">Long</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@checkpointInterval:Long" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| |
| </li><li name="io.gearpump.streaming.state.api.PersistentTask#checkpointManager" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="checkpointManager:io.gearpump.streaming.state.impl.CheckpointManager"></a> |
| <a id="checkpointManager:CheckpointManager"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">checkpointManager</span><span class="result">: <a href="../impl/CheckpointManager.html" class="extype" name="io.gearpump.streaming.state.impl.CheckpointManager">CheckpointManager</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@checkpointManager:io.gearpump.streaming.state.impl.CheckpointManager" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| |
| </li><li name="io.gearpump.streaming.state.api.PersistentTask#checkpointStore" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="checkpointStore:io.gearpump.streaming.transaction.api.CheckpointStore"></a> |
| <a id="checkpointStore:CheckpointStore"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">checkpointStore</span><span class="result">: <a href="../../transaction/api/CheckpointStore.html" class="extype" name="io.gearpump.streaming.transaction.api.CheckpointStore">CheckpointStore</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@checkpointStore:io.gearpump.streaming.transaction.api.CheckpointStore" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| |
| </li><li name="io.gearpump.streaming.state.api.PersistentTask#checkpointStoreFactory" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="checkpointStoreFactory:io.gearpump.streaming.transaction.api.CheckpointStoreFactory"></a> |
| <a id="checkpointStoreFactory:CheckpointStoreFactory"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">checkpointStoreFactory</span><span class="result">: <a href="../../transaction/api/CheckpointStoreFactory.html" class="extype" name="io.gearpump.streaming.transaction.api.CheckpointStoreFactory">CheckpointStoreFactory</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@checkpointStoreFactory:io.gearpump.streaming.transaction.api.CheckpointStoreFactory" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| |
| </li><li name="scala.AnyRef#clone" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="clone():Object"></a> |
| <a id="clone():AnyRef"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">clone</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@clone():Object" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@throws</span><span class="args">(<span> |
| |
| <span class="defval" name="classOf[java.lang.CloneNotSupportedException]">...</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="eq(x$1:AnyRef):Boolean"></a> |
| <a id="eq(AnyRef):Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@eq(x$1:AnyRef):Boolean" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="scala.AnyRef#equals" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="equals(x$1:Any):Boolean"></a> |
| <a id="equals(Any):Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@equals(x$1:Any):Boolean" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.AnyRef#finalize" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="finalize():Unit"></a> |
| <a id="finalize():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">finalize</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@finalize():Unit" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@throws</span><span class="args">(<span> |
| |
| <span class="symbol">classOf[java.lang.Throwable]</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="scala.AnyRef#getClass" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="getClass():Class[_]"></a> |
| <a id="getClass():Class[_]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">getClass</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Class">Class</span>[_]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@getClass():Class[_]" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.AnyRef#hashCode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="hashCode():Int"></a> |
| <a id="hashCode():Int"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@hashCode():Int" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.Any#isInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="isInstanceOf[T0]:Boolean"></a> |
| <a id="isInstanceOf[T0]:Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@isInstanceOf[T0]:Boolean" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div> |
| </li><li name="scala.AnyRef#ne" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="ne(x$1:AnyRef):Boolean"></a> |
| <a id="ne(AnyRef):Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@ne(x$1:AnyRef):Boolean" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="scala.AnyRef#notify" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="notify():Unit"></a> |
| <a id="notify():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">notify</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@notify():Unit" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="scala.AnyRef#notifyAll" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="notifyAll():Unit"></a> |
| <a id="notifyAll():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">notifyAll</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@notifyAll():Unit" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="io.gearpump.streaming.state.api.PersistentTask#onNext" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="onNext(message:io.gearpump.Message):Unit"></a> |
| <a id="onNext(Message):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">onNext</span><span class="params">(<span name="message">message: <a href="../../../Message.html" class="extype" name="io.gearpump.Message">Message</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@onNext(message:io.gearpump.Message):Unit" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Method called for each message received.</p><div class="fullcomment"><div class="comment cmt"><p>Method called for each message received.</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="io.gearpump.streaming.state.api.PersistentTask">PersistentTask</a> → <a href="../../task/Task.html" class="extype" name="io.gearpump.streaming.task.Task">Task</a> → <a href="../../task/TaskInterface.html" class="extype" name="io.gearpump.streaming.task.TaskInterface">TaskInterface</a></dd></dl></div> |
| </li><li name="io.gearpump.streaming.state.api.PersistentTask#onStart" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="onStart(startTime:io.gearpump.streaming.task.StartTime):Unit"></a> |
| <a id="onStart(StartTime):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">onStart</span><span class="params">(<span name="startTime">startTime: <a href="../../task/StartTime.html" class="extype" name="io.gearpump.streaming.task.StartTime">StartTime</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@onStart(startTime:io.gearpump.streaming.task.StartTime):Unit" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Method called with the task is initialized.</p><div class="fullcomment"><div class="comment cmt"><p>Method called with the task is initialized.</p></div><dl class="paramcmts block"><dt class="param">startTime</dt><dd class="cmt"><p>startTime that can be used to decide from when a source producer task should replay the data source, or from when a processor task should recover its checkpoint data in to in-memory state. |
| </p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="io.gearpump.streaming.state.api.PersistentTask">PersistentTask</a> → <a href="../../task/Task.html" class="extype" name="io.gearpump.streaming.task.Task">Task</a> → <a href="../../task/TaskInterface.html" class="extype" name="io.gearpump.streaming.task.TaskInterface">TaskInterface</a></dd></dl></div> |
| </li><li name="io.gearpump.streaming.state.api.PersistentTask#onStop" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="onStop():Unit"></a> |
| <a id="onStop():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">onStop</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@onStop():Unit" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Method called when task is under clean up.</p><div class="fullcomment"><div class="comment cmt"><p>Method called when task is under clean up. |
| This can be used to cleanup resource when the application finished. |
| </p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="io.gearpump.streaming.state.api.PersistentTask">PersistentTask</a> → <a href="../../task/Task.html" class="extype" name="io.gearpump.streaming.task.Task">Task</a> → <a href="../../task/TaskInterface.html" class="extype" name="io.gearpump.streaming.task.TaskInterface">TaskInterface</a></dd></dl></div> |
| </li><li name="io.gearpump.streaming.task.Task#receiveUnManagedMessage" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="receiveUnManagedMessage:akka.actor.Actor.Receive"></a> |
| <a id="receiveUnManagedMessage:Receive"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">receiveUnManagedMessage</span><span class="result">: <span class="extype" name="akka.actor.Actor.Receive">Receive</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@receiveUnManagedMessage:akka.actor.Actor.Receive" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">handler for unmanaged message</p><div class="fullcomment"><div class="comment cmt"><p>handler for unmanaged message</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the handler |
| </p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../../task/Task.html" class="extype" name="io.gearpump.streaming.task.Task">Task</a> → <a href="../../task/TaskInterface.html" class="extype" name="io.gearpump.streaming.task.TaskInterface">TaskInterface</a></dd></dl></div> |
| </li><li name="io.gearpump.streaming.task.Task#self" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="self:akka.actor.ActorRef"></a> |
| <a id="self:ActorRef"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">implicit </span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">self</span><span class="result">: <span class="extype" name="akka.actor.ActorRef">ActorRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@self:akka.actor.ActorRef" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../../task/Task.html" class="extype" name="io.gearpump.streaming.task.Task">Task</a></dd></dl></div> |
| </li><li name="io.gearpump.streaming.task.Task#sender" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="sender:akka.actor.ActorRef"></a> |
| <a id="sender:ActorRef"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">sender</span><span class="result">: <span class="extype" name="akka.actor.ActorRef">ActorRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@sender:akka.actor.ActorRef" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">For managed message(type of Message), the sender mean nothing, |
| you should not use this directory</p><div class="fullcomment"><div class="comment cmt"><p>For managed message(type of Message), the sender mean nothing, |
| you should not use this directory</p><p>For unmanaged message, the sender represent the sender actor</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the sender |
| </p></dd></dl><dl class="attributes block"> <dt>Attributes</dt><dd>protected </dd><dt>Definition Classes</dt><dd><a href="../../task/Task.html" class="extype" name="io.gearpump.streaming.task.Task">Task</a></dd></dl></div> |
| </li><li name="io.gearpump.streaming.state.api.PersistentTask#state" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="state:io.gearpump.streaming.state.api.PersistentState[T]"></a> |
| <a id="state:PersistentState[T]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">state</span><span class="result">: <a href="PersistentState.html" class="extype" name="io.gearpump.streaming.state.api.PersistentState">PersistentState</a>[<span class="extype" name="io.gearpump.streaming.state.api.PersistentTask.T">T</span>]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@state:io.gearpump.streaming.state.api.PersistentState[T]" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| |
| </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="synchronized[T0](x$1:=>T0):T0"></a> |
| <a id="synchronized[T0](⇒T0):T0"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: ⇒ <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>)</span><span class="result">: <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@synchronized[T0](x$1:=>T0):T0" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="io.gearpump.streaming.task.Task#system" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="system:akka.actor.ActorSystem"></a> |
| <a id="system:ActorSystem"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">implicit </span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">system</span><span class="result">: <span class="extype" name="akka.actor.ActorSystem">ActorSystem</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@system:akka.actor.ActorSystem" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected </dd><dt>Definition Classes</dt><dd><a href="../../task/Task.html" class="extype" name="io.gearpump.streaming.task.Task">Task</a></dd></dl></div> |
| </li><li name="scala.AnyRef#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="toString():String"></a> |
| <a id="toString():String"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@toString():String" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="wait():Unit"></a> |
| <a id="wait():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">wait</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@wait():Unit" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@throws</span><span class="args">(<span> |
| |
| <span class="defval" name="classOf[java.lang.InterruptedException]">...</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="wait(x$1:Long,x$2:Int):Unit"></a> |
| <a id="wait(Long,Int):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>, <span name="arg1">arg1: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@wait(x$1:Long,x$2:Int):Unit" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@throws</span><span class="args">(<span> |
| |
| <span class="defval" name="classOf[java.lang.InterruptedException]">...</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="wait(x$1:Long):Unit"></a> |
| <a id="wait(Long):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../../index.html#io.gearpump.streaming.state.api.PersistentTask@wait(x$1:Long):Unit" title="Permalink" target="_top"> |
| <img src="../../../../../lib/permalink.png" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@throws</span><span class="args">(<span> |
| |
| <span class="defval" name="classOf[java.lang.InterruptedException]">...</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li></ol> |
| </div> |
| |
| |
| |
| |
| </div> |
| |
| <div id="inheritedMembers"> |
| <div class="parent" name="io.gearpump.streaming.task.Task"> |
| <h3>Inherited from <a href="../../task/Task.html" class="extype" name="io.gearpump.streaming.task.Task">Task</a></h3> |
| </div><div class="parent" name="io.gearpump.streaming.task.TaskInterface"> |
| <h3>Inherited from <a href="../../task/TaskInterface.html" class="extype" name="io.gearpump.streaming.task.TaskInterface">TaskInterface</a></h3> |
| </div><div class="parent" name="scala.AnyRef"> |
| <h3>Inherited from <span class="extype" name="scala.AnyRef">AnyRef</span></h3> |
| </div><div class="parent" name="scala.Any"> |
| <h3>Inherited from <span class="extype" name="scala.Any">Any</span></h3> |
| </div> |
| |
| </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> |