| <!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_112) on Sun Feb 26 17:08:08 EST 2017 --> |
| <title>Executable (Edgent v1.1.0)</title> |
| <meta name="date" content="2017-02-26"> |
| <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="Executable (Edgent v1.1.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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="class-use/Executable.html">Use</a></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="../../../../../org/apache/edgent/runtime/etiao/EtiaoJob.html" title="class in org.apache.edgent.runtime.etiao"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/edgent/runtime/etiao/Invocation.html" title="class in org.apache.edgent.runtime.etiao"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/edgent/runtime/etiao/Executable.html" target="_top">Frames</a></li> |
| <li><a href="Executable.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">org.apache.edgent.runtime.etiao</div> |
| <h2 title="Class Executable" class="title">Class Executable</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.edgent.runtime.etiao.Executable</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/edgent/execution/services/RuntimeServices.html" title="interface in org.apache.edgent.execution.services">RuntimeServices</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">Executable</span> |
| extends java.lang.Object |
| implements <a href="../../../../../org/apache/edgent/execution/services/RuntimeServices.html" title="interface in org.apache.edgent.execution.services">RuntimeServices</a></pre> |
| <div class="block">Executes and provides runtime services to the executable graph |
| elements (oplets and functions).</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="../../../../../org/apache/edgent/runtime/etiao/Executable.html#Executable-java.lang.String-org.apache.edgent.execution.services.ServiceContainer-">Executable</a></span>(java.lang.String name, |
| <a href="../../../../../org/apache/edgent/execution/services/ServiceContainer.html" title="class in org.apache.edgent.execution.services">ServiceContainer</a> containerServices)</code> |
| <div class="block">Creates a new <code>Executable</code> for the specified job.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/runtime/etiao/Executable.html#Executable-java.lang.String-org.apache.edgent.execution.services.ServiceContainer-java.util.concurrent.ThreadFactory-">Executable</a></span>(java.lang.String name, |
| <a href="../../../../../org/apache/edgent/execution/services/ServiceContainer.html" title="class in org.apache.edgent.execution.services">ServiceContainer</a> containerServices, |
| java.util.concurrent.ThreadFactory threads)</code> |
| <div class="block">Creates a new <code>Executable</code> for the specified topology name, which uses the |
| given thread factory to create new threads for oplet execution.</div> |
| </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><T extends <a href="../../../../../org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet">Oplet</a><I,O>,I,O><br><a href="../../../../../org/apache/edgent/runtime/etiao/Invocation.html" title="class in org.apache.edgent.runtime.etiao">Invocation</a><T,I,O></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/runtime/etiao/Executable.html#addOpletInvocation-T-int-int-">addOpletInvocation</a></span>(T oplet, |
| int inputs, |
| int outputs)</code> |
| <div class="block">Creates a new <code>Invocation</code> associated with the specified oplet.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/runtime/etiao/Executable.html#close--">close</a></span>()</code> |
| <div class="block">Shuts down the user scheduler and thread factory, close all |
| invocations, then shutdown the control scheduler.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/runtime/etiao/Executable.html#createJob-org.apache.edgent.graph.Graph-java.lang.String-java.lang.String-">createJob</a></span>(<a href="../../../../../org/apache/edgent/graph/Graph.html" title="interface in org.apache.edgent.graph">Graph</a> graph, |
| java.lang.String topologyName, |
| java.lang.String jobName)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Throwable</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/runtime/etiao/Executable.html#getLastError--">getLastError</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.util.concurrent.ScheduledExecutorService</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/runtime/etiao/Executable.html#getScheduler--">getScheduler</a></span>()</code> |
| <div class="block">Returns the <code>ScheduledExecutorService</code> used for running |
| executable graph elements.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/runtime/etiao/Executable.html#getService-java.lang.Class-">getService</a></span>(java.lang.Class<T> serviceClass)</code> |
| <div class="block">Acts as a service provider for executable elements in the graph, first |
| looking for a service specific to this job, and then one from the |
| container.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/runtime/etiao/Executable.html#hasActiveTasks--">hasActiveTasks</a></span>()</code> |
| <div class="block">Check whether there are user tasks still active.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/runtime/etiao/Executable.html#initialize--">initialize</a></span>()</code> |
| <div class="block">Initializes the invocations.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/runtime/etiao/Executable.html#start--">start</a></span>()</code> |
| <div class="block">Starts all the invocations.</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="Executable-java.lang.String-org.apache.edgent.execution.services.ServiceContainer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Executable</h4> |
| <pre>public Executable(java.lang.String name, |
| <a href="../../../../../org/apache/edgent/execution/services/ServiceContainer.html" title="class in org.apache.edgent.execution.services">ServiceContainer</a> containerServices)</pre> |
| <div class="block">Creates a new <code>Executable</code> for the specified job.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the executable</dd> |
| <dd><code>containerServices</code> - runtime services provided by the container</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="Executable-java.lang.String-org.apache.edgent.execution.services.ServiceContainer-java.util.concurrent.ThreadFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Executable</h4> |
| <pre>public Executable(java.lang.String name, |
| <a href="../../../../../org/apache/edgent/execution/services/ServiceContainer.html" title="class in org.apache.edgent.execution.services">ServiceContainer</a> containerServices, |
| java.util.concurrent.ThreadFactory threads)</pre> |
| <div class="block">Creates a new <code>Executable</code> for the specified topology name, which uses the |
| given thread factory to create new threads for oplet execution.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the executable</dd> |
| <dd><code>containerServices</code> - runtime services provided by the container</dd> |
| <dd><code>threads</code> - thread factory for executing the oplets</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getScheduler--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScheduler</h4> |
| <pre>public java.util.concurrent.ScheduledExecutorService getScheduler()</pre> |
| <div class="block">Returns the <code>ScheduledExecutorService</code> used for running |
| executable graph elements.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the scheduler</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getService-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getService</h4> |
| <pre>public <T> T getService(java.lang.Class<T> serviceClass)</pre> |
| <div class="block">Acts as a service provider for executable elements in the graph, first |
| looking for a service specific to this job, and then one from the |
| container.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/edgent/execution/services/RuntimeServices.html#getService-java.lang.Class-">getService</a></code> in interface <code><a href="../../../../../org/apache/edgent/execution/services/RuntimeServices.html" title="interface in org.apache.edgent.execution.services">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - service class type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serviceClass</code> - Type of the service required.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Service of type implementing <code>serviceClass</code> if the |
| container this invocation runs in supports that service, |
| otherwise <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addOpletInvocation-org.apache.edgent.oplet.Oplet-int-int-"> |
| <!-- --> |
| </a><a name="addOpletInvocation-T-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addOpletInvocation</h4> |
| <pre>public <T extends <a href="../../../../../org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet">Oplet</a><I,O>,I,O> <a href="../../../../../org/apache/edgent/runtime/etiao/Invocation.html" title="class in org.apache.edgent.runtime.etiao">Invocation</a><T,I,O> addOpletInvocation(T oplet, |
| int inputs, |
| int outputs)</pre> |
| <div class="block">Creates a new <code>Invocation</code> associated with the specified oplet.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Oplet type</dd> |
| <dd><code>I</code> - Tuple type of input streams</dd> |
| <dd><code>O</code> - Tuple type of output streams</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>oplet</code> - the oplet</dd> |
| <dd><code>inputs</code> - the invocation's inputs</dd> |
| <dd><code>outputs</code> - the invocation's outputs</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new invocation for the given oplet</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initialize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>public void initialize()</pre> |
| <div class="block">Initializes the invocations.</div> |
| </li> |
| </ul> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>public void start()</pre> |
| <div class="block">Starts all the invocations.</div> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block">Shuts down the user scheduler and thread factory, close all |
| invocations, then shutdown the control scheduler.</div> |
| </li> |
| </ul> |
| <a name="hasActiveTasks--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasActiveTasks</h4> |
| <pre>public boolean hasActiveTasks()</pre> |
| <div class="block">Check whether there are user tasks still active.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if at least a user task is still active.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLastError--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastError</h4> |
| <pre>public java.lang.Throwable getLastError()</pre> |
| </li> |
| </ul> |
| <a name="createJob-org.apache.edgent.graph.Graph-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createJob</h4> |
| <pre>public <a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a> createJob(<a href="../../../../../org/apache/edgent/graph/Graph.html" title="interface in org.apache.edgent.graph">Graph</a> graph, |
| java.lang.String topologyName, |
| java.lang.String jobName)</pre> |
| </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="class-use/Executable.html">Use</a></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 class="aboutLanguage"><a href="http://edgent.incubator.apache.org">Apache Edgent (incubating)</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/edgent/runtime/etiao/EtiaoJob.html" title="class in org.apache.edgent.runtime.etiao"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/edgent/runtime/etiao/Invocation.html" title="class in org.apache.edgent.runtime.etiao"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/edgent/runtime/etiao/Executable.html" target="_top">Frames</a></li> |
| <li><a href="Executable.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> |
| </body> |
| </html> |