Google Git
Sign in
apache / incubator-retired-edgent-website / 1d74f4c030b7ba91ee3052633b8aafac15d6919c / . / site / javadoc / r1.2.0 / overview-summary.html
blob: d2f2fc587954502981f70a49e6bc3688e4f354c7 [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:23 EST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Overview (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="Overview (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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-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 class="title">Apache Edgent (incubating) v1.2.0 API</h1>
</div>
<div class="header">
<div class="subTitle">
<div class="block">Apache Edgent is an SDK for developing and executing streaming analytics at the <i>edge</i>.</div>
</div>
<p>See: <a href="#overview.description">Description</a></p>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Edgent Providers table, listing packages, and an explanation">
<caption><span>Edgent Providers</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/providers/development/package-summary.html">org.apache.edgent.providers.development</a></td>
<td class="colLast">
<div class="block">Execution of a streaming topology in a development environment .</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/providers/direct/package-summary.html">org.apache.edgent.providers.direct</a></td>
<td class="colLast">
<div class="block">Direct execution of a streaming topology.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/providers/iot/package-summary.html">org.apache.edgent.providers.iot</a></td>
<td class="colLast">
<div class="block">Iot provider that allows multiple applications to
share an <code>IotDevice</code>.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Edgent API table, listing packages, and an explanation">
<caption><span>Edgent API</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/execution/package-summary.html">org.apache.edgent.execution</a></td>
<td class="colLast">
<div class="block">Execution of Edgent topologies and graphs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/execution/mbeans/package-summary.html">org.apache.edgent.execution.mbeans</a></td>
<td class="colLast">
<div class="block">Management MBeans for execution.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/execution/services/package-summary.html">org.apache.edgent.execution.services</a></td>
<td class="colLast">
<div class="block">Execution services.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/function/package-summary.html">org.apache.edgent.function</a></td>
<td class="colLast">
<div class="block">Functional interfaces for lambda expressions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/topology/package-summary.html">org.apache.edgent.topology</a></td>
<td class="colLast">
<div class="block">Functional api to build a streaming topology.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/topology/json/package-summary.html">org.apache.edgent.topology.json</a></td>
<td class="colLast">
<div class="block">Utilities for use of JSON in a streaming topology.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/topology/mbeans/package-summary.html">org.apache.edgent.topology.mbeans</a></td>
<td class="colLast">
<div class="block">Controls for executing topologies.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/topology/plumbing/package-summary.html">org.apache.edgent.topology.plumbing</a></td>
<td class="colLast">
<div class="block">Plumbing for a streaming topology.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/topology/services/package-summary.html">org.apache.edgent.topology.services</a></td>
<td class="colLast">
<div class="block">Services for topologies.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Edgent Analytics table, listing packages, and an explanation">
<caption><span>Edgent Analytics</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/analytics/math3/package-summary.html">org.apache.edgent.analytics.math3</a></td>
<td class="colLast">
<div class="block">Analytics using Apache Commons Math.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/analytics/math3/json/package-summary.html">org.apache.edgent.analytics.math3.json</a></td>
<td class="colLast">
<div class="block">JSON analytics using Apache Commons Math.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/analytics/math3/stat/package-summary.html">org.apache.edgent.analytics.math3.stat</a></td>
<td class="colLast">
<div class="block">Statistical algorithms using Apache Commons Math.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/analytics/sensors/package-summary.html">org.apache.edgent.analytics.sensors</a></td>
<td class="colLast">
<div class="block">Analytics focused on handling sensor data.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Edgent Connectors table, listing packages, and an explanation">
<caption><span>Edgent Connectors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/command/package-summary.html">org.apache.edgent.connectors.command</a></td>
<td class="colLast">
<div class="block">Command / OS Process connector.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/csv/package-summary.html">org.apache.edgent.connectors.csv</a></td>
<td class="colLast">
<div class="block">Utilities for handling Comma Separated Value strings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/file/package-summary.html">org.apache.edgent.connectors.file</a></td>
<td class="colLast">
<div class="block">File stream connector.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/http/package-summary.html">org.apache.edgent.connectors.http</a></td>
<td class="colLast">
<div class="block">HTTP stream connector.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/iot/package-summary.html">org.apache.edgent.connectors.iot</a></td>
<td class="colLast">
<div class="block">Edgent IoT device and IoT Gateway device connector API to an IoT message hub.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/iotp/package-summary.html">org.apache.edgent.connectors.iotp</a></td>
<td class="colLast">
<div class="block">IBM Watson IoT Platform stream connector.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/jdbc/package-summary.html">org.apache.edgent.connectors.jdbc</a></td>
<td class="colLast">
<div class="block">JDBC based database stream connector.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/kafka/package-summary.html">org.apache.edgent.connectors.kafka</a></td>
<td class="colLast">
<div class="block">Apache Kafka enterprise messaging hub stream connector.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/mqtt/package-summary.html">org.apache.edgent.connectors.mqtt</a></td>
<td class="colLast">
<div class="block">MQTT (lightweight messaging protocol for small sensors and mobile devices) stream connector.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/mqtt/iot/package-summary.html">org.apache.edgent.connectors.mqtt.iot</a></td>
<td class="colLast">
<div class="block">An MQTT based IotDevice connector.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/pubsub/package-summary.html">org.apache.edgent.connectors.pubsub</a></td>
<td class="colLast">
<div class="block">Publish subscribe model between jobs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/pubsub/oplets/package-summary.html">org.apache.edgent.connectors.pubsub.oplets</a></td>
<td class="colLast">
<div class="block">Oplets supporting publish subscribe service.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/pubsub/service/package-summary.html">org.apache.edgent.connectors.pubsub.service</a></td>
<td class="colLast">
<div class="block">Publish subscribe service.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/serial/package-summary.html">org.apache.edgent.connectors.serial</a></td>
<td class="colLast">
<div class="block">Serial port connector API.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/wsclient/package-summary.html">org.apache.edgent.connectors.wsclient</a></td>
<td class="colLast">
<div class="block">A generic WebSocket Client Connector API for sending and receiving messages to a WebSocket Server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/connectors/wsclient/javax/websocket/package-summary.html">org.apache.edgent.connectors.wsclient.javax.websocket</a></td>
<td class="colLast">
<div class="block">A JSR356 based WebSocket Client Connector for sending and receiving messages to a WebSocket Server.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Edgent Utilities table, listing packages, and an explanation">
<caption><span>Edgent Utilities</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/metrics/package-summary.html">org.apache.edgent.metrics</a></td>
<td class="colLast">
<div class="block">Metric utility methods, oplets, and reporters which allow an
application to expose metric values, for example via JMX.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/metrics/oplets/package-summary.html">org.apache.edgent.metrics.oplets</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/streamscope/package-summary.html">org.apache.edgent.streamscope</a></td>
<td class="colLast">
<div class="block">Stream Oscilloscope - package for instrumenting streams to capture tuples.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/streamscope/mbeans/package-summary.html">org.apache.edgent.streamscope.mbeans</a></td>
<td class="colLast">
<div class="block">Stream Oscilloscope <a href="org/apache/edgent/execution/services/ControlService.html" title="interface in org.apache.edgent.execution.services"><code>ControlService</code></a>
Management Bean interfaces.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/streamscope/oplets/package-summary.html">org.apache.edgent.streamscope.oplets</a></td>
<td class="colLast">
<div class="block">Stream Oscilloscope underlying implementation oplets.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Edgent Tester table, listing packages, and an explanation">
<caption><span>Edgent Tester</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/topology/tester/package-summary.html">org.apache.edgent.topology.tester</a></td>
<td class="colLast">
<div class="block">Testing for a streaming topology.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Edgent Low-Level API table, listing packages, and an explanation">
<caption><span>Edgent Low-Level API</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/graph/package-summary.html">org.apache.edgent.graph</a></td>
<td class="colLast">
<div class="block">Low-level graph building API.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/graph/spi/package-summary.html">org.apache.edgent.graph.spi</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/graph/spi/execution/package-summary.html">org.apache.edgent.graph.spi.execution</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/oplet/package-summary.html">org.apache.edgent.oplet</a></td>
<td class="colLast">
<div class="block">Oplets API.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/oplet/core/package-summary.html">org.apache.edgent.oplet.core</a></td>
<td class="colLast">
<div class="block">Core primitive oplets.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/oplet/functional/package-summary.html">org.apache.edgent.oplet.functional</a></td>
<td class="colLast">
<div class="block">Oplets that process tuples using functions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/oplet/plumbing/package-summary.html">org.apache.edgent.oplet.plumbing</a></td>
<td class="colLast">
<div class="block">Oplets that control the flow of tuples.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/oplet/window/package-summary.html">org.apache.edgent.oplet.window</a></td>
<td class="colLast">
<div class="block">Oplets using windows.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/window/package-summary.html">org.apache.edgent.window</a></td>
<td class="colLast">
<div class="block">Window API.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Edgent SPI table, listing packages, and an explanation">
<caption><span>Edgent SPI</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/topology/spi/package-summary.html">org.apache.edgent.topology.spi</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/topology/spi/functions/package-summary.html">org.apache.edgent.topology.spi.functions</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/topology/spi/graph/package-summary.html">org.apache.edgent.topology.spi.graph</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/topology/spi/tester/package-summary.html">org.apache.edgent.topology.spi.tester</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Other Packages table, listing packages, and an explanation">
<caption><span>Other Packages</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/apps/iot/package-summary.html">org.apache.edgent.apps.iot</a></td>
<td class="colLast">
<div class="block">Applications for use in an Internet of Things environment.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/apps/runtime/package-summary.html">org.apache.edgent.apps.runtime</a></td>
<td class="colLast">
<div class="block">Applications which provide monitoring and failure recovery to other
Edgent applications.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/runtime/appservice/package-summary.html">org.apache.edgent.runtime.appservice</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/runtime/etiao/package-summary.html">org.apache.edgent.runtime.etiao</a></td>
<td class="colLast">
<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>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/runtime/etiao/graph/package-summary.html">org.apache.edgent.runtime.etiao.graph</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/runtime/etiao/graph/model/package-summary.html">org.apache.edgent.runtime.etiao.graph.model</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/runtime/etiao/mbeans/package-summary.html">org.apache.edgent.runtime.etiao.mbeans</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/runtime/jmxcontrol/package-summary.html">org.apache.edgent.runtime.jmxcontrol</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/edgent/runtime/jobregistry/package-summary.html">org.apache.edgent.runtime.jobregistry</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/edgent/runtime/jsoncontrol/package-summary.html">org.apache.edgent.runtime.jsoncontrol</a></td>
<td class="colLast">
<div class="block">Control service that takes a Json message and invokes
an operation on a control service MBean.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer"><a name="overview.description">
<!-- -->
</a>
<div class="block">Apache Edgent is an SDK for developing and executing streaming analytics at the <i>edge</i>.
<P>
<em>
Apache Edgent is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by Apache Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
</em>
</P>
<H1>Edgent</H1>
<OL>
<LI><a href="#overview">Overview</A></LI>
<LI><a href="#model">Programming Model</A></LI>
<LI><a href="#start">Getting Started</A></LI>
</OL>
<a name="overview"></a>
<H2>Overview</H2>
Apache Edgent is an SDK for developing and executing streaming analytics at the <i>edge</i>.
Edgent provides a stream processing style programming model for
composing stream processing graphs and a micro-services style runtime for
executing the graphs. Some analytics and a rich collection
of connectors are provided. Users can easily develop and use their
own analytics and connectors.
A framework for testing processing graphs is also included.
<P>
Edgent is focusing on two edge cases:
<UL>
<LI>Internet of Things (IoT) - Widely distributed and/or mobile devices and gateways.</LI>
<LI>Enterprise Embedded - Edge analytics within an enterprise, such as local analytic applications of each system in a machine room, or error log analytics in application servers.</LI>
</UL>
In both cases Edgent applications analyze live data and
send results of that analytics and/or data intermittently
to back-end systems for deeper analysis. An Edgent application
can use analytics to decide when to send information to back-end systems,
such as when the behaviour of the system is outside normal parameters
(e.g. an engine running too hot).
<BR>
Edgent applications do not send data continually
to back-end systems as the cost of communication may be high
(e.g. cellular networks) or bandwidth may be limited.
<P>
Edgent applications communicate with back-end systems through
some form of message hub as there may be millions of edge devices.
Edgent supports these message hubs:
<UL>
<LI> MQTT - Messaging standard for IoT</LI>
<LI> IBM Watson IoT Platform - Cloud based service providing a device model on top of MQTT</LI>
<LI> Apache Kafka - Enterprise message bus</LI>
</UL>
</P>
<P>
Back-end analytic systems are used to perform analysis on information from Edgent applications that cannot be performed at the edge. Such analysis may be:
<UL>
<LI>Running complex analytic algorithms than require more resources (cpu, memory etc.) than are available at the edge. </LI>
<LI>Maintaining more state per device that can exist at the edge, e.g. hours of state for patients' medical sensors. </LI>
<LI>Correlating device information with multiple data sources:
<UL>
<LI> Weather data</LI>
<LI> Social media data</LI>
<LI> Data of record (e.g patients' medical histories, trucking manifests).</LI>
<LI> Other devices </LI>
<LI>etc.</LI>
</UL>
</LI>
</UL>
<BR>
Back-end systems can interact or control devices based upon their analytics, by sending commands to specific devices, e.g. reduce maximum engine revs to reduce chance of failure before the next scheduled service, or send an alert of an accident ahead.
</P>
<a name="model"></a>
<H2>Programming Model</H2>
Edgent applications are streaming applications in which each <em>tuple</em>
(data item or event) in a <em>stream</em> of data is processed as it occurs.
Additionally, you can process <em>windows</em> (logical subsets) of data.
For example, you could analyze the last 90 seconds of data from a sensor to identify trends in the data
<P>
<H3>Topology functional API</H3>
<H4>Overview</H4>
The primary api is <a href="org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology"><code>Topology</code></a> which uses a functional
model to build a topology of <a href="org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology"><code>streams</code></a> for an application.
<BR>
<a href="org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology"><code>TStream</code></a> is a declaration of a stream of tuples, an application will create streams that source data (e.g. sensor readings) and then apply functions that transform those streams into derived streams, for example simply filtering a stream containg engine temperator readings to a derived stream that only contains readings thar are greater than 100&deg;C.
<BR>
An application terminates processing for a stream by <em>sinking</em> it. Sinking effectively terminates a stream by applying processing to each tuple on the stream (as it occurs) that does not produce a result. Typically this sinking is transmitting the tuple to an external system, for example the messgae hub to send the data to a back-end system, or locally sending the data to a user interface.
</P>
<P>
This programming style is typical for streaming systems and similar APIs are supported by systems such as Apache Flink, Apache Spark Streaming, IBM Streams and Java 8 streams.
</P>
<H4>Functions</H4>
Edgent supports Java 8 and it is encouraged to use Java 8 as functions can be easily and clearly written using lambda expressions.
<H4>Arbitrary Topology</H4>
Simple applications may just be a pipeline of streams, for example, logically:
<BR>
<code>source --&gt; filter --&gt; transform --&gt; aggregate --&gt; send to MQTT</code>
<BR>
However Edgent allows arbitrary topologies including:
<UL>
<LI>Multiple source streams in an application</LI>
<LI>Multiple sinks in an application </LI>
<LI>Multiple processing including sinks against a stream (fan-out)</LI>
<LI>Union of streams (fan-in) </LI>
<LI>Correlation of streams by allowing streams to be joined</LI>
</UL>
<H3>Graph API</H3>
<H4>Overview</H4>
The <a href="org/apache/edgent/graph/Graph.html" title="interface in org.apache.edgent.graph"><code>graph</code></a> API is a lower-level API that the
topology api is built on top of. A graph consists of
<a href="org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet"><code>oplet</code></a> invocations connected by streams.
The oplet invocations contain the processing applied to each tuple
on streams connected to their input ports. Processing by the oplet
submits tuples to its output ports for subsequent processing
by downstream connected oplet invocations.
<a name="start"></a>
<H2>Getting Started</H2>
<P>
A number of sample Java applications are provided that demonstrate use of Edgent.
General information about Edgent Application development and
some development utilities are included.
See <a href="https://edgent.apache.org/docs/edgent-getting-started">Getting Started</a>.</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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-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>