| <!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:40 CST 2016 --> |
| <title>Processor</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="Processor"; |
| } |
| //--> |
| </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/LifeTime$.html" title="class in io.gearpump.streaming"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="class in io.gearpump.streaming"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?io/gearpump/streaming/Processor.html" target="_top">Frames</a></li> |
| <li><a href="Processor.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><a href="#nested_class_summary">Nested</a> | </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</div> |
| <h2 title="Interface Processor" class="title">Interface Processor<T extends <a href="../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a>></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>io.gearpump.util.ReferenceEqual</dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../io/gearpump/streaming/javaapi/Processor.html" title="class in io.gearpump.streaming.javaapi">Processor</a>, <a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="class in io.gearpump.streaming">Processor.DefaultProcessor</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">Processor<T extends <a href="../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a>></span> |
| extends io.gearpump.util.ReferenceEqual</pre> |
| <div class="block">Processor is the blueprint for tasks. |
| <p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="class in io.gearpump.streaming">Processor.DefaultProcessor</a><<a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="type parameter in Processor.DefaultProcessor">T</a> extends <a href="../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a>></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor$.html" title="class in io.gearpump.streaming">Processor.DefaultProcessor$</a></strong></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="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>java.lang.String</code></td> |
| <td class="colLast"><code><strong><a href="../../../io/gearpump/streaming/Processor.html#description()">description</a></strong>()</code> |
| <div class="block">Some description text for this processor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../io/gearpump/streaming/Processor.html#parallelism()">parallelism</a></strong>()</code> |
| <div class="block">How many tasks you want to use for this processor.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.Class<? extends <a href="../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../io/gearpump/streaming/Processor.html#taskClass()">taskClass</a></strong>()</code> |
| <div class="block">The task class, should be a subtype of Task.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>io.gearpump.cluster.UserConfig</code></td> |
| <td class="colLast"><code><strong><a href="../../../io/gearpump/streaming/Processor.html#taskConf()">taskConf</a></strong>()</code> |
| <div class="block">The custom <code>UserConfig</code>, it is used to initialize a task in runtime.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_io.gearpump.util.ReferenceEqual"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface io.gearpump.util.ReferenceEqual</h3> |
| <code>equals</code></li> |
| </ul> |
| </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="parallelism()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parallelism</h4> |
| <pre>int parallelism()</pre> |
| <div class="block">How many tasks you want to use for this processor.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> |
| </li> |
| </ul> |
| <a name="taskConf()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>taskConf</h4> |
| <pre>io.gearpump.cluster.UserConfig taskConf()</pre> |
| <div class="block">The custom <code>UserConfig</code>, it is used to initialize a task in runtime.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> |
| </li> |
| </ul> |
| <a name="description()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>description</h4> |
| <pre>java.lang.String description()</pre> |
| <div class="block">Some description text for this processor.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> |
| </li> |
| </ul> |
| <a name="taskClass()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>taskClass</h4> |
| <pre>java.lang.Class<? extends <a href="../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a>> taskClass()</pre> |
| <div class="block">The task class, should be a subtype of Task. |
| <p> |
| Each runtime instance of this class is a task.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><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/LifeTime$.html" title="class in io.gearpump.streaming"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../io/gearpump/streaming/Processor.DefaultProcessor.html" title="class in io.gearpump.streaming"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?io/gearpump/streaming/Processor.html" target="_top">Frames</a></li> |
| <li><a href="Processor.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><a href="#nested_class_summary">Nested</a> | </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> |