| <!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 (version 1.7.0_67) on Thu Feb 04 13:28:41 CST 2016 --> |
| <title>TaskContext</title> |
| <meta name="date" content="2016-02-04"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="TaskContext"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/TaskActor$.html" title="class in io.gearpump.streaming.task"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../io/gearpump/streaming/task/TaskContextData.html" title="class in io.gearpump.streaming.task"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?io/gearpump/streaming/task/TaskContext.html" target="_top">Frames</a></li> |
| <li><a href="TaskContext.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>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface TaskContext" class="title">Interface TaskContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../io/gearpump/streaming/task/TaskWrapper.html" title="class in io.gearpump.streaming.task">TaskWrapper</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">TaskContext</span></pre> |
| <div class="block">This provides context information for a task.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>akka.actor.ActorRef</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#actorOf(akka.actor.Props)">actorOf</a></strong>(akka.actor.Props props)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>akka.actor.ActorRef</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#actorOf(akka.actor.Props,%20java.lang.String)">actorOf</a></strong>(akka.actor.Props props, |
| java.lang.String name)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#appId()">appId</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>akka.actor.ActorRef</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#appMaster()">appMaster</a></strong>()</code> |
| <div class="block">The actorRef of AppMaster</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#appName()">appName</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#executorId()">executorId</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>org.slf4j.Logger</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#logger()">logger</a></strong>()</code> |
| <div class="block">logger is environment dependant, it should be provided by |
| containing environment.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#output(io.gearpump.Message)">output</a></strong>(io.gearpump.Message msg)</code> |
| <div class="block">This can be used to output messages to downstream tasks.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#parallelism()">parallelism</a></strong>()</code> |
| <div class="block">The task parallelism</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>akka.actor.Cancellable</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#schedule(scala.concurrent.duration.FiniteDuration,%20scala.concurrent.duration.FiniteDuration,%20scala.Function0)">schedule</a></strong>(scala.concurrent.duration.FiniteDuration initialDelay, |
| scala.concurrent.duration.FiniteDuration interval, |
| scala.Function0<scala.runtime.BoxedUnit> f)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>akka.actor.Cancellable</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#scheduleOnce(scala.concurrent.duration.FiniteDuration,%20scala.Function0)">scheduleOnce</a></strong>(scala.concurrent.duration.FiniteDuration initialDelay, |
| scala.Function0<scala.runtime.BoxedUnit> f)</code> |
| <div class="block">akka.actor.ActorRefProvider.scheduleOnce</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>akka.actor.ActorRef</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#self()">self</a></strong>()</code> |
| <div class="block">Please don't use this if possible.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>akka.actor.ActorRef</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#sender()">sender</a></strong>()</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 class="rowColor"> |
| <td class="colFirst"><code>akka.actor.ActorSystem</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#system()">system</a></strong>()</code> |
| <div class="block">Please don't use this if possible</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#taskId()">taskId</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/TaskContext.html#upstreamMinClock()">upstreamMinClock</a></strong>()</code> |
| <div class="block">retrieve upstream min clock from TaskActor</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="taskId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>taskId</h4> |
| <pre><a href="../../../../io/gearpump/streaming/task/TaskId.html" title="class in io.gearpump.streaming.task">TaskId</a> taskId()</pre> |
| </li> |
| </ul> |
| <a name="executorId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>executorId</h4> |
| <pre>int executorId()</pre> |
| </li> |
| </ul> |
| <a name="appId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appId</h4> |
| <pre>int appId()</pre> |
| </li> |
| </ul> |
| <a name="appName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appName</h4> |
| <pre>java.lang.String appName()</pre> |
| </li> |
| </ul> |
| <a name="appMaster()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appMaster</h4> |
| <pre>akka.actor.ActorRef appMaster()</pre> |
| <div class="block">The actorRef of AppMaster</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>application master's actor reference</dd></dl> |
| </li> |
| </ul> |
| <a name="parallelism()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parallelism</h4> |
| <pre>int parallelism()</pre> |
| <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="strong">Returns:</span></dt><dd>the parallelism level</dd></dl> |
| </li> |
| </ul> |
| <a name="self()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>self</h4> |
| <pre>akka.actor.ActorRef self()</pre> |
| <div class="block">Please don't use this if possible.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>self actor ref</dd></dl> |
| </li> |
| </ul> |
| <a name="system()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>system</h4> |
| <pre>akka.actor.ActorSystem system()</pre> |
| <div class="block">Please don't use this if possible</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the actor system</dd></dl> |
| </li> |
| </ul> |
| <a name="output(io.gearpump.Message)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>output</h4> |
| <pre>void output(io.gearpump.Message msg)</pre> |
| <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="strong">Parameters:</span></dt><dd><code>msg</code> - message to output</dd></dl> |
| </li> |
| </ul> |
| <a name="actorOf(akka.actor.Props)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>actorOf</h4> |
| <pre>akka.actor.ActorRef actorOf(akka.actor.Props props)</pre> |
| </li> |
| </ul> |
| <a name="actorOf(akka.actor.Props, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>actorOf</h4> |
| <pre>akka.actor.ActorRef actorOf(akka.actor.Props props, |
| java.lang.String name)</pre> |
| </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>akka.actor.Cancellable schedule(scala.concurrent.duration.FiniteDuration initialDelay, |
| scala.concurrent.duration.FiniteDuration interval, |
| scala.Function0<scala.runtime.BoxedUnit> f)</pre> |
| </li> |
| </ul> |
| <a name="scheduleOnce(scala.concurrent.duration.FiniteDuration, scala.Function0)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scheduleOnce</h4> |
| <pre>akka.actor.Cancellable scheduleOnce(scala.concurrent.duration.FiniteDuration initialDelay, |
| scala.Function0<scala.runtime.BoxedUnit> f)</pre> |
| <div class="block">akka.actor.ActorRefProvider.scheduleOnce</div> |
| <dl><dt><span class="strong">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="strong">Returns:</span></dt><dd>the executable</dd></dl> |
| </li> |
| </ul> |
| <a name="sender()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sender</h4> |
| <pre>akka.actor.ActorRef sender()</pre> |
| <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="strong">Returns:</span></dt><dd>sender</dd></dl> |
| </li> |
| </ul> |
| <a name="upstreamMinClock()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>upstreamMinClock</h4> |
| <pre>long upstreamMinClock()</pre> |
| <div class="block">retrieve upstream min clock from TaskActor</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the min clock</dd></dl> |
| </li> |
| </ul> |
| <a name="logger()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>logger</h4> |
| <pre>org.slf4j.Logger logger()</pre> |
| <div class="block">logger is environment dependant, it should be provided by |
| containing environment.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/TaskActor$.html" title="class in io.gearpump.streaming.task"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../io/gearpump/streaming/task/TaskContextData.html" title="class in io.gearpump.streaming.task"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?io/gearpump/streaming/task/TaskContext.html" target="_top">Frames</a></li> |
| <li><a href="TaskContext.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>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
