blob: b57b4e728df46b17d352a3eaaf00cb8cf709c864 [file] [log] [blame]
<!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 Mon Dec 18 11:25:21 EST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.edgent.runtime.etiao (Apache Edgent (incubating) v1.2.0 API)</title>
<meta name="date" content="2017-12-18">
<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="org.apache.edgent.runtime.etiao (Apache Edgent (incubating) v1.2.0 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/appservice/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/edgent/runtime/etiao/graph/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/edgent/runtime/etiao/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.edgent.runtime.etiao</h1>
<div class="docSummary">
<div class="block">A runtime for executing an Edgent streaming topology, designed as an embeddable library
so that it can be executed in a simple Java application.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/edgent/runtime/etiao/AbstractContext.html" title="class in org.apache.edgent.runtime.etiao">AbstractContext</a>&lt;I,O&gt;</td>
<td class="colLast">
<div class="block">Provides a skeletal implementation of the <a href="../../../../../org/apache/edgent/oplet/OpletContext.html" title="interface in org.apache.edgent.oplet"><code>OpletContext</code></a>
interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/edgent/runtime/etiao/EtiaoJob.html" title="class in org.apache.edgent.runtime.etiao">EtiaoJob</a></td>
<td class="colLast">
<div class="block">Etiao runtime implementation of the <a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution"><code>Job</code></a> interface.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/edgent/runtime/etiao/Executable.html" title="class in org.apache.edgent.runtime.etiao">Executable</a></td>
<td class="colLast">
<div class="block">Executes and provides runtime services to the executable graph
elements (oplets and functions).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/edgent/runtime/etiao/Invocation.html" title="class in org.apache.edgent.runtime.etiao">Invocation</a>&lt;T extends <a href="../../../../../org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet">Oplet</a>&lt;I,O&gt;,I,O&gt;</td>
<td class="colLast">
<div class="block">An <a href="../../../../../org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet"><code>Oplet</code></a> invocation in the context of the
<a href="../../../../../org/apache/edgent/runtime/etiao/package-summary.html">ETIAO</a> runtime.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/edgent/runtime/etiao/InvocationContext.html" title="class in org.apache.edgent.runtime.etiao">InvocationContext</a>&lt;I,O&gt;</td>
<td class="colLast">
<div class="block">Context information for the <code>Oplet</code>'s execution context.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/edgent/runtime/etiao/SettableForwarder.html" title="class in org.apache.edgent.runtime.etiao">SettableForwarder</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A forwarding Streamer whose destination
can be changed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/edgent/runtime/etiao/ThreadFactoryTracker.html" title="class in org.apache.edgent.runtime.etiao">ThreadFactoryTracker</a></td>
<td class="colLast">
<div class="block">Tracks threads created for executing user tasks.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/edgent/runtime/etiao/TrackingScheduledExecutor.html" title="class in org.apache.edgent.runtime.etiao">TrackingScheduledExecutor</a></td>
<td class="colLast">
<div class="block">Extends a <code>ScheduledThreadPoolExecutor</code> with the ability to track
scheduled tasks and cancel them in case a task completes abruptly due to
an exception.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.edgent.runtime.etiao Description">Package org.apache.edgent.runtime.etiao Description</h2>
<div class="block">A runtime for executing an Edgent streaming topology, designed as an embeddable library
so that it can be executed in a simple Java application.
<h2>"EveryThing Is An Oplet" (ETIAO)</h2>
The runtime's focus is on executing oplets and their connected streams, where each
oplet is just a black box. Specifically this means that functionality is added by the introduction
of oplets into the graph that were not explicitly declared by the application developer.
For example, metrics are implemented by oplets, not the runtime. A metric collector is an
oplet that calculates metrics on tuples accepted on its input port, and them makes them
available, for example through JMX.</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/appservice/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/edgent/runtime/etiao/graph/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/edgent/runtime/etiao/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2016&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>