| <!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_40) on Mon Apr 04 23:10:27 CST 2016 --> |
| <title>TaskWrapper</title> |
| <meta name="date" content="2016-04-04"> |
| <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="TaskWrapper"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../../io/gearpump/streaming/task/TaskUtil$.html" title="class in io.gearpump.streaming.task"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../io/gearpump/streaming/task/UpdateClock.html" title="class in io.gearpump.streaming.task"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?io/gearpump/streaming/task/TaskWrapper.html" target="_top">Frames</a></li> |
| <li><a href="TaskWrapper.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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">io.gearpump.streaming.task</div> |
| <h2 title="Class TaskWrapper" class="title">Class TaskWrapper</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>io.gearpump.streaming.task.TaskWrapper</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a>, <a href="../../../../io/gearpump/streaming/task/TaskInterface.html" title="interface in io.gearpump.streaming.task">TaskInterface</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">TaskWrapper</span> |
| extends java.lang.Object |
| implements <a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a>, <a href="../../../../io/gearpump/streaming/task/TaskInterface.html" title="interface in io.gearpump.streaming.task">TaskInterface</a></pre> |
| <div class="block">This provides TaskContext for user defined tasks</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#TaskWrapper-io.gearpump.streaming.task.TaskId-java.lang.Class-io.gearpump.streaming.task.TaskContextData-io.gearpump.cluster.UserConfig-">TaskWrapper</a></span>(<a href="../../../../io/gearpump/streaming/task/TaskId.html" title="class in io.gearpump.streaming.task">TaskId</a> taskId, |
| java.lang.Class<? extends <a href="../../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a>> taskClass, |
| <a href="../../../../io/gearpump/streaming/task/TaskContextData.html" title="class in io.gearpump.streaming.task">TaskContextData</a> context, |
| io.gearpump.cluster.UserConfig userConf)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>akka.actor.ActorRef</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#actorOf-akka.actor.Props-">actorOf</a></span>(akka.actor.Props props)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>akka.actor.ActorRef</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#actorOf-akka.actor.Props-java.lang.String-">actorOf</a></span>(akka.actor.Props props, |
| java.lang.String name)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#appId--">appId</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>akka.actor.ActorRef</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#appMaster--">appMaster</a></span>()</code> |
| <div class="block">The actorRef of AppMaster</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#appName--">appName</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#executorId--">executorId</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>org.slf4j.Logger</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#logger--">logger</a></span>()</code> |
| <div class="block">logger is environment dependant, it should be provided by |
| containing environment.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#onNext-io.gearpump.Message-">onNext</a></span>(io.gearpump.Message msg)</code> |
| <div class="block">Method called for each message received.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#onStart-io.gearpump.streaming.task.StartTime-">onStart</a></span>(<a href="../../../../io/gearpump/streaming/task/StartTime.html" title="class in io.gearpump.streaming.task">StartTime</a> startTime)</code> |
| <div class="block">Method called with the task is initialized.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#onStop--">onStop</a></span>()</code> |
| <div class="block">Method called when task is under clean up.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#output-int-io.gearpump.Message-">output</a></span>(int index, |
| io.gearpump.Message msg)</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#output-io.gearpump.Message-">output</a></span>(io.gearpump.Message msg)</code> |
| <div class="block">This can be used to output messages to downstream tasks.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#outputUnManaged-java.lang.Object-scala.collection.Seq-">outputUnManaged</a></span>(java.lang.Object msg, |
| scala.collection.Seq<<a href="../../../../io/gearpump/streaming/task/TaskId.html" title="class in io.gearpump.streaming.task">TaskId</a>> tasks)</code> |
| <div class="block">Use with caution, output unmanaged message to target tasks</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#parallelism--">parallelism</a></span>()</code> |
| <div class="block">The task parallelism</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#receiveUnManagedMessage--">receiveUnManagedMessage</a></span>()</code> |
| <div class="block">handler for unmanaged message</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>akka.actor.Cancellable</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#schedule-scala.concurrent.duration.FiniteDuration-scala.concurrent.duration.FiniteDuration-scala.Function0-">schedule</a></span>(scala.concurrent.duration.FiniteDuration initialDelay, |
| scala.concurrent.duration.FiniteDuration interval, |
| scala.Function0<scala.runtime.BoxedUnit> f)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>akka.actor.Cancellable</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#scheduleOnce-scala.concurrent.duration.FiniteDuration-scala.Function0-">scheduleOnce</a></span>(scala.concurrent.duration.FiniteDuration initialDelay, |
| scala.Function0<scala.runtime.BoxedUnit> f)</code> |
| <div class="block">akka.actor.ActorRefProvider.scheduleOnce</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>akka.actor.ActorRef</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#self--">self</a></span>()</code> |
| <div class="block">Please don't use this if possible.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>akka.actor.ActorRef</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#sender--">sender</a></span>()</code> |
| <div class="block">For managed message(type of Message), the sender only serve as a unique Id, |
| It's address is not something meaningful, you should not use this directly</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#setTaskActor-io.gearpump.streaming.task.TaskActor-">setTaskActor</a></span>(<a href="../../../../io/gearpump/streaming/task/TaskActor.html" title="class in io.gearpump.streaming.task">TaskActor</a> actor)</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>akka.actor.ActorSystem</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#system--">system</a></span>()</code> |
| <div class="block">Please don't use this if possible</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../io/gearpump/streaming/task/TaskId.html" title="class in io.gearpump.streaming.task">TaskId</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#taskId--">taskId</a></span>()</code> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html#upstreamMinClock--">upstreamMinClock</a></span>()</code> |
| <div class="block">retrieve upstream min clock from TaskActor</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="TaskWrapper-io.gearpump.streaming.task.TaskId-java.lang.Class-io.gearpump.streaming.task.TaskContextData-io.gearpump.cluster.UserConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TaskWrapper</h4> |
| <pre>public TaskWrapper(<a href="../../../../io/gearpump/streaming/task/TaskId.html" title="class in io.gearpump.streaming.task">TaskId</a> taskId, |
| java.lang.Class<? extends <a href="../../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a>> taskClass, |
| <a href="../../../../io/gearpump/streaming/task/TaskContextData.html" title="class in io.gearpump.streaming.task">TaskContextData</a> context, |
| io.gearpump.cluster.UserConfig userConf)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="taskId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>taskId</h4> |
| <pre>public <a href="../../../../io/gearpump/streaming/task/TaskId.html" title="class in io.gearpump.streaming.task">TaskId</a> taskId()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#taskId--">taskId</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTaskActor-io.gearpump.streaming.task.TaskActor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTaskActor</h4> |
| <pre>public void setTaskActor(<a href="../../../../io/gearpump/streaming/task/TaskActor.html" title="class in io.gearpump.streaming.task">TaskActor</a> actor)</pre> |
| </li> |
| </ul> |
| <a name="appId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appId</h4> |
| <pre>public int appId()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#appId--">appId</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="appName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appName</h4> |
| <pre>public java.lang.String appName()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#appName--">appName</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="executorId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>executorId</h4> |
| <pre>public int executorId()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#executorId--">executorId</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parallelism--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parallelism</h4> |
| <pre>public int parallelism()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#parallelism--">TaskContext</a></code></span></div> |
| <div class="block">The task parallelism |
| <p> |
| For example, we can create 3 source tasks, and 3 sink tasks, |
| the task parallelism is 3 for each. |
| <p> |
| This can be useful when reading from partitioned data source. |
| For example, for kafka, there may be 10 partitions, if we have |
| parallelism of 2 for this task, then each task will be responsible |
| to read data from 5 partitions. |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#parallelism--">parallelism</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the parallelism level</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="appMaster--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appMaster</h4> |
| <pre>public akka.actor.ActorRef appMaster()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#appMaster--">TaskContext</a></code></span></div> |
| <div class="block">The actorRef of AppMaster</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#appMaster--">appMaster</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>application master's actor reference</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="output-io.gearpump.Message-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>output</h4> |
| <pre>public void output(io.gearpump.Message msg)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#output-io.gearpump.Message-">TaskContext</a></code></span></div> |
| <div class="block">This can be used to output messages to downstream tasks. |
| The data shuffling rule can be decided by Partitioner.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#output-io.gearpump.Message-">output</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>msg</code> - message to output</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="output-int-io.gearpump.Message-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>output</h4> |
| <pre>public void output(int index, |
| io.gearpump.Message msg)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index,</code> - not same as ProcessorId</dd> |
| <dd><code>msg</code> - </dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>TaskActor.output</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="outputUnManaged-java.lang.Object-scala.collection.Seq-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outputUnManaged</h4> |
| <pre>public void outputUnManaged(java.lang.Object msg, |
| scala.collection.Seq<<a href="../../../../io/gearpump/streaming/task/TaskId.html" title="class in io.gearpump.streaming.task">TaskId</a>> tasks)</pre> |
| <div class="block">Use with caution, output unmanaged message to target tasks</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>msg</code> - message to output</dd> |
| <dd><code>tasks</code> - the tasks to output to</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="self--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>self</h4> |
| <pre>public akka.actor.ActorRef self()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#self--">TaskContext</a></code></span></div> |
| <div class="block">Please don't use this if possible.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#self--">self</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>self actor ref</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sender--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sender</h4> |
| <pre>public akka.actor.ActorRef sender()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#sender--">TaskContext</a></code></span></div> |
| <div class="block">For managed message(type of Message), the sender only serve as a unique Id, |
| It's address is not something meaningful, you should not use this directly |
| <p> |
| For unmanaged message, the sender represent the sender ActorRef</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#sender--">sender</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>sender</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="system--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>system</h4> |
| <pre>public akka.actor.ActorSystem system()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#system--">TaskContext</a></code></span></div> |
| <div class="block">Please don't use this if possible</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#system--">system</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the actor system</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="actorOf-akka.actor.Props-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>actorOf</h4> |
| <pre>public akka.actor.ActorRef actorOf(akka.actor.Props props)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#actorOf-akka.actor.Props-">actorOf</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="actorOf-akka.actor.Props-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>actorOf</h4> |
| <pre>public akka.actor.ActorRef actorOf(akka.actor.Props props, |
| java.lang.String name)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#actorOf-akka.actor.Props-java.lang.String-">actorOf</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onStart-io.gearpump.streaming.task.StartTime-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onStart</h4> |
| <pre>public void onStart(<a href="../../../../io/gearpump/streaming/task/StartTime.html" title="class in io.gearpump.streaming.task">StartTime</a> startTime)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html#onStart-io.gearpump.streaming.task.StartTime-">TaskInterface</a></code></span></div> |
| <div class="block">Method called with the task is initialized.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html#onStart-io.gearpump.streaming.task.StartTime-">onStart</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html" title="interface in io.gearpump.streaming.task">TaskInterface</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startTime</code> - 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.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onNext-io.gearpump.Message-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onNext</h4> |
| <pre>public void onNext(io.gearpump.Message msg)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html#onNext-io.gearpump.Message-">TaskInterface</a></code></span></div> |
| <div class="block">Method called for each message received.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html#onNext-io.gearpump.Message-">onNext</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html" title="interface in io.gearpump.streaming.task">TaskInterface</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>msg</code> - message send by upstream tasks</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onStop--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onStop</h4> |
| <pre>public void onStop()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html#onStop--">TaskInterface</a></code></span></div> |
| <div class="block">Method called when task is under clean up. |
| This can be used to cleanup resource when the application finished.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html#onStop--">onStop</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html" title="interface in io.gearpump.streaming.task">TaskInterface</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="receiveUnManagedMessage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>receiveUnManagedMessage</h4> |
| <pre>public scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receiveUnManagedMessage()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html#receiveUnManagedMessage--">TaskInterface</a></code></span></div> |
| <div class="block">handler for unmanaged message</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html#receiveUnManagedMessage--">receiveUnManagedMessage</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html" title="interface in io.gearpump.streaming.task">TaskInterface</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the handler</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="upstreamMinClock--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>upstreamMinClock</h4> |
| <pre>public long upstreamMinClock()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#upstreamMinClock--">TaskContext</a></code></span></div> |
| <div class="block">retrieve upstream min clock from TaskActor</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#upstreamMinClock--">upstreamMinClock</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the min clock</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="schedule-scala.concurrent.duration.FiniteDuration-scala.concurrent.duration.FiniteDuration-scala.Function0-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>schedule</h4> |
| <pre>public akka.actor.Cancellable schedule(scala.concurrent.duration.FiniteDuration initialDelay, |
| scala.concurrent.duration.FiniteDuration interval, |
| scala.Function0<scala.runtime.BoxedUnit> f)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#schedule-scala.concurrent.duration.FiniteDuration-scala.concurrent.duration.FiniteDuration-scala.Function0-">schedule</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="scheduleOnce-scala.concurrent.duration.FiniteDuration-scala.Function0-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scheduleOnce</h4> |
| <pre>public akka.actor.Cancellable scheduleOnce(scala.concurrent.duration.FiniteDuration initialDelay, |
| scala.Function0<scala.runtime.BoxedUnit> f)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#scheduleOnce-scala.concurrent.duration.FiniteDuration-scala.Function0-">TaskContext</a></code></span></div> |
| <div class="block">akka.actor.ActorRefProvider.scheduleOnce</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#scheduleOnce-scala.concurrent.duration.FiniteDuration-scala.Function0-">scheduleOnce</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialDelay</code> - the initial delay</dd> |
| <dd><code>f</code> - the function to execute after initial delay</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the executable</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="logger--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>logger</h4> |
| <pre>public org.slf4j.Logger logger()</pre> |
| <div class="block">logger is environment dependant, it should be provided by |
| containing environment.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskContext.html#logger--">logger</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </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="../../../../io/gearpump/streaming/task/TaskUtil$.html" title="class in io.gearpump.streaming.task"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../io/gearpump/streaming/task/UpdateClock.html" title="class in io.gearpump.streaming.task"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?io/gearpump/streaming/task/TaskWrapper.html" target="_top">Frames</a></li> |
| <li><a href="TaskWrapper.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |